Share via


VMConnectionInfo Class

Definition

The class that contains connection information for a remote session between a local host and VM. The local host can be a VM in nested scenario.

public ref class VMConnectionInfo sealed : System::Management::Automation::Runspaces::RunspaceConnectionInfo
public sealed class VMConnectionInfo : System.Management.Automation.Runspaces.RunspaceConnectionInfo
type VMConnectionInfo = class
    inherit RunspaceConnectionInfo
Public NotInheritable Class VMConnectionInfo
Inherits RunspaceConnectionInfo
Inheritance
VMConnectionInfo

Fields

MaxPort

Maximum value for port.

(Inherited from RunspaceConnectionInfo)
MinPort

Minimum value for port.

(Inherited from RunspaceConnectionInfo)

Properties

AuthenticationMechanism

Authentication mechanism to use while connecting to the server. Only Default is supported.

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

ThumbPrint of a certificate used for connecting to a remote machine. When this is specified, you dont need to supply credential and authentication mechanism. Will always be null to signify that this is not supported.

ComputerName

Name of the target VM.

ConfigurationName

Configuration name of the VM session.

Credential

Credential used for the connection.

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)
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)
UICulture

UI culture that the remote session should use.

(Inherited from RunspaceConnectionInfo)
VMGuid

GUID of the target VM.

Methods

Clone()

Create a copy of the connection info object.

Clone()

Create a copy of the connection info object.

(Inherited from RunspaceConnectionInfo)
CreateClientSessionTransportManager(Guid, String, PSRemotingCryptoHelper)

Creates the appropriate client session transportmanager.

CreateClientSessionTransportManager(Guid, String, PSRemotingCryptoHelper)

Creates the appropriate client session transportmanager.

(Inherited from RunspaceConnectionInfo)
SetSessionOptions(PSSessionOption)

Populates session options from a PSSessionOption instance.

(Inherited from RunspaceConnectionInfo)

Applies to