Get-PowerShellServerFile Cmdlet

Parameters   Output Objects   Config Settings  

The Get-PowerShellServerFile Component is used to retrieve a file from a remote PowerShell Server.

Syntax

Get-PowerShellServerFile [parameters]

Remarks

Get-PowerShellServerFile provides an easy way to copy files from the remote server to the local machine.

Parameter List

---

The following is the full list of the parameters of the cmdlet with short descriptions. Click on the links for further details.

LogFile	The location of a file to which debug information is written.
AuthMode	The type of authentication used by the component.
CertPassword	The password to the certificate store.
CertStore	The name of the certificate store for the client certificate.
CertStoreType	The type of certificate store for the client certificate.
CertSubject	The subject of the certificate used for client authentication.
CompressionAlgorithms	A comma-separated list containing all allowable compression algorithms.
Config	Specifies one or more configuration settings.
Credential	The PSCredential object to use for user/password authentication.
DecryptionPassword	The password used to decrypt the received file.
EncryptionAlgorithms	A comma-separated list containing all allowable compression algorithms.
FirewallHost	Name or IP address of firewall.
FirewallPassword	A password if authentication is to be used when connecting through the firewall.
FirewallPort	The port of the firewall to which to connect.
FirewallType	Determines the type of firewall to connect through.
FirewallUser	A user name if authentication is to be used connecting through a firewall.
Force	Forces the component to accept the default behavior instead of querying the user.
LocalFile	Name of the local file to write to.
LocalIP	The IP address of the local interface to use.
LogFile	The location of a file to which debug information is written.
Offset	Specifies the byte from which to start receiving the file.
Password	The password to use for authentication.
Port	The port to be used.
PreserveTimeStamp	Indicates whether to preserve the timestamps while downloading files.
RemoteFile	Name of the remote file to get.
Server	The address of the Server.
SSHAccept	The hex-encoded fingerprint of the host to trust explicitly.
Timeout	The maximum time allowed for the operation.
User	The username to use for authentication.

Output Objects

---

The following is the full list of the output objects returned by the cmdlet with short descriptions. Click on the links for further details.

Config Settings

---

The following is a list of config settings for the cmdlet with short descriptions. Click on the links for further details.

GSSAPIMechanisms	The desired GSS-API authentication mechanism.
KerberosDelegation	If true, asks for credentials with delegation enabled during authentication.
KerberosRealm	The fully qualified domain name of the Kerberos Realm to use for GSSAPI authentication.
KerberosSPN	The Kerberos Service Principal Name of the SSH host.
BuildInfo	Information about the product's build.
CodePage	The system code page used for Unicode to Multibyte translations.
LicenseInfo	Information about the current license.
MaskSensitive	Whether sensitive data is masked in log messages.
UseInternalSecurityAPI	Tells the component whether or not to use the system security libraries or an internal implementation.

LogFile Parameter (Get-PowerShellServerFile Cmdlet)

The location of a file to which debug information is written.

Syntax

Get-PowerShellServerFile -LogFile string

Remarks

When specified, the cmdlet will log debug information to the file. If the file exists, the information will be appended.

Default Value

null

AuthMode Property (Get-PowerShellServerFile Cmdlet)

The type of authentication used by the component.

Syntax

Get-PowerShellServerFile -AuthMode string

Remarks

Normally, the cmdlet will attempt to log in to the SSH server and authenticate via username and password. This behavior can be changed to use client key (RSA) authentication by setting this parameter to 'PublicKey'.

Default Value

2

CertPassword Property (Get-PowerShellServerFile Cmdlet)

The password to the certificate store.

Syntax

Get-PowerShellServerFile -CertPassword string

Remarks

Specifies a password (if required) to access the specified certificate store.

Default Value

""

Parameter Alias

CertificatePassword

CertStore Property (Get-PowerShellServerFile Cmdlet)

The name of the certificate store for the client certificate.

Syntax

Get-PowerShellServerFile -CertStore string

Remarks

The CertStoreType parameter specifies the type of the certificate store specified by CertStore. If the store is password protected, specify the password in CertPassword.

CertStore is used in conjunction with the CertSubject parameter in order to specify client certificates. If CertStore has a value, and CertSubject has been set, a search for a certificate is initiated during logon. Please refer to the CertSubject parameter for details.

Designations of certificate stores are platform-dependent.

The following are designations of the most common User and Machine certificate stores in Windows:

When the certificate store type is PFXFile, this parameter must be set to the name of the file.

Default Value

"MY"

Parameter Alias

CertificateStore

CertStoreType Property (Get-PowerShellServerFile Cmdlet)

The type of certificate store for the client certificate.

Syntax

Get-PowerShellServerFile -CertStoreType string

Remarks

This parameter can take one of the following values:

Default Value

0

CertSubject Property (Get-PowerShellServerFile Cmdlet)

The subject of the certificate used for client authentication.

Syntax

Get-PowerShellServerFile -CertSubject string

Remarks

During the user authentication phase of the logon process, the cmdlet will search the store specified in CertStore for a certificate that matches this parameter. If the store contains a private key for that certificate, it is used to verify the user's identity with the secure server.

When this parameter is set, a search is performed in the current certificate store certificate with matching subject.

If an exact match is not found, the store is searched for subjects containing the value of the parameter.

When setting the parameter to a partial subject, CN= should be omitted. For example, the following code would find the certificate with subject CN=Test Certificate, OU=People, C=US

Example (Searching with partial subject)

-certsubject "Test"

If a match is not found, the parameter is set to an empty string, and no certificate is selected.

The special value "*" picks a random certificate in the certificate store.

Default Value

"*"

CompressionAlgorithms Property (Get-PowerShellServerFile Cmdlet)

A comma-separated list containing all allowable compression algorithms.

Syntax

Get-PowerShellServerFile -CompressionAlgorithms string

Remarks

During the SSH handshake, this list will be used to negotiate the compression algorithm to be used between the client and server. This list is used for both directions: client to server and server to client. When negotiating algorithms, each side sends a list of all algorithms it supports or allows. The algorithm chosen for each direction is the first algorithm to appear in the sender's list that the receiver supports, so it is important to list multiple algorithms in preferential order. If no algorithm can be agreed upon, the cmdlet will raise an error and the connection will be aborted.

At least one support algorithm must appear in this list. The following compression algorithms are supported by the cmdlet:

• zlib
• none

Default Value

"zlib,none"

Config Property (Get-PowerShellServerFile Cmdlet)

Specifies one or more configuration settings.

Syntax

Get-PowerShellServerFile -Config string[]

Remarks

The Config parameter takes one or more name-value pairs that represent the name of the configuration setting and value, i.e.: -config "Name=Value"

Default Value

null

Credential Property (Get-PowerShellServerFile Cmdlet)

The PSCredential object to use for user/password authentication.

Syntax

Get-PowerShellServerFile -Credential PSCredential

Remarks

Every cmdlet that supports user authentication will expose a Credential parameter. A PSCredential object should be specified for this parameter. Alternatively, the User and Password parameters can be set to represent the credential information.

If the cmdlet supports client key authentication it uses the password field of this object for the certificate's password. This setting is enabled by using public key authentication. Note: Due to security reasons, it is recommended that you use the Credential parameter rather than User and Password to specify the authentication information.

Default Value

null

Parameter Position

1

Parameter Alias

auth

DecryptionPassword Property (Get-PowerShellServerFile Cmdlet)

The password used to decrypt the received file.

Syntax

Get-PowerShellServerFile -DecryptionPassword string

Remarks

If DecryptionPassword is set, it will be used to generate decryption keys to decrypt the file as it is received. Will only work with files encrypted by the Send-PowershellServerFile cmdlet

If DecryptionPassword is not set, files will be transmitted just as they are in the server without any change.

Default Value

""

EncryptionAlgorithms Property (Get-PowerShellServerFile Cmdlet)

A comma-separated list containing all allowable compression algorithms.

Syntax

Get-PowerShellServerFile -EncryptionAlgorithms string

Remarks

During the SSH handshake, this list will be used to negotiate the encryption algorithm to be used between the client and server. This list is used for both directions: client to server and server to client. When negotiating algorithms, each side sends a list of all algorithms it supports or allows. The algorithm chosen for each direction is the first algorithm to appear in the sender's list that the receiver supports, so it is important to list multiple algorithms in preferential order. If no algorithm can be agreed upon, the cmdlet will raise an error and the connection will be aborted.

At least one support algorithm must appear in this list. The following encryption algorithms are supported by the cmdlet:

By default, "aes256-cbc", the only encryption algorithm recommended by the SSH specification, and "3des-cbc", the only algorithm required, are enabled. It is not recommended to enable "none", as this defeats the purpose of an SSH connection.

Default Value

"aes256-cbc,3des-cbc"

FirewallHost Property (Get-PowerShellServerFile Cmdlet)

Name or IP address of firewall.

Syntax

Get-PowerShellServerFile -FirewallHost string

Remarks

If a FirewallHost is given, requested connections will be authenticated through the specified firewall when connecting.

If the FirewallHost parameter is set to a Domain Name, a DNS request is initiated. Upon successful termination of the request, the FirewallHost parameter is set to the corresponding address. If the search is not successful, an error is returned.

Default Value

""

FirewallPassword Property (Get-PowerShellServerFile Cmdlet)

A password if authentication is to be used when connecting through the firewall.

Syntax

Get-PowerShellServerFile -FirewallPassword string

Remarks

If FirewallHost is specified, the FirewallUser and FirewallPassword properties are used to authenticate against the firewall.

Default Value

""

FirewallPort Property (Get-PowerShellServerFile Cmdlet)

The port of the firewall to which to connect.

Syntax

Get-PowerShellServerFile -FirewallPort int

Remarks

The TCP port for the FirewallHost. See the description of the FirewallHost parameter for details.

Note that the FirewallPort is set automatically when FirewallType is set to a valid value. See the description of the FirewallType parameter for details. Setting this parameter will overwrite the default settings for the firewall port as specified by FirewallType.

Default Value

0

FirewallType Property (Get-PowerShellServerFile Cmdlet)

Determines the type of firewall to connect through.

Syntax

Get-PowerShellServerFile -FirewallType string

Remarks

The applicable values are the following:

Default Value

0

FirewallUser Property (Get-PowerShellServerFile Cmdlet)

A user name if authentication is to be used connecting through a firewall.

Syntax

Get-PowerShellServerFile -FirewallUser string

Remarks

If FirewallHost is specified, the FirewallUser and FirewallPassword properties are used to authenticate against the firewall.

Default Value

""

Force Property (Get-PowerShellServerFile Cmdlet)

Forces the component to accept the default behavior instead of querying the user.

Syntax

Get-PowerShellServerFile -Force SwitchParameter

Remarks

The Force parameter is especially useful in a script environment where user interaction is not an option. Certain cmdlets that are SSH and SSL based will query the user if the security credentials of the certificate presented by the server are not met. Setting this parameter will force the cmdlet to accept the certificate of the server unconditionally.

Default Value

false

LocalFile Property (Get-PowerShellServerFile Cmdlet)

Name of the local file to write to.

Syntax

Get-PowerShellServerFile -LocalFile string

Remarks

Specifies the path and name of the file the received content will be written to.

Default Value

""

This is a required parameter.

LocalIP Property (Get-PowerShellServerFile Cmdlet)

The IP address of the local interface to use.

Syntax

Get-PowerShellServerFile -LocalIP string

Remarks

This parameter is useful when the cmdlet is running on a machine that has more than one network interface (each with its own IP address and network access privileges).

Default Value

""

Parameter Alias

LocalAddress

LogFile Property (Get-PowerShellServerFile Cmdlet)

The location of a file to which debug information is written.

Syntax

Get-PowerShellServerFile -LogFile string

Remarks

When specified, the cmdlet will log debug information to the file. If the file exists, the information will be appended.

Default Value

""

Offset Property (Get-PowerShellServerFile Cmdlet)

Specifies the byte from which to start receiving the file.

Syntax

Get-PowerShellServerFile -Offset long

Remarks

If Offset is greater than 0, the cmdlet will ask the server to only send bytes starting from Offset instead of the entire file, and will try to append the remaining bytes to the local file.

This can be useful when you want to resume an previous interrupted attempt to download the file.

Default Value

0

Password Property (Get-PowerShellServerFile Cmdlet)

The password to use for authentication.

Syntax

Get-PowerShellServerFile -Password string

Remarks

Every time User, or Password are set, the cmdlet will authenticate with the server. It is recommended that the Credential parameter is set instead of User/Password because of security reasons. If both Credential and this parameter is set, the Credential value is used.

Default Value

""

Port Property (Get-PowerShellServerFile Cmdlet)

The port to be used.

Syntax

Get-PowerShellServerFile -Port int

Remarks

Port specifies a service port on the remote host to which to connect.

A valid port number (a value between 1 and 65535) is required for the connection to take place.

Default Value

22

PreserveTimeStamp Property (Get-PowerShellServerFile Cmdlet)

Indicates whether to preserve the timestamps while downloading files.

Syntax

Get-PowerShellServerFile -PreserveTimeStamp SwitchParameter

Remarks

By default, the timestamps are not preserved.

Default Value

false

RemoteFile Property (Get-PowerShellServerFile Cmdlet)

Name of the remote file to get.

Syntax

Get-PowerShellServerFile -RemoteFile string

Remarks

Specifies the path and name of the remote file to get from the server.

Default Value

""

This is a required parameter.

Server Property (Get-PowerShellServerFile Cmdlet)

The address of the Server.

Syntax

Get-PowerShellServerFile -Server string

Remarks

The cmdlet requires a server address to be provided. Either an IP address or the server host name can be provided.

Default Value

""

Parameter Position

0

This is a required parameter.

SSHAccept Property (Get-PowerShellServerFile Cmdlet)

The hex-encoded fingerprint of the host to trust explicitly.

Syntax

Get-PowerShellServerFile -SSHAccept string

Remarks

The fingerprint will be an MD5 hash of the host key in hex-encoded form, i.e. "0a:1b:2c:3d". Setting this will instruct the cmdlet to trust the fingerprint provided without prompting for verification.

After each connection, regardless of whether or not the key was trusted, the cmdlet will store the server's host key in the $SSHServerHostKey session variable. This variable can be inspected to view details of the server's key.

If the Force parameter is set, the cmdlet will accept the server's key unconditionally.

In cases where the host key presented by the server is not trusted, a prompt will be shown to the user. This prompt will allow the user to decide whether or not they would like to accept the host key presented by the server.

There may be cases where you do not want a prompt to be displayed or would like to handle the response supplied directly within your script. This can be done by setting the $SSHAcceptPreference variable prior to running the cmdlet. The available values for this variable are:

Default Value

""

Parameter Alias

Fingerprint

Timeout Property (Get-PowerShellServerFile Cmdlet)

The maximum time allowed for the operation.

Syntax

Get-PowerShellServerFile -Timeout int

Remarks

After the specified interval in seconds, the cmdlet will throw a Timeout error if the operation is not completed.

Default Value

10

User Property (Get-PowerShellServerFile Cmdlet)

The username to use for authentication.

Syntax

Get-PowerShellServerFile -User string

Remarks

Every time User and Password are set, the cmdlet will authenticate with the server. It is recommended that the Credential parameter is set instead of User/Password because of security reasons. If both Credential and this parameter is set, the Credential value is used.

Default Value

""

Config Settings (Get-PowerShellServerFile Cmdlet)

The cmdlet accepts one or more of the following configuration settings. Configuration settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the cmdlet, access to these internal properties is provided through the Config method.

Get-PowerShellServerFile Config Settings

Base Config Settings