Edit

Share via

Set-CMDriverPackage

Module:
ConfigurationManager Module

Modify a driver package.

Syntax

SetByValueMandatory (Default) 

Set-CMDriverPackage
    -InputObject <IResultObject>
    [-CopyToPackageShareOnDistributionPoint <Boolean>]
    [-CustomPackageShareName <String>]
    [-Description <String>]
    [-DisconnectUserFromDistributionPoint <Boolean>]
    [-DisconnectUserFromDistributionPointMins <UInt32>]
    [-DisconnectUserFromDistributionPointRetryCount <UInt32>]
    [-DistributionPointUpdateSchedule <IResultObject>]
    [-DriverManufacturer <String>]
    [-DriverModel <String>]
    [-DriverPackageSource <String>]
    [-MulticastAllow <Boolean>]
    [-MulticastEncrypt <Boolean>]
    [-MulticastTransferOnly <Boolean>]
    [-NewName <String>]
    [-PassThru]
    [-PrestageBehavior <PrestageBehavior>]
    [-Priority <Priority>]
    [-SendToPreferredDistributionPoint <Boolean>]
    [-Version <String>]
    [-DisableWildcardHandling]
    [-ForceWildcardHandling]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

SetById 

Set-CMDriverPackage
    -Id <String>
    [-CopyToPackageShareOnDistributionPoint <Boolean>]
    [-CustomPackageShareName <String>]
    [-Description <String>]
    [-DisconnectUserFromDistributionPoint <Boolean>]
    [-DisconnectUserFromDistributionPointMins <UInt32>]
    [-DisconnectUserFromDistributionPointRetryCount <UInt32>]
    [-DistributionPointUpdateSchedule <IResultObject>]
    [-DriverManufacturer <String>]
    [-DriverModel <String>]
    [-DriverPackageSource <String>]
    [-MulticastAllow <Boolean>]
    [-MulticastEncrypt <Boolean>]
    [-MulticastTransferOnly <Boolean>]
    [-NewName <String>]
    [-PassThru]
    [-PrestageBehavior <PrestageBehavior>]
    [-Priority <Priority>]
    [-SendToPreferredDistributionPoint <Boolean>]
    [-Version <String>]
    [-DisableWildcardHandling]
    [-ForceWildcardHandling]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

SetByName 

Set-CMDriverPackage
    -Name <String>
    [-CopyToPackageShareOnDistributionPoint <Boolean>]
    [-CustomPackageShareName <String>]
    [-Description <String>]
    [-DisconnectUserFromDistributionPoint <Boolean>]
    [-DisconnectUserFromDistributionPointMins <UInt32>]
    [-DisconnectUserFromDistributionPointRetryCount <UInt32>]
    [-DistributionPointUpdateSchedule <IResultObject>]
    [-DriverManufacturer <String>]
    [-DriverModel <String>]
    [-DriverPackageSource <String>]
    [-MulticastAllow <Boolean>]
    [-MulticastEncrypt <Boolean>]
    [-MulticastTransferOnly <Boolean>]
    [-NewName <String>]
    [-PassThru]
    [-PrestageBehavior <PrestageBehavior>]
    [-Priority <Priority>]
    [-SendToPreferredDistributionPoint <Boolean>]
    [-Version <String>]
    [-DisableWildcardHandling]
    [-ForceWildcardHandling]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Description

Use this cmdlet to modify a driver package.

For more information, see Manage drivers in Configuration Manager.

Note

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

Examples

Example 1: Configure the manufacturer and model of a driver package

This command configures the manufacturer and model of the driver package with the ID XYZ00091.

Set-CMDriverPackage -PackageId "XYZ00091" -DriverManufacturer "Microsoft" -DriverModel "Surface 2"

Parameters

-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

-CopyToPackageShareOnDistributionPoint

Clients can always download a driver package from a distribution point. If you set this parameter to $true, the site makes it available via a named network share on distribution points. Use CustomPackageShareName to specify a custom share name.

When you enable this option, more space is required on distribution points. It applies to all distribution points to which you distribute this driver package.

Parameter properties

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

Parameter sets

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

-CustomPackageShareName

If you enable CopyToPackageShareOnDistributionPoint, you can use this parameter to customize the share name. The maximum length is 127 characters, and can't include any of the following characters: " / [ ] : | < > + = ; , ? *. You can specify a share name and a folder name, but then the maximum for each is 80 characters. For example, ShareName\FolderName.

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

-Description

Specify an optional description of a driver package to help you identify it.

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

-DisconnectUserFromDistributionPoint

This option is deprecated. It sets the ForcedDisconnectEnabled property of the driver package.

Parameter properties

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

Parameter sets

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

-DisconnectUserFromDistributionPointMins

This option is deprecated. It sets the ForcedDisconnectDelay property of the driver package.

Parameter properties

Type:UInt32
Default value:None
Supports wildcards:False
DontShow:False
Aliases:DisconnectUsersFromDistributionPointsMinutes

Parameter sets

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

-DisconnectUserFromDistributionPointRetryCount

This option is deprecated. It sets the ForcedDisconnectNumRetries property of the driver package.

Parameter properties

Type:UInt32
Default value:None
Supports wildcards:False
DontShow:False
Aliases:DisconnectUsersFromDistributionPointsRetries

Parameter sets

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

-DistributionPointUpdateSchedule

Use this parameter to update distribution points on a schedule. To get a schedule object, use the New-CMSchedule 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

-DriverManufacturer

Use this parameter to set the manufacturer of the device. The maximum length is 100 characters.

Use it with the DriverModel parameter. You can use them for managing the driver catalog, and with task sequence pre-caching. For more information, see Configure pre-cache content for task sequences.

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

-DriverModel

Use this parameter to set the model of the device. The maximum length is 100 characters.

Use it with the DriverManufacturer parameter. You can use them for managing the driver catalog, and with task sequence pre-caching. For more information, see Configure pre-cache content for task sequences.

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

-DriverPackageSource

Specify a file path to the network location to source the driver files.

When you create a driver package, the source location of the package must point to an empty network share that's not used by another driver package. The SMS Provider must have Full control permissions to that location.

When you add device drivers to a driver package, Configuration Manager copies it to this path. You can add to a driver package only device drivers that you've imported and that are enabled in the driver catalog.

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

-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

Specify the ID of a driver package to configure. This value is a standard package ID, for example: XYZ00020.

Parameter properties

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

Parameter sets

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

-InputObject

Specify a driver package object to configure. To get this object, use the Get-CMDriverPackage cmdlet.

Parameter properties

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

Parameter sets

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

-MulticastAllow

Set this parameter to $true to allow this package to be transferred via multicast. For more information, see Use multicast to deploy Windows over the network with Configuration Manager.

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

-MulticastEncrypt

If you enable MulticastAllow, set this parameter to $true to encrypt multicast packages.

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

-MulticastTransferOnly

If you enable MulticastAllow, set this parameter to $true to only transfer this driver package via multicast.

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

-Name

Specify the name of a driver package to configure.

Parameter properties

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

Parameter sets

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

-NewName

Specify a new name for the 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

-PassThru

Add this parameter to return an object that represents the item with which you're working. By default, this cmdlet may 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

-PrestageBehavior

Specify the behavior when you enable a distribution point for prestaged content:

  • ManualCopy: Manually copy the content in this package to the distribution point
  • DownloadDelta: Download only content changes to the distribution point
  • OnDemand: Automatically download content when packages are assigned to distribution points

For more information, see Use prestaged content.

Parameter properties

Type:PrestageBehavior
Default value:None
Accepted values:ManualCopy, DownloadDelta, OnDemand
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

-Priority

Specify the order in which the site sends the content to other sites and the distribution points in this site.

The site sends high priority content before packages with medium or low priority. Packages with equal priority are sent in the order in which they're created.

Parameter properties

Type:Priority
Default value:None
Accepted values:High, Medium, Low
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

-SendToPreferredDistributionPoint

If you want to enable on-demand content distribution to preferred distribution points, set this parameter to $true. When you enable this setting, if a client requests the content for the package and the content isn't available on any distribution points, then the management point distributes the content. For more information, see On-demand content distribution.

Parameter properties

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

Parameter sets

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

-Version

Specify the version of the driver package. This value is a string that you manage.

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

-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