Connect-PowerShellServerCmdlet
Parameters Output Objects Config Settings
The Connect-PowerShellServer cmdlet is used to create a persistent connection object.
Syntax
$cnn = Connect-PowerShellServer [parameters]
Remarks
This cmdlet allows you to create a persistent connection object to be used with related cmdlets.When executing the cmdlet a connection object is returned. Pass this object to the Connection parameter of related cmdlets to use the newly created connection object.
To disconnect call Disconnect-PowerShellServer.
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. |
| 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. |
| LocalIP | The IP address of the local interface to use. |
| LogFile | The location of a file to which debug information is written. |
| Password | The password to use for authentication. |
| Port | The port to be used. |
| 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.
| PowerShellServerConnection | The connection object. |
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 (Connect-PowerShellServer Cmdlet)
The location of a file to which debug information is written.
Syntax
Connect-PowerShellServer -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 Parameter (Connect-PowerShellServer Cmdlet)
The type of authentication used by the component.
Syntax
Connect-PowerShellServer -AuthMode string
Remarks
Default Value
2
CertPassword Parameter (Connect-PowerShellServer Cmdlet)
The password to the certificate store.
Syntax
Connect-PowerShellServer -CertPassword string
Remarks
Default Value
""
Parameter Alias
CertificatePassword
CertStore Parameter (Connect-PowerShellServer Cmdlet)
The name of the certificate store for the client certificate.
Syntax
Connect-PowerShellServer -CertStore string
Remarks
Default Value
"MY"
Parameter Alias
CertificateStore
CertStoreType Parameter (Connect-PowerShellServer Cmdlet)
The type of certificate store for the client certificate.
Syntax
Connect-PowerShellServer -CertStoreType string
Remarks
Default Value
0
CertSubject Parameter (Connect-PowerShellServer Cmdlet)
The subject of the certificate used for client authentication.
Syntax
Connect-PowerShellServer -CertSubject string
Remarks
Default Value
"*"
Command Parameter (Connect-PowerShellServer Cmdlet)
The command to send to the remote SSH Server.
Syntax
Connect-PowerShellServer -Command string
Remarks
Default Value
""
Parameter Position
1
This is a required parameter.
CompressionAlgorithms Parameter (Connect-PowerShellServer Cmdlet)
A comma-separated list containing all allowable compression algorithms.
Syntax
Connect-PowerShellServer -CompressionAlgorithms string
Remarks
Default Value
"zlib,none"
Config Parameter (Connect-PowerShellServer Cmdlet)
Specifies one or more configuration settings.
Syntax
Connect-PowerShellServer -Config string[]
Remarks
Default Value
null
Credential Parameter (Connect-PowerShellServer Cmdlet)
The PSCredential object to use for user/password authentication.
Syntax
Connect-PowerShellServer -Credential PSCredential
Remarks
Default Value
null
Parameter Position
1
Parameter Alias
auth
EncryptionAlgorithms Parameter (Connect-PowerShellServer Cmdlet)
A comma-separated list containing all allowable compression algorithms.
Syntax
Connect-PowerShellServer -EncryptionAlgorithms string
Remarks
Default Value
"aes256-cbc,3des-cbc"
FirewallHost Parameter (Connect-PowerShellServer Cmdlet)
Name or IP address of firewall.
Syntax
Connect-PowerShellServer -FirewallHost string
Remarks
Default Value
""
FirewallPassword Parameter (Connect-PowerShellServer Cmdlet)
A password if authentication is to be used when connecting through the firewall.
Syntax
Connect-PowerShellServer -FirewallPassword string
Remarks
Default Value
""
FirewallPort Parameter (Connect-PowerShellServer Cmdlet)
The port of the firewall to which to connect.
Syntax
Connect-PowerShellServer -FirewallPort int
Remarks
Default Value
0
FirewallType Parameter (Connect-PowerShellServer Cmdlet)
Determines the type of firewall to connect through.
Syntax
Connect-PowerShellServer -FirewallType string
Remarks
Default Value
0
FirewallUser Parameter (Connect-PowerShellServer Cmdlet)
A user name if authentication is to be used connecting through a firewall.
Syntax
Connect-PowerShellServer -FirewallUser string
Remarks
Default Value
""
Force Parameter (Connect-PowerShellServer Cmdlet)
Forces the component to accept the default behavior instead of querying the user.
Syntax
Connect-PowerShellServer -Force SwitchParameter
Remarks
Default Value
false
LocalIP Parameter (Connect-PowerShellServer Cmdlet)
The IP address of the local interface to use.
Syntax
Connect-PowerShellServer -LocalIP string
Remarks
Default Value
""
Parameter Alias
LocalAddress
LogFile Parameter (Connect-PowerShellServer Cmdlet)
The location of a file to which debug information is written.
Syntax
Connect-PowerShellServer -LogFile string
Remarks
Default Value
""
Password Parameter (Connect-PowerShellServer Cmdlet)
The password to use for authentication.
Syntax
Connect-PowerShellServer -Password string
Remarks
Default Value
""
Port Parameter (Connect-PowerShellServer Cmdlet)
The port to be used.
Syntax
Connect-PowerShellServer -Port int
Remarks
Default Value
22
Server Parameter (Connect-PowerShellServer Cmdlet)
The address of the Server.
Syntax
Connect-PowerShellServer -Server string
Remarks
Default Value
""
Parameter Position
0
This is a required parameter.
SSHAccept Parameter (Connect-PowerShellServer Cmdlet)
The hex-encoded fingerprint of the host to trust explicitly.
Syntax
Connect-PowerShellServer -SSHAccept string
Remarks
Default Value
""
Parameter Alias
Fingerprint
Timeout Parameter (Connect-PowerShellServer Cmdlet)
The maximum time allowed for the operation.
Syntax
Connect-PowerShellServer -Timeout int
Remarks
Default Value
10
User Parameter (Connect-PowerShellServer Cmdlet)
The username to use for authentication.
Syntax
Connect-PowerShellServer -User string
Remarks
Default Value
""
PowerShellServerConnection Output Object (Connect-PowerShellServer Cmdlet)
The connection object.
Syntax
Object PowerShellServerConnection {string AuthMode;
string CertPassword;
string CertStore;
string CertStoreType;
string CertSubject;
string CompressionAlgorithms;
string[] Config;
PSCredential Credential;
string EncryptionAlgorithms;
string FirewallHost;
string FirewallPassword;
int FirewallPort;
string FirewallType;
string FirewallUser;
SwitchParameter Force;
string LocalIP;
string LogFile;
string Password;
int Port;
string Server;
string SSHAccept;
int Timeout;
string User;
}