RunspaceConnectionInfo Class

  • Reference

Definition

Namespace:
System.Management.Automation.Runspaces
Assembly:
System.Management.Automation.dll
Package:
Microsoft.PowerShell.5.1.ReferenceAssemblies v1.0.0
Package:
System.Management.Automation v7.0.13
Package:
System.Management.Automation v7.1.7
Package:
System.Management.Automation v7.2.12
Package:
System.Management.Automation v7.3.5
Package:
System.Management.Automation v7.4.0
Package:
Microsoft.WSMan.Runtime v6.1.0
Package:
Microsoft.WSMan.Runtime v6.2.0

Class which defines connection path to a remote runspace that needs to be created. Transport specific connection paths will be derived from this.

public ref class RunspaceConnectionInfo abstract
public abstract class RunspaceConnectionInfo
type RunspaceConnectionInfo = class
Public MustInherit Class RunspaceConnectionInfo
Inheritance
Object
RunspaceConnectionInfo
Derived

Constructors

RunspaceConnectionInfo()

Fields

MaxPort

Maximum value for port.
MinPort

Minimum value for port.

Properties

AuthenticationMechanism

Authentication mechanism to use while connecting to the server.
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.
CertificateThumbprint

ThumbPrint of a certificate used for connecting to a remote machine. When this is specified, you dont need to supply credential and authentication mechanism.
ComputerName

Name of the computer.
Credential

Credential used for the connection.
Culture

Culture that the remote session should use.
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.
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.
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.
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.
UICulture

UI culture that the remote session should use.

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.

Applies to