Get-SCStep

Get-SCStep

Gets the steps for the specified VMM job.

Syntax

Parameter Set: Default
Get-SCStep [-Job] <Task> [-Name <String> ] [-OnBehalfOfUser <System.String> ] [-OnBehalfOfUserRole <Microsoft.SystemCenter.VirtualMachineManager.UserRole> ] [ <CommonParameters>]




Detailed 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.

Parameters

-Job<Task>

Specifies a VMM job object.


Aliases

none

Required?

true

Position?

1

Default Value

none

Accept Pipeline Input?

True (ByValue)

Accept Wildcard Characters?

false

-Name<String>

Specifies the name of a VMM object.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-OnBehalfOfUser<System.String>

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-OnBehalfOfUserRole<Microsoft.SystemCenter.VirtualMachineManager.UserRole>

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

<CommonParameters>

This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see    about_CommonParameters (http://go.microsoft.com/fwlink/p/?LinkID=113216).

Inputs

The input type is the type of the objects that you can pipe to the cmdlet.

Outputs

The output type is the type of the objects that the cmdlet emits.

  • Step

Examples

Example 1: Get all steps for a specified job

The first command gets the VMM job object with the ID cb3a0f0a-9fbc-4bd0-a999-3fae8cd77177, and then stores the object in the $Job variable.

The second command gets the step object for the VMM job in $Job, and then stores it in the $Steps variable.

The last command lists information about each step for the VMM job, including a description of the step, its progress, and its status.


PS C:\> $Job = Get-SCJob -ID "cb3a0f0a-9fbc-4bd0-a999-3fae8cd77177"
PS C:\> $Steps = Get-SCStep -Job $Job
PS C:\> $Steps.Children

Related topics

Community Additions

ADD
Show: