New-CMTSStepCaptureUserState

{{ Fill in the Synopsis }}

Syntax

New-CMTSStepCaptureUserState
   [-ConfigFile <String[]>]
   [-ContinueOnLockedFile <Boolean>]
   [-FileAccessOption <FileAccessType>]
   [-ModeOption <ModeType>]
   [-OfflineUserState <Boolean>]
   -Package <IResultObject>
   [-SkipEncryptedFile <Boolean>]
   [-UseHardLinks <Boolean>]
   [-VerboseLogging <Boolean>]
   [-Condition <IResultObject[]>]
   [-ContinueOnError]
   [-Description <String>]
   [-Disable]
   -Name <String>
   [-DisableWildcardHandling]
   [-ForceWildcardHandling]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Description

{{ Fill in the Description }}

Note

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

Examples

Example 1

PS XYZ:\> {{ Add example code here }}

{{ Add example description here }}

Parameters

-Condition

Specify a condition object to use with this step.

Type:IResultObject[]
Aliases:Conditions
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-ConfigFile

{{ Fill ConfigFile Description }}

Type:String[]
Aliases:ConfigFiles
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-Confirm

Prompts you for confirmation before running the cmdlet.

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

Add this parameter to enable the step option Continue on error. When you enable this option, if the step fails, the task sequence continues.

Type:SwitchParameter
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-ContinueOnLockedFile

{{ Fill ContinueOnLockedFile Description }}

Type:Boolean
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-Description

Specify an optional description for this task sequence step.

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

Add this parameter to disable this task sequence step.

Type:SwitchParameter
Aliases:DisableThisStep
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-DisableWildcardHandling

This parameter treats wildcard characters as literal character values. You can't combine it with ForceWildcardHandling.

Type:SwitchParameter
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-FileAccessOption

{{ Fill FileAccessOption Description }}

Type:FileAccessType
Accepted values:Normal, VolumeCopyShadowService
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-ForceWildcardHandling

This parameter processes wildcard characters and may lead to unexpected behavior (not recommended). You can't combine it with DisableWildcardHandling.

Type:SwitchParameter
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-ModeOption

{{ Fill ModeOption Description }}

Type:ModeType
Accepted values:Standard, Customize
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-Name

Specify a name for this step to identify it in the task sequence.

Type:String
Aliases:StepName
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-OfflineUserState

{{ Fill OfflineUserState Description }}

Type:Boolean
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-Package

{{ Fill Package Description }}

Type:IResultObject
Aliases:UserStateMigrationToolPackage
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-SkipEncryptedFile

{{ Fill SkipEncryptedFile Description }}

Type:Boolean
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-UseHardLinks

{{ Fill UseHardLinks Description }}

Type:Boolean
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-VerboseLogging

{{ Fill VerboseLogging Description }}

Type:Boolean
Position:Named
Default value:None
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
Accept pipeline input:False
Accept wildcard characters:False

Inputs

None

Outputs

IResultObject