Set-CMDriver

Set-CMDriver

Changes the settings of a device driver.

Syntax

Parameter Set: SetDriverById
Set-CMDriver -Id <String> [-AddBootImagePackage <IResultObject[]> ] [-AddDriverPackage <IResultObject[]> ] [-AdministrativeCategory <IResultObject[]> ] [-Description <String> ] [-DriverSource <String> ] [-EnableAndAllowInstall <Boolean> ] [-NewName <String> ] [-RemoveBootImagePackage <IResultObject[]> ] [-RemoveDriverPackage <IResultObject[]> ] [-RunOnAnyPlatform] [-SupportedPlatformName <String[]> ] [-UpdateDistributionPointsforBootImagePackage <Boolean> ] [-UpdateDistributionPointsforDriverPackage <Boolean> ] [-Confirm] [-WhatIf] [ <CommonParameters>]

Parameter Set: SetDriverByName
Set-CMDriver -Name <String> [-AddBootImagePackage <IResultObject[]> ] [-AddDriverPackage <IResultObject[]> ] [-AdministrativeCategory <IResultObject[]> ] [-Description <String> ] [-DriverSource <String> ] [-EnableAndAllowInstall <Boolean> ] [-NewName <String> ] [-RemoveBootImagePackage <IResultObject[]> ] [-RemoveDriverPackage <IResultObject[]> ] [-RunOnAnyPlatform] [-SupportedPlatformName <String[]> ] [-UpdateDistributionPointsforBootImagePackage <Boolean> ] [-UpdateDistributionPointsforDriverPackage <Boolean> ] [-Confirm] [-WhatIf] [ <CommonParameters>]

Parameter Set: SetDriverByResultObject
Set-CMDriver -InputObject <IResultObject> [-AddBootImagePackage <IResultObject[]> ] [-AddDriverPackage <IResultObject[]> ] [-AdministrativeCategory <IResultObject[]> ] [-Description <String> ] [-DriverSource <String> ] [-EnableAndAllowInstall <Boolean> ] [-NewName <String> ] [-RemoveBootImagePackage <IResultObject[]> ] [-RemoveDriverPackage <IResultObject[]> ] [-RunOnAnyPlatform] [-SupportedPlatformName <String[]> ] [-UpdateDistributionPointsforBootImagePackage <Boolean> ] [-UpdateDistributionPointsforDriverPackage <Boolean> ] [-Confirm] [-WhatIf] [ <CommonParameters>]

Detailed Description

The Set-CMDriver cmdlet changes settings of a device driver in the driver catalog.

Parameters

-AddBootImagePackage<IResultObject[]>

Specifies an array of boot image objects. Use this parameter to specify the boot images that can install the device drivers. To obtain a boot image object, use the Get-CMBootImage cmdlet.

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-AddDriverPackage<IResultObject[]>

Specifies an array of driver package objects. Use this parameter to specify the driver packages that Configuration Manager uses to distribute the device drivers. To obtain a driver package object, use the Get-CMDriverPackage cmdlet.

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-AdministrativeCategory<IResultObject[]>

Specifies an array of administrative categories. Assign the device drivers to an administrative category for filtering purposes, such as Desktops or Notebooks categories.

To obtain an administrative category object, use the Get-CMCategory cmdlet.

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-Description<String>

Specifies a description for the device driver.

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-DriverSource<String>

Specifies the driver package source location. When you create a driver package, the source location of the package must point to an empty network share that is not used by another driver package.

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-EnableAndAllowInstall<Boolean>

Indicates whether Configuration Manager enables the drivers and allows computers to install the drivers.

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-Id<String>

Specifies the ID of a device driver.

Aliases

none

Required?

true

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-InputObject<IResultObject>

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

Aliases

none

Required?

true

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-Name<String>

Specifies the name of a device driver.

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 device driver.

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-RemoveBootImagePackage<IResultObject[]>

Specifies an array of boot image objects. Use this parameter to remove the boot images that can install the device driver. To obtain a boot image object, use the Get-CMBootImage cmdlet.

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-RemoveDriverPackage<IResultObject[]>

Specifies an array of driver package objects. Use this parameter to remove the driver packages that Configuration Manager uses to distribute the device drivers. To obtain a driver package object, use the Get-CMDriverPackage cmdlet.

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-RunOnAnyPlatform

Indicates that the device driver can run on all platforms.

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-SupportedPlatformName<String[]>

Specifies an array of names of platforms on which the device driver can run.

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-UpdateDistributionPointsforBootImagePackage<Boolean>

Indicates whether Configuration Manager updates distribution points when the device driver is added to the boot image package.

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-UpdateDistributionPointsforDriverPackage<Boolean>

Indicates whether Configuration Manager updates distribution points when the device driver is added to the driver package.

Aliases

none

Required?

false

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: Changes the settings of a device driver

This example changes the settings of a device driver.

The first command uses the Get-CMBootImage cmdlet to get the boot image that has the ID CM100004, and stores the result in the $bootPackage variable.

The second command changes the settings of the device driver named Fabrikam Digital Audio. The command specifies a new name and a description for the device driver. The command enables the driver and allows computers to install it. The command specifies that the device driver can run on all platforms, and removes the boot image stored in $bootPackage that can install the device driver.

PS C:\> $bootPackage = Get-CMBootImage –Id "CM100004"
PS C:\> Set-CMDriver -Name "Fabrikam Digital Audio" -NewName " FabrikamDA" -Description "Previous version" -EnableAndAllowInstall $True -RunOnAnyPlatform $True -RemoveBootImagePackage $bootPackage

Get-CMDriver

Import-CMDriver

Enable-CMDriver

Disable-CMDriver

Remove-CMDriver

Get-CMCategory

Get-CMBootImage

Get-CMDriverPackage