Import-WdsBootImage

Article
06/30/2015

Import-WdsBootImage

Imports a boot image to the image store.

Syntax

Parameter Set: AutoStart
Import-WdsBootImage -Multicast -Path <String> [-AsJob] [-CimSession <CimSession[]> ] [-DisplayOrder <UInt32> ] [-NewDescription <String> ] [-NewFileName <String> ] [-NewImageName <String> ] [-SkipVerify] [-ThrottleLimit <Int32> ] [-TransmissionName <String> ] [ <CommonParameters>]

Parameter Set: ImageFile
Import-WdsBootImage -Path <String> [-AsJob] [-CimSession <CimSession[]> ] [-DisplayOrder <UInt32> ] [-NewDescription <String> ] [-NewFileName <String> ] [-NewImageName <String> ] [-SkipVerify] [-ThrottleLimit <Int32> ] [ <CommonParameters>]

Detailed Description

The Import-WdsBootImage cmdlet imports a boot image from a Windows image file (.wim) to the Windows Deployment Services image store. You can assign the name, description, and file name of the image that you import. You can also enable a multicast transmission for the image.

Parameters

-AsJob

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

-DisplayOrder<UInt32>

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

If two boot images have the same display order, the imported images appear in alphabetical order of file name. If you do not specify this parameter, the imported images appear in the middle of the list.

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-Multicast

Indicates that the cmdlet enables an autocast transmission of the image. If you do not specify the TransmissionName parameter, Windows Deployment Services uses the image name of the imported image for the multicast.

Aliases	none
Required?	true
Position?	named
Default Value	none
Accept Pipeline Input?	false
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

-NewFileName<String>

Specifies a new file name for the image file. Windows Deployment Services verifies that the source image file is unique before adding it to the image store.

If you do not specify this parameter, Windows Deployment Services uses the file name of the source image file for the imported image file.

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.

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-Path<String>

Specifies the fully qualified path of the file that contains the boot image. The path must 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

-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. If you do not specify this parameter, Windows Deployment Services uses the image name of the imported image for the multicast.

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 (https://go.microsoft.com/fwlink/p/?LinkID=113216).

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: Import a boot image

This command imports a boot image named boot.wim. The command specifies a new image name, description, and file name for the imported image. The command specifies that Windows Deployment Services does not verify the source image file before adding it to the image store.

PS C:\> Import-WdsBootImage -Path "E:\sources\boot.wim" -NewImageName "Fabrikam LOB setup (x86)" -NewDescription "Choose this image to install Fabrikam LOB on computers with x86 processors." -NewFileName "Fabrikamx86boot.wim" -SkipVerify

Example 2: Import a boot image and enable multicast

This command imports a boot image named winpe.wim. The command specifies the order in which boot images appear in the menu on PXE clients. The command enables a multicast transmission of the image and specifies the name for the multicast transmission.

PS C:\> Import-WdsBootImage -Path "D:\Images\BootImages\winpe.wim" -DisplayOrder 3 -Multicast -TransmissionName "Custom LOB multicast"

Import-WdsBootImage