Export (0) Print
Expand All

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

Import-WdsInstallImage

Imports an install image to an image store.

Syntax

Parameter Set: SingleImage
Import-WdsInstallImage -Path <String> [-AsJob] [-CimSession <CimSession[]> ] [-DisplayOrder <UInt32> ] [-ImageGroup <String> ] [-ImageName <String> ] [-NewDescription <String> ] [-NewFileName <String> ] [-NewImageName <String> ] [-SkipVerify] [-ThrottleLimit <Int32> ] [-UnattendFile <String> ] [ <CommonParameters>]

Parameter Set: SingleImageAutoStart
Import-WdsInstallImage -Multicast -Path <String> [-AsJob] [-CimSession <CimSession[]> ] [-ClientCount <UInt32> ] [-DisplayOrder <UInt32> ] [-ImageGroup <String> ] [-ImageName <String> ] [-NewDescription <String> ] [-NewFileName <String> ] [-NewImageName <String> ] [-SkipVerify] [-StartTime <DateTime> ] [-ThrottleLimit <Int32> ] [-TransmissionName <String> ] [-UnattendFile <String> ] [ <CommonParameters>]

Parameter Set: SingleImageManualStart
Import-WdsInstallImage -ManualStart -Multicast -Path <String> [-AsJob] [-CimSession <CimSession[]> ] [-DisplayOrder <UInt32> ] [-ImageGroup <String> ] [-ImageName <String> ] [-NewDescription <String> ] [-NewFileName <String> ] [-NewImageName <String> ] [-SkipVerify] [-ThrottleLimit <Int32> ] [-TransmissionName <String> ] [-UnattendFile <String> ] [ <CommonParameters>]




Detailed Description

The Import-WdsInstallImage cmdlet imports an install image to an image store. You can import a single image from a WIM file, all images from a WIM file, or a VHD image. If you add a single image, you can also specify a new name, description, and file name for the image.

When you work with multicast transmissions that use a single install image as content you can do any of the following:

-- Create and name an AutoCast transmission.
-- Create and name a ScheduledCast transmission which begins when a preset number of clients are ready to start, at a specific time, or both.
-- Create a manually started ScheduledCast transmission.

An AutoCast transmission is a multicast transmission. When a client requests an install image, the multicast transmission begins. Clients that request the same image are joined to the multicast transmission.

A ScheduledCast transmission is a multicast transmission. When a specified number of clients request an image, or a specified time of day is reached, the multicast transmission begins. If you do not specify either of these conditions, you must manually start the transmission.

If you add multiple images, they will be added to the same image group. You can associate an answer file for unattended install with the images that you import. Specify the image to import by using the full path to the image file.

Parameters

-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

-ClientCount<UInt32>

Specifies the number of clients that must connect to a transmission. If you also specify MulticastTransmission, this parameter specifies the number of clients that must connect to the ScheduledCast transmission in order for it to begin. The StartScheduledCast parameter can start a transmission before reaching the client count. If you specify the ClientCount parameter with the StartTime parameter, the transmission begins when either a sufficient number of clients connect, or at the time specified by the StartTime parameter.

You may not use this parameter together with the ManualStart parameter.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-DisplayOrder<UInt32>

Specifies the order in which images appear in the boot menu on Pre-Boot Execution Environment (PXE) clients. The menu lists the boot images in ascending order, smallest number to largest number.


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 import. 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?

false

Accept Wildcard Characters?

false

-ImageName<String>

Specifies the name of an image. This is the name of the image to import. This parameter does not support VHD images.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-ManualStart

Indicates that the transmission uses a manual start. If you also specify the MulticastTransmission parameter, the cmdlet creates a ScheduledCast transmission that does not begin until a StartScheduledCast command is given.


Aliases

none

Required?

true

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-Multicast

Indicates that the cmdlet enables an AutoCast transmission on the image. If you do not specify a name by using the TransmissionName parameter, the multicast transmission uses the image name.


Aliases

none

Required?

true

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-NewDescription<String>

Specifies a new description for the install image to create in the import operation.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-NewFileName<String>

Specifies a new file name for the install image to create in the import operation. If you do not specify a name, the cmdlet uses the display name of the source image. The file name must be unique. If you add more than one image, a number is appended to the file name.


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 import operation.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-Path<String>

Specifies a fully-qualified path that is accessible to the Windows Deployment Services server.


Aliases

none

Required?

true

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByValue)

Accept Wildcard Characters?

false

-SkipVerify

Indicates that Windows Deployment Services does not verify the source image file before adding it to the image store.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-StartTime<DateTime>

Specifies a day and time, in MM/DD/YYYY.hh:mm:ss format, that denotes the start time. When you specify the MulticastTransmission parameter, this parameter denotes the time the ScheduledCast transmission begins. The StartScheduledCast command can start a transmission before reaching the client count. If you specify both the StartTime parameter and the ClientCount parameter, the transmission begins when either a sufficient number of clients connect, or the time specified in this parameter is reached. Do not specify this parameter together with the ManualStart parameter.


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

-TransmissionName<String>

Specifies a name for the multicast transmission.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-UnattendFile<String>

Specifies the full path to the answer file associated with the image.


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: Import an image

This command imports an install image and skips the verification of the image.


PS C:\> Import-WdsInstallImage -Path "D:\images\install.wim" -ImageGroup "Fabrikam Latest Images" -SkipVerify

Example 2: Import an install image by using an unattend file

This command imports an install image by using an answer file named FabrikamLatestwLOB.xml.


PS C:\> Import-WdsInstallImage -Path "D:\images\install.wim" -ImageName "Fabrikam Latest with LOB apps" -ImageGroup "Fabrikam Latest Images" -DisplayOrder 0 -NewImageName "Fabrikam Latest with LOB v2.0 apps" -UnattendFile "D:\images\unattend\FabrikamLatestwLOB.xml"

Example 3: Import an install image and create a multicast transmission

This command imports an install image and creates a multicast transmission.


PS C:\> Import-WdsInstallImage -Path "D:\images\install.wim" -ImageName "Fabrikam Latest with LOB apps" -ImageGroup "Fabrikam Latest Images" -Multicast -TransmissionName "Fabrikam Latest AutoCast"

Example 4: Import an install image and create a multicast transmission with a start time

This command imports an install image and create a multicast transmission with an automatic start time.


PS C:\> Import-WdsInstallImage -Path "D:\images\install.wim" -ImageName "Fabrikam Latest with LOB apps" -ImageGroup "Fabrikam Latest Images" -Multicast -ClientCount 50 -StartTime 2014/12/01:11:00 -TransmissionName "Fabrikam Latest ScheduledCast with automatic start"

Example 5: Import an install image and create a multicast transmission with manual start

This command imports an install image and creates a multicast transmission with a manual start.


PS C:\> Import-WdsInstallImage -Path "D:\images\install.wim" -ImageName "Fabrikam Latest with LOB apps" -ImageGroup "Fabrikam Latest Images" -Multicast -ManualStart -TransmissionName "Fabrikam Latest ScheduledCast with manual start"

Related topics

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