NewPSSessionOptionCommand NewPSSessionOptionCommand NewPSSessionOptionCommand NewPSSessionOptionCommand Class

Definition

This class implements New-PSSessionOption cmdlet.
Spec: TBD

public ref class NewPSSessionOptionCommand sealed : System::Management::Automation::PSCmdlet
[System.Management.Automation.Cmdlet("New", "PSSessionOption", HelpUri="https://go.microsoft.com/fwlink/?LinkID=144305", RemotingCapability=System.Management.Automation.RemotingCapability.None)]
[System.Management.Automation.OutputType(new System.Type[] { typeof(System.Management.Automation.Remoting.PSSessionOption) })]
public sealed class NewPSSessionOptionCommand : System.Management.Automation.PSCmdlet
type NewPSSessionOptionCommand = class
    inherit PSCmdlet
Public NotInheritable Class NewPSSessionOptionCommand
Inherits PSCmdlet
Inheritance
NewPSSessionOptionCommandNewPSSessionOptionCommandNewPSSessionOptionCommandNewPSSessionOptionCommand
Attributes

Constructors

NewPSSessionOptionCommand() NewPSSessionOptionCommand() NewPSSessionOptionCommand() NewPSSessionOptionCommand()

Properties

ApplicationArguments ApplicationArguments ApplicationArguments ApplicationArguments

Application arguments the server can see in ApplicationArguments

CancelTimeout CancelTimeout CancelTimeout CancelTimeout

The duration for which PowerShell should wait (in milliseconds) 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.

CommandOrigin CommandOrigin CommandOrigin CommandOrigin

This property tells you if you were being invoked inside the runspace or if it was an external request.

(Inherited from InternalCommand)
CommandRuntime CommandRuntime CommandRuntime CommandRuntime

Holds the command runtime object for this command. This object controls what actually happens when a write is called.

(Inherited from Cmdlet)
Culture Culture Culture Culture

Culture that the remote session should use

CurrentPSTransaction CurrentPSTransaction CurrentPSTransaction CurrentPSTransaction

Gets an object that surfaces the current PowerShell transaction. When this object is disposed, PowerShell resets the active transaction

(Inherited from Cmdlet)
Events Events Events Events

Gets the event manager for the current runspace.

(Inherited from PSCmdlet)
Host Host Host Host

Gets the host interaction APIs.

(Inherited from PSCmdlet)
IdleTimeout IdleTimeout IdleTimeout IdleTimeout

The duration for which a Runspace on server needs to wait (in milliseconds) 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 scenarios.

IncludePortInSPN IncludePortInSPN IncludePortInSPN IncludePortInSPN

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

InvokeCommand InvokeCommand InvokeCommand InvokeCommand

Provides access to utility routines for executing scripts and creating script blocks.

(Inherited from PSCmdlet)
InvokeProvider InvokeProvider InvokeProvider InvokeProvider

Gets the instance of the provider interface APIs for the current runspace.

(Inherited from PSCmdlet)
JobManager JobManager JobManager JobManager

Manager for JobSourceAdapters registered.

(Inherited from PSCmdlet)
JobRepository JobRepository JobRepository JobRepository

Repostiory for jobs

(Inherited from PSCmdlet)
MaxConnectionRetryCount MaxConnectionRetryCount MaxConnectionRetryCount MaxConnectionRetryCount

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

MaximumReceivedDataSizePerCommand MaximumReceivedDataSizePerCommand MaximumReceivedDataSizePerCommand 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 MaximumReceivedObjectSize MaximumReceivedObjectSize MaximumReceivedObjectSize

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

MaximumRedirection MaximumRedirection MaximumRedirection MaximumRedirection

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

MyInvocation MyInvocation MyInvocation MyInvocation

Contains information about the identity of this cmdlet and how it was invoked.

(Inherited from PSCmdlet)
NoCompression NoCompression NoCompression 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 NoEncryption NoEncryption NoEncryption

The following is the definition of the input parameter "UnEncrypted". 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 NoMachineProfile NoMachineProfile 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 OpenTimeout OpenTimeout OpenTimeout

The duration for which PowerShell remoting waits (in milliseconds) 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.

OperationTimeout OperationTimeout OperationTimeout OperationTimeout

The following is the definition of the input parameter "Timeout". Defines the timeout in milliseconds for the wsman operation

OutputBufferingMode OutputBufferingMode OutputBufferingMode OutputBufferingMode

Specifies the output mode on the server when it is in Disconnected mode and its output data cache becomes full.

PagingParameters PagingParameters PagingParameters PagingParameters

If the cmdlet declares paging support (via SupportsPaging), then PagingParameters property contains arguments of the paging parameters. Otherwise PagingParameters property is null.

(Inherited from PSCmdlet)
ParameterSetName ParameterSetName ParameterSetName ParameterSetName

The name of the parameter set in effect.

(Inherited from PSCmdlet)
ProxyAccessType ProxyAccessType ProxyAccessType ProxyAccessType

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

ProxyAuthentication ProxyAuthentication ProxyAuthentication 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
ProxyCredential ProxyCredential ProxyCredential ProxyCredential

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

SessionState SessionState SessionState SessionState

Gets the instance of session state for the current runspace.

(Inherited from PSCmdlet)
SkipCACheck SkipCACheck SkipCACheck SkipCACheck

The following is the definition of the input parameter "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 SkipCNCheck SkipCNCheck SkipCNCheck

The following is the definition of the input parameter "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 SkipRevocationCheck SkipRevocationCheck SkipRevocationCheck

The following is the definition of the input parameter "SkipRevocation". 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

Stopping Stopping Stopping Stopping

Is this command stopping?

(Inherited from Cmdlet)
UICulture UICulture UICulture UICulture

UI culture that the remote session should use

UseUTF16 UseUTF16 UseUTF16 UseUTF16

The following is the definition of the input parameter "UTF16". Indicates the request is encoded in UTF16 format rather than UTF8 format; UTF8 is the default.

Methods

BeginProcessing() BeginProcessing() BeginProcessing() BeginProcessing()

When overridden in the derived class, performs initialization of command execution. Default implementation in the base class just returns.

(Inherited from Cmdlet)
CurrentProviderLocation(String) CurrentProviderLocation(String) CurrentProviderLocation(String) CurrentProviderLocation(String) Inherited from PSCmdlet
EndProcessing() EndProcessing() EndProcessing() EndProcessing()

When overridden in the derived class, performs clean-up after the command execution. Default implementation in the base class just returns.

(Inherited from Cmdlet)
GetResolvedProviderPathFromPSPath(String, ProviderInfo) GetResolvedProviderPathFromPSPath(String, ProviderInfo) GetResolvedProviderPathFromPSPath(String, ProviderInfo) GetResolvedProviderPathFromPSPath(String, ProviderInfo) Inherited from PSCmdlet
GetResourceString(String, String) GetResourceString(String, String) GetResourceString(String, String) GetResourceString(String, String)

Gets the resource string corresponding to baseName and resourceId from the current assembly. You should override this if you require a different behavior.

(Inherited from Cmdlet)
GetUnresolvedProviderPathFromPSPath(String) GetUnresolvedProviderPathFromPSPath(String) GetUnresolvedProviderPathFromPSPath(String) GetUnresolvedProviderPathFromPSPath(String) Inherited from PSCmdlet
GetVariableValue(String) GetVariableValue(String) GetVariableValue(String) GetVariableValue(String) Inherited from PSCmdlet
GetVariableValue(String, Object) GetVariableValue(String, Object) GetVariableValue(String, Object) GetVariableValue(String, Object) Inherited from PSCmdlet
Invoke() Invoke() Invoke() Invoke()

Invoke this cmdlet object returning a collection of results.

(Inherited from Cmdlet)
Invoke<T>() Invoke<T>() Invoke<T>() Invoke<T>()

Returns a strongly-typed enumerator for the results of this cmdlet.

(Inherited from Cmdlet)
ProcessRecord() ProcessRecord() ProcessRecord() ProcessRecord()

When overridden in the derived class, performs execution of the command.

(Inherited from Cmdlet)
ShouldContinue(String, String) ShouldContinue(String, String) ShouldContinue(String, String) ShouldContinue(String, String)

Confirm an operation or grouping of operations with the user. This differs from ShouldProcess in that it is not affected by preference settings or command-line parameters, it always does the query. This variant only offers Yes/No, not YesToAll/NoToAll.

(Inherited from Cmdlet)
ShouldContinue(String, String, Boolean, Boolean) ShouldContinue(String, String, Boolean, Boolean) ShouldContinue(String, String, Boolean, Boolean) ShouldContinue(String, String, Boolean, Boolean)

Confirm an operation or grouping of operations with the user. This differs from ShouldProcess in that it is not affected by preference settings or command-line parameters, it always does the query. This variant offers Yes, No, YesToAll and NoToAll.

(Inherited from Cmdlet)
ShouldContinue(String, String, Boolean, Boolean, Boolean) ShouldContinue(String, String, Boolean, Boolean, Boolean) ShouldContinue(String, String, Boolean, Boolean, Boolean) ShouldContinue(String, String, Boolean, Boolean, Boolean)

Confirm an operation or grouping of operations with the user. This differs from ShouldProcess in that it is not affected by preference settings or command-line parameters, it always does the query. This variant offers Yes, No, YesToAll and NoToAll.

(Inherited from Cmdlet)
ShouldProcess(String) ShouldProcess(String) ShouldProcess(String) ShouldProcess(String)

Confirm the operation with the user. Cmdlets which make changes (e.g. delete files, stop services etc.) should call ShouldProcess to give the user the opportunity to confirm that the operation should actually be performed.

(Inherited from Cmdlet)
ShouldProcess(String, String) ShouldProcess(String, String) ShouldProcess(String, String) ShouldProcess(String, String)

Confirm the operation with the user. Cmdlets which make changes (e.g. delete files, stop services etc.) should call ShouldProcess to give the user the opportunity to confirm that the operation should actually be performed.

This variant allows the caller to specify text for both the target resource and the action.

(Inherited from Cmdlet)
ShouldProcess(String, String, String) ShouldProcess(String, String, String) ShouldProcess(String, String, String) ShouldProcess(String, String, String)

Confirm the operation with the user. Cmdlets which make changes (e.g. delete files, stop services etc.) should call ShouldProcess to give the user the opportunity to confirm that the operation should actually be performed.

This variant allows the caller to specify the complete text describing the operation, rather than just the name and action.

(Inherited from Cmdlet)
ShouldProcess(String, String, String, ShouldProcessReason) ShouldProcess(String, String, String, ShouldProcessReason) ShouldProcess(String, String, String, ShouldProcessReason) ShouldProcess(String, String, String, ShouldProcessReason)

Confirm the operation with the user. Cmdlets which make changes (e.g. delete files, stop services etc.) should call ShouldProcess to give the user the opportunity to confirm that the operation should actually be performed.

This variant allows the caller to specify the complete text describing the operation, rather than just the name and action.

(Inherited from Cmdlet)
StopProcessing() StopProcessing() StopProcessing() StopProcessing()

When overridden in the derived class, interrupts currently running code within the command. It should interrupt BeginProcessing, ProcessRecord, and EndProcessing. Default implementation in the base class just returns.

(Inherited from Cmdlet)
ThrowTerminatingError(ErrorRecord) ThrowTerminatingError(ErrorRecord) ThrowTerminatingError(ErrorRecord) ThrowTerminatingError(ErrorRecord)

Terminate the command and report an error

(Inherited from Cmdlet)
TransactionAvailable() TransactionAvailable() TransactionAvailable() TransactionAvailable()

Returns true if a transaction is available and active.

(Inherited from Cmdlet)
WriteCommandDetail(String) WriteCommandDetail(String) WriteCommandDetail(String) WriteCommandDetail(String)

Write text into pipeline execution log.

(Inherited from Cmdlet)
WriteDebug(String) WriteDebug(String) WriteDebug(String) WriteDebug(String)

Display debug information

(Inherited from Cmdlet)
WriteError(ErrorRecord) WriteError(ErrorRecord) WriteError(ErrorRecord) WriteError(ErrorRecord)

Internal variant: Writes the specified error to the error pipe.

(Inherited from Cmdlet)
WriteInformation(InformationRecord) WriteInformation(InformationRecord) WriteInformation(InformationRecord) WriteInformation(InformationRecord)

Route information to the user or host.

(Inherited from Cmdlet)
WriteInformation(Object, String[]) WriteInformation(Object, String[]) WriteInformation(Object, String[]) WriteInformation(Object, String[])

Route information to the user or host.

(Inherited from Cmdlet)
WriteObject(Object) WriteObject(Object) WriteObject(Object) WriteObject(Object)

Writes the object to the output pipe.

(Inherited from Cmdlet)
WriteObject(Object, Boolean) WriteObject(Object, Boolean) WriteObject(Object, Boolean) WriteObject(Object, Boolean)

Writes one or more objects to the output pipe. If the object is a collection and the enumerateCollection flag is true, the objects in the collection will be written individually.

(Inherited from Cmdlet)
WriteProgress(ProgressRecord) WriteProgress(ProgressRecord) WriteProgress(ProgressRecord) WriteProgress(ProgressRecord)

Display progress information

(Inherited from Cmdlet)
WriteVerbose(String) WriteVerbose(String) WriteVerbose(String) WriteVerbose(String)

Display verbose information

(Inherited from Cmdlet)
WriteWarning(String) WriteWarning(String) WriteWarning(String) WriteWarning(String)

Display warning information

(Inherited from Cmdlet)

Applies to