PSSessionOption Class

Definition

Options for a remote PSSession

public ref class PSSessionOption sealed
public sealed class PSSessionOption
type PSSessionOption = class
Public NotInheritable Class PSSessionOption
Inheritance
PSSessionOption

Constructors

PSSessionOption()

Creates a new instance of PSSessionOption

Properties

ApplicationArguments

Application arguments the server can see in ApplicationArguments

CancelTimeout

The duration 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 user 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 user a feeling that the PowerShell client has hung.

Default: 60 * 1000 = 1 minute

Culture

Culture that the remote session should use

IdleTimeout

The duration 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.

Default: -1 -> Use current server value for IdleTimeout.

IncludePortInSPN

Uses Service Principal Name (SPN) along with the Port number during authentication.

MaxConnectionRetryCount

Number of times a connection will be re-attempted when a connection fails due to network issues.

MaximumConnectionRedirectionCount

The MaximumConnectionRedirectionCount parameter enables the implicit redirection functionality. -1 = no limit 0 = no redirection

MaximumReceivedDataSizePerCommand

Total data (in bytes) that can be received from a remote machine targeted towards a command. If null, then the size is unlimited. Default is unlimited data.

MaximumReceivedObjectSize

Maximum size (in bytes) of a deserialized object received from a remote machine. If null, then the size is unlimited. Default is 200MB object size.

NoCompression

If false, underlying WSMan infrastructure will compress data sent on the network. If true, data will not be compressed. Compression improves performance by reducing the amount of data sent on the network. Compression my require extra memory consumption and CPU usage. In cases where available memory / CPU is less, set this property to "true". By default the value of this property is "false".

NoEncryption

Specifies that no encryption will be used when doing remote operations over http. Unencrypted traffix is not allowed by default and must be enabled in the local configuration

NoMachineProfile

If true then Operating System won't load the user profile (i.e. registry keys under HKCU) on the remote server which can result in a faster session creation time. This option won't have any effect if the remote machine has already loaded the profile (i.e. in another session).

OpenTimeout

The duration 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 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: 3 * 60 * 1000 = 3 minutes

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

OutputBufferingMode

Determines how server in disconnected state deals with cached output data when the cache becomes filled. Default value is 'block mode' where command execution is blocked after the server side data cache becomes filled.

ProxyAccessType

By default, ProxyAccessType is None, that means Proxy information (ProxyAccessType, ProxyAuthenticationMechanism and ProxyCredential)is not passed to WSMan at all.

ProxyAuthentication

The following is the definition of the input parameter "ProxyAuthentication". This parameter takes a set of authentication methods the user can select from. The available options should be as follows:

  • Negotiate: Use the default authentication (as defined by the underlying protocol) for establishing a remote connection.
  • Basic: Use basic authentication for establishing a remote connection
  • Digest: Use Digest authentication for establishing a remote connection

Default is Negotiate.

ProxyCredential

The following is the definition of the input parameter "ProxyCredential".

SkipCACheck

When connecting over HTTPS, the client does not validate that the server certificate is signed by a trusted certificate authority (CA). Use only when the remote computer is trusted by other means, for example, if the remote computer is part of a network that is physically secure and isolated or the remote computer is listed as a trusted host in WinRM configuration

SkipCNCheck

Indicates that certificate common name (CN) of the server need not match the hostname of the server. Used only in remote operations using https. This option should only be used for trusted machines.

SkipRevocationCheck

Indicates that certificate common name (CN) of the server need not match the hostname of the server. Used only in remote operations using https. This option should only be used for trusted machines

UICulture

UI culture that the remote session should use

UseUTF16

Indicates the request is encoded in UTF16 format rather than UTF8 format; UTF8 is the default.

Applies to