Edit

Share via

Get-DiskImage

  • Reference
Module:
Storage

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

Syntax

Get-DiskImage
   [-ImagePath] <String[]>
   [-StorageType <StorageType>]
   [-CimSession <CimSession[]>]
   [-ThrottleLimit <Int32>]
   [-AsJob]
   [<CommonParameters>]
Get-DiskImage
   [-Volume <CimInstance>]
   [-StorageType <StorageType>]
   [-CimSession <CimSession[]>]
   [-ThrottleLimit <Int32>]
   [-AsJob]
   [<CommonParameters>]
Get-DiskImage
   -DevicePath <String[]>
   [-StorageType <StorageType>]
   [-CimSession <CimSession[]>]
   [-ThrottleLimit <Int32>]
   [-AsJob]
   [<CommonParameters>]

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.

Examples

Example 1: Get a disk image by path

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

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

Example 2: Get a disk image by device path

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

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

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

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

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

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

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

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

Parameters

-AsJob

Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to complete.

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

-DevicePath

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

Type:String[]
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-ImagePath

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

Type:String[]
Position:0
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

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

Type:StorageType
Accepted values:Unknown, ISO, VHD, VHDX, VHDSet
Position:Named
Default value:None
Required:False
Accept pipeline input:True
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
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Volume

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.

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

Inputs

CimInstance

You can pipe a Volume object to the Volume parameter.

Outputs

CimInstance

This cmdlet returns an object that represents the specified disk image.

Notes

  • When used in Failover Cluster, cmdlets from the Storage module operate on cluster level (all servers in the cluster).