Dismount-VHD

Reference

Module:: Hyper-V

Dismounts a virtual hard disk.

Syntax

Dismount-VHD
        [-Path] <String[]>
        [-SnapshotId <Guid>]
        [-Passthru]
        [-CimSession <CimSession[]>]
        [-ComputerName <String[]>]
        [-Credential <PSCredential[]>]
        [-WhatIf]
        [-Confirm]
        [<CommonParameters>]

Dismount-VHD
        [-DiskNumber] <UInt32>
        [-Passthru]
        [-CimSession <CimSession[]>]
        [-ComputerName <String[]>]
        [-Credential <PSCredential[]>]
        [-WhatIf]
        [-Confirm]
        [<CommonParameters>]

Description

The Dismount-VHD cmdlet dismounts a virtual hard disk.

Examples

Example 1

PS C:\> Dismount-VHD -Path c:\test\testvhdx.vhdx

Dismounts an attached virtual hard disk where the path to the virtual hard disk file path is c:\test\testvhdx.vhdx.

Example 2

PS C:\> Dismount-VHD -DiskNumber 6

Dismounts the attached virtual hard disk image with disk number 6.

Parameters

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

-ComputerName

Specifies one or more Hyper-V hosts on which a virtual hard disk is to be dismounted. NetBIOS names, IP addresses, and fully qualified domain names are allowable. The default is the local computer. Use localhost or a dot (.) to specify the local computer explicitly.

Type:	String[]
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

-Credential

Specifies one or more user accounts that have permission to perform this action. The default is the current user.

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

-DiskNumber

Specifies the disk number of the virtual hard disk to be dismounted.

Type:	UInt32
Aliases:	Number
Position:	0
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False

-Passthru

Specifies that an object is to be passed through to the pipeline representing the virtual hard disk to be dismounted.

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

-Path

Specifies one or more virtual hard disk files for which the corresponding virtual hard disks are to be dismounted.

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

-SnapshotId

Specifies the unique ID of a VHD set snapshot.

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

Outputs

Microsoft.Vhd.PowerShell.VirtualHardDisk

Partilhar via