Edit

Share via

Set-CMDriver

Module:
ConfigurationManager Module

Changes the settings of a device driver.

Syntax

SetDriverByResultObject (Default) 

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

SetDriverById 

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

SetDriverByName 

Set-CMDriver
    -Name <String>
    [-AddAdministrativeCategory <IResultObject[]>]
    [-AddBootImagePackage <IResultObject[]>]
    [-AddDriverPackage <IResultObject[]>]
    [-AddSupportedPlatformName <String[]>]
    [-AdministrativeCategory <IResultObject[]>]
    [-ClearAdministrativeCategory]
    [-ClearSupportedPlatformName]
    [-Description <String>]
    [-DriverSource <String>]
    [-EnableAndAllowInstall <Boolean>]
    [-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.

Parameter properties

Type:

IResultObject[]

Default value:None
Supports wildcards:False
DontShow:False
Aliases:AddAdministrativeCategories

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments: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.

Parameter properties

Type:

IResultObject[]

Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments: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.

Parameter properties

Type:

IResultObject[]

Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-AddSupportedPlatformName

{{ Fill AddSupportedPlatformName Description }}

Parameter properties

Type:

String[]

Default value:None
Supports wildcards:False
DontShow:False
Aliases:AddSupportedPlatformNames

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments: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.

Parameter properties

Type:

IResultObject[]

Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-ClearAdministrativeCategory

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

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False
Aliases:ClearAdministrativeCategories

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-ClearSupportedPlatformName

{{ Fill ClearSupportedPlatformName Description }}

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False
Aliases:ClearSupportedPlatformNames

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Confirm

Prompts you for confirmation before running the cmdlet.

Parameter properties

Type:SwitchParameter
Default value:False
Supports wildcards:False
DontShow:False
Aliases:cf

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Description

Specifies a description for the device driver.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-DisableWildcardHandling

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

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments: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.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-EnableAndAllowInstall

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

Parameter properties

Type:Boolean
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-ForceWildcardHandling

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

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Id

Specifies the ID of a device driver.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

SetDriverById
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-InputObject

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

Parameter properties

Type:IResultObject
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

SetDriverByResultObject
Position:Named
Mandatory:True
Value from pipeline:True
Value from pipeline by property name:False
Value from remaining arguments:False

-Name

Specifies the name of a device driver.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

SetDriverByName
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-NewName

Specifies a new name for the device driver.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-PassThru

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

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments: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.

Parameter properties

Type:

IResultObject[]

Default value:None
Supports wildcards:False
DontShow:False
Aliases:RemoveAdministrativeCategories

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments: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.

Parameter properties

Type:

IResultObject[]

Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments: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.

Parameter properties

Type:

IResultObject[]

Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-RemoveSupportedPlatformName

{{ Fill RemoveSupportedPlatformName Description }}

Parameter properties

Type:

String[]

Default value:None
Supports wildcards:False
DontShow:False
Aliases:RemoveSupportedPlatformNames

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-RunOnAnyPlatform

Indicates that the device driver can run on all platforms.

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-SupportedPlatformName

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

Parameter properties

Type:

String[]

Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-UpdateBootImageDistributionPoint

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

Parameter properties

Type:Boolean
Default value:None
Supports wildcards:False
DontShow:False
Aliases:UpdateDistributionPointsForBootImagePackage, UpdateBootImageDistributionPoints

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-UpdateDriverDistributionPoint

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

Parameter properties

Type:Boolean
Default value:None
Supports wildcards:False
DontShow:False
Aliases:UpdateDistributionPointsForDriverPackage, UpdateDriverDistributionPoints

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-WhatIf

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

Parameter properties

Type:SwitchParameter
Default value:False
Supports wildcards:False
DontShow:False
Aliases:wi

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

Inputs

Microsoft.ConfigurationManagement.ManagementProvider.IResultObject

Outputs

System.Object