PSExecutionCmdlet Class

Definition

Namespace:

Microsoft.PowerShell.Commands

Assembly:

System.Management.Automation.dll

Package:

System.Management.Automation v7.4.0

Base class for any cmdlet which has to execute a pipeline. The following cmdlets currently fall under this category: 1. Invoke-Expression 2. Start-PSJob.

public ref class PSExecutionCmdlet abstract : Microsoft::PowerShell::Commands::PSRemotingBaseCmdlet

public abstract class PSExecutionCmdlet : Microsoft.PowerShell.Commands.PSRemotingBaseCmdlet

type PSExecutionCmdlet = class
    inherit PSRemotingBaseCmdlet

Public MustInherit Class PSExecutionCmdlet
Inherits PSRemotingBaseCmdlet

Inheritance

Object

InternalCommand

Cmdlet

PSCmdlet

PSRemotingCmdlet

PSRemotingBaseCmdlet

PSExecutionCmdlet

Derived

Microsoft.PowerShell.Commands.InvokeCommandCommand

Microsoft.PowerShell.Commands.StartJobCommand

Constructors

PSExecutionCmdlet()

Fields

ComputerInstanceIdParameterSet	Computername with session instance ID parameter set. (Inherited from PSRemotingCmdlet)
ComputerNameParameterSet	Computername parameter set. (Inherited from PSRemotingCmdlet)
ContainerIdParameterSet	Container ID parameter set. (Inherited from PSRemotingCmdlet)
DefaultPowerShellRemoteShellAppName	Default application name for the connection uri. (Inherited from PSRemotingCmdlet)
DefaultPowerShellRemoteShellName	Default shellname. (Inherited from PSRemotingCmdlet)
FilePathComputerNameParameterSet	FilePathComputername parameter set.
FilePathContainerIdParameterSet	Container ID file path parameter set.
FilePathSessionParameterSet	FilePathRunspace parameter set.
FilePathSSHHostHashParameterSet	SSH Host file path parameter set with HashTable connection parameter.
FilePathSSHHostParameterSet	SSH Host file path parameter set.
FilePathUriParameterSet	FilePathUri parameter set.
FilePathVMIdParameterSet	VM guid file path parameter set.
FilePathVMNameParameterSet	VM name file path parameter set.
LiteralFilePathComputerNameParameterSet	LiteralFilePathComputername parameter set.
SessionParameterSet	Runspace parameter set. (Inherited from PSRemotingCmdlet)
SSHHostHashParameterSet	SSH host parmeter set supporting hash connection parameters. (Inherited from PSRemotingCmdlet)
SSHHostParameterSet	SSH host parameter set. (Inherited from PSRemotingCmdlet)
UriParameterSet	Uri parameter set. (Inherited from PSRemotingBaseCmdlet)
UseWindowsPowerShellParameterSet	Parameter set to use Windows PowerShell. (Inherited from PSRemotingCmdlet)
VMIdParameterSet	VM guid parameter set. (Inherited from PSRemotingCmdlet)
VMNameParameterSet	VM name parameter set. (Inherited from PSRemotingCmdlet)

Properties

AllowRedirection	The AllowRedirection parameter enables the implicit redirection functionality. (Inherited from PSRemotingBaseCmdlet)
ApplicationName	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. (Inherited from PSRemotingBaseCmdlet)
ArgumentList	Arguments that are passed to this scriptblock.
Authentication	Use basic authentication to authenticate the user. (Inherited from PSRemotingBaseCmdlet)
CertificateThumbprint	Specifies the certificate thumbprint to be used to impersonate the user on the remote machine. (Inherited from PSRemotingBaseCmdlet)
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)
ComputerName	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. (Inherited from PSRemotingBaseCmdlet)
ConfigurationName	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.
ConnectingTimeout	Gets or sets a value in milliseconds that limits the time allowed for an SSH connection to be established. Default timeout value is infinite. (Inherited from PSRemotingBaseCmdlet)
ConnectionUri	A complete URI(s) specified for the remote computer and shell to connect to and create runspace for. (Inherited from PSRemotingBaseCmdlet)
ContainerId	ID of target container.
Credential	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. (Inherited from PSRemotingBaseCmdlet)
CurrentPSTransaction	Gets an object that surfaces the current PowerShell transaction. When this object is disposed, PowerShell resets the active transaction. (Inherited from Cmdlet)
DisconnectedSessionName	Session names optionally provided for Disconnected parameter.
EnableNetworkAccess	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.
Events	Gets the event manager for the current runspace. (Inherited from PSCmdlet)
FilePath	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.
Host	Gets the host interaction APIs. (Inherited from PSCmdlet)
HostName	Host name for an SSH remote connection. (Inherited from PSRemotingBaseCmdlet)
InputObject	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.
InvokeAndDisconnect	Indicates that if a job/command is invoked remotely the connection should be severed right have invocation of job/command.
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)
IsLiteralPath	True if FilePath should be processed as a literal path.
JobManager	Manager for JobSourceAdapters registered. (Inherited from PSCmdlet)
JobRepository	Repository for jobs. (Inherited from PSCmdlet)
KeyFilePath	SSH Key File Path. (Inherited from PSRemotingBaseCmdlet)
MyInvocation	Contains information about the identity of this cmdlet and how it was invoked. (Inherited from PSCmdlet)
Options	Gets or sets the Hashtable containing options to be passed to OpenSSH. (Inherited from PSRemotingBaseCmdlet)
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)
Port	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) (Inherited from PSRemotingBaseCmdlet)
ResolvedComputerNames	Computer names after they have been resolved (null, empty string, "." resolves to localhost) (Inherited from PSRemotingBaseCmdlet)
RunAsAdministrator	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. (Inherited from PSRemotingBaseCmdlet)
ScriptBlock	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.
Session	The PSSession object describing the remote runspace using which the specified cmdlet operation will be performed. (Inherited from PSRemotingBaseCmdlet)
SessionOption	Extended Session Options for controlling the session creation. Use "New-WSManSessionOption" cmdlet to supply value for this parameter. (Inherited from PSRemotingBaseCmdlet)
SessionState	Gets the instance of session state for the current runspace. (Inherited from PSCmdlet)
SSHConnection	Hashtable array containing SSH connection parameters for each remote target ComputerName (Alias: HostName) (required) UserName (optional) KeyFilePath (Alias: IdentityFilePath) (optional) (Inherited from PSRemotingBaseCmdlet)
SSHTransport	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. (Inherited from PSRemotingBaseCmdlet)
Stopping	Is this command stopping? (Inherited from Cmdlet)
Subsystem	Gets or sets a value for the SSH subsystem to use for the remote connection. (Inherited from PSRemotingBaseCmdlet)
ThrottleLimit	Allows the user of the cmdlet to specify a throttling value for throttling the number of remote operations that can be executed simultaneously. (Inherited from PSRemotingBaseCmdlet)
UserName	SSH User Name. (Inherited from PSRemotingBaseCmdlet)
UseSSL	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. (Inherited from PSRemotingBaseCmdlet)
VMId	Guid of target virtual machine.
VMName	Name of target virtual machine.

Methods

BeginProcessing()	Creates the helper classes for the specified parameter set.
CloseAllInputStreams()	Closes the input streams on all the pipelines.
CreateHelpersForSpecifiedComputerNames()	Creates helper objects with the command for the specified remote computer names.
CreateHelpersForSpecifiedContainerSession()	Creates helper objects with the command for the specified container IDs or names.
CreateHelpersForSpecifiedRunspaces()	Creates helper objects with the specified command for the specified remote runspaceinfo objects.
CreateHelpersForSpecifiedSSHComputerNames()	Creates helper objects for SSH remoting computer names remoting.
CreateHelpersForSpecifiedSSHHashComputerNames()	Creates helper objects for SSH remoting from HashTable parameters.
CreateHelpersForSpecifiedUris()	Creates helper objects with the command for the specified remote connection uris.
CreateHelpersForSpecifiedVMSession()	Creates helper objects with the command for the specified VM GUIDs or VM names.
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)
GetScriptBlockFromFile(String, Boolean)	Reads content of file and converts it to a scriptblock.
GetUnresolvedProviderPathFromPSPath(String)	(Inherited from PSCmdlet)
GetVariableValue(String, Object)	(Inherited from PSCmdlet)
GetVariableValue(String)	(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)
ParseSshHostName(String, String, String, Int32)	Parse a hostname used with SSH Transport to get embedded username and/or port. (Inherited from PSRemotingBaseCmdlet)
ProcessRecord()	When overridden in the derived class, performs execution of the command. (Inherited from Cmdlet)
ResolveAppName(String)	Determines the appname to be used based on the following order: 1. AppName parameter specified 2. DEFAULTREMOTEAPPNAME variable set 3. WSMan. (Inherited from PSRemotingCmdlet)
ResolveComputerName(String)	Resolves a computer name. If its null or empty its assumed to be localhost. (Inherited from PSRemotingCmdlet)
ResolveComputerNames(String[], String[])	Resolve all the machine names provided. Basically, if a machine name is '.' assume localhost. (Inherited from PSRemotingCmdlet)
ResolveShell(String)	Determines the shellname to use based on the following order: 1. ShellName parameter specified 2. DEFAULTREMOTESHELLNAME variable set 3. PowerShell. (Inherited from PSRemotingCmdlet)
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)
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)	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)
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)
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)	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)	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)
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)
ValidateComputerName(String[])	Validates computer names to check if none of them happen to be a Uri. If so this throws an error. (Inherited from PSRemotingBaseCmdlet)
ValidateRemoteRunspacesSpecified()	Validate the PSSession objects specified and write appropriate error records. (Inherited from PSRemotingBaseCmdlet)
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, 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)
WriteObject(Object)	Writes the object to the output pipe. (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)