Set-VHD

Set-VHD

Set properties associated with a virtual hard disk.

Syntax

Parameter Set: Parent
Set-VHD [-Path] <String> [-ParentPath] <String> [-ComputerName <String[]> ] [-IgnoreIdMismatch] [-LeafPath <String> ] [-Passthru] [-Confirm] [-WhatIf] [ <CommonParameters>]

Parameter Set: PhysicalSectorSize
Set-VHD [-Path] <String> -PhysicalSectorSizeBytes <UInt32> [-ComputerName <String[]> ] [-Passthru] [-Confirm] [-WhatIf] [ <CommonParameters>]

Detailed Description

The Set-VHD cmdlet sets the ParentPath or PhysicalSectorSizeBytes properties of a virtual hard disk. The two properties must be set in separate operations.

Parameters

-ComputerName<String[]>

Specifies one or more Hyper-V hosts on which the parent of a virtual hard disk in a differencing hard disk chain is to be set. 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.

-IgnoreIdMismatch

Specifies that the check for identifier mismatch between the parent and child virtual hard disk is to be skipped.

-LeafPath<String>

Specifies the path to the virtual hard disk file of the virtual hard disk representing the leaf node of the virtual hard disk chain. Required when performing the operation in online mode.

-ParentPath<String>

Specifies the path to the parent disk of a differencing virtual hard disk. Can be performed regardless of whether the disk is online or offline.

-Passthru

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

-Path<String>

Specifies the path to the virtual hard disk file of the virtual hard disk drive whose parent in the virtual hard disk chain is to be set.

-PhysicalSectorSizeBytes<UInt32>

Specifies the physical sector size, in bytes. Valid values are 512 and 4096. This parameter is supported only on a VHDX-format disk that is not attached when the operation is initiated.

-Confirm

Prompts you for confirmation before running the cmdlet.

-WhatIf

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

<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

This example sets the parent of the virtual hard disk associated with ParentCopy.vhd as the parent of the chained virtual hard disk associated with Child1.vhd, where the leaf of the virtual disk chain is the virtual hard disk associated with Child2.vhd. The operation is performed in online mode.

PS C:\> Set-VHD –Path Child1.vhd –ParentPath ParentCopy.vhd –LeafPath Child2.vhd

Example 2

This example sets the parent of the virtual hard disk associated with ParentCopy.vhd as the parent of the chained virtual hard disk associated with Child1.vhd. This operation cannot be performed when the virtual disk chain is attached.

PS C:\> Set-VHD –Path Child1.vhd –ParentPath ParentCopy.vhd

Example 3

This example sets the parent of Child1.vhd to point to parentcopywithnewid.vhd, even though parentcopywithnewid.vhd has a different ID than the original parent of child1.vhd. The operation is performed in offline mode. This mode should be used with extreme caution, and only when it is certain that the block contents of the new and old parents are exactly the same. Otherwise data loss can occur.

PS C:\> Set-VHD -Path Child1.vhd -parentpath parentcopywithnewid.vhd -IgnoreMismatchId

Example 4

This example sets the physical sector size of a VHDX to 512 bytes.

PS C:\> Set-VHD –Path c:\test.vhdx –PhysicalSectorSizeBytes 512