Set-CMOperatingSystemImage

Changes configuration settings of OS images.

Syntax

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

Description

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.

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

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

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

Set-CMOperatingSystemImage -SecurityScopeAction AddMembership -SecurityScopeName "SecScope02" -Name "ImagePkg01"

Example 3: Remove an OS image from a security scope

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

Set-CMOperatingSystemImage -SecurityScopeAction RemoveMembership -SecurityScopeName "SecScope02" -Name "ImagePkg01"

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

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

-DisableWildcardHandling

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

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

-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). Can't combine with DisableWildcardHandling.

Type:SwitchParameter
Position:Named
Default value:None
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
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
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

-Name

Specifies the name of an OS image.

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

-NewName

Specifies the new name of an OS image.

Type:String
Position:Named
Default value:None
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
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
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
Accepted values: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
Accepted values:High, Medium, Low
Position:Named
Default value:None
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
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 OS 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 doesn't run.

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

Inputs

Microsoft.ConfigurationManagement.ManagementProvider.IResultObject

Outputs

System.Object