Export (0) Print
Expand All
Expand Minimize

Set-CMBootImage

Updated: February 7, 2014

Applies To: System Center 2012 R2 Configuration Manager

Set-CMBootImage

Modifies an operating system boot image.

Syntax

Parameter Set: SetById
Set-CMBootImage -Id <String[]> [-Description <String> ] [-NewName <String> ] [-PackageSourcePath <String> ] [-SecuredScopeNames <String> ] [-Version <String> ] [-Confirm] [-WhatIf] [ <CommonParameters>]

Parameter Set: SetByName
Set-CMBootImage -Name <String> [-Description <String> ] [-NewName <String> ] [-PackageSourcePath <String> ] [-SecuredScopeNames <String> ] [-Version <String> ] [-Confirm] [-WhatIf] [ <CommonParameters>]

Parameter Set: SetByValueMandatory
Set-CMBootImage -InputObject <IResultObject> [-Description <String> ] [-NewName <String> ] [-PackageSourcePath <String> ] [-SecuredScopeNames <String> ] [-Version <String> ] [-Confirm] [-WhatIf] [ <CommonParameters>]

Parameter Set: SetSecurityScopeById
Set-CMBootImage -Id <String[]> -SecurityScopeAction <SecurityScopeActionType> {AddMembership | RemoveMembership} -SecurityScopeName <String> [-SecuredScopeNames <String> ] [-Confirm] [-WhatIf] [ <CommonParameters>]

Parameter Set: SetSecurityScopeByName
Set-CMBootImage -Name <String> -SecurityScopeAction <SecurityScopeActionType> {AddMembership | RemoveMembership} -SecurityScopeName <String> [-SecuredScopeNames <String> ] [-Confirm] [-WhatIf] [ <CommonParameters>]

Parameter Set: SetSecurityScopeByValue
Set-CMBootImage -InputObject <IResultObject> -SecurityScopeAction <SecurityScopeActionType> {AddMembership | RemoveMembership} -SecurityScopeName <String> [-Confirm] [-WhatIf] [ <CommonParameters>]




Detailed Description

The Set-CMBootImage cmdlet modifies an operating system boot image. Boot images are Windows Preinstallation Environment (Windows PE) images into which you boot a client computer before you install an operating system.

You can add device drivers to a boot image or change its properties. Before you can add a new device driver, you must first import the driver to the Microsoft System Center 2012 Configuration Manager driver catalog and enable it.

A modification to the boot image does not change its source package.

Parameters

-Description<String>

Describes the contents of a boot image.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-Id<String[]>

Specifies an array of boot image identifiers.


Aliases

PackageId

Required?

true

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-InputObject<IResultObject>

Specifies a boot image object.


Aliases

none

Required?

true

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-Name<String>

Specifies a name of a boot image.


Aliases

none

Required?

true

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-NewName<String>

Specifies a new name for the boot image.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-PackageSourcePath<String>

Modifies the location of the Windows Imaging (WIM) format file for a boot image.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-SecuredScopeNames<String>

Specifies a secured scope name.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-SecurityScopeAction<SecurityScopeActionType>

Specifies an action for 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 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 boot 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: Rename a boot image object that is identified by using its ID

This command retrieves a boot image by using its ID, and then renames the boot image. Depending on replication issues, this modification can take a long time to display in the Configuration Manager console.


PS C:\> Set-CMBootimage -Id "CM100004" -NewName "Windows8 (x64)"

Example 2: Rename a boot image object that is identified by using its name

This command retrieves a boot image by using its name, and then renames the boot image. The command also adds a version and description to the boot image object. Depending on replication issues, this modification can take a long time to display in the Configuration Manager console.


PS C:\> Set-CMBootImage -Name "Boot Image (x64)" -NewName "Windows 8 x64" -Version "6.2.8400.1" -Description "Microsoft Windows 8 PE (x64)"

Related topics

 
Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft