Set-CMTSStepApplyOperatingSystem

Module:

ConfigurationManager Module

Configure an instance of the Apply OS Image task sequence step.

Syntax

ByValue (Default)

Set-CMTSStepApplyOperatingSystem
    -InputObject <IResultObject>
    [-ConfigFileName <String>]
    [-ConfigFilePackage <IResultObject>]
    [-LayeredDriver <OsdLayeredDriver>]
    [-Destination <DestinationType>]
    [-DestinationDisk <Int32>]
    [-DestinationDriveLetter <String>]
    [-DestinationPartition <Int32>]
    [-DestinationVariable <String>]
    [-ImagePackage <IResultObject>]
    [-ImagePackageIndex <Int32>]
    [-InstallPackage <IResultObject>]
    [-InstallPackageIndex <Int32>]
    [-RunFromNet <Boolean>]
    [-AddCondition <IResultObject[]>]
    [-ClearCondition]
    [-Description <String>]
    [-IsContinueOnError <Boolean>]
    [-IsEnabled <Boolean>]
    [-MoveToIndex <Int32>]
    [-NewStepName <String>]
    [-RemoveConditionFile]
    [-RemoveConditionFolder]
    [-RemoveConditionIfStatement]
    [-RemoveConditionOperatingSystem]
    [-RemoveConditionQueryWmi]
    [-RemoveConditionRegistry]
    [-RemoveConditionSoftware]
    [-RemoveConditionVariable]
    [-StepName <String>]
    [-StepOrder <ReorderType>]
    [-DisableWildcardHandling]
    [-ForceWildcardHandling]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

ById

Set-CMTSStepApplyOperatingSystem
    -TaskSequenceId <String>
    [-ConfigFileName <String>]
    [-ConfigFilePackage <IResultObject>]
    [-LayeredDriver <OsdLayeredDriver>]
    [-Destination <DestinationType>]
    [-DestinationDisk <Int32>]
    [-DestinationDriveLetter <String>]
    [-DestinationPartition <Int32>]
    [-DestinationVariable <String>]
    [-ImagePackage <IResultObject>]
    [-ImagePackageIndex <Int32>]
    [-InstallPackage <IResultObject>]
    [-InstallPackageIndex <Int32>]
    [-RunFromNet <Boolean>]
    [-AddCondition <IResultObject[]>]
    [-ClearCondition]
    [-Description <String>]
    [-IsContinueOnError <Boolean>]
    [-IsEnabled <Boolean>]
    [-MoveToIndex <Int32>]
    [-NewStepName <String>]
    [-RemoveConditionFile]
    [-RemoveConditionFolder]
    [-RemoveConditionIfStatement]
    [-RemoveConditionOperatingSystem]
    [-RemoveConditionQueryWmi]
    [-RemoveConditionRegistry]
    [-RemoveConditionSoftware]
    [-RemoveConditionVariable]
    [-StepName <String>]
    [-StepOrder <ReorderType>]
    [-DisableWildcardHandling]
    [-ForceWildcardHandling]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

ByName

Set-CMTSStepApplyOperatingSystem
    -TaskSequenceName <String>
    [-ConfigFileName <String>]
    [-ConfigFilePackage <IResultObject>]
    [-LayeredDriver <OsdLayeredDriver>]
    [-Destination <DestinationType>]
    [-DestinationDisk <Int32>]
    [-DestinationDriveLetter <String>]
    [-DestinationPartition <Int32>]
    [-DestinationVariable <String>]
    [-ImagePackage <IResultObject>]
    [-ImagePackageIndex <Int32>]
    [-InstallPackage <IResultObject>]
    [-InstallPackageIndex <Int32>]
    [-RunFromNet <Boolean>]
    [-AddCondition <IResultObject[]>]
    [-ClearCondition]
    [-Description <String>]
    [-IsContinueOnError <Boolean>]
    [-IsEnabled <Boolean>]
    [-MoveToIndex <Int32>]
    [-NewStepName <String>]
    [-RemoveConditionFile]
    [-RemoveConditionFolder]
    [-RemoveConditionIfStatement]
    [-RemoveConditionOperatingSystem]
    [-RemoveConditionQueryWmi]
    [-RemoveConditionRegistry]
    [-RemoveConditionSoftware]
    [-RemoveConditionVariable]
    [-StepName <String>]
    [-StepOrder <ReorderType>]
    [-DisableWildcardHandling]
    [-ForceWildcardHandling]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

ByIdSetConditionIfStatement

Set-CMTSStepApplyOperatingSystem
    -TaskSequenceId <String>
    [-Condition <IResultObject[]>]
    [-SetConditionIfStatement]
    [-StatementType <ConditionStatementType>]
    [-StepName <String>]
    [-DisableWildcardHandling]
    [-ForceWildcardHandling]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

ByNameSetConditionIfStatement

Set-CMTSStepApplyOperatingSystem
    -TaskSequenceName <String>
    [-Condition <IResultObject[]>]
    [-SetConditionIfStatement]
    [-StatementType <ConditionStatementType>]
    [-StepName <String>]
    [-DisableWildcardHandling]
    [-ForceWildcardHandling]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

ByValueSetConditionIfStatement

Set-CMTSStepApplyOperatingSystem
    -InputObject <IResultObject>
    [-Condition <IResultObject[]>]
    [-SetConditionIfStatement]
    [-StatementType <ConditionStatementType>]
    [-StepName <String>]
    [-DisableWildcardHandling]
    [-ForceWildcardHandling]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

ByIdSetConditionVariable

Set-CMTSStepApplyOperatingSystem
    -TaskSequenceId <String>
    [-ConditionVariableName <String>]
    [-ConditionVariableValue <String>]
    [-OperatorType <VariableOperatorType>]
    [-SetConditionVariable]
    [-StepName <String>]
    [-DisableWildcardHandling]
    [-ForceWildcardHandling]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

ByNameSetConditionVariable

Set-CMTSStepApplyOperatingSystem
    -TaskSequenceName <String>
    [-ConditionVariableName <String>]
    [-ConditionVariableValue <String>]
    [-OperatorType <VariableOperatorType>]
    [-SetConditionVariable]
    [-StepName <String>]
    [-DisableWildcardHandling]
    [-ForceWildcardHandling]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

ByValueSetConditionVariable

Set-CMTSStepApplyOperatingSystem
    -InputObject <IResultObject>
    [-ConditionVariableName <String>]
    [-ConditionVariableValue <String>]
    [-OperatorType <VariableOperatorType>]
    [-SetConditionVariable]
    [-StepName <String>]
    [-DisableWildcardHandling]
    [-ForceWildcardHandling]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

ByIdSetConditionFile

Set-CMTSStepApplyOperatingSystem
    -TaskSequenceId <String>
    [-FileDateTimeOperator <VariableOperatorType>]
    [-FilePath <String>]
    [-FileTimestamp <DateTime>]
    [-FileVersion <String>]
    [-SetConditionFile]
    [-StepName <String>]
    [-VersionOperator <VariableOperatorType>]
    [-DisableWildcardHandling]
    [-ForceWildcardHandling]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

ByNameSetConditionFile

Set-CMTSStepApplyOperatingSystem
    -TaskSequenceName <String>
    [-FileDateTimeOperator <VariableOperatorType>]
    [-FilePath <String>]
    [-FileTimestamp <DateTime>]
    [-FileVersion <String>]
    [-SetConditionFile]
    [-StepName <String>]
    [-VersionOperator <VariableOperatorType>]
    [-DisableWildcardHandling]
    [-ForceWildcardHandling]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

ByValueSetConditionFile

Set-CMTSStepApplyOperatingSystem
    -InputObject <IResultObject>
    [-FileDateTimeOperator <VariableOperatorType>]
    [-FilePath <String>]
    [-FileTimestamp <DateTime>]
    [-FileVersion <String>]
    [-SetConditionFile]
    [-StepName <String>]
    [-VersionOperator <VariableOperatorType>]
    [-DisableWildcardHandling]
    [-ForceWildcardHandling]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

ByIdSetConditionFolder

Set-CMTSStepApplyOperatingSystem
    -TaskSequenceId <String>
    [-FolderDateTimeOperator <VariableOperatorType>]
    [-FolderPath <String>]
    [-FolderTimestamp <DateTime>]
    [-SetConditionFolder]
    [-StepName <String>]
    [-DisableWildcardHandling]
    [-ForceWildcardHandling]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

ByNameSetConditionFolder

Set-CMTSStepApplyOperatingSystem
    -TaskSequenceName <String>
    [-FolderDateTimeOperator <VariableOperatorType>]
    [-FolderPath <String>]
    [-FolderTimestamp <DateTime>]
    [-SetConditionFolder]
    [-StepName <String>]
    [-DisableWildcardHandling]
    [-ForceWildcardHandling]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

ByValueSetConditionFolder

Set-CMTSStepApplyOperatingSystem
    -InputObject <IResultObject>
    [-FolderDateTimeOperator <VariableOperatorType>]
    [-FolderPath <String>]
    [-FolderTimestamp <DateTime>]
    [-SetConditionFolder]
    [-StepName <String>]
    [-DisableWildcardHandling]
    [-ForceWildcardHandling]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

ByValueSetConditionQueryWmi

Set-CMTSStepApplyOperatingSystem
    -InputObject <IResultObject>
    [-Namespace <String[]>]
    [-Query <String>]
    [-SetConditionQueryWmi]
    [-StepName <String>]
    [-DisableWildcardHandling]
    [-ForceWildcardHandling]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

ByValueSetConditionOperatingSystem

Set-CMTSStepApplyOperatingSystem
    -InputObject <IResultObject>
    [-SetConditionOperatingSystem]
    [-StepName <String>]
    [-SupportedPlatform <IResultObject[]>]
    [-DisableWildcardHandling]
    [-ForceWildcardHandling]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

ByValueSetConditionRegistry

Set-CMTSStepApplyOperatingSystem
    -InputObject <IResultObject>
    [-RegistryKey <String>]
    [-RegistryOperator <VariableOperatorType>]
    [-RegistryValueData <String>]
    [-RegistryValueName <String>]
    [-RootKey <RegistryRootKeyType>]
    [-SetConditionRegistry]
    [-StepName <String>]
    [-ValueType <RegistryValueType>]
    [-DisableWildcardHandling]
    [-ForceWildcardHandling]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

ByValueSetConditionSoftware

Set-CMTSStepApplyOperatingSystem
    -InputObject <IResultObject>
    [-IsAnyVersion <Boolean>]
    [-MsiFilePath <String>]
    [-SetConditionSoftware]
    [-StepName <String>]
    [-DisableWildcardHandling]
    [-ForceWildcardHandling]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

ByIdSetConditionSoftware

Set-CMTSStepApplyOperatingSystem
    -TaskSequenceId <String>
    [-IsAnyVersion <Boolean>]
    [-MsiFilePath <String>]
    [-SetConditionSoftware]
    [-StepName <String>]
    [-DisableWildcardHandling]
    [-ForceWildcardHandling]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

ByNameSetConditionSoftware

Set-CMTSStepApplyOperatingSystem
    -TaskSequenceName <String>
    [-IsAnyVersion <Boolean>]
    [-MsiFilePath <String>]
    [-SetConditionSoftware]
    [-StepName <String>]
    [-DisableWildcardHandling]
    [-ForceWildcardHandling]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

ByIdSetConditionQueryWmi

Set-CMTSStepApplyOperatingSystem
    -TaskSequenceId <String>
    [-Namespace <String[]>]
    [-Query <String>]
    [-SetConditionQueryWmi]
    [-StepName <String>]
    [-DisableWildcardHandling]
    [-ForceWildcardHandling]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

ByNameSetConditionQueryWmi

Set-CMTSStepApplyOperatingSystem
    -TaskSequenceName <String>
    [-Namespace <String[]>]
    [-Query <String>]
    [-SetConditionQueryWmi]
    [-StepName <String>]
    [-DisableWildcardHandling]
    [-ForceWildcardHandling]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

ByIdSetConditionRegistry

Set-CMTSStepApplyOperatingSystem
    -TaskSequenceId <String>
    [-RegistryKey <String>]
    [-RegistryOperator <VariableOperatorType>]
    [-RegistryValueData <String>]
    [-RegistryValueName <String>]
    [-RootKey <RegistryRootKeyType>]
    [-SetConditionRegistry]
    [-StepName <String>]
    [-ValueType <RegistryValueType>]
    [-DisableWildcardHandling]
    [-ForceWildcardHandling]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

ByNameSetConditionRegistry

Set-CMTSStepApplyOperatingSystem
    -TaskSequenceName <String>
    [-RegistryKey <String>]
    [-RegistryOperator <VariableOperatorType>]
    [-RegistryValueData <String>]
    [-RegistryValueName <String>]
    [-RootKey <RegistryRootKeyType>]
    [-SetConditionRegistry]
    [-StepName <String>]
    [-ValueType <RegistryValueType>]
    [-DisableWildcardHandling]
    [-ForceWildcardHandling]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

ByIdSetConditionOperatingSystem

Set-CMTSStepApplyOperatingSystem
    -TaskSequenceId <String>
    [-SetConditionOperatingSystem]
    [-StepName <String>]
    [-SupportedPlatform <IResultObject[]>]
    [-DisableWildcardHandling]
    [-ForceWildcardHandling]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

ByNameSetConditionOperatingSystem

Set-CMTSStepApplyOperatingSystem
    -TaskSequenceName <String>
    [-SetConditionOperatingSystem]
    [-StepName <String>]
    [-SupportedPlatform <IResultObject[]>]
    [-DisableWildcardHandling]
    [-ForceWildcardHandling]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Description

Use this cmdlet to configure an instance of the Apply OS Image task sequence step.

For more information on this step, see About task sequence steps: Apply OS Image.

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 changes the Apply OS image step in the Default OS deployment task sequence to use a specific disk and partition.

$tsNameOsd = "Default OS deployment"
$tsStepNameApplyOsImage = "Apply OS image"

Set-CMTSStepApplyOperatingSystem -TaskSequenceName $tsNameOsd -StepName $tsStepNameApplyOsImage -Destination SpecificDiskAndPartition -DestinationDisk 5 -DestinationPartition 50

Parameters

-AddCondition

Specify a condition object to add to this step. To get this object, use one of the task sequence condition cmdlets. For example, Get-CMTSStepConditionVariable.

Parameter properties

Type:	IResultObject[]
Default value:	None
Supports wildcards:	False
DontShow:	False
Aliases:	AddConditions

Parameter sets

ByValue

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

ById

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

ByName

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-ClearCondition

Remove a condition from this step. Use the -Condition parameter to specify the condition to remove.

Parameter properties

Type:	SwitchParameter
Default value:	None
Supports wildcards:	False
DontShow:	False
Aliases:	ClearConditions

Parameter sets

ByValue

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

ById

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

ByName

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-Condition

Specify a condition object to use with this step. To get this object, use one of the task sequence condition cmdlets. For example, Get-CMTSStepConditionVariable.

Parameter properties

Type:	IResultObject[]
Default value:	None
Supports wildcards:	False
DontShow:	False
Aliases:	SubCondition, SubConditions

Parameter sets

ByIdSetConditionIfStatement

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

ByNameSetConditionIfStatement

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

ByValueSetConditionIfStatement

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-ConditionVariableName

Specify the name of the task sequence variable to use as a condition.

Parameter properties

Type:	String
Default value:	None
Supports wildcards:	False
DontShow:	False
Aliases:	Variable

Parameter sets

ByIdSetConditionVariable

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

ByNameSetConditionVariable

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

ByValueSetConditionVariable

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-ConditionVariableValue

Specify the value of the task sequence variable to use in a condition.

Parameter properties

Type:	String
Default value:	None
Supports wildcards:	False
DontShow:	False
Aliases:	Value

Parameter sets

ByIdSetConditionVariable

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

ByNameSetConditionVariable

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

ByValueSetConditionVariable

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-ConfigFileName

Specify the file name of an unattended or Sysprep answer file to use for a custom installation. Use this parameter with the ConfigFilePackage parameter.

Parameter properties

Type:	String
Default value:	None
Supports wildcards:	False
DontShow:	False
Aliases:	AnswerFileName

Parameter sets

ByValue

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

ById

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

ByName

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-ConfigFilePackage

Specify a package object that includes the unattended or Sysprep answer file to use for a custom installation. To get this object, use the Get-CMPackage cmdlet. Use this parameter with the ConfigFileName parameter.

Parameter properties

Type:	IResultObject
Default value:	None
Supports wildcards:	False
DontShow:	False
Aliases:	AnswerFilePackage

Parameter sets

ByValue

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

ById

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

ByName

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-Confirm

Prompts you for confirmation before running the cmdlet.

Parameter properties

Type:	SwitchParameter
Default value:	None
Supports wildcards:	False
DontShow:	False
Aliases:	cf

Parameter sets

(All)

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-Description

Specify an optional description for this task sequence step.

Parameter properties

Type:	String
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

ByValue

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

ById

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

ByName

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-Destination

Specify the location where you want to apply this OS. If you don't specify this parameter, the default is NextAvailableFormattedPartition.

• NextAvailableFormattedPartition: Use the next sequential partition not already targeted by an Apply Operating System or Apply Data Image step in this task sequence.

• SpecificDiskAndPartition: Specify the disk number with the DestinationDisk parameter and the partition number with the DestinationPartition parameter.

• SpecificLogicalDriverLetter: Use the DestinationDriveLetter parameter to specify the logical drive letter assigned to the partition by Windows PE. This drive letter can be different from the drive letter assigned by the newly deployed OS.

• LogicalDriverLetterInVariable: Use the DestinationVariable parameter to specify the task sequence variable containing the drive letter assigned to the partition by Windows PE. This variable is typically set with the DiskNumberVariable parameter of the Set-CMTSStepPartitionDisk or New-CMTSStepPartitionDisk cmdlets for the Format and Partition Disk task sequence step.

Parameter properties

Type:	DestinationType
Default value:	None
Accepted values:	NextAvailableFormattedPartition, SpecificDiskAndPartition, SpecificLogicalDriverLetter, LogicalDriverLetterInVariable
Supports wildcards:	False
DontShow:	False

Parameter sets

ByValue

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

ById

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

ByName

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-DestinationDisk

When you use -Destination SpecificDiskAndPartition, use this parameter to specify the disk number. Specify an integer from 0 to 99. Also use the DestinationPartition parameter.

Parameter properties

Type:	Int32
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

ByValue

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

ById

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

ByName

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-DestinationDriveLetter

When you use -Destination SpecificLogicalDriverLetter, use this parameter to specify the logical drive letter. Specify a drive letter from C to Z.

Parameter properties

Type:	String
Default value:	None
Supports wildcards:	False
DontShow:	False
Aliases:	DestinationLogicalDrive

Parameter sets

ByValue

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

ById

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

ByName

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-DestinationPartition

When you use -Destination SpecificDiskAndPartition, use this parameter to specify the partition number. Specify an integer from 1 to 99. Also use the DestinationDisk parameter.

Parameter properties

Type:	Int32
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

ByValue

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

ById

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

ByName

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-DestinationVariable

When you use -Destination LogicalDriverLetterInVariable, use this parameter to specify the task sequence variable with the logical drive letter. The variable name needs to alphanumeric without spaces and fewer than 256 characters.

Parameter properties

Type:	String
Default value:	None
Supports wildcards:	False
DontShow:	False
Aliases:	DestinationVariableName

Parameter sets

ByValue

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

ById

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

ByName

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-DisableWildcardHandling

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

Parameter properties

Type:	SwitchParameter
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

-FileDateTimeOperator

Specify a variable operator type for a file date/time condition.

Parameter properties

Type:	VariableOperatorType
Default value:	None
Accepted values:	Equals, NotEquals, Greater, GreaterEqual, Less, LessEqual
Supports wildcards:	False
DontShow:	False

Parameter sets

ByIdSetConditionFile

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

ByNameSetConditionFile

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

ByValueSetConditionFile

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-FilePath

Specify the path for a file condition.

Parameter properties

Type:	String
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

ByIdSetConditionFile

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

ByNameSetConditionFile

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

ByValueSetConditionFile

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-FileTimestamp

Specify a date/time value to use for a file condition.

Parameter properties

Type:	DateTime
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

ByIdSetConditionFile

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

ByNameSetConditionFile

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

ByValueSetConditionFile

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-FileVersion

Specify a version string for a file condition.

Parameter properties

Type:	String
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

ByIdSetConditionFile

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

ByNameSetConditionFile

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

ByValueSetConditionFile

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-FolderDateTimeOperator

Specify a variable operator for a folder date/time condition.

Parameter properties

Type:	VariableOperatorType
Default value:	None
Accepted values:	Equals, NotEquals, Greater, GreaterEqual, Less, LessEqual
Supports wildcards:	False
DontShow:	False

Parameter sets

ByIdSetConditionFolder

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

ByNameSetConditionFolder

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

ByValueSetConditionFolder

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-FolderPath

Specify the path for a folder condition.

Parameter properties

Type:	String
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

ByIdSetConditionFolder

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

ByNameSetConditionFolder

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

ByValueSetConditionFolder

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-FolderTimestamp

Specify a date/time value to use for a folder condition.

Parameter properties

Type:	DateTime
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

ByIdSetConditionFolder

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

ByNameSetConditionFolder

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

ByValueSetConditionFolder

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-ForceWildcardHandling

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

Parameter properties

Type:	SwitchParameter
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

-ImagePackage

Specify an OS image package object. The step applies the OS from this image. Use the ImagePackageIndex parameter to set the image index.

To get this object, use the Get-CMOperatingSystemImage cmdlet.

Parameter properties

Type:	IResultObject
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

ByValue

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

ById

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

ByName

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-ImagePackageIndex

Specify an integer value of the image index. Use this parameter with the ImagePackage parameter.

Parameter properties

Type:	Int32
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

ByValue

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

ById

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

ByName

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-InputObject

Specify a task sequence object that has the Apply OS Image step to configure. To get this object, use the Get-CMTaskSequence cmdlet.

Parameter properties

Type:	IResultObject
Default value:	None
Supports wildcards:	False
DontShow:	False
Aliases:	TaskSequence

Parameter sets

ByValue

Position:	Named
Mandatory:	True
Value from pipeline:	True
Value from pipeline by property name:	False
Value from remaining arguments:	False

ByValueSetConditionIfStatement

Position:	Named
Mandatory:	True
Value from pipeline:	True
Value from pipeline by property name:	False
Value from remaining arguments:	False

ByValueSetConditionVariable

Position:	Named
Mandatory:	True
Value from pipeline:	True
Value from pipeline by property name:	False
Value from remaining arguments:	False

ByValueSetConditionFile

Position:	Named
Mandatory:	True
Value from pipeline:	True
Value from pipeline by property name:	False
Value from remaining arguments:	False

ByValueSetConditionFolder

Position:	Named
Mandatory:	True
Value from pipeline:	True
Value from pipeline by property name:	False
Value from remaining arguments:	False

ByValueSetConditionQueryWmi

Position:	Named
Mandatory:	True
Value from pipeline:	True
Value from pipeline by property name:	False
Value from remaining arguments:	False

ByValueSetConditionOperatingSystem

Position:	Named
Mandatory:	True
Value from pipeline:	True
Value from pipeline by property name:	False
Value from remaining arguments:	False

ByValueSetConditionRegistry

Position:	Named
Mandatory:	True
Value from pipeline:	True
Value from pipeline by property name:	False
Value from remaining arguments:	False

ByValueSetConditionSoftware

Position:	Named
Mandatory:	True
Value from pipeline:	True
Value from pipeline by property name:	False
Value from remaining arguments:	False

-InstallPackage

Specify an OS upgrade package object. The step applies the OS from this original installation source. Use the InstallPackageIndex parameter to set the edition.

To get this object, use the Get-CMOperatingSystemInstaller cmdlet.

Parameter properties

Type:	IResultObject
Default value:	None
Supports wildcards:	False
DontShow:	False
Aliases:	UpgradePackage

Parameter sets

ByValue

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

ById

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

ByName

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-InstallPackageIndex

Specify an integer value of the OS upgrade package edition. Use this parameter with the InstallPackage parameter.

Parameter properties

Type:	Int32
Default value:	None
Supports wildcards:	False
DontShow:	False
Aliases:	UpgradePackageIndex

Parameter sets

ByValue

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

ById

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

ByName

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-IsAnyVersion

Use this parameter with the SetConditionSoftware parameter to match any version of the product.

Parameter properties

Type:	Boolean
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

ByValueSetConditionSoftware

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

ByIdSetConditionSoftware

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

ByNameSetConditionSoftware

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-IsContinueOnError

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

Parameter properties

Type:	Boolean
Default value:	None
Supports wildcards:	False
DontShow:	False
Aliases:	IsThisStepContinueOnError

Parameter sets

ByValue

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

ById

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

ByName

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-IsEnabled

Use this parameter to enable this task sequence step.

Parameter properties

Type:	Boolean
Default value:	None
Supports wildcards:	False
DontShow:	False
Aliases:	IsThisStepEnabled

Parameter sets

ByValue

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

ById

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

ByName

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-LayeredDriver

Starting in version 2107, use this parameter to select other types of keyboards that are common with Japanese and Korean languages. Specify an integer value for the layered driver to install with Windows. Use the same values as the OsdLayeredDriver task sequence variable.

Parameter properties

Type:	OsdLayeredDriver
Default value:	None
Accepted values:	DoNotSpecify, Driver1, Driver2, Driver3, Driver4, Driver5, Driver6
Supports wildcards:	False
DontShow:	False
Aliases:	KeyboardDriver

Parameter sets

ByValue

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

ById

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

ByName

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-MoveToIndex

Move this step to the specified index position in the task sequence.

Parameter properties

Type:	Int32
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

ByValue

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

ById

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

ByName

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-MsiFilePath

Use this parameter with the SetConditionSoftware parameter to specify the path to a Windows Installer file.

Parameter properties

Type:	String
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

ByValueSetConditionSoftware

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

ByIdSetConditionSoftware

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

ByNameSetConditionSoftware

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-Namespace

Specify the namespace for a WMI query condition.

Parameter properties

Type:	String[]
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

ByValueSetConditionQueryWmi

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

ByIdSetConditionQueryWmi

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

ByNameSetConditionQueryWmi

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-NewStepName

Use this parameter to rename this task sequence step.

Parameter properties

Type:	String
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

ByValue

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

ById

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

ByName

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-OperatorType

Specify an operator to use with a task sequence variable condition.

Parameter properties

Type:	VariableOperatorType
Default value:	None
Accepted values:	Exists, NotExists, Equals, NotEquals, Greater, GreaterEqual, Less, LessEqual, Like, NotLike
Supports wildcards:	False
DontShow:	False

Parameter sets

ByIdSetConditionVariable

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

ByNameSetConditionVariable

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

ByValueSetConditionVariable

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-Query

Specify a WMI query string to use for a condition.

Parameter properties

Type:	String
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

ByValueSetConditionQueryWmi

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

ByIdSetConditionQueryWmi

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

ByNameSetConditionQueryWmi

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-RegistryKey

Specify the key to use with a registry condition.

Parameter properties

Type:	String
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

ByValueSetConditionRegistry

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

ByIdSetConditionRegistry

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

ByNameSetConditionRegistry

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-RegistryOperator

Specify an operator to use with a registry condition.

Parameter properties

Type:	VariableOperatorType
Default value:	None
Accepted values:	Exists, NotExists, Equals, NotEquals, Greater, GreaterEqual, Less, LessEqual
Supports wildcards:	False
DontShow:	False

Parameter sets

ByValueSetConditionRegistry

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

ByIdSetConditionRegistry

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

ByNameSetConditionRegistry

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-RegistryValueData

Specify the value data to use with a registry condition.

Parameter properties

Type:	String
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

ByValueSetConditionRegistry

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

ByIdSetConditionRegistry

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

ByNameSetConditionRegistry

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-RegistryValueName

Specify the value name to use with a registry condition.

Parameter properties

Type:	String
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

ByValueSetConditionRegistry

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

ByIdSetConditionRegistry

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

ByNameSetConditionRegistry

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-RemoveConditionFile

Use this parameter to remove a file condition.

Parameter properties

Type:	SwitchParameter
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

ByValue

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

ById

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

ByName

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-RemoveConditionFolder

Use this parameter to remove a folder condition.

Parameter properties

Type:	SwitchParameter
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

ByValue

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

ById

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

ByName

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-RemoveConditionIfStatement

Use this parameter to remove an if statement condition.

Parameter properties

Type:	SwitchParameter
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

ByValue

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

ById

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

ByName

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-RemoveConditionOperatingSystem

Use this parameter to remove an OS condition.

Parameter properties

Type:	SwitchParameter
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

ByValue

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

ById

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

ByName

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-RemoveConditionQueryWmi

Use this parameter to remove a WMI query condition.

Parameter properties

Type:	SwitchParameter
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

ByValue

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

ById

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

ByName

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-RemoveConditionRegistry

Use this parameter to remove a registry condition.

Parameter properties

Type:	SwitchParameter
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

ByValue

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

ById

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

ByName

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-RemoveConditionSoftware

Use this parameter to remove a software condition.

Parameter properties

Type:	SwitchParameter
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

ByValue

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

ById

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

ByName

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-RemoveConditionVariable

Use this parameter to remove a task sequence variable condition.

Parameter properties

Type:	SwitchParameter
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

ByValue

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

ById

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

ByName

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-RootKey

Specify the root key to use with a registry condition.

Parameter properties

Type:	RegistryRootKeyType
Default value:	None
Accepted values:	HKeyCurrentUser, HKeyLocalMachine, HKeyUsers, HKeyCurrentConfig
Supports wildcards:	False
DontShow:	False

Parameter sets

ByValueSetConditionRegistry

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

ByIdSetConditionRegistry

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

ByNameSetConditionRegistry

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-RunFromNet

Set this parameter to $true to allow the task sequence to apply the OS image directly from the distribution point.

For greatest security, it's recommended to not enable this setting. This option is designed for use on devices with limited storage capacity. For more information, see Access content directly from the distribution point.

Parameter properties

Type:	Boolean
Default value:	None
Supports wildcards:	False
DontShow:	False
Aliases:	AllowAccessFromDistributionPoint

Parameter sets

ByValue

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

ById

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

ByName

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-SetConditionFile

Add a new file condition.

Parameter properties

Type:	SwitchParameter
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

ByIdSetConditionFile

Position:	Named
Mandatory:	True
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

ByNameSetConditionFile

Position:	Named
Mandatory:	True
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

ByValueSetConditionFile

Position:	Named
Mandatory:	True
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-SetConditionFolder

Add a new folder condition.

Parameter properties

Type:	SwitchParameter
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

ByIdSetConditionFolder

Position:	Named
Mandatory:	True
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

ByNameSetConditionFolder

Position:	Named
Mandatory:	True
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

ByValueSetConditionFolder

Position:	Named
Mandatory:	True
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-SetConditionIfStatement

Add a new if statement condition.

Parameter properties

Type:	SwitchParameter
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

ByIdSetConditionIfStatement

Position:	Named
Mandatory:	True
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

ByNameSetConditionIfStatement

Position:	Named
Mandatory:	True
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

ByValueSetConditionIfStatement

Position:	Named
Mandatory:	True
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-SetConditionOperatingSystem

Add a new OS condition.

Parameter properties

Type:	SwitchParameter
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

ByValueSetConditionOperatingSystem

Position:	Named
Mandatory:	True
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

ByIdSetConditionOperatingSystem

Position:	Named
Mandatory:	True
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

ByNameSetConditionOperatingSystem

Position:	Named
Mandatory:	True
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-SetConditionQueryWmi

Add a new WMI query condition.

Parameter properties

Type:	SwitchParameter
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

ByValueSetConditionQueryWmi

Position:	Named
Mandatory:	True
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

ByIdSetConditionQueryWmi

Position:	Named
Mandatory:	True
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

ByNameSetConditionQueryWmi

Position:	Named
Mandatory:	True
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-SetConditionRegistry

Add a new registry condition.

Parameter properties

Type:	SwitchParameter
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

ByValueSetConditionRegistry

Position:	Named
Mandatory:	True
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

ByIdSetConditionRegistry

Position:	Named
Mandatory:	True
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

ByNameSetConditionRegistry

Position:	Named
Mandatory:	True
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-SetConditionSoftware

Add a new software condition.

Parameter properties

Type:	SwitchParameter
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

ByValueSetConditionSoftware

Position:	Named
Mandatory:	True
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

ByIdSetConditionSoftware

Position:	Named
Mandatory:	True
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

ByNameSetConditionSoftware

Position:	Named
Mandatory:	True
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-SetConditionVariable

Add a new task sequence variable condition.

Parameter properties

Type:	SwitchParameter
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

ByIdSetConditionVariable

Position:	Named
Mandatory:	True
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

ByNameSetConditionVariable

Position:	Named
Mandatory:	True
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

ByValueSetConditionVariable

Position:	Named
Mandatory:	True
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-StatementType

Set the type for an if statement condition.

Parameter properties

Type:	ConditionStatementType
Default value:	None
Accepted values:	All, Any, None
Supports wildcards:	False
DontShow:	False
Aliases:	Operator

Parameter sets

ByIdSetConditionIfStatement

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

ByNameSetConditionIfStatement

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

ByValueSetConditionIfStatement

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-StepName

Specify the name of the step to select for changes.

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

-StepOrder

Use this parameter to reorder the step in the task sequence.

Parameter properties

Type:	ReorderType
Default value:	None
Accepted values:	MoveUp, MoveDown, MoveToIndex
Supports wildcards:	False
DontShow:	False

Parameter sets

ByValue

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

ById

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

ByName

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-SupportedPlatform

Use this parameter to specify the platforms for an OS condition.

Parameter properties

Type:	IResultObject[]
Default value:	None
Supports wildcards:	False
DontShow:	False
Aliases:	SupportedPlatforms

Parameter sets

ByValueSetConditionOperatingSystem

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

ByIdSetConditionOperatingSystem

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

ByNameSetConditionOperatingSystem

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-TaskSequenceId

Specify the package ID of the task sequence with the Apply OS Image step to configure. This value is a standard package ID, for example XYZ00858.

Parameter properties

Type:	String
Default value:	None
Supports wildcards:	False
DontShow:	False
Aliases:	Id, TaskSequencePackageId

Parameter sets

ById

Position:	Named
Mandatory:	True
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

ByIdSetConditionIfStatement

Position:	Named
Mandatory:	True
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

ByIdSetConditionVariable

Position:	Named
Mandatory:	True
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

ByIdSetConditionFile

Position:	Named
Mandatory:	True
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

ByIdSetConditionFolder

Position:	Named
Mandatory:	True
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

ByIdSetConditionSoftware

Position:	Named
Mandatory:	True
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

ByIdSetConditionQueryWmi

Position:	Named
Mandatory:	True
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

ByIdSetConditionRegistry

Position:	Named
Mandatory:	True
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

ByIdSetConditionOperatingSystem

Position:	Named
Mandatory:	True
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-TaskSequenceName

Specify the name of the task sequence with the Apply OS Image step to configure.

Parameter properties

Type:	String
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

ByName

Position:	Named
Mandatory:	True
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

ByNameSetConditionIfStatement

Position:	Named
Mandatory:	True
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

ByNameSetConditionVariable

Position:	Named
Mandatory:	True
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

ByNameSetConditionFile

Position:	Named
Mandatory:	True
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

ByNameSetConditionFolder

Position:	Named
Mandatory:	True
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

ByNameSetConditionSoftware

Position:	Named
Mandatory:	True
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

ByNameSetConditionQueryWmi

Position:	Named
Mandatory:	True
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

ByNameSetConditionRegistry

Position:	Named
Mandatory:	True
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

ByNameSetConditionOperatingSystem

Position:	Named
Mandatory:	True
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-ValueType

Specify the type of value for a registry condition.

Parameter properties

Type:	RegistryValueType
Default value:	None
Accepted values:	RegistrySZ, RegistryExpandSZ, RegistryDWord
Supports wildcards:	False
DontShow:	False

Parameter sets

ByValueSetConditionRegistry

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

ByIdSetConditionRegistry

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

ByNameSetConditionRegistry

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-VersionOperator

Specify an operator to use with a file condition.

Parameter properties

Type:	VariableOperatorType
Default value:	None
Accepted values:	Equals, NotEquals, Greater, GreaterEqual, Less, LessEqual
Supports wildcards:	False
DontShow:	False

Parameter sets

ByIdSetConditionFile

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

ByNameSetConditionFile

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

ByValueSetConditionFile

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-WhatIf

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

Parameter properties

Type:	SwitchParameter
Default value:	None
Supports wildcards:	False
DontShow:	False
Aliases:	wi

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.

Inputs

Microsoft.ConfigurationManagement.ManagementProvider.IResultObject

Outputs

System.Object

Related Links

• Get-CMTSStepApplyOperatingSystem
• New-CMTSStepApplyOperatingSystem
• Remove-CMTSStepApplyOperatingSystem
• About task sequence steps: Apply OS Image