Export (0) Print
Expand All

Export-WdsInstallImage

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-WdsInstallImage

Exports an existing install image from an image store.

Syntax

Parameter Set: InstallImageName
Export-WdsInstallImage -Destination <String> -ImageName <String> [-Append] [-AsJob] [-CimSession <CimSession[]> ] [-FileName <String> ] [-Force] [-ImageGroup <String> ] [-NewDescription <String> ] [-NewImageName <String> ] [-ThrottleLimit <Int32> ] [ <CommonParameters>]




Detailed Description

The Export-WdsInstallImage cmdlet exports an existing install image from an image store to a file. If an image file already exists in that location, you may overwrite it, append the new image to a file, or leave it in place. Specify the install image with the image name and image group name. You must specify the file name if the image name and image group name do not uniquely identify the install image.

Parameters

-Append

Indicates that the cmdlet appends an image to an existing image file. The cmdlet creates a new file with the image if there is no existing image file.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

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 a fully-qualified path that is accessible to the Windows Deployment Service 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 install image. Specifies the file name of the install image. Use this parameter to specify the file name for the install image if the install 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

Forces the command to run without asking for user confirmation.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-ImageGroup<String>

Specifies the name of an image group. This image group contains the image to export. If you do not specify an image group, and only one image group exists on the server, the cmdlet uses that image group by default. If more than one image group exists on the server, you must specify the image group


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

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 for the install image to create in the export operation


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-NewImageName<String>

Specifies a new name for the image file to create in the export operation. If you do not specify a name, the cmdlet uses the display name of the source 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_WdsInstallImage

Examples

Example 1: Export an image

This command exports an image and appends the image to an existing file, if it exists.


PS C:\> Export-WdsInstallImage -Append -Destination D:\images\exported.wim -ImageName "Windows Latest with LOB apps" -FileName install-3.wim -ImageGroup "Fabrikam Latest Images" -NewImageName "Fabrikam Latest" 

Related topics

Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft