.png)
Set-CMOperatingSystemImage
Updated: March 1, 2013
Applies To: System Center 2012 Configuration Manager SP1
Set-CMOperatingSystemImage
Syntax
Parameter Set: SetById Set-CMOperatingSystemImage -Id <String[]> [-Description <String> ] [-NewName <String> ] [-Path <String> ] [-SecuredScopeNames <String> ] [-Version <String> ] [-Confirm] [-WhatIf] [ <CommonParameters>] Parameter Set: SetByName Set-CMOperatingSystemImage -Name <String> [-Description <String> ] [-NewName <String> ] [-Path <String> ] [-SecuredScopeNames <String> ] [-Version <String> ] [-Confirm] [-WhatIf] [ <CommonParameters>] Parameter Set: SetByValueMandatory Set-CMOperatingSystemImage -InputObject <IResultObject> [-Description <String> ] [-NewName <String> ] [-Path <String> ] [-Version <String> ] [-Confirm] [-WhatIf] [ <CommonParameters>] Parameter Set: SetSecurityScopeById Set-CMOperatingSystemImage -Id <String[]> -SecurityScopeAction <SecurityScopeActionType> -SecurityScopeName <String> [-SecuredScopeNames <String> ] [-Confirm] [-WhatIf] [ <CommonParameters>] Parameter Set: SetSecurityScopeByName Set-CMOperatingSystemImage -Name <String> -SecurityScopeAction <SecurityScopeActionType> -SecurityScopeName <String> [-SecuredScopeNames <String> ] [-Confirm] [-WhatIf] [ <CommonParameters>] Parameter Set: SetSecurityScopeByValue Set-CMOperatingSystemImage -InputObject <IResultObject> -SecurityScopeAction <SecurityScopeActionType> -SecurityScopeName <String> [-Confirm] [-WhatIf] [ <CommonParameters>]
Detailed Description
The Set-CMOperatingSystemImage cmdlet changes configuration settings of one or more operating system images in Microsoft System Center 2012 Configuration Manager. Operating system images are Microsoft Windows Imaging (WIM) format files and represent a compressed collection of reference files and folders that System Center 2012 Configuration Manager requires to successfully install and configure an operating system on a computer.
Parameters
-Description<String>
Specifies a description for the operating system installer.
Aliases | none |
Required? | false |
Position? | named |
Default Value | none |
Accept Pipeline Input? | True (ByPropertyName) |
Accept Wildcard Characters? | false |
-Id<String[]>
Specifies an array of IDs of operating system images.
Aliases | PackageId |
Required? | true |
Position? | named |
Default Value | none |
Accept Pipeline Input? | True (ByPropertyName) |
Accept Wildcard Characters? | false |
-InputObject<IResultObject>
Specifies a CMOperatingSystemImage object. To obtain a CMOperatingSystemImage object, use the Get-CMOperatingSystemImage cmdlet.
Aliases | none |
Required? | true |
Position? | named |
Default Value | none |
Accept Pipeline Input? | True (ByPropertyName) |
Accept Wildcard Characters? | false |
-Name<String>
Specifies the name of an operating system image.
Aliases | none |
Required? | true |
Position? | named |
Default Value | none |
Accept Pipeline Input? | True (ByPropertyName) |
Accept Wildcard Characters? | false |
-NewName<String>
Specifies the new name of an operating system image.
Aliases | none |
Required? | false |
Position? | named |
Default Value | none |
Accept Pipeline Input? | True (ByPropertyName) |
Accept Wildcard Characters? | false |
-Path<String>
Specifies the network path to the installation source files of an operating system image.
You can specify either a full local path or a Universal Naming Convention (UNC) path. Make sure that this location contains all the files and subdirectories that the program needs to execute, including any scripts.
Aliases | PackageSourcePath |
Required? | false |
Position? | named |
Default Value | none |
Accept Pipeline Input? | True (ByPropertyName) |
Accept Wildcard Characters? | false |
-SecuredScopeNames<String>
Specifies names of security scopes. A security scope name can be Default or the name of a custom-created security scope.
Aliases | none |
Required? | false |
Position? | named |
Default Value | none |
Accept Pipeline Input? | True (ByPropertyName) |
Accept Wildcard Characters? | false |
-SecurityScopeAction<SecurityScopeActionType>
Applies an action to a security scope. Valid values are: AddMembership and RemoveMembership.
Aliases | none |
Required? | true |
Position? | named |
Default Value | none |
Accept Pipeline Input? | True (ByPropertyName) |
Accept Wildcard Characters? | false |
-SecurityScopeName<String>
Specifies the name of a security scope. A security scope name can be Default or the name of a custom-created security scope.
Aliases | none |
Required? | true |
Position? | named |
Default Value | none |
Accept Pipeline Input? | True (ByPropertyName) |
Accept Wildcard Characters? | false |
-Version<String>
Specifies the version of the operating system image.
Aliases | none |
Required? | false |
Position? | named |
Default Value | none |
Accept Pipeline Input? | True (ByPropertyName) |
Accept Wildcard Characters? | false |
-Confirm
Prompts you for confirmation before executing the command.
Required? | false |
Position? | named |
Default Value | false |
Accept Pipeline Input? | false |
Accept Wildcard Characters? | false |
-WhatIf
Describes what would happen if you executed the command without actually executing the command.
Required? | false |
Position? | named |
Default Value | false |
Accept Pipeline Input? | false |
Accept Wildcard Characters? | false |
<CommonParameters>
This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see about_CommonParameters.
Inputs
The input type is the type of the objects that you can pipe to the cmdlet.
Outputs
The output type is the type of the objects that the cmdlet emits.
Examples
Example 1: Change settings for an operating system image by using an ID
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.
PS C:\> Set-CMOperatingSystemImage -Id "Cm10004f" -NewName "Microsoft Windows PE (x64)" -Version "I20C" -Description "Dept02 OS Image" -Path "\\atc-dist-08\Public\CM\AdminUITeam\FeatureUIDataFile_Obsoleted\OSD\Win2k3X64\Boot\x64\boot.wim"
Example 2: Change settings for an operating system image by using a name
This command changes configuration settings of the operating system image named Windows PE (x64). 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.
PS C:\> Set-CMOperatingSystemImage -Name "Windows PE (x64)" -NewName "Microsoft Windows PE (x64)" -Version "I20C" -Description "Dept02 OS Image" -Path "\\atc-dist-08\Public\CM\AdminUITeam\FeatureUIDataFile_Obsoleted\OSD\Win2k3X64\Boot\x64\boot.wim"
Example 3: Add an operating system image to a security scope by using a name
This command adds membership to the security scope named SecScope02 for the operating system installer named OSImagePkg01.
PS C:\> Set-CMOperatingSystemImage -SecurityScopeAction AddMembership -SecurityScopeName "SecScope02" -Name "OSImagePkg01"
Example 4: Remove an operating system image from a security scope
This command removes membership from the security scope named SecScope02 for the operating system installer named OSImagePkg01.
PS C:\> Set-CMOperatingSystemImage -SecurityScopeAction RemoveMembership -SecurityScopeName "SecScope02" -Name "OSImagePkg01"
