The Set-CMOperatingSystemImage cmdlet changes configuration settings of one or more OS images in Configuration Manager.
OS images are .wim format files and represent a compressed collection of reference files and folders that Configuration Manager requires to successfully install and configure an OS on a computer.
Note
Run Configuration Manager cmdlets from the Configuration Manager site drive, for example PS XYZ:\>. For more information, see getting started.
Examples
Example 1: Change settings for an OS image by using an ID
This command changes configuration settings of the OS image that has the ID Cm10004f.
The command renames the OS image, adds a version and description, and specifies the path to the installation source files of the OS image.
Prompts you for confirmation before running the cmdlet.
Type:
SwitchParameter
Aliases:
cf
Position:
Named
Default value:
False
Required:
False
Accept pipeline input:
False
Accept wildcard characters:
False
-CopyToPackageShareOnDistributionPoint
Type:
Boolean
Aliases:
CopyToPackageShareOnDistributionPoints
Position:
Named
Default value:
None
Required:
False
Accept pipeline input:
False
Accept wildcard characters:
False
-CustomPackageShareName
Type:
String
Position:
Named
Default value:
None
Required:
False
Accept pipeline input:
False
Accept wildcard characters:
False
-Description
Specifies a description for the OS image.
Type:
String
Position:
Named
Default value:
None
Required:
False
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
Required:
False
Accept pipeline input:
False
Accept wildcard characters:
False
-DisconnectUserFromDistributionPoint
Type:
Boolean
Aliases:
DisconnectUsersFromDistributionPoints
Position:
Named
Default value:
None
Required:
False
Accept pipeline input:
False
Accept wildcard characters:
False
-DisconnectUserFromDistributionPointMins
Type:
UInt32
Aliases:
DisconnectUsersFromDistributionPointsMinutes
Position:
Named
Default value:
None
Required:
False
Accept pipeline input:
False
Accept wildcard characters:
False
-DisconnectUserFromDistributionPointRetryCount
Type:
UInt32
Aliases:
DisconnectUsersFromDistributionPointsRetries
Position:
Named
Default value:
None
Required:
False
Accept pipeline input:
False
Accept wildcard characters:
False
-DistributionPointUpdateSchedule
Type:
IResultObject
Position:
Named
Default value:
None
Required:
False
Accept pipeline input:
False
Accept wildcard characters:
False
-EnableBinaryDeltaReplication
Type:
Boolean
Position:
Named
Default value:
None
Required:
False
Accept pipeline input:
False
Accept wildcard characters:
False
-ForceWildcardHandling
ForceWildcardHandling processes wildcard characters and may lead to unexpected behavior (not recommended). Can't combine with DisableWildcardHandling.
Type:
SwitchParameter
Position:
Named
Default value:
None
Required:
False
Accept pipeline input:
False
Accept wildcard characters:
False
-Id
Specifies an array of IDs of OS images.
Type:
String
Aliases:
PackageId
Position:
Named
Default value:
None
Required:
True
Accept pipeline input:
False
Accept wildcard characters:
False
-InputObject
Specifies a CMOperatingSystemImage object.
To obtain a CMOperatingSystemImage object, use the Get-CMOperatingSystemImage cmdlet.
Type:
IResultObject
Position:
Named
Default value:
None
Required:
True
Accept pipeline input:
True
Accept wildcard characters:
False
-MulticastAllow
Type:
Boolean
Position:
Named
Default value:
None
Required:
False
Accept pipeline input:
False
Accept wildcard characters:
False
-MulticastEncrypt
Type:
Boolean
Position:
Named
Default value:
None
Required:
False
Accept pipeline input:
False
Accept wildcard characters:
False
-MulticastTransferOnly
Type:
Boolean
Position:
Named
Default value:
None
Required:
False
Accept pipeline input:
False
Accept wildcard characters:
False
-Name
Specifies the name of an OS image.
Type:
String
Position:
Named
Default value:
None
Required:
True
Accept pipeline input:
False
Accept wildcard characters:
False
-NewName
Specifies the new name of an OS image.
Type:
String
Position:
Named
Default value:
None
Required:
False
Accept pipeline input:
False
Accept wildcard characters:
False
-PassThru
Add this parameter to return an object that represents the item with which you're working. By default, this cmdlet may not generate any output.
Type:
SwitchParameter
Position:
Named
Default value:
None
Required:
False
Accept pipeline input:
False
Accept wildcard characters:
False
-Path
Specifies the network path to the OS image source .wim file.
Type:
String
Aliases:
PackageSourcePath
Position:
Named
Default value:
None
Required:
False
Accept pipeline input:
False
Accept wildcard characters:
False
-PersistContentInCache
Type:
Boolean
Position:
Named
Default value:
None
Required:
False
Accept pipeline input:
False
Accept wildcard characters:
False
-PrestageBehavior
Type:
PrestageBehavior
Accepted values:
ManualCopy, DownloadDelta, OnDemand
Position:
Named
Default value:
None
Required:
False
Accept pipeline input:
False
Accept wildcard characters:
False
-Priority
Specifies a change for the priority of the deployment type.
Valid values are: Increase and Decrease.
Type:
Priority
Accepted values:
High, Medium, Low
Position:
Named
Default value:
None
Required:
False
Accept pipeline input:
False
Accept wildcard characters:
False
-Reload
Applies to version 2006 and later. If you change the image properties using an external tool, use this option to reload the information in the site database.
Type:
SwitchParameter
Aliases:
ReloadImage
Position:
Named
Default value:
None
Required:
False
Accept pipeline input:
False
Accept wildcard characters:
False
-SendToPreferredDistributionPoint
Type:
Boolean
Aliases:
SendToPreferredDistributionPoints
Position:
Named
Default value:
None
Required:
False
Accept pipeline input:
False
Accept wildcard characters:
False
-Version
Specifies the version of the OS image.
Type:
String
Position:
Named
Default value:
None
Required:
False
Accept pipeline input:
False
Accept wildcard characters:
False
-WhatIf
Shows what would happen if the cmdlet runs. The cmdlet doesn't run.