Export (0) Print
Expand All
Expand Minimize

Get-DiskImage

Windows Server 2012 R2 and Windows 8.1

Updated: June 4, 2014

Applies To: Windows 8.1, Windows PowerShell 4.0, Windows Server 2012 R2

Get-DiskImage

Gets one or more disk image objects (virtual hard disk or ISO).

Syntax

Parameter Set: ByImagePath
Get-DiskImage [-ImagePath] <String[]> [-AsJob] [-CimSession <CimSession[]> ] [-StorageType <StorageType> ] [-ThrottleLimit <Int32> ] [ <CommonParameters>]

Parameter Set: ByDevicePath
Get-DiskImage -DevicePath <String[]> [-AsJob] [-CimSession <CimSession[]> ] [-StorageType <StorageType> ] [-ThrottleLimit <Int32> ] [ <CommonParameters>]

Parameter Set: ByVolume
Get-DiskImage [-AsJob] [-CimSession <CimSession[]> ] [-StorageType <StorageType> ] [-ThrottleLimit <Int32> ] [-Volume <CimInstance> ] [ <CommonParameters>]




Detailed Description

The Get-DiskImage cmdlet gets the objects associated with one or more disk images (virtual hard disk or ISO). This cmdlet requires either the full image path of the ISO or VHD file, or the device path.

This cmdlet reports whether the specified ISO or VHD file is currently attached.

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.


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

-DevicePath<String[]>

Specifies the device path of the ISO or VHD file. You cannot use this parameter with the ImagePath parameter.


Aliases

none

Required?

true

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-ImagePath<String[]>

Specifies the path of the ISO or VHD file. You cannot use this parameter with the DevicePath parameter.


Aliases

none

Required?

true

Position?

1

Default Value

none

Accept Pipeline Input?

True (ByValue, ByPropertyName)

Accept Wildcard Characters?

false

-StorageType<StorageType>

Specifies the type of a disk image: ISO, VHD, VHDx, or Unknown. If the StorageType parameter is not specified or the Unknown type is provided, the storage type is determined by file extension.


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

-Volume<CimInstance>

Gets the disk image associated with the specified Volume object. Enter a Volume CIM object, which can be obtained by using the Get-Volume cmdlet.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByValue)

Accept Wildcard Characters?

false

<CommonParameters>

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

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.

Notes

  • The Microsoft.Management.Infrastructure.CimInstance object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. The path after the pound sign (#) provides the namespace and class name for the underlying WMI object.

Examples

Example 1: Get a disk image by path

This example gets an ISO disk image specified by path and displays information about the disk image.


PS C:\> Get-DiskImage –ImagePath "E:\ISO-Files\My US Visit Fall 2010 Pictures.iso"

Example 2: Get a disk image by device path

This example gets an ISO disk image specified by device path and displays information about the disk image.


PS C:\> Get-DiskImage -DevicePath \\.\CDROM1

Example 3: Get the drive letter associated with a mounted ISO

This example displays the drive letter associated with an ISO file.


PS C:\> Get-DiskImage -DevicePath \\.\CDROM1 | Get-Volume

Example 4: Get the drive letter associated with a mounted VHD

This example displays one or more drive letters associated with volumes in a VHD file.


PS C:\> Get-DiskImage –ImagePath E:\vhd1.vhdx | Get-Disk | Get-Partition | Get-Volume
DriveLetter       FileSystemLabel   FileSystem        DriveType         HealthStatus        SizeRemaining             Size
----------- --------------- ---------- --------- ------------ ------------- ----
F New Volume NTFS Fixed Healthy 19.27 GB 19.87 GB

Related topics

Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft