Edit

Share via

Set-CMOperatingSystemImage

Module:
ConfigurationManager Module

Changes configuration settings of OS images.

Syntax

SetByValueMandatory (Default) 

Set-CMOperatingSystemImage
    -InputObject <IResultObject>
    [-CopyToPackageShareOnDistributionPoint <Boolean>]
    [-CustomPackageShareName <String>]
    [-Description <String>]
    [-DisconnectUserFromDistributionPoint <Boolean>]
    [-DisconnectUserFromDistributionPointMins <UInt32>]
    [-DisconnectUserFromDistributionPointRetryCount <UInt32>]
    [-DistributionPointUpdateSchedule <IResultObject>]
    [-EnableBinaryDeltaReplication <Boolean>]
    [-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>]

SetById 

Set-CMOperatingSystemImage
    -Id <String>
    [-CopyToPackageShareOnDistributionPoint <Boolean>]
    [-CustomPackageShareName <String>]
    [-Description <String>]
    [-DisconnectUserFromDistributionPoint <Boolean>]
    [-DisconnectUserFromDistributionPointMins <UInt32>]
    [-DisconnectUserFromDistributionPointRetryCount <UInt32>]
    [-DistributionPointUpdateSchedule <IResultObject>]
    [-EnableBinaryDeltaReplication <Boolean>]
    [-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>]

SetByName 

Set-CMOperatingSystemImage
    -Name <String>
    [-CopyToPackageShareOnDistributionPoint <Boolean>]
    [-CustomPackageShareName <String>]
    [-Description <String>]
    [-DisconnectUserFromDistributionPoint <Boolean>]
    [-DisconnectUserFromDistributionPointMins <UInt32>]
    [-DisconnectUserFromDistributionPointRetryCount <UInt32>]
    [-DistributionPointUpdateSchedule <IResultObject>]
    [-EnableBinaryDeltaReplication <Boolean>]
    [-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>]

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.

Parameter properties

Type:SwitchParameter
Default value:False
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

-CopyToPackageShareOnDistributionPoint

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.

Parameter properties

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

Parameter sets

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

-CustomPackageShareName

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.

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

-Description

Specifies a description for the OS image.

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

-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

-DisconnectUserFromDistributionPoint

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.

Parameter properties

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

Parameter sets

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

-DisconnectUserFromDistributionPointMins

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.

Parameter properties

Type:UInt32
Default value:None
Supports wildcards:False
DontShow:False
Aliases:DisconnectUsersFromDistributionPointsMinutes

Parameter sets

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

-DisconnectUserFromDistributionPointRetryCount

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.

Parameter properties

Type:UInt32
Default value:None
Supports wildcards:False
DontShow:False
Aliases:DisconnectUsersFromDistributionPointsRetries

Parameter sets

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

-DistributionPointUpdateSchedule

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.

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

-EnableBinaryDeltaReplication

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.

Parameter properties

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

ForceWildcardHandling processes wildcard characters and may lead to unexpected behavior (not recommended). Can't combine 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

-Id

Specifies an array of IDs of OS images.

Parameter properties

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

Parameter sets

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

-InputObject

Specifies a CMOperatingSystemImage object. To obtain a CMOperatingSystemImage object, use the Get-CMOperatingSystemImage cmdlet.

Parameter properties

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

Parameter sets

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

-MulticastAllow

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.

Parameter properties

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

-MulticastEncrypt

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.

Parameter properties

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

-MulticastTransferOnly

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.

Parameter properties

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

-Name

Specifies the name of an OS image.

Parameter properties

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

Parameter sets

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

-NewName

Specifies the new name of an OS image.

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

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

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

-Path

Specifies the network path to the OS image source .wim file.

Parameter properties

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

Parameter sets

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

-PersistContentInCache

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.

Parameter properties

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

-PrestageBehavior

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.

Parameter properties

Type:PrestageBehavior
Default value:None
Accepted values:ManualCopy, DownloadDelta, OnDemand
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

-Priority

Specifies a change for the priority of the deployment type. Valid values are: Increase and Decrease.

Parameter properties

Type:Priority
Default value:None
Accepted values:High, Medium, Low
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

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

Parameter properties

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

Parameter sets

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

-SendToPreferredDistributionPoint

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.

Parameter properties

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

Parameter sets

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

-Version

Specifies the version of the OS image.

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

-WhatIf

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

Parameter properties

Type:SwitchParameter
Default value:False
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