StartJobCommand Class

Definition

This cmdlet start invocation of jobs in background.

public ref class StartJobCommand : Microsoft::PowerShell::Commands::PSExecutionCmdlet, IDisposable
public class StartJobCommand : Microsoft.PowerShell.Commands.PSExecutionCmdlet, IDisposable
[System.Management.Automation.Cmdlet("Start", "Job", DefaultParameterSetName="ComputerName", HelpUri="https://go.microsoft.com/fwlink/?LinkID=2096796")]
public class StartJobCommand : Microsoft.PowerShell.Commands.PSExecutionCmdlet, IDisposable
[System.Management.Automation.Cmdlet("Start", "Job", DefaultParameterSetName="ComputerName", HelpUri="https://go.microsoft.com/fwlink/?LinkID=113405")]
public class StartJobCommand : Microsoft.PowerShell.Commands.PSExecutionCmdlet, IDisposable
type StartJobCommand = class
    inherit PSExecutionCmdlet
    interface IDisposable
Public Class StartJobCommand
Inherits PSExecutionCmdlet
Implements IDisposable
Inheritance
Attributes
Implements

Constructors

StartJobCommand()

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

(Inherited from PSExecutionCmdlet)
FilePathContainerIdParameterSet

Container ID file path parameter set.

(Inherited from PSExecutionCmdlet)
FilePathSessionParameterSet

FilePathRunspace parameter set

(Inherited from PSExecutionCmdlet)
FilePathSSHHostHashParameterSet

SSH Host file path parameter set with HashTable connection parameter

(Inherited from PSExecutionCmdlet)
FilePathSSHHostParameterSet

SSH Host file path parameter set.

(Inherited from PSExecutionCmdlet)
FilePathUriParameterSet

FilePathUri parameter set

(Inherited from PSExecutionCmdlet)
FilePathVMIdParameterSet

VM guid file path parameter set.

(Inherited from PSExecutionCmdlet)
FilePathVMNameParameterSet

VM name file path parameter set.

(Inherited from PSExecutionCmdlet)
LiteralFilePathComputerNameParameterSet

LiteralFilePathComputername parameter set

(Inherited from PSExecutionCmdlet)
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 (Inherited from PSRemotingCmdlet)
VMIdParameterSet

VM guid parameter set

(Inherited from PSRemotingCmdlet)
VMNameParameterSet

VM name parameter set

(Inherited from PSRemotingCmdlet)

Properties

AllowRedirection

Overriding to suppress this parameter

ApplicationName

Overriding to suppress this parameter

ArgumentList

ArgumentList.

Authentication

Use basic authentication to authenticate the user.

CertificateThumbprint

Overriding to suppress this parameter

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

Overriding to suppress this parameter

ConfigurationName

Overriding to suppress this parameter

ConnectionUri

Overriding to suppress this parameter

ContainerId

Overriding to suppress this parameter

Credential

Credential to use for this job

CurrentPSTransaction

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

(Inherited from Cmdlet)
DefinitionName

JobDefintion Name.

DefinitionPath

JobDefinition file path.

DisconnectedSessionName

Session names optionally provided for Disconnected parameter.

(Inherited from PSExecutionCmdlet)
EnableNetworkAccess

Not used for OutOfProc jobs. Suppressing this parameter.

Events

Gets the event manager for the current runspace.

(Inherited from PSCmdlet)
FilePath

Filepath to execute as a script

Host

Gets the host interaction APIs.

(Inherited from PSCmdlet)
HostName
HostName

Host name for an SSH remote connection.

(Inherited from PSRemotingBaseCmdlet)
InitializationScript

Script that is used to initialize the background job.

InputObject

InputObject.

InvokeAndDisconnect

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

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

(Inherited from PSExecutionCmdlet)
JobManager

Manager for JobSourceAdapters registered.

(Inherited from PSCmdlet)
JobRepository

Repostiory for jobs

(Inherited from PSCmdlet)
KeyFilePath

Suppress KeyFilePath

KeyFilePath

SSH Key File Path

(Inherited from PSRemotingBaseCmdlet)
LiteralPath

Literal Filepath to execute as a script

MyInvocation

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

(Inherited from PSCmdlet)
Name

Friendly name for this job object

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

Overriding to suppress this parameter

PSVersion

Powershell Version to execute the background job

ResolvedComputerNames

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

(Inherited from PSRemotingBaseCmdlet)
RunAs32

Launces the background job as a 32-bit process. This can be used on 64-bit systems to launch a 32-bit wow process for the background job.

RunAsAdministrator

Overriding to suppress this parameter

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

Overriding to suppress this parameter

SessionOption

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

SessionState

Gets the instance of session state for the current runspace.

(Inherited from PSCmdlet)
SSHConnection

Suppress SSHConnection

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

Suppress SSHTransport

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
Subsystem (Inherited from PSRemotingBaseCmdlet)
ThrottleLimit

Overriding to suppress this parameter

Type

Job SourceAdapter type for this job definition.

UserName

Suppress UserName

UserName

SSH User Name

(Inherited from PSRemotingBaseCmdlet)
UseSSL

Overriding to suppress this parameter

VMId

Overriding to suppress this parameter

VMName

Overriding to suppress this parameter

WorkingDirectory

Methods

BeginProcessing()
  1. Set the throttling limit and reset operations complete
  2. Create helper objects
  3. For async case, write the async result object down the pipeline
CloseAllInputStreams()

Closes the input streams on all the pipelines

(Inherited from PSExecutionCmdlet)
CreateHelpersForSpecifiedComputerNames()

Create a throttle operation using NewProcessConnectionInfo ie., Out-Of-Process runspace.

CreateHelpersForSpecifiedContainerSession()

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

(Inherited from PSExecutionCmdlet)
CreateHelpersForSpecifiedRunspaces()

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

(Inherited from PSExecutionCmdlet)
CreateHelpersForSpecifiedSSHComputerNames()

Creates helper objects for SSH remoting computer names remoting.

(Inherited from PSExecutionCmdlet)
CreateHelpersForSpecifiedSSHHashComputerNames()

Creates helper objects for SSH remoting from HashTable parameters.

(Inherited from PSExecutionCmdlet)
CreateHelpersForSpecifiedUris()

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

(Inherited from PSExecutionCmdlet)
CreateHelpersForSpecifiedVMSession()

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

(Inherited from PSExecutionCmdlet)
CurrentProviderLocation(String) (Inherited from PSCmdlet)
Dispose()

Dispose the cmdlet

EndProcessing()

InvokeAsync would have been called in ProcessRecord. Wait here for all the results to become available.

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

(Inherited from PSExecutionCmdlet)
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)
ParseSshHostName(String, String, String, Int32) (Inherited from PSRemotingBaseCmdlet)
ProcessRecord()

The expression will be executed in the remote computer if a remote runspace parameter or computer name is specified. If none other than command parameter is specified, then it just executes the command locally without creating a new remote runspace object.

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)

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

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