powershellscripts.com

Tutorials  PowerShell Cmdlet Help for New-PSSessionOption



NAME
New-PSSessionOption

SYNOPSIS
Creates an object that contains advanced options for a PSSession.

SYNTAX
New-PSSessionOption [-ApplicationArguments ] [-CancelTimeOut ] [-Culture ]
[-IdleTimeOut ] [-MaximumReceivedDataSizePerCommand ] [-MaximumReceivedObjectSize ] [-MaximumRedire
ction ] [-NoCompression] [-NoEncryption] [-NoMachineProfile] [-OpenTimeOut ] [-OperationTimeOut ] [-
ProxyAccessType {None | IEConfig | WinHttpConfig | AutoDetect | NoProxyServer}] [-ProxyAuthentication {Default | Ba
sic | Negotiate | NegotiateWithImplicitCredential | Credssp | Digest | Kerberos}] [-ProxyCredential ]
[-SkipCACheck] [-SkipCNCheck] [-SkipRevocationCheck] [-UICulture ] [-UseUTF16] []


DESCRIPTION
The New-PSSessionOption cmdlet creates an object that contains advanced options for a PSSession. You can use the ob
ject as the value of the SessionOption parameter of cmdlets that create a PSSession, such as New-PSSession, Enter-P
SSession, and Invoke-Command.

Without parameters, New-PSSessionOption generates an object that contains the default values for all of the options
. Because all of the properties can be edited, you can use the resulting object as a template, and create standard
option objects for your enterprise.


PARAMETERS
-ApplicationArguments
Specifies a hash table that is sent directly to the session configuration without interpretation. This hash tab
le is available to the session configuration as a property of the PSSenderInfo class.

Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false

-CancelTimeOut
Determines how long Windows PowerShell waits for a cancel operation (CTRL + C) to complete before terminating
it. Enter a value in milliseconds.

The default value is 60000 (one minute). A value of 0 (zero) means no timeout; the command continues indefinite
ly.

Required? false
Position? named
Default value 60000
Accept pipeline input? false
Accept wildcard characters? false

-Culture
Specifies the culture to use for the PSSession. Enter a culture name in - f
ormat, such as "ja-jP", a variable that contains a CultureInfo object, or a command that gets a CultureInfo ob
ject, such as "get-culture".

The default value is $null, and the culture that is set in the operating system when the PSSession is created i
s used in the PSSession.

Required? false
Position? named
Default value Current culture
Accept pipeline input? false
Accept wildcard characters? false

-IdleTimeOut
Determines how long the PSSession stays open if the remote computer does not receive any communication from the
local computer, including the heartbeat signal. When the interval expires, the PSSession closes.

Enter a value in milliseconds. The default value is 240000 (4 minutes). The minimum value is 60000 (1 minute).

If both the local and remote computers specify an idle timeout value, the PSSession uses the shorter timeout va
lue. The local computer can set an idle timeout value by using this parameter or by setting an idle timeout in
the $PSSessionOption preference variable. The remote computer can specify an idle timeout value in the WS-Manag
ement configuration (WSMAN:\localhost\shell\idletimeout).

Required? false
Position? named
Default value 240000
Accept pipeline input? false
Accept wildcard characters? false

-MaximumReceivedDataSizePerCommand
Specifies the maximum number of bytes that the local computer can receive from the remote computer in a single
command. Enter a value in bytes. By default, there is no data size limit.

This option is designed to protect the resources on the client computer.

Required? false
Position? named
Default value No limit
Accept pipeline input? false
Accept wildcard characters? false

-MaximumReceivedObjectSize
Specifies the maximum size of an object that the local computer can receive from the remote computer. Enter a v
alue in bytes. By default, there is no data size limit.

This option is designed to protect the resources on the client computer.

Required? false
Position? named
Default value No limit
Accept pipeline input? false
Accept wildcard characters? false

-MaximumRedirection
Determines how many times Windows PowerShell redirects a connection to an alternate Uniform Resource Identifier
(URI) before the connection fails. The default value is 5. A value of 0 (zero) prevents all redirection.

This option is used in the PSSession only when the AllowRedirection parameter is used in the command that creat
es the PSSession.

Required? false
Position? named
Default value 5
Accept pipeline input? false
Accept wildcard characters? false

-NoCompression []
Turns off packet compression in the PSSession. Compression uses more processor cycles, but it makes transmissio
n faster.

Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false

-NoEncryption []
Turns off data encryption.

Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false

-NoMachineProfile []
Prevents loading the user's Windows user profile. As a result, the PSSession might be created faster, but user-
specific registry settings, items such as environment variables, and certificates are not available in the PSSe
ssion.

Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false

-OpenTimeOut
Determines how long the client computer waits for the session connection to be established. When the interval e
xpires, the command to establish the connection fails. Enter a value in milliseconds.

The default value is 180000 (3 minutes). A value of 0 (zero) means no time-out; the command continues indefinit
ely.

Required? false
Position? named
Default value 180000
Accept pipeline input? false
Accept wildcard characters? false

-OperationTimeOut
Determines the maximum time that any operation in the PSSession can run. When the interval expires, the operati
on fails. Enter a value in milliseconds.

The default value is 180000 (3 minutes). A value of 0 (zero) means no time-out; the operation continues indefin
itely.

Required? false
Position? named
Default value 180000
Accept pipeline input? false
Accept wildcard characters? false

-ProxyAccessType
Determines which mechanism is used to resolve the host name. Valid values are IEConfig, WinHttpConfig, AutoDete
ct, NoProxyServer and None. The default value is None.

For information about the values of this parameter, see the description of the System.Management.Automation.Rem
oting.ProxyAccessType enumeration in the MSDN (Microsoft Developer Network) Library at http://go.microsoft.com/
fwlink/?LinkId=144756.

Required? false
Position? named
Default value None
Accept pipeline input? false
Accept wildcard characters? false

-ProxyAuthentication
Specifies the authentication method that is used for proxy resolution. Valid values are Basic, Digest, and Nego
tiate. The default value is Negotiate.

For information about the values of this parameter, see the description of the System.Management.Automation.Run
spaces.AuthenticationMechanism enumeration in the MSDN library at http://go.microsoft.com/fwlink/?LinkID=144382
.

Required? false
Position? named
Default value Negotiate
Accept pipeline input? false
Accept wildcard characters? false

-ProxyCredential
Specifies the credentials to use for proxy authentication. Enter a variable that contains a PSCredential object
or a command that gets a PSCredential object, such as Get-Credential. If this option is not set, no credential
s are specified.

Required? false
Position? named
Default value None
Accept pipeline input? false
Accept wildcard characters? false

-SkipCACheck []
Specifies that when connecting over HTTPS, the client does not validate that the server certificate is signed b
y a trusted certificate authority (CA).

Use this option only when the remote computer is trusted by using another mechanism, such as when the remote co
mputer is part of a network that is physically secure and isolated, or the remote computer is listed as a trust
ed host in a WinRM configuration.

Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false

-SkipCNCheck []
Specifies that the certificate common name (CN) of the server does not need to match the hostname of the server
. This option is used only in remote operations that use the HTTPS protocol.

Use this option only for trusted computers.

Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false

-SkipRevocationCheck []
Does not validate the revocation status of the server certificate.

Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false

-UICulture
Specifies the UI culture to use for the PSSession.

Enter a culture name in - format, such as "ja-jP", a variable that contain
s a CultureInfo object, or a command that gets a CultureInfo object, such as Get-Culture.

The default value is $null, and the UI culture that is set in the operating system when the PSSession is create
d is used in the PSSession.

Required? false
Position? named
Default value Current UI culture
Accept pipeline input? false
Accept wildcard characters? false

-UseUTF16 []
Encode the request in UTF16 format rather than UTF8 format.

Required? false
Position? named
Default value False (UTF8 encoding)
Accept pipeline input? false
Accept wildcard characters? false


This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer and OutVariable. For more information, type,
"get-help about_commonparameters".

INPUTS
None
You cannot pipe input to this cmdlet.


OUTPUTS
System.Management.Automation.Remoting.PSSessionOption



NOTES


If the SessionOption parameter is not used in a command to create a PSSession, the session options are determin
ed by the property values of the $PSSessionOption preference variable, if it is set. For more information about
the $PSSessionOption variable, see about_Preference_Variables.


-------------------------- EXAMPLE 1 --------------------------

C:\PS>New-PSSessionOption


MaximumConnectionRedirectionCount : 5
NoCompression : False
NoMachineProfile : False
ProxyAccessType : IEConfig
ProxyAuthentication : Negotiate
ProxyCredential :
SkipCACheck : False
SkipCNCheck : False
SkipRevocationCheck : False
OperationTimeout : 00:03:00
NoEncryption : False
UseUTF16 : False
Culture :
UICulture :
MaximumReceivedDataSizePerCommand :
MaximumReceivedObjectSize :
ApplicationArguments :
OpenTimeout : 00:03:00
CancelTimeout : 00:01:00
IdleTimeout : 00:04:00


Description
-----------
This command creates a session option object with all of the default values.





-------------------------- EXAMPLE 2 --------------------------

C:\PS>$pso = new-pssessionoption -Culture "fr-fr" -MaximumReceivedObjectSize 10MB

C:\PS> new-pssession -computerName Server01 -SessionOption $pso


Description
-----------
This example shows how to use a session option object to configure a session.

The first command creates a new session option object and saves it in the value of the $pso variable.

The second command uses the New-PSSession cmdlet to create a PSSession on the Server01 remote computer. The command
uses the session option object in the value of the $pso variable as the value of the SessionOption parameter of th
e command.





-------------------------- EXAMPLE 3 --------------------------

C:\PS>enter-pssession -computername Server01 -sessionOption (new-pssessionoption -noEncryption -noCompression)


Description
-----------
This command uses the Enter-PSSession cmdlet to start an interactive session with the Server01 computer. The value
of the SessionOption parameter is a New-PSSessionOption command with the NoEncryption and NoCompression switch para
meters.

The New-PSSessionOption command is enclosed in parentheses to make sure that it runs before the Enter-PSSession com
mand.





-------------------------- EXAMPLE 4 --------------------------

C:\PS>$a = new-pssessionoption


MaximumConnectionRedirectionCount : 5
NoCompression : False
NoMachineProfile : False
ProxyAccessType : IEConfig
ProxyAuthentication : Negotiate
ProxyCredential :
SkipCACheck : False
SkipCNCheck : False
SkipRevocationCheck : False
OperationTimeout : 00:03:00
NoEncryption : False
UseUTF16 : False
Culture :
UICulture :
MaximumReceivedDataSizePerCommand :
MaximumReceivedObjectSize :
ApplicationArguments :
OpenTimeout : 00:03:00
CancelTimeout : 00:01:00
IdleTimeout : 00:04:00

C:\PS> $a.UICulture = (get-UICulture)
C:\PS> $a.OpenTimeout = (new-timespan -minutes 4)
C:\PS> $a.MaximumConnectionRedirectionCount = 1

C:\PS> $a

MaximumConnectionRedirectionCount : 1
NoCompression : False
NoMachineProfile : False
ProxyAccessType : IEConfig
ProxyAuthentication : Negotiate
ProxyCredential :
SkipCACheck : False
SkipCNCheck : False
SkipRevocationCheck : False
OperationTimeout : 00:03:00
NoEncryption : False
UseUTF16 : False
Culture :
UICulture : en-US
MaximumReceivedDataSizePerCommand :
MaximumReceivedObjectSize :
ApplicationArguments :
OpenTimeout : 00:04:00
CancelTimeout : 00:01:00
IdleTimeout : 00:04:00


Description
-----------
This example demonstrates that you can edit the session option object. All properties have read/write values.

Use this method to create a standard session object for your enterprise, and then create customized versions of it
for particular uses.





-------------------------- EXAMPLE 5 --------------------------

C:\PS>$PSSessionOption = New-PSSessionOption -OpenTimeOut 120000


Description
-----------
This command creates a $PSSessionOption preference variable.

When the $PSSessionOption preference variable exists in the session, it establishes default values for options in t
he PSSessions that are created by using the New-PSSession, Enter-PSSession, and Invoke-Command cmdlets.

To make the $PSSessionOption variable available in all sessions, add it to your Windows PowerShell session and to y
our Windows PowerShell profile.

For more information about the $PSSessionOption variable, see about_Preference_Variables. For more information abou
t profiles, see about_Profiles.





-------------------------- EXAMPLE 6 --------------------------

C:\PS>$skipCN = new-pssessionoption -SkipCNCheck

C:\PS> new-pssession -computername 171.09.21.207 -UseSSL -credential domain01\user01 -sessionOption $skipCN


Description
-----------
This example shows how to use a SessionOption object to fulfill the requirements for a remote session configuration
.

The first command uses the New-PSSessionOption cmdlet to create a session option object with the SkipCNCheck proper
ty. The command saves the resulting session object in the $skipCN variable.

The second command uses the New-PSSession cmdlet to create a new PSSession on a remote computer. The $skipCN check
variable is used in the value of the SessionOption parameter.

Because the computer is identified by its IP address, the value of the ComputerName parameter does not match any of
the common names in the certificate used for Secure Sockets Layer (SSL). As a result, the SkipCNCheck option is re
quired.






RELATED LINKS
Online version: http://go.microsoft.com/fwlink/?LinkID=144305
Enter-PSSession
New-PSSession
Invoke-Command