SSHConnectionInfo Class

Definition

Namespace:

System.Management.Automation.Runspaces

Assembly:

System.Management.Automation.dll

Package:

System.Management.Automation v7.4.0

Class used to create a connection through an SSH.exe client to a remote host machine. Connection information includes SSH target (user name and host machine) along with client key used for key based user authorization.

public ref class SSHConnectionInfo sealed : System::Management::Automation::Runspaces::RunspaceConnectionInfo

public sealed class SSHConnectionInfo : System.Management.Automation.Runspaces.RunspaceConnectionInfo

type SSHConnectionInfo = class
    inherit RunspaceConnectionInfo

Public NotInheritable Class SSHConnectionInfo
Inherits RunspaceConnectionInfo

Inheritance

Object

RunspaceConnectionInfo

SSHConnectionInfo

Constructors

SSHConnectionInfo(String, String, String)	Initializes a new instance of the SSHConnectionInfo class.
SSHConnectionInfo(String, String, String, Int32)	Initializes a new instance of the SSHConnectionInfo class.
SSHConnectionInfo(String, String, String, Int32, String)	Initializes a new instance of the SSHConnectionInfo class.
SSHConnectionInfo(String, String, String, Int32, String, Int32)	Initializes a new instance of SSHConnectionInfo.
SSHConnectionInfo(String, String, String, Int32, String, Int32, Hashtable)	Initializes a new instance of the SSHConnectionInfo class.

Fields

MaxPort	Maximum value for port. (Inherited from RunspaceConnectionInfo)
MinPort	Minimum value for port. (Inherited from RunspaceConnectionInfo)

Properties

AuthenticationMechanism	Authentication.
CancelTimeout	The duration (in ms) for which PowerShell should wait before it times out on cancel operations (close runspace or stop powershell). For instance, when the user hits ctrl-C, New-PSSession cmdlet tries to call a stop on all remote runspaces which are in the Opening state. The administrator wouldn't mind waiting for 15 seconds, but this should be time bound and of a shorter duration. A high timeout here like 3 minutes will give the administrator a feeling that the PowerShell client is not responding. (Inherited from RunspaceConnectionInfo)
CertificateThumbprint	CertificateThumbprint.
ComputerName	Computer is always localhost.
ConnectingTimeout	Gets or sets a time in milliseconds after which a connection attempt is terminated. Default value (-1) never times out and a connection attempt waits indefinitely.
Credential	Credential.
Culture	Culture that the remote session should use. (Inherited from RunspaceConnectionInfo)
IdleTimeout	The duration (in ms) for which a Runspace on server needs to wait before it declares the client dead and closes itself down. This is especially important as these values may have to be configured differently for enterprise administration and exchange scenarios. (Inherited from RunspaceConnectionInfo)
KeyFilePath	Key File Path.
MaxIdleTimeout	The maximum allowed idle timeout duration (in ms) that can be set on a Runspace. This is a read-only property that is set once the Runspace is successfully created and opened. (Inherited from RunspaceConnectionInfo)
OpenTimeout	The duration (in ms) for which PowerShell remoting waits before timing out on a connection to a remote machine. Simply put, the timeout for a remote runspace creation. The administrator would like to tweak this timeout depending on whether he/she is connecting to a machine in the data center or across a slow WAN. (Inherited from RunspaceConnectionInfo)
OperationTimeout	The duration for which PowerShell remoting waits before timing out for any operation. The user would like to tweak this timeout depending on whether he/she is connecting to a machine in the data center or across a slow WAN. Default: 3601000 == 3minutes. (Inherited from RunspaceConnectionInfo)
Port	Port for connection.
Subsystem	Subsystem to use.
UICulture	UI culture that the remote session should use. (Inherited from RunspaceConnectionInfo)
UserName	User Name.

Methods

Clone()	Create a copy of the connection info object.
CreateClientSessionTransportManager(Guid, String, PSRemotingCryptoHelper)	Creates the appropriate client session transportmanager.
SetSessionOptions(PSSessionOption)	Populates session options from a PSSessionOption instance. (Inherited from RunspaceConnectionInfo)