Table of contents
TLS
TOC
Collapse the table of content
Expand the table of content

Get-WdsInstallImage

Last Updated: 3/8/2017

SYNOPSIS

Gets properties of install images from an image store.

SYNTAX

Get-WdsInstallImage [-FileName <String>] [-ImageGroup <String>] [-ImageName <String>]
 [-CimSession <CimSession[]>] [-ThrottleLimit <Int32>] [-AsJob] [<CommonParameters>]

DESCRIPTION

The Get-WdsInstallImage cmdlet gets the properties of install images in a Windows Deployment Services image store. Specify the install image by using the image name and image group name. If no parameter is specified, this cmdlet gets the properties of all install images. If the image name and architecture do not uniquely identify an image, the command returns all images that meet the criteria.

EXAMPLES

Example 1: Retrieve images

PS C:\> Get-WdsInstallImage -InstallImageName "Fabrikam Latest with LOB apps" -ImageGroup "Fabrikam Latest Images" -FileName "install-3.wim"

This command retrieves install images named Fabrikam Latest with LOB apps.

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.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: 

Required: False
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[]
Parameter Sets: (All)
Aliases: Session

Required: False
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 install image.

Type: String
Parameter Sets: (All)
Aliases: 

Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-ImageGroup

Specifies the name of an image group. This image group contains the image to retrieve. If you do not specify an image group, the cmdlet returns images from all image groups.

Type: String
Parameter Sets: (All)
Aliases: 

Required: False
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 retrieve. If you do not specify an image name, the cmdlet returns images from all image groups.

Type: String
Parameter Sets: (All)
Aliases: 

Required: False
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
Parameter Sets: (All)
Aliases: 

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

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

INPUTS

OUTPUTS

Microsoft.Management.Infrastructure.CimInstance#MSFT_WdsInstallImage

NOTES

Copy-WdsInstallImage

Disable-WdsInstallImage

Enable-WdsInstallImage

Export-WdsInstallImage

Import-WdsInstallImage

Remove-WdsInstallImage

Set-WdsInstallImage

© 2017 Microsoft