NewWSManSessionOptionCommand Class

Definition

Creates a WSMan Session option hashtable which can be passed into WSMan cmdlets: Get-WSManInstance Set-WSManInstance Invoke-WSManAction Connect-WSMan.

[System.Management.Automation.Cmdlet("New", "WSManSessionOption", HelpUri="https://go.microsoft.com/fwlink/?LinkId=2096845")]
public class NewWSManSessionOptionCommand : System.Management.Automation.PSCmdlet
[System.Management.Automation.Cmdlet("New", "WSManSessionOption", HelpUri="https://go.microsoft.com/fwlink/?LinkId=2096845")]
[System.Management.Automation.OutputType(new System.Type[] { typeof(Microsoft.WSMan.Management.SessionOption) })]
public class NewWSManSessionOptionCommand : System.Management.Automation.PSCmdlet
[<System.Management.Automation.Cmdlet("New", "WSManSessionOption", HelpUri="https://go.microsoft.com/fwlink/?LinkId=2096845")>]
type NewWSManSessionOptionCommand = class
    inherit PSCmdlet
[<System.Management.Automation.Cmdlet("New", "WSManSessionOption", HelpUri="https://go.microsoft.com/fwlink/?LinkId=2096845")>]
[<System.Management.Automation.OutputType(new System.Type[] { typeof(Microsoft.WSMan.Management.SessionOption) })>]
type NewWSManSessionOptionCommand = class
    inherit PSCmdlet
Public Class NewWSManSessionOptionCommand
Inherits PSCmdlet
Inheritance
NewWSManSessionOptionCommand
Attributes

Constructors

NewWSManSessionOptionCommand()

Properties

CommandOrigin

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

(Inherited from InternalCommand)
CommandRuntime

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

(Inherited from Cmdlet)
CurrentPSTransaction

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

(Inherited from Cmdlet)
Events

Gets the event manager for the current runspace.

(Inherited from PSCmdlet)
Host

Gets the host interaction APIs.

(Inherited from PSCmdlet)
InvokeCommand

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

(Inherited from PSCmdlet)
InvokeProvider

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

(Inherited from PSCmdlet)
JobManager

Manager for JobSourceAdapters registered.

(Inherited from PSCmdlet)
JobRepository

Repository for jobs.

(Inherited from PSCmdlet)
MyInvocation

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

(Inherited from PSCmdlet)
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 traffic is not allowed by default and must be enabled in the local configuration.

OperationTimeout

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

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

The name of the parameter set in effect.

(Inherited from PSCmdlet)
ProxyAccessType
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 (ad 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

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

SessionState

Gets the instance of session state for the current runspace.

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

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

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.

SPNPort

The following is the definition of the input parameter "SPNPort". Appends port number to the connection Service Principal Name SPN of the remote server. SPN is used when authentication mechanism is Kerberos or Negotiate.

Stopping

Is this command stopping?

(Inherited from Cmdlet)
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 method.

CurrentProviderLocation(String) (Inherited from PSCmdlet)
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) (Inherited from PSCmdlet)
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) (Inherited from PSCmdlet)
GetVariableValue(String) (Inherited from PSCmdlet)
GetVariableValue(String, Object) (Inherited from PSCmdlet)
Invoke()

Invoke this cmdlet object returning a collection of results.

(Inherited from Cmdlet)
Invoke<T>()

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

(Inherited from Cmdlet)
ProcessRecord()

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

(Inherited from Cmdlet)
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)

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)

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)

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)

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)

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)

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

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)

Terminate the command and report an error.

(Inherited from Cmdlet)
TransactionAvailable()

Returns true if a transaction is available and active.

(Inherited from Cmdlet)
WriteCommandDetail(String)

Write text into pipeline execution log.

(Inherited from Cmdlet)
WriteDebug(String)

Display debug information.

(Inherited from Cmdlet)
WriteError(ErrorRecord)

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

(Inherited from Cmdlet)
WriteInformation(InformationRecord)

Route information to the user or host.

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

Route information to the user or host.

(Inherited from Cmdlet)
WriteObject(Object)

Writes the object to the output pipe.

(Inherited from Cmdlet)
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)

Display progress information.

(Inherited from Cmdlet)
WriteVerbose(String)

Display verbose information.

(Inherited from Cmdlet)
WriteWarning(String)

Display warning information.

(Inherited from Cmdlet)

Applies to