Set-CMBootImage

Modifies an operating system boot image.

Syntax

Set-CMBootImage
   -Id <String>
   [-NewName <String>]
   [-Version <String>]
   [-Description <String>]
   [-Path <String>]
   [-EnablePrestartCommand <Boolean>]
   [-PrestartCommandLine <String>]
   [-IncludeFilesForPrestart <Boolean>]
   [-PrestartIncludeFilesDirectory <String>]
   [-BackgroundBitmapPath <String>]
   [-ScratchSpace <UInt32>]
   [-EnableCommandSupport <Boolean>]
   [-PersistContentInCache <Boolean>]
   [-EnableBinaryDeltaReplication <Boolean>]
   [-DeployFromPxeDistributionPoint <Boolean>]
   [-DistributionPointUpdateSchedule <IResultObject>]
   [-CustomPackageShareName <String>]
   [-DisconnectUserFromDistributionPoint <Boolean>]
   [-DisconnectUserFromDistributionPointRetryCount <UInt32>]
   [-DisconnectUserFromDistributionPointMins <UInt32>]
   [-AddOptionalComponent <IResultObject[]>]
   [-RemoveOptionalComponent <IResultObject[]>]
   [-CopyToPackageShareOnDistributionPoint <Boolean>]
   [-Force]
   [-Priority <Priority>]
   [-SendToPreferredDistributionPoint <Boolean>]
   [-PrestageBehavior <PrestageBehavior>]
   [-PassThru]
   [-DisableWildcardHandling]
   [-ForceWildcardHandling]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
Set-CMBootImage
   -InputObject <IResultObject>
   [-NewName <String>]
   [-Version <String>]
   [-Description <String>]
   [-Path <String>]
   [-EnablePrestartCommand <Boolean>]
   [-PrestartCommandLine <String>]
   [-IncludeFilesForPrestart <Boolean>]
   [-PrestartIncludeFilesDirectory <String>]
   [-BackgroundBitmapPath <String>]
   [-ScratchSpace <UInt32>]
   [-EnableCommandSupport <Boolean>]
   [-PersistContentInCache <Boolean>]
   [-EnableBinaryDeltaReplication <Boolean>]
   [-DeployFromPxeDistributionPoint <Boolean>]
   [-DistributionPointUpdateSchedule <IResultObject>]
   [-CustomPackageShareName <String>]
   [-DisconnectUserFromDistributionPoint <Boolean>]
   [-DisconnectUserFromDistributionPointRetryCount <UInt32>]
   [-DisconnectUserFromDistributionPointMins <UInt32>]
   [-AddOptionalComponent <IResultObject[]>]
   [-RemoveOptionalComponent <IResultObject[]>]
   [-CopyToPackageShareOnDistributionPoint <Boolean>]
   [-Force]
   [-Priority <Priority>]
   [-SendToPreferredDistributionPoint <Boolean>]
   [-PrestageBehavior <PrestageBehavior>]
   [-PassThru]
   [-DisableWildcardHandling]
   [-ForceWildcardHandling]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
Set-CMBootImage
   -Name <String>
   [-NewName <String>]
   [-Version <String>]
   [-Description <String>]
   [-Path <String>]
   [-EnablePrestartCommand <Boolean>]
   [-PrestartCommandLine <String>]
   [-IncludeFilesForPrestart <Boolean>]
   [-PrestartIncludeFilesDirectory <String>]
   [-BackgroundBitmapPath <String>]
   [-ScratchSpace <UInt32>]
   [-EnableCommandSupport <Boolean>]
   [-PersistContentInCache <Boolean>]
   [-EnableBinaryDeltaReplication <Boolean>]
   [-DeployFromPxeDistributionPoint <Boolean>]
   [-DistributionPointUpdateSchedule <IResultObject>]
   [-CustomPackageShareName <String>]
   [-DisconnectUserFromDistributionPoint <Boolean>]
   [-DisconnectUserFromDistributionPointRetryCount <UInt32>]
   [-DisconnectUserFromDistributionPointMins <UInt32>]
   [-AddOptionalComponent <IResultObject[]>]
   [-RemoveOptionalComponent <IResultObject[]>]
   [-CopyToPackageShareOnDistributionPoint <Boolean>]
   [-Force]
   [-Priority <Priority>]
   [-SendToPreferredDistributionPoint <Boolean>]
   [-PrestageBehavior <PrestageBehavior>]
   [-PassThru]
   [-DisableWildcardHandling]
   [-ForceWildcardHandling]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

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 Configuration Manager driver catalog and enable it.

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

Examples

Example 1: Rename a boot image object that is identified by using its ID

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

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.

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

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

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.

Required Parameters

-Id

Specifies an array of boot image identifiers.

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

Specifies a boot image object.

Type:IResultObject
Position:Named
Default value:None
Accept pipeline input:True (ByValue)
Accept wildcard characters:False
-Name

Specifies a name of a boot image.

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

Optional Parameters

-AddOptionalComponent
Type:IResultObject[]
Aliases:AddOptionalComponents
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-BackgroundBitmapPath
Type:String
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-Confirm

Prompts you for confirmation before running the cmdlet.

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:False
Accept pipeline input:False
Accept wildcard characters:False
-CopyToPackageShareOnDistributionPoint
Type:Boolean
Aliases:CopyToPackageShareOnDistributionPoints
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-CustomPackageShareName
Type:String
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-DeployFromPxeDistributionPoint
Type:Boolean
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-Description

Describes the contents of a boot image.

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

DisableWildcardHandling treats wildcard characters as literal character values. Cannot be combined with ForceWildcardHandling.

Type:SwitchParameter
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-DisconnectUserFromDistributionPoint
Type:Boolean
Aliases:DisconnectUsersFromDistributionPoints
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-DisconnectUserFromDistributionPointMins
Type:UInt32
Aliases:DisconnectUsersFromDistributionPointsMinutes
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-DisconnectUserFromDistributionPointRetryCount
Type:UInt32
Aliases:DisconnectUsersFromDistributionPointsRetries
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-DistributionPointUpdateSchedule
Type:IResultObject
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-EnableBinaryDeltaReplication
Type:Boolean
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-EnableCommandSupport
Type:Boolean
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-EnablePrestartCommand
Type:Boolean
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-Force

Forces the command to run without asking for user confirmation.

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

ForceWildcardHandling processes wildcard characters and may lead to unexpected behavior (not recommended). Cannot be combined with DisableWildcardHandling.

Type:SwitchParameter
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-IncludeFilesForPrestart
Type:Boolean
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-NewName

Specifies a new name for the boot image.

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

Returns the current working object. By default, this cmdlet does not generate any output.

Type:SwitchParameter
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-Path
Type:String
Aliases:ImagePath
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-PersistContentInCache
Type:Boolean
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-PrestageBehavior
Type:PrestageBehavior
Parameter Sets:ManualCopy, DownloadDelta, OnDemand
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-PrestartCommandLine
Type:String
Aliases:CommandLine
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-PrestartIncludeFilesDirectory
Type:String
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-Priority
Type:Priority
Parameter Sets:High, Medium, Low
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-RemoveOptionalComponent
Type:IResultObject[]
Aliases:RemoveOptionalComponents
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-ScratchSpace
Type:UInt32
Parameter Sets:32, 64, 128, 256, 512
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-SendToPreferredDistributionPoint
Type:Boolean
Aliases:SendToPreferredDistributionPoints
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-Version

Specifies the version of the boot image.

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

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Type:SwitchParameter
Aliases:wi
Position:Named
Default value:False
Accept pipeline input:False
Accept wildcard characters:False