NewPSSessionOptionCommand Class
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
This class implements New-PSSessionOption cmdlet. Spec: TBD.
public ref class NewPSSessionOptionCommand sealed : System::Management::Automation::PSCmdletpublic sealed class NewPSSessionOptionCommand : System.Management.Automation.PSCmdlet[System.Management.Automation.Cmdlet("New", "PSSessionOption", HelpUri="https://go.microsoft.com/fwlink/?LinkID=2096488", 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[System.Management.Automation.Cmdlet("New", "PSSessionOption", HelpUri="https://go.microsoft.com/fwlink/?LinkID=2096488", RemotingCapability=System.Management.Automation.RemotingCapability.None)]
[System.Management.Automation.OutputType(typeof(System.Management.Automation.Remoting.PSSessionOption))]
public sealed class NewPSSessionOptionCommand : System.Management.Automation.PSCmdlet[System.Management.Automation.OutputType(new System.Type[] { typeof(System.Management.Automation.Remoting.PSSessionOption) })]
[System.Management.Automation.Cmdlet("New", "PSSessionOption", HelpUri="https://go.microsoft.com/fwlink/?LinkID=144305", RemotingCapability=System.Management.Automation.RemotingCapability.None)]
public sealed class NewPSSessionOptionCommand : System.Management.Automation.PSCmdlettype NewPSSessionOptionCommand = class
inherit PSCmdlet[<System.Management.Automation.Cmdlet("New", "PSSessionOption", HelpUri="https://go.microsoft.com/fwlink/?LinkID=2096488", RemotingCapability=System.Management.Automation.RemotingCapability.None)>]
[<System.Management.Automation.OutputType(new System.Type[] { typeof(System.Management.Automation.Remoting.PSSessionOption) })>]
type NewPSSessionOptionCommand = class
inherit PSCmdlet[<System.Management.Automation.Cmdlet("New", "PSSessionOption", HelpUri="https://go.microsoft.com/fwlink/?LinkID=2096488", RemotingCapability=System.Management.Automation.RemotingCapability.None)>]
[<System.Management.Automation.OutputType(typeof(System.Management.Automation.Remoting.PSSessionOption))>]
type NewPSSessionOptionCommand = class
inherit PSCmdlet[<System.Management.Automation.OutputType(new System.Type[] { typeof(System.Management.Automation.Remoting.PSSessionOption) })>]
[<System.Management.Automation.Cmdlet("New", "PSSessionOption", HelpUri="https://go.microsoft.com/fwlink/?LinkID=144305", RemotingCapability=System.Management.Automation.RemotingCapability.None)>]
type NewPSSessionOptionCommand = class
inherit PSCmdletPublic NotInheritable Class NewPSSessionOptionCommand
Inherits PSCmdlet- Inheritance
- Attributes
Constructors
| NewPSSessionOptionCommand() |
Properties
| ApplicationArguments |
Application arguments the server can see in ApplicationArguments |
| 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 |
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) |
| Culture |
Culture that the remote session should use |
| 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) |
| 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 |
Uses Service Principal Name (SPN) along with the Port number during authentication. |
| 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) |
| MaxConnectionRetryCount |
Maximum number of times a connection will be re-attempted when a connection fails due to network issues. |
| 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 unlimited object size. |
| MaximumRedirection |
The MaximumRedirection parameter enables the implicit redirection functionality -1 = no limit 0 = no redirection |
| MyInvocation |
Contains information about the identity of this cmdlet and how it was invoked. (Inherited from PSCmdlet) |
| 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 |
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 |
If |
| 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 |
The following is the definition of the input parameter "Timeout". Defines the timeout in milliseconds for the wsman operation |
| OutputBufferingMode |
Specifies the output mode on the server when it is in Disconnected mode and its output data cache becomes full. |
| PagingParameters |
If the cmdlet declares paging support (via SupportsPaging),
then PagingParameters property contains arguments of the paging parameters.
Otherwise PagingParameters property is |
| ParameterSetName |
The name of the parameter set in effect. (Inherited from PSCmdlet) |
| 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:
|
| 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 |
| Stopping |
Is this command stopping? (Inherited from Cmdlet) |
| UICulture |
UI culture that the remote session should use |
| 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() |
When overridden in the derived class, performs initialization of command execution. Default implementation in the base class just returns. (Inherited from Cmdlet) |
| 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) |