PSExecutionCmdlet Class

Computername with session instance ID parameter set.

Computername parameter set.

Container ID parameter set.

Default application name for the connection uri.

Default shellname.

FilePathComputername parameter set.

Container ID file path parameter set.

FilePathRunspace parameter set.

SSH Host file path parameter set with HashTable connection parameter.

SSH Host file path parameter set.

FilePathUri parameter set.

VM guid file path parameter set.

VM name file path parameter set.

LiteralFilePathComputername parameter set.

Runspace parameter set.

SSH host parmeter set supporting hash connection parameters.

SSH host parameter set.

Uri parameter set.

Parameter set to use Windows PowerShell.

VM guid parameter set.

VM name parameter set.

The AllowRedirection parameter enables the implicit redirection functionality.

This parameters specifies the appname which identifies the connection end point on the remote machine. If this parameter is not specified then the value specified in DEFAULTREMOTEAPPNAME will be used. If that's not specified as well, then "WSMAN" will be used.

Arguments that are passed to this scriptblock.

Use basic authentication to authenticate the user.

Specifies the certificate thumbprint to be used to impersonate the user on the remote machine.

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

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

This parameter represents the address(es) of the remote computer(s). The following formats are supported: (a) Computer name (b) IPv4 address : 132.3.4.5 (c) IPv6 address: 3ffe:8311:ffff:f70f:0:5efe:172.30.162.18.

For WSMan session: If this parameter is not specified then the value specified in the environment variable DEFAULTREMOTESHELLNAME will be used. If this is not set as well, then Microsoft.PowerShell is used.

For VM/Container sessions: If this parameter is not specified then no configuration is used.

Gets or sets a value in milliseconds that limits the time allowed for an SSH connection to be established. Default timeout value is infinite.

A complete URI(s) specified for the remote computer and shell to connect to and create runspace for.

ID of target container.

Specifies the credentials of the user to impersonate in the remote machine. If this parameter is not specified then the credentials of the current user process will be assumed.

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

Session names optionally provided for Disconnected parameter.

When set and in loopback scenario (localhost) this enables creation of WSMan host process with the user interactive token, allowing PowerShell script network access, i.e., allows going off box. When this property is true and a PSSession is disconnected, reconnection is allowed only if reconnecting from a PowerShell session on the same box.

Gets the event manager for the current runspace.

The file containing the script that the user has specified in the cmdlet. This will be converted to a powershell before its actually sent to the remote end.

Gets the host interaction APIs.

Host name for an SSH remote connection.

Input object which gets assigned to $input when executed on the remote machine. This is the only parameter in this cmdlet which will bind with a ValueFromPipeline=true.

Indicates that if a job/command is invoked remotely the connection should be severed right have invocation of job/command.

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

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

True if FilePath should be processed as a literal path.

Manager for JobSourceAdapters registered.

Repository for jobs.

SSH Key File Path.

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

Gets or sets the Hashtable containing options to be passed to OpenSSH.

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

The name of the parameter set in effect.

Port specifies the alternate port to be used in case the default ports are not used for the transport mechanism (port 80 for http and port 443 for useSSL)

Computer names after they have been resolved (null, empty string, "." resolves to localhost)

When set, PowerShell process inside container will be launched with high privileged account. Otherwise (default case), PowerShell process inside container will be launched with low privileged account.

Command to execute specified as a string. This can be a single cmdlet, an expression or anything that can be internally converted into a ScriptBlock.

The PSSession object describing the remote runspace using which the specified cmdlet operation will be performed.

Extended Session Options for controlling the session creation. Use "New-WSManSessionOption" cmdlet to supply value for this parameter.

Gets the instance of session state for the current runspace.

Hashtable array containing SSH connection parameters for each remote target ComputerName (Alias: HostName) (required) UserName (optional) KeyFilePath (Alias: IdentityFilePath) (optional)

This parameter specifies that SSH is used to establish the remote connection and act as the remoting transport. By default WinRM is used as the remoting transport. Using the SSH transport requires that SSH is installed and PowerShell remoting is enabled on both client and remote machines.

Is this command stopping?

Gets or sets a value for the SSH subsystem to use for the remote connection.

Allows the user of the cmdlet to specify a throttling value for throttling the number of remote operations that can be executed simultaneously.

SSH User Name.

This parameter suggests that the transport scheme to be used for remote connections is useSSL instead of the default http.Since there are only two possible transport schemes that are possible at this point, a SwitchParameter is being used to switch between the two.

Guid of target virtual machine.

Name of target virtual machine.

Creates the helper classes for the specified parameter set.

Closes the input streams on all the pipelines.

Creates helper objects with the command for the specified remote computer names.

Creates helper objects with the command for the specified container IDs or names.

Creates helper objects with the specified command for the specified remote runspaceinfo objects.

Creates helper objects for SSH remoting computer names remoting.

Creates helper objects for SSH remoting from HashTable parameters.

Creates helper objects with the command for the specified remote connection uris.

Creates helper objects with the command for the specified VM GUIDs or VM names.

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

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

Reads content of file and converts it to a scriptblock.

Invoke this cmdlet object returning a collection of results.

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

Parse a hostname used with SSH Transport to get embedded username and/or port.

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

Determines the appname to be used based on the following order: 1. AppName parameter specified 2. DEFAULTREMOTEAPPNAME variable set 3. WSMan.

Resolves a computer name. If its null or empty its assumed to be localhost.

Resolve all the machine names provided. Basically, if a machine name is '.' assume localhost.

Determines the shellname to use based on the following order: 1. ShellName parameter specified 2. DEFAULTREMOTESHELLNAME variable set 3. PowerShell.

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.

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.

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.

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.

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.

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.

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.

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.

Terminate the command and report an error.

Returns true if a transaction is available and active.

Validates computer names to check if none of them happen to be a Uri. If so this throws an error.

Validate the PSSession objects specified and write appropriate error records.

Write text into pipeline execution log.

Display debug information.

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

Route information to the user or host.

Route information to the user or host.

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.

Writes the object to the output pipe.

Display progress information.

Display verbose information.

Display warning information.