Export (0) Print
Expand All
This topic has not yet been rated - Rate this topic

Export-WdsBootImage

Windows Server 2012 R2 and Windows 8.1

Updated: October 17, 2013

Applies To: Windows 8.1, Windows PowerShell 4.0, Windows Server 2012 R2

Export-WdsBootImage

Exports an existing boot image from an image store.

Syntax

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




Detailed Description

The Export-WdsBootImage cmdlet exports a boot image from the Windows Deployment Services image store to a Windows image file (.wim). You can use the Force parameter to overwrite the image file if you export an image to a file that already exists.

Specify the boot image by using the ImageName and Architecture parameters. If the image name and architecture do not uniquely identify the image, also specify the FileName parameter.

Parameters

-Architecture<Architecture>

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 this parameter to ensure that you export the correct image. 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

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.


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

-Destination<String>

Specifies the fully qualified path of the exported image. The path must accessible to the Windows Deployment Services server.


Aliases

none

Required?

true

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 does not uniquely identify the image.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-Force

Indicates that the cmdlet overwrites an image file if the file exists in the path that you specify.


Aliases

none

Required?

false

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 image to export.


Aliases

none

Required?

true

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-NewDescription<String>

Specifies a new description.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-NewImageName<String>

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.


Aliases

none

Required?

false

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.

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_WdsBootImage

Examples

Example 1: Export a boot image

This command exports the boot image named Fabrikam LOB setup (x86) for the x86 architecture. The command exports the image to the file 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.


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

Related topics

Did you find this helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft. All rights reserved.