Get-CMVhd

Get-CMVhd

Gets VHD images.

Syntax

Parameter Set: SearchByName
Get-CMVhd [-Name <String> ] [-SecuredScopeNames <String> ] [ <CommonParameters>]

Parameter Set: SearchByIdMandatory
Get-CMVhd -Id <String[]> [-SecuredScopeNames <String> ] [ <CommonParameters>]

Detailed Description

The Get-CMVhd cmdlet gets one or more virtual hard disk (VHD) images that were created by using the operating system deployment feature.

Parameters

-Id<String[]>

Specifies an array of IDs of VHD images.

Aliases

PackageId

Required?

true

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-Name<String>

Specifies the name of a VHD image.

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-SecuredScopeNames<String>

Specifies the name of a secured scope. A secured scope name can be Default or the name of a custom-created secured scope.

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

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.

Examples

Example 1: Get a VHD image by using its name

This command gets the virtual hard disk (VHD) image named VHDAccounting08.

PS C:\> Get-CMVhd -Name "VHDAccounting08"

New-CMVhd

Remove-CMVhd

Set-CMVhd