Get-PowerShellServerFile Cmdlet
Parameters Output Objects Configuration Settings
The Get-PowerShellServerFile Cmdlet 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 cmdlet. |
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 cmdlet 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.
Configuration Settings
The following is a list of configuration settings for the cmdlet with short descriptions. Click on the links for further details.
GSSAPIMechanisms | The desired GSS-API authentication mechanism. |
KerberosRealm | The fully qualified domain name of the Kerberos Realm to use for GSSAPI authentication. |
KerberosDelegation | If true, asks for credentials with delegation enabled during authentication. |
KerberosSPN | The Kerberos Service Principal Name of the SSH host. |
UseBackgroundThread | Whether threads created by the cmdlet are background threads. |
UseInternalSecurityAPI | Tells the cmdlet whether or not to use the system security libraries or an internal implementation. |