Set-CMDriverBootImage

Set-CMDriverBootImage

Adds a driver to a boot image or removes a driver from a boot image.

Syntax

Parameter Set: SetDriverBootImagesById_Id
Set-CMDriverBootImage -BootImageId <String> -DriverId <String> -SetDriveBootImageAction <SetDriveBootImageActionType> {AddDriverToBootImage | RemoveDriverFromBootImage} [-Confirm] [-WhatIf] [ <CommonParameters>]

Parameter Set: SetDriverBootImagesById_Name
Set-CMDriverBootImage -BootImageName <String> -DriverId <String> -SetDriveBootImageAction <SetDriveBootImageActionType> {AddDriverToBootImage | RemoveDriverFromBootImage} [-Confirm] [-WhatIf] [ <CommonParameters>]

Parameter Set: SetDriverBootImagesById_Object
Set-CMDriverBootImage -BootImage <IResultObject> -DriverId <String> -SetDriveBootImageAction <SetDriveBootImageActionType> {AddDriverToBootImage | RemoveDriverFromBootImage} [-Confirm] [-WhatIf] [ <CommonParameters>]

Parameter Set: SetDriverBootImagesByName_Id
Set-CMDriverBootImage -BootImageId <String> -DriverName <String> -SetDriveBootImageAction <SetDriveBootImageActionType> {AddDriverToBootImage | RemoveDriverFromBootImage} [-Confirm] [-WhatIf] [ <CommonParameters>]

Parameter Set: SetDriverBootImagesByName_Name
Set-CMDriverBootImage -BootImageName <String> -DriverName <String> -SetDriveBootImageAction <SetDriveBootImageActionType> {AddDriverToBootImage | RemoveDriverFromBootImage} [-Confirm] [-WhatIf] [ <CommonParameters>]

Parameter Set: SetDriverBootImagesByName_Object
Set-CMDriverBootImage -BootImage <IResultObject> -DriverName <String> -SetDriveBootImageAction <SetDriveBootImageActionType> {AddDriverToBootImage | RemoveDriverFromBootImage} [-Confirm] [-WhatIf] [ <CommonParameters>]

Parameter Set: SetDriverBootImagesByObject_Id
Set-CMDriverBootImage -BootImageId <String> -Driver <IResultObject> -SetDriveBootImageAction <SetDriveBootImageActionType> {AddDriverToBootImage | RemoveDriverFromBootImage} [-Confirm] [-WhatIf] [ <CommonParameters>]

Parameter Set: SetDriverBootImagesByObject_Name
Set-CMDriverBootImage -BootImageName <String> -Driver <IResultObject> -SetDriveBootImageAction <SetDriveBootImageActionType> {AddDriverToBootImage | RemoveDriverFromBootImage} [-Confirm] [-WhatIf] [ <CommonParameters>]

Parameter Set: SetDriverBootImagesByObject_Object
Set-CMDriverBootImage -BootImage <IResultObject> -Driver <IResultObject> -SetDriveBootImageAction <SetDriveBootImageActionType> {AddDriverToBootImage | RemoveDriverFromBootImage} [-Confirm] [-WhatIf] [ <CommonParameters>]

Detailed Description

The Set-CMDriverBootImage cmdlet adds a driver to a boot image or removes a driver from a boot image. You can add Windows device drivers that you have imported into the Microsoft System Center 2012 SP1 Configuration Manager driver catalog to one or more boot images. You should add only mass storage device drivers and network adapter device drivers to boot images because other types of drivers are not needed and will increase the size of the boot image.

Parameters

-BootImage<IResultObject>

Specifies a CMBootImage object. To obtain a CMBootImage object, use the Get-CMBootImage cmdlet.

Aliases

none

Required?

true

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-BootImageId<String>

Specifies the ID of a boot image.

Aliases

none

Required?

true

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-BootImageName<String>

Specifies the name of a boot image.

Aliases

none

Required?

true

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-Driver<IResultObject>

Specifies a driver object. To obtain a CMDriver object, use the Get-CMDriver cmdlet.

Aliases

none

Required?

true

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-DriverId<String>

Specifies the ID of a driver.

Aliases

none

Required?

true

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-DriverName<String>

Specifies the name of a driver.

Aliases

none

Required?

true

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-SetDriveBootImageAction<SetDriveBootImageActionType>

Specifies the boot image action. The acceptable values for this parameter are:

-- AddDriverToBootImage
-- RemoveDriverFromBootImage

Aliases

none

Required?

true

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-Confirm

Prompts you for confirmation before running the cmdlet.

Required?

false

Position?

named

Default Value

false

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-WhatIf

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

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 (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: Add a driver to a boot image

This command adds the driver named Adaptec Embedded SCSI HostRAID Controller to the boot image named Boot image (x64).

PS C:\> Set-CMDriverBootImage -SetDriveBootImageAction AddDriverToBootImage -DriverName "Adaptec Embedded SCSI HostRAID Controller" -BootImageName "Boot image (x64)"

Example 2: Remove a driver from a boot image

This command removes the driver named Adaptec SCSI HostRAID Management Processor Device from the boot image named Boot image (x64).

PS C:\> Set-CMDriverBootImage -SetDriveBootImageAction RemoveDriverFromBootImage -DriverName "Adaptec SCSI HostRAID Management Processor Device" -BootImageName "Boot image (x64)"

Get-CMBootImage

Get-CMDriver