Get-WdsBootImage

Get-WdsBootImage

Gets properties of boot images from the image store.

Syntax

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

Detailed 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, it will get all boot images. If the image name and architecture do not uniquely identify a single image, the command will return all images that meet the criteria.

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

     -- ARM
     -- ia64
     -- x64
     -- x86

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-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

-FileName<String>

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

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 get.

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

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 (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: Get properties of a boot image

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

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

Set-WdsBootImage

Enable-WdsBootImage

Disable-WdsBootImage

Remove-WdsBootImage

Import-WdsBootImage

Export-WdsBootImage