Share via


Windows Deployment Services Cmdlets in Windows PowerShell

Windows PowerShell® is a task-based command-line shell and scripting language designed especially for system administration. This reference topic for the information technology (IT) professional provides assistance in utilizing the Windows PowerShell cmdlets to script and automate tasks.

Windows Deployment Services Cmdlets

This reference provides cmdlet descriptions and syntax for all Windows Deployment Services cmdlets. It lists the cmdlets in alphabetical order based on the verb at the beginning of the cmdlet.

Cmdlet Description

Add-WdsDriverPackage

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

Approve-WdsClient

Approves clients.

Copy-WdsInstallImage

Copies install images within an image group.

Deny-WdsClient

Denies approval for clients.

Disable-WdsBootImage

Disables a boot image.

Disable-WdsDriverPackage

Disables a driver package in the Windows Deployment Services driver store.

Disable-WdsInstallImage

Disables an install image.

Disconnect-WdsMulticastClient

Disconnects a multicast client from a transmission or namespace.

Enable-WdsBootImage

Enables a boot image.

Enable-WdsDriverPackage

Enables a driver package in the Windows Deployment Services driver store.

Enable-WdsInstallImage

Enables an install image.

Export-WdsBootImage

Exports an existing boot image from an image store.

Export-WdsInstallImage

Exports an existing install image from an image store.

Get-WdsBootImage

Gets properties of boot images from the image store.

Get-WdsClient

Gets client devices from the pending device database, or pre-staged devices from Active Directory or the standalone server device database.

Get-WdsDriverPackage

Gets properties of driver packages from the Windows Deployment Services driver store.

Get-WdsInstallImage

Gets properties of install images from an image store.

Get-WdsInstallImageGroup

Gets properties of install image groups.

Get-WdsMulticastClient

Gets a list of clients connected to a multicast transmission or namespace.

Import-WdsBootImage

Imports a boot image to the image store.

Import-WdsDriverPackage

Imports a driver package into the Windows Deployment Services driver store.

Import-WdsInstallImage

Imports an install image to an image store.

New-WdsClient

Creates a pre-staged client.

New-WdsInstallImageGroup

Creates an install image group.

Remove-WdsBootImage

Removes a boot image from the image store.

Remove-WdsClient

Removes a pre-staged client from AD DS or the stand-alone server device database, or clears the Pending Devices database.

Remove-WdsDriverPackage

Removes a driver package from a driver group or removes it from all driver groups and deletes it.

Remove-WdsInstallImage

Removes an install image from an image store.

Remove-WdsInstallImageGroup

Removes an install image group.

Set-WdsBootImage

Modifies settings of a boot image.

Set-WdsClient

Modifies a pre-staged client device.

Set-WdsInstallImage

Modifies the properties of an install image.

Set-WdsInstallImageGroup

Modifies the name and access permissions of an install image group.

Note

To list all the cmdlets that are available, use the Get-Command –Module WindowsDeploymentServices cmdlet.

For more information about, or for the syntax of, any of the cmdlets, use the Get-Help <cmdlet name> cmdlet, where <cmdlet name> is the name of the cmdlet that you want to research. For more detailed information, you can run any of the following cmdlets:

Get-Help <cmdlet name> -Detailed
Get-Help <cmdlet name> -Examples
Get-Help <cmdlet name> -Full