Edit

Get-CMBootImage

  • Reference
Module:
ConfigurationManager

Get an OS boot image.

Syntax

Get-CMBootImage
   [-Name <String>]
   [-Reload]
   [-DisableWildcardHandling]
   [-ForceWildcardHandling]
   [<CommonParameters>]
Get-CMBootImage
   -Id <String>
   [-Reload]
   [-DisableWildcardHandling]
   [-ForceWildcardHandling]
   [<CommonParameters>]

Description

Use this cmdlet to get a Windows Preinstallation Environment (PE) OS boot image that Configuration Manager uses to deploy an OS. By default, Configuration Manager includes both x86 and x64 boot images. For more information, see Manage boot images with Configuration Manager.

Note

Run Configuration Manager cmdlets from the Configuration Manager site drive, for example PS XYZ:\>. For more information, see getting started.

Examples

Example 1: Get a boot image by using its ID

This command gets a boot image by using its ID.

Get-CMBootImage -Id "XYZ00002"

Example 2: List all boot images

This command gets all boot images at the site and lists several properties in a table format.

Get-CMBootImage | Select-Object PackageId, Name, ImageOSVersion, ProductionClientVersion, InputLocale | Format-Table

Parameters

-DisableWildcardHandling

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

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

-ForceWildcardHandling

This parameter processes wildcard characters and may lead to unexpected behavior (not recommended). You can't combine it with DisableWildcardHandling.

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

-Id

Specify a boot image ID to get. This value is a standard package ID, for example, XYZ00002.

Type:String
Aliases:PackageId
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-Name

Specify the name of a boot image to get.

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

-Reload

Applies to version 2006 and later. If the version of the Windows ADK components in the boot image are out of date, use this parameter to reload this boot image with the current Windows PE version from the Windows ADK. For more information, see Update distribution points with the boot image.

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

Inputs

None

Outputs

IResultObject[]

IResultObject

Notes

For more information on this return object and its properties, see SMS_BootImagePackage server WMI class.