New-CMTSStepApplyOperatingSystem

Module:

ConfigurationManager Module

Create an Apply OS Image step, which you can add to a task sequence.

Syntax

Default (Default)

New-CMTSStepApplyOperatingSystem
    [-ConfigFileName <String>]
    [-ConfigFilePackage <IResultObject>]
    [-Destination <DestinationType>]
    [-DestinationDisk <Int32>]
    [-DestinationDriveLetter <String>]
    [-LayeredDriver <OsdLayeredDriver>]
    [-DestinationPartition <Int32>]
    [-DestinationVariable <String>]
    [-ImagePackage <IResultObject>]
    [-ImagePackageIndex <Int32>]
    [-InstallPackage <IResultObject>]
    [-InstallPackageIndex <Int32>]
    [-RunFromNet <Boolean>]
    [-Condition <IResultObject[]>]
    [-ContinueOnError]
    [-Description <String>]
    [-Disable]
    -Name <String>
    [-DisableWildcardHandling]
    [-ForceWildcardHandling]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Description

This cmdlet creates a new Apply OS Image step object. Then use the Add-CMTaskSequenceStep cmdlet to add the step to a task sequence. 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 first uses the Get-CMOperatingSystemImage cmdlet to get an object for the OS image package. It saves this object in the $osImgPkg variable. The next step creates an object for the Apply OS Image step, using the $osImgPkg object as the image package.

It then gets a task sequence object, and adds this new step to the task sequence at index 11.

$osImgPkg = Get-CMOperatingSystemImage -Name "OSImagePkg01"
$step = New-CMTSStepApplyOperatingSystem -Name "Apply OS image" -ImagePackage $osImgPkg -ImagePackageIndex 1

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

$tsOsd | Add-CMTaskSequenceStep -Step $step -InsertStepStartIndex 11

Parameters

-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:	Conditions

Parameter sets

(All)

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

(All)

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

(All)

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

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

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

-Description

Specify an optional description for this task sequence step.

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

-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

(All)

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

(All)

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

(All)

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

(All)

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

(All)

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

-Disable

Add this parameter to disable this task sequence step.

Parameter properties

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

Parameter sets

(All)

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

-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

(All)

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

(All)

Position:	Named
Mandatory:	False
Value from pipeline:	False
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

(All)

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

(All)

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

(All)

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

-Name

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

Parameter properties

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

Parameter sets

(All)

Position:	Named
Mandatory:	True
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

(All)

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

None

Outputs

IResultObject

Notes

For more information on this return object and its properties, see SMS_TaskSequence_ApplyOperatingSystemAction server WMI class.

Related Links

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