Get-SCStep
Gets the steps for the specified VMM job.
Syntax
Default (Default)
Get-SCStep
[-Job] <Task>
[-Name <String>]
[-OnBehalfOfUser <String>]
[-OnBehalfOfUserRole <UserRole>]
[<CommonParameters>]
Description
The Get-SCStep cmdlet gets the steps for the specified Virtual Machine Manager (VMM) job.
A job is composed of one or more steps, each of which has its own status. An earlier step must complete or be skipped before the next step runs.
Examples
Example 1: Get all steps for a specified job
PS C:\> $Job = Get-SCJob -ID "cb3a0f0a-9fbc-4bd0-a999-3fae8cd77177"
PS C:\> $Steps = Get-SCStep -Job $Job
PS C:\> $Steps.Children
The first command gets the VMM job object with the ID cb3a0f0a-9fbc-4bd0-a999-3fae8cd77177 and stores the object in the $Job variable.
The second command gets the step object for the VMM job in $Job.
The last command lists information about each step for the VMM job, including a description of the step, its progress, and its status.
Parameters
-Job
Specifies a VMM job object.
Parameter properties
| Type: | Task |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | 0 |
| Mandatory: | True |
| Value from pipeline: | True |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-Name
Specifies the name of a VMM object.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-OnBehalfOfUser
Specifies a user name. This cmdlet operates on behalf of the user that this parameter specifies.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-OnBehalfOfUserRole
Specifies a user role. To obtain a user role, use the Get-SCUserRole cmdlet. This cmdlet operates on behalf of the user role that this parameter specifies.
Parameter properties
| Type: | UserRole |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.
Outputs
Step
This cmdlet returns a Step object.