Get-Wds Boot Image

Module:
wds
Gets properties of boot images from the image store.

Syntax 

Get-WdsBootImage
   [-Architecture <Architecture>]
   [-FileName <String>]
   [-ImageName <String>]
   [-CimSession <CimSession[]>]
   [-ThrottleLimit <Int32>]
   [-AsJob]
   [<CommonParameters>]

Description

The Get-WdsBootImage cmdlet gets properties of boot images in the Windows Deployment Services image store. Get a boot image by specifying the Architecture , FileName , and ImageName parameters. If the image name and architecture do not uniquely identify the image, also specify the Filename parameter. If no parameter is specified, the cmdlet gets all boot images. If the image name and architecture do not uniquely identify a single image, the command returns all images that meet the criteria.

Examples

Example 1: Get properties of a boot image 

PS C:\> Get-WdsBootImage -Architecture x86 -ImageName "Fabrikam LOB setup (x86)"

This command gets properties of the boot image named Fabrikam LOB setup (x86) for the x86 architecture.

Optional Parameters

-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 make sure that that you return the correct image. The acceptable values for this parameter are:

  • ARM
  • ia64
  • x64
  • x86
Type: Architecture
Parameter Sets: X86, Ia64, X64, Arm
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 .

Type: SwitchParameter
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-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.

Type: CimSession[]
Aliases: Session
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-FileName

Specifies a file name. This is the file name of the boot image.

Type: String
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
-ImageName

Specifies the name of an image. This is the name of the image to get.

Type: String
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
-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.

Type: Int32
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

Outputs

Microsoft.Management.Infrastructure.CimInstance#MSFT_WdsBootImage