Add-WdsDriverPackage

Add-WdsDriverPackage

Adds an existing driver package to a driver group or injects it into a boot image.

Syntax

Parameter Set: IdIntoBootImageProperties
Add-WdsDriverPackage -Architecture <Architecture> -Id <Guid> -ImageName <String> [-AsJob] [-CimSession <CimSession[]> ] [-FileName <String> ] [-ThrottleLimit <Int32> ] [ <CommonParameters>]

Parameter Set: IdIntoDriverGroupName
Add-WdsDriverPackage -GroupName <String> -Id <Guid> [-AsJob] [-CimSession <CimSession[]> ] [-ThrottleLimit <Int32> ] [ <CommonParameters>]

Parameter Set: NameIntoBootImageProperties
Add-WdsDriverPackage -Architecture <Architecture> -ImageName <String> -Name <String> [-AsJob] [-CimSession <CimSession[]> ] [-FileName <String> ] [-ThrottleLimit <Int32> ] [ <CommonParameters>]

Parameter Set: NameIntoDriverGroupName
Add-WdsDriverPackage -GroupName <String> -Name <String> [-AsJob] [-CimSession <CimSession[]> ] [-ThrottleLimit <Int32> ] [ <CommonParameters>]

Detailed Description

The Add-WdsDriverPackage cmdlet adds an existing driver package to a driver group or injects a driver package into a boot image. Use the Import-WdsDriverPackage cmdlet to import driver packages into the Windows Deployment Services driver store. Specify a driver package by its unique name or ID.

To add a driver package to a driver group, specify the group name. Use the Remove-WdsDriverPackage to remove a drive package from a group.

To inject a driver package into a boot image, specify the image name and architecture. If the image name and architecture do not uniquely identify the boot image, specify the boot image file. After you inject a driver package into a boot image, Windows Deployment Services cannot remove the driver package.

Parameters

-Architecture<Architecture>

Specifies an architecture. This is the architecture of the image. In order to inject a driver into a boot image, you must specify an architecture. The acceptable values for this parameter are:

-- Arm
-- Ia64
-- X64
-- X86

Aliases

none

Required?

true

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-AsJob

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-CimSession<CimSession[]>

Runs the cmdlet in a remote session or on a remote computer. Enter a computer name or a session object, such as the output of a New-CimSession or Get-CimSession cmdlet. The default is the current session on the local computer.

Aliases

Session

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-FileName<String>

Specifies a file name. This is the file name of the boot image. Use this parameter to specify the file name for the boot image if the boot image name and architecture do not uniquely identify the image.

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-GroupName<String>

Specifies the name of a driver group. The cmdlet adds the driver package to this group.

Aliases

none

Required?

true

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-Id<Guid>

Specifies an ID. This is the ID of the driver package to add.

Aliases

none

Required?

true

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-ImageName<String>

Specifies the name of an image. This is the name of the boot image. If this name is not unique, specify the file name of the boot image by using the FileName parameter.

Aliases

none

Required?

true

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-Name<String>

Specifies a name. This is the unique name of the driver package. If this name is not unique, specify the driver package ID, instead, by using the Id parameter.

Aliases

none

Required?

true

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-ThrottleLimit<Int32>

Specifies the maximum number of concurrent operations that can be established to run the cmdlet. If this parameter is omitted or a value of 0 is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. The throttle limit applies only to the current cmdlet, not to the session or to the computer.

Aliases

none

Required?

false

Position?

named

Default Value

none

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.

  • Microsoft.Management.Infrastructure.CimInstance#MSFT_WdsDriverPackage

Examples

Example 1: Add a driver package to a group by using the package ID

This command adds a driver package to the group named Drivers for Frabrikam Devices. The command specifies the ID of the driver package.

PS C:\> Add-WdsDriverPackage -Id 32d78628-07fb-4e18-adc4-f0ecf8b41bbe -GroupName "Drivers for Fabrikam Devices"

Example 2: Add a driver package to a group by using the package name

This command adds a driver package to the group named Drivers for Frabrikam Devices. The command specifies Fabrikam Device Driver (x64) as the name of the driver package.

PS C:\> Add-WdsDriverPackage -GroupName "Drivers for Fabrikam Devices" -Name "Fabrikam Device Driver (x64)"

Example 3: Inject a driver package into a boot image by using the package ID

This command injects the driver package into the boot image named Contoso general setup (x64). The command specifies the ID of the driver package.

PS C:\> Add-WdsDriverPackage -Architecture X64 -Id 32d78628-07fb-4e18-adc4-f0ecf8b41bbe -ImageName "Contoso general setup (x64)"

Example 4: Inject a driver package into a boot image by using the package name

This command injects the driver package into the boot image named Contoso general setup (x64). The command specifies Fabrikam Device Driver (x64) as the name of the driver package.

PS C:\> Add-WdsDriverPackage -Architecture X64 -ImageName "Contoso general setup (x64)" -Name "Fabrikam Device Driver (x64)"

Disable-WdsDriverPackage

Enable-WdsDriverPackage

Get-WdsDriverPackage

Import-WdsDriverPackage

Remove-WdsDriverPackage