COMMAND EVERYTHING.

Export-WdsBootImage

Exports an existing boot image from an image store.

PowerShell · Risk: High · Documentation Verified

Last verified: 2026-10-26

Microsoft WDS reference: Exports an existing boot image from an image store. The syntax and selected example below are adapted from the pinned Windows Server 2025 reference. Module availability, target configuration and delegated permissions determine whether it can run in your environment. Documentation and parameter text: Microsoft, CC BY 4.0; formatting adapted by Cmdlet World. No execution testing is claimed.

Export-WdsBootImage [-NewDescription <String>] -Destination <String> [-NewImageName <String>] [-Force]
 -ImageName <String> -Architecture <Architecture> [-FileName <String>] [-CimSession <CimSession[]>]
 [-ThrottleLimit <Int32>] [-AsJob] [<CommonParameters>]

Copied 0 times

Required permissions

Use an account with the target resource permissions documented for Export-WdsBootImage. Modifying administrative cmdlets may require elevation or delegated administration. This catalog does not assert that ordinary users can execute the command.

Supported environments

Windows / WDS · Windows Server 2025 documentation; feature/module prerequisites apply

Parameters

-Architecture (required): Specifies an architecture. This is the architecture of the boot image. Because you can use the same image name for boot images in different architectures, specify this parameter to make sure that you export the correct image. The acceptable values for this parameter are: - ARM - ia64 - x64 - x86
-AsJob: Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to complete. The cmdlet immediately returns an object that represents the job and then displays the command prompt. You can continue to work in the session while the job completes. To manage the job, use the *-Job cmdlets. To get the job results, use the Receive-Job cmdlet. For more information about Windows PowerShell® background jobs, see about_Jobs.
-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.
-Destination (required): Specifies the fully qualified path of the exported image. The path must available to the Windows Deployment Services server.
-FileName: 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 does not uniquely identify the image.
-Force: Indicates that the cmdlet overwrites an image file if the file is in the path that you specify.
-ImageName (required): Specifies the name of an image. This is the name of the image to export.
-NewDescription: Specifies a new description.
-NewImageName: Specifies a name for the image. If you do not specify this parameter, the cmdlet uses the name of the source image for the name of the exported image.
-ThrottleLimit: 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.

Prerequisites

Windows with the WDS module and the Windows feature or management tools that provide it. Confirm target connectivity and version compatibility using the linked Microsoft reference.

Security considerations

This cmdlet changes system state. Review every target and parameter in the official reference, test outside production, and prepare an appropriate backup or rollback. Do not execute the example automatically.

Examples

Example 1: Export a boot image

Export-WdsBootImage -Architecture x86 -Destination "D:\images\exported.wim" -ImageName "Fabrikam LOB setup (x86)" -NewDescription "Fabrikam LOB exported from server" -Force

This command exports the boot image named Fabrikam LOB setup (x86) for the x86 architecture. The command exports the image to the file that is named exported.wim. The command specifies a description for the exported image. The *Force* parameter specifies that the cmdlet overwrites a file that has the same name without prompting you for confirmation. Source: Microsoft, CC BY 4.0; transcript prompt/output removed. This example was not executed.

Sources

https://github.com/MicrosoftDocs/windows-powershell-docs/blob/b7645dd8c687139b28e845119da30ec670526507/docset/winserver2025-ps/WDS/Export-WdsBootImage.md

https://learn.microsoft.com/powershell/module/wds/export-wdsbootimage?view=windowsserver2025-ps

Personal collections

Explain or customize this command with AI

Related commands