Get-CMBootImage

Get-CMBootImage

Gets an operating system boot image.

Syntax

Parameter Set: SearchByName
Get-CMBootImage [-Name <String> ] [-SecuredScopeNames <String> ] [ <CommonParameters>]

Parameter Set: SearchByIdMandatory
Get-CMBootImage -Id <String[]> [-SecuredScopeNames <String> ] [ <CommonParameters>]

Detailed Description

The Get-CMBootImage cmdlet gets a Windows Preinstallation Environment (PE) operating system boot image that Microsoft System Center 2012 SP1 Configuration Manager can use to deploy an operating system.

Operating system boot images are .wim format files. These files contain a compressed set of reference files and folders that are required to successfully install and configure an operating system image. By default, System Center 2012 Configuration Manager includes both x86 and x64 boot images.

You must run the Get-CMBootImage cmdlet on the computer that is running the Systems Management Server (SMS) provider. The computer account of the computer that is running the SMS provider must have Read and Write access to the source package of the boot image. For more information about the SMS provider, see Planning for the SMS Provider in Configuration Manager (https://go.microsoft.com/fwlink/?LinkID=263566) on TechNet.

Parameters

-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

-Name<String>

Specifies a name of a boot image.

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-SecuredScopeNames<String>

Specifies secured scope name.

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

<CommonParameters>

This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see    about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216).

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: Get a boot image by using its ID

This command gets a boot image by using its ID.

PS C:\> Get-CMBootImage -Id "c0eb2912-0de8-4a2a-9c77-603b35bcf7e4"

Example 2: Get a boot image by using its name

This command gets a boot image by using its name.

PS C:\> Get-CMBootImage -Name "SMS_BootImagePackage"

New-CMBootImage

Remove-CMBootImage

Set-CMBootImage

Planning for the SMS Provider in Configuration Manager