Set-CMDriver

Module:

ConfigurationManager

Changes the settings of a device driver.

Syntax

Set-CMDriver
   [-AddAdministrativeCategory <IResultObject[]>]
   [-AddBootImagePackage <IResultObject[]>]
   [-AddDriverPackage <IResultObject[]>]
   [-AddSupportedPlatformName <String[]>]
   [-AdministrativeCategory <IResultObject[]>]
   [-ClearAdministrativeCategory]
   [-ClearSupportedPlatformName]
   [-Description <String>]
   [-DriverSource <String>]
   [-EnableAndAllowInstall <Boolean>]
   -InputObject <IResultObject>
   [-NewName <String>]
   [-PassThru]
   [-RemoveAdministrativeCategory <IResultObject[]>]
   [-RemoveBootImagePackage <IResultObject[]>]
   [-RemoveDriverPackage <IResultObject[]>]
   [-RemoveSupportedPlatformName <String[]>]
   [-RunOnAnyPlatform]
   [-SupportedPlatformName <String[]>]
   [-UpdateBootImageDistributionPoint <Boolean>]
   [-UpdateDriverDistributionPoint <Boolean>]
   [-DisableWildcardHandling]
   [-ForceWildcardHandling]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Set-CMDriver
   [-AddAdministrativeCategory <IResultObject[]>]
   [-AddBootImagePackage <IResultObject[]>]
   [-AddDriverPackage <IResultObject[]>]
   [-AddSupportedPlatformName <String[]>]
   [-AdministrativeCategory <IResultObject[]>]
   [-ClearAdministrativeCategory]
   [-ClearSupportedPlatformName]
   [-Description <String>]
   [-DriverSource <String>]
   [-EnableAndAllowInstall <Boolean>]
   -Id <String>
   [-NewName <String>]
   [-PassThru]
   [-RemoveAdministrativeCategory <IResultObject[]>]
   [-RemoveBootImagePackage <IResultObject[]>]
   [-RemoveDriverPackage <IResultObject[]>]
   [-RemoveSupportedPlatformName <String[]>]
   [-RunOnAnyPlatform]
   [-SupportedPlatformName <String[]>]
   [-UpdateBootImageDistributionPoint <Boolean>]
   [-UpdateDriverDistributionPoint <Boolean>]
   [-DisableWildcardHandling]
   [-ForceWildcardHandling]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Set-CMDriver
   [-AddAdministrativeCategory <IResultObject[]>]
   [-AddBootImagePackage <IResultObject[]>]
   [-AddDriverPackage <IResultObject[]>]
   [-AddSupportedPlatformName <String[]>]
   [-AdministrativeCategory <IResultObject[]>]
   [-ClearAdministrativeCategory]
   [-ClearSupportedPlatformName]
   [-Description <String>]
   [-DriverSource <String>]
   [-EnableAndAllowInstall <Boolean>]
   -Name <String>
   [-NewName <String>]
   [-PassThru]
   [-RemoveAdministrativeCategory <IResultObject[]>]
   [-RemoveBootImagePackage <IResultObject[]>]
   [-RemoveDriverPackage <IResultObject[]>]
   [-RemoveSupportedPlatformName <String[]>]
   [-RunOnAnyPlatform]
   [-SupportedPlatformName <String[]>]
   [-UpdateBootImageDistributionPoint <Boolean>]
   [-UpdateDriverDistributionPoint <Boolean>]
   [-DisableWildcardHandling]
   [-ForceWildcardHandling]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Description

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

Note

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

Examples

Example 1: Modify a driver

PS XYZ:\> $Driver = Get-CMDriver -Name "cdrom.sys"
PS XYZ:\> Set-CMDriver -InputObject $Driver -NewName "testDriver" -Description "Test configuration" -EnableAndAllowInstall $True -RunOnAnyPlatform $True

The first command gets a device driver named cdrom.sys by using the Get-CMDriver cmdlet. The command stores that object in the $Driver variable.

The second command renames the driver and adds a description. The command specifies values for the EnableAndAllowInstall and RunOnAnyPlatform parameters.

Example 2: Modify a driver by using the pipeline

PS XYZ:\> Get-CMDriver -Name "cdrom.sys" | Set-CMDriver -NewName testDriver -Description description -EnableAndAllowInstall $True -RunOnAnyPlatform $True

This command gets a driver named cdrom.sys, and then passes it to the current cmdlet by using the pipeline operator. The current cmdlet renames the driver and adds a description. The command specifies values for EnableAndAllowInstall and RunOnAnyPlatform.

Parameters

-AddAdministrativeCategory

Specifies an array of administrative category objects that this cmdlet adds to a driver. To obtain an administrative category object, use the Get-CMCategory cmdlet.

Type:	IResultObject[]
Aliases:	AddAdministrativeCategories
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-AddBootImagePackage

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.

Type:	IResultObject[]
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-AddDriverPackage

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.

Type:	IResultObject[]
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-AddSupportedPlatformName

{{ Fill AddSupportedPlatformName Description }}

Type:	String[]
Aliases:	AddSupportedPlatformNames
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-AdministrativeCategory

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.

Type:	IResultObject[]
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-ClearAdministrativeCategory

Indicates that this cmdlet removes all the administrative category objects from the driver.

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

-ClearSupportedPlatformName

{{ Fill ClearSupportedPlatformName Description }}

Type:	SwitchParameter
Aliases:	ClearSupportedPlatformNames
Position:	Named
Default value:	None
Required:	False
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
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Description

Specifies a description for the device driver.

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

-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

-DriverSource

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.

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

-EnableAndAllowInstall

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

Type:	Boolean
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

Specifies the ID of a device driver.

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

-InputObject

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

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

-Name

Specifies the name of a device driver.

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

-NewName

Specifies a new name for the device driver.

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

-PassThru

Returns an object that represents the driver. By default, this cmdlet does not generate any output.

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

-RemoveAdministrativeCategory

Specifies an array of administrative category objects that this cmdlet removes from a driver. To obtain an administrative category object, use Get-CMCategory.

Type:	IResultObject[]
Aliases:	RemoveAdministrativeCategories
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-RemoveBootImagePackage

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.

Type:	IResultObject[]
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-RemoveDriverPackage

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.

Type:	IResultObject[]
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-RemoveSupportedPlatformName

{{ Fill RemoveSupportedPlatformName Description }}

Type:	String[]
Aliases:	RemoveSupportedPlatformNames
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-RunOnAnyPlatform

Indicates that the device driver can run on all platforms.

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

-SupportedPlatformName

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

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

-UpdateBootImageDistributionPoint

Indicates whether Configuration Manager updates boot images on their distribution points to add the new drivers.

Type:	Boolean
Aliases:	UpdateDistributionPointsForBootImagePackage, UpdateBootImageDistributionPoints
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-UpdateDriverDistributionPoint

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

Type:	Boolean
Aliases:	UpdateDistributionPointsForDriverPackage, UpdateDriverDistributionPoints
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet doesn't run.

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

Inputs

Microsoft.ConfigurationManagement.ManagementProvider.IResultObject

Outputs

System.Object

Related Links

• Disable-CMDriver
• Enable-CMDriver
• Get-CMDriver
• Import-CMDriver
• Remove-CMDriver
• Get-CMCategory
• Get-CMBootImage
• Get-CMDriverPackage