Edit

Share via

Get-CMTSStepRestoreUserState

  • Reference
Module:
ConfigurationManager

Get the Restore User State step from a specific task sequence.

Syntax

Get-CMTSStepRestoreUserState
   [-InputObject] <IResultObject>
   [-StepName <String>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
Get-CMTSStepRestoreUserState
   [-TaskSequenceId] <String>
   [-StepName <String>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
Get-CMTSStepRestoreUserState
   [-TaskSequenceName] <String>
   [-StepName <String>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Description

Use this cmdlet to get a task sequence step object for one or more instances of the Restore User State step. You can use this object to:

For more information on this step, see About task sequence steps: Restore User State.

Note

Run Configuration Manager cmdlets from the Configuration Manager site drive, for example PS XYZ:\>. For more information, see getting started.

Examples

Example 1

This example first gets a task sequence object in the $tsOsd variable. It then passes that variable as the input object to get the Restore User State step.

$tsNameOsd = "Default OS deployment"
$tsOsd = Get-CMTaskSequence -Name $tsNameOsd -Fast

$tsStepNameRestoreState = "Restore User State"
$tsStepRestoreState = Get-CMTSStepRestoreUserState -InputObject $tsOsd -StepName $tsStepNameRestoreState

Parameters

-Confirm

Prompts you for confirmation before running the cmdlet.

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-InputObject

Specify a task sequence object from which to get the Restore User State step. To get this object, use the Get-CMTaskSequence cmdlet.

Type:IResultObject
Aliases:TaskSequence
Position:0
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-StepName

Specify the name of the Restore User State step to get from the task sequence.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-TaskSequenceId

Specify the package ID of the task sequence from which to get the Restore User State step. This value is a standard package ID, for example XYZ00858.

Type:String
Aliases:Id, TaskSequencePackageId
Position:0
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-TaskSequenceName

Specify the name of the task sequence from which to get the Restore User State step.

Type:String
Position:0
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet doesn't run.

Type:SwitchParameter
Aliases:wi
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

Inputs

Microsoft.ConfigurationManagement.ManagementProvider.IResultObject

Outputs

System.Object