Edit

Dismount-DiskImage

  • Reference
Module:
Storage

Dismounts a disk image (virtual hard disk or ISO) so that it can no longer be accessed as a disk.

Syntax

Dismount-DiskImage
        [-ImagePath] <String[]>
        [-StorageType <StorageType>]
        [-CimSession <CimSession[]>]
        [-ThrottleLimit <Int32>]
        [-AsJob]
        [-WhatIf]
        [-Confirm]
        [<CommonParameters>]
Dismount-DiskImage
        -DevicePath <String[]>
        [-StorageType <StorageType>]
        [-CimSession <CimSession[]>]
        [-ThrottleLimit <Int32>]
        [-AsJob]
        [-WhatIf]
        [-Confirm]
        [<CommonParameters>]
Dismount-DiskImage
        -InputObject <CimInstance[]>
        [-CimSession <CimSession[]>]
        [-ThrottleLimit <Int32>]
        [-AsJob]
        [-WhatIf]
        [-Confirm]
        [<CommonParameters>]

Description

The Dismount-DiskImage cmdlet dismounts a disk image (virtual hard disk or ISO) so that it can no longer be accessed as a disk. This cmdlet requires either the full image path of the ISO or VHD file, or the device path.

To eject a VHD file, administrator privilege is required. Administrator privilege is not needed to eject an ISO file on Windows® 8. On Windows Server® 2012, only an administrator is allowed to mount or eject ISO file.

Examples

Example 1: Dismount a disk image by path

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

This example ejects an ISO named My US Visit Fall 2010 Pictures by specifying the image path at E:\ISO-Files.

Example 2: Dismount a disk image by device path

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

This example ejects an ISO by specifying device path for cdrom1. Refer to the Get-DiskImage cmdlet to learn how to find the device path of an ISO or 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

-Confirm

Prompts you for confirmation before running the cmdlet.

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-DevicePath

Specifies the device path of the ISO/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

-InputObject

Specifies the input object that is used in a pipeline command.

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

-StorageType

Specifies the storage type of a file: 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

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Type:SwitchParameter
Aliases:wi
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False

Inputs

CimInstance

You can pipe a DiskImage object to the InputObject parameter.

Outputs

CimInstance

If you specify the PassThru parameter, this cmdlet outputs an object that represents the disk image that you dismounted.

Notes

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