Set-​CM​Operating​System​Image

Changes configuration settings of operating system images.

Syntax

Set-CMOperatingSystemImage
   [-Confirm]
   [-CopyToPackageShareOnDistributionPoint <Boolean>]
   [-CustomPackageShareName <String>]
   [-Description <String>]
   [-DisableWildcardHandling]
   [-DisconnectUserFromDistributionPoint <Boolean>]
   [-DisconnectUserFromDistributionPointMins <UInt32>]
   [-DisconnectUserFromDistributionPointRetryCount <UInt32>]
   [-DistributionPointUpdateSchedule <IResultObject>]
   [-EnableBinaryDeltaReplication <Boolean>]
   [-ForceWildcardHandling]
   -Id <String>
   [-MulticastAllow <Boolean>]
   [-MulticastEncrypt <Boolean>]
   [-MulticastTransferOnly <Boolean>]
   [-NewName <String>]
   [-PassThru]
   [-Path <String>]
   [-PersistContentInCache <Boolean>]
   [-PrestageBehavior <PrestageBehavior>]
   [-Priority <Priority>]
   [-SendToPreferredDistributionPoint <Boolean>]
   [-Version <String>]
   [-WhatIf]
   [<CommonParameters>]
Set-CMOperatingSystemImage
   [-Confirm]
   [-CopyToPackageShareOnDistributionPoint <Boolean>]
   [-CustomPackageShareName <String>]
   [-Description <String>]
   [-DisableWildcardHandling]
   [-DisconnectUserFromDistributionPoint <Boolean>]
   [-DisconnectUserFromDistributionPointMins <UInt32>]
   [-DisconnectUserFromDistributionPointRetryCount <UInt32>]
   [-DistributionPointUpdateSchedule <IResultObject>]
   [-EnableBinaryDeltaReplication <Boolean>]
   [-ForceWildcardHandling]
   -InputObject <IResultObject>
   [-MulticastAllow <Boolean>]
   [-MulticastEncrypt <Boolean>]
   [-MulticastTransferOnly <Boolean>]
   [-NewName <String>]
   [-PassThru]
   [-Path <String>]
   [-PersistContentInCache <Boolean>]
   [-PrestageBehavior <PrestageBehavior>]
   [-Priority <Priority>]
   [-SendToPreferredDistributionPoint <Boolean>]
   [-Version <String>]
   [-WhatIf]
   [<CommonParameters>]
Set-CMOperatingSystemImage
   [-Confirm]
   [-CopyToPackageShareOnDistributionPoint <Boolean>]
   [-CustomPackageShareName <String>]
   [-Description <String>]
   [-DisableWildcardHandling]
   [-DisconnectUserFromDistributionPoint <Boolean>]
   [-DisconnectUserFromDistributionPointMins <UInt32>]
   [-DisconnectUserFromDistributionPointRetryCount <UInt32>]
   [-DistributionPointUpdateSchedule <IResultObject>]
   [-EnableBinaryDeltaReplication <Boolean>]
   [-ForceWildcardHandling]
   [-MulticastAllow <Boolean>]
   [-MulticastEncrypt <Boolean>]
   [-MulticastTransferOnly <Boolean>]
   -Name <String>
   [-NewName <String>]
   [-PassThru]
   [-Path <String>]
   [-PersistContentInCache <Boolean>]
   [-PrestageBehavior <PrestageBehavior>]
   [-Priority <Priority>]
   [-SendToPreferredDistributionPoint <Boolean>]
   [-Version <String>]
   [-WhatIf]
   [<CommonParameters>]

Description

The Set-CMOperatingSystemImage cmdlet changes configuration settings of one or more operating system images in Microsoft System Center Configuration Manager. Operating system images are .wim format files and represent a compressed collection of reference files and folders that System Center Configuration Manager requires to successfully install and configure an operating system on a computer.

Examples

Example 1: Change settings for an operating system image by using an ID

PS C:\> Set-CMOperatingSystemImage -Id "Cm10004f" -NewName "Microsoft Windows 8 (x64)" -Version "I20C" -Description "Dept02 Sys Image" -Path "\\Contoso\Public\OSD\win8x64.wim"

This command changes configuration settings of the operating system image that has the ID Cm10004f. The command renames the operating system image, adds a version and description, and specifies the path to the installation source files of the operating system image.

Example 2: Add an operating system image to a security scope by using a name

PS C:\> Set-CMOperatingSystemImage -SecurityScopeAction AddMembership -SecurityScopeName "SecScope02" -Name "ImagePkg01"

This command adds membership to the security scope named SecScope02 for the operating system image named ImagePkg01.

Example 3: Remove an operating system image from a security scope

PS C:\> Set-CMOperatingSystemImage -SecurityScopeAction RemoveMembership -SecurityScopeName "SecScope02" -Name "ImagePkg01"

This command removes membership from the security scope named SecScope02 for the operating system image named ImagePkg01.

Required Parameters

-Id

Specifies an array of IDs of operating system images.

Type:String
Aliases:PackageId
Position:Named
Default value:None
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
Accept pipeline input:True (ByValue)
Accept wildcard characters:False
-Name

Specifies the name of an operating system image.

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

Optional Parameters

-Confirm

Prompts you for confirmation before running the cmdlet.

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:False
Accept pipeline input:False
Accept wildcard characters:False
-CopyToPackageShareOnDistributionPoint
Type:Boolean
Aliases:CopyToPackageShareOnDistributionPoints
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-CustomPackageShareName
Type:String
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-Description

Specifies a description for the operating system image.

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

DisableWildcardHandling treats wildcard characters as literal character values. Cannot be combined with ForceWildcardHandling.

Type:SwitchParameter
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-DisconnectUserFromDistributionPoint
Type:Boolean
Aliases:DisconnectUsersFromDistributionPoints
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-DisconnectUserFromDistributionPointMins
Type:UInt32
Aliases:DisconnectUsersFromDistributionPointsMinutes
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-DisconnectUserFromDistributionPointRetryCount
Type:UInt32
Aliases:DisconnectUsersFromDistributionPointsRetries
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-DistributionPointUpdateSchedule
Type:IResultObject
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-EnableBinaryDeltaReplication
Type:Boolean
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-ForceWildcardHandling

ForceWildcardHandling processes wildcard characters and may lead to unexpected behavior (not recommended). Cannot be combined with DisableWildcardHandling.

Type:SwitchParameter
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-MulticastAllow
Type:Boolean
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-MulticastEncrypt
Type:Boolean
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-MulticastTransferOnly
Type:Boolean
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-NewName

Specifies the new name of an operating system image.

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

Returns the current working object. By default, this cmdlet does not generate any output.

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

Specifies the network path to the operating system image source .wim file.

Type:String
Aliases:PackageSourcePath
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-PersistContentInCache
Type:Boolean
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-PrestageBehavior
Type:PrestageBehavior
Parameter Sets:ManualCopy, DownloadDelta, OnDemand
Position:Named
Default value:None
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
Parameter Sets:High, Medium, Low
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-SendToPreferredDistributionPoint
Type:Boolean
Aliases:SendToPreferredDistributionPoints
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-Version

Specifies the version of the operating system image.

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

Shows what would happen if the cmdlet runs. The cmdlet is not run.

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