Set-SCVirtualHardDisk

Syntax

Set-SCVirtualHardDisk
   [-OperatingSystem <OperatingSystem>]
   [-VirtualizationPlatform <VirtualizationPlatform>]
   [-Tag <System.Collections.Generic.List`1[System.String]>]
   [-ProductKey <String>]
   [-UserRole <UserRole>]
   [-Enabled <Boolean>]
   [-VMMServer <ServerConnection>]
   [-VirtualHardDisk] <VirtualHardDisk>
   [-JobGroup <Guid>]
   [-Name <String>]
   [-SharePath <String>]
   [-Description <String>]
   [-Owner <String>]
   [-FamilyName <String>]
   [-Release <String>]
   [-RunAsynchronously]
   [-PROTipID <Guid>]
   [-JobVariable <String>]
   [<CommonParameters>]

Set-SCVirtualHardDisk
   [-VMMServer <ServerConnection>]
   [-VirtualHardDisks] <System.Collections.Generic.List`1[Microsoft.SystemCenter.VirtualMachineManager.VirtualHardDisk]>
   -FamilyName <String>
   -Release <String>
   [-RunAsynchronously]
   [-PROTipID <Guid>]
   [-JobVariable <String>]
   [<CommonParameters>]

Description

The Set-SCVirtualHardDisk cmdlet changes one or more properties of a virtual hard disk object used in a Virtual Machine Manager (VMM) environment. A virtual hard disk file used in VMM is either a Windows-based .vhd file, a Citrix XenServer-based .vhd file, or a VMware-based .vmdk file.

Properties that you can change include:

• Description
• Enabled
• Name
• Operating System
• Owner
• SharePath

A virtual hard disk file might be stored in the VMM library, or it might be attached to a virtual disk drive on a virtual machine or template.

To change the Bus and LUN settings for a virtual disk drive, use the Set-SCVirtualDiskDrive cmdlet.

Examples

Example 1: Change the description of a virtual hard disk

PS C:\> $VHD = Get-SCVirtualHardDisk -VMMServer "VMMServer01.Contoso.com" | where { $_.LibraryServer.Name -eq "LibraryServer01.Contoso.com" -and $_.Name -eq "WindowsServer2008R2BootVHD.vhd"}
PS C:\> Set-SCVirtualHardDisk -VirtualHardDisk $VHD -Description "Latest Windows Server 2008 R2 Boot VHD"

The first command retrieves the virtual hard disk object named "WindowsServer2003BootVHD.vhd" from the library on VMMServer01 and then stores the object in the $VHD variable.

The second command changes the description of the virtual hard disk object stored in $VHD to "Latest Windows Server 2008 R2 Boot VHD".

Example 2: Enable a VMware-based virtual hard disk in the library

PS C:\> $VMDK = Get-SCVirtualHardDisk -VMMServer "VMMServer01.Contoso.com" | where { $_.LibraryServer.Name -eq "LibraryServer01.Contoso.com" -and $_.Name -eq "WindowsServer2008.vmdk"}
PS C:\> Set-SCVirtualHardDisk -VirtualHardDisk $VMDK -Enabled $FALSE

The first command gets the virtual hard disk object named WindowsServer2008.vmdk and then stores the virtual hard disk object in the $VMDK variable.

The second command disables the virtual hard disk object stored in $VMDK.

Example 3: Specify an owner for all virtual hard disks with an "Unknown" owner

PS C:\> Get-SCVirtualHardDisk -VMMServer "VMMServer01.Contoso.com" | where {$_.Owner -eq "Unknown"} | Set-SCVirtualHardDisk -Owner "Contoso\ReneeLo"

This command gets all virtual hard disk objects from the VMM library whose owner is "Unknown", and then specifies an owner for each virtual hard disk object.

Parameters

-Description

-Enabled

-FamilyName

-JobGroup

-JobVariable

-Name

-OperatingSystem

-Owner

-ProductKey

-PROTipID

-Release

-RunAsynchronously

-SharePath

-Tag

-UserRole

-VirtualHardDisk

-VirtualHardDisks

-VirtualizationPlatform

-VMMServer

Outputs

VirtualHardDisk

This cmdlet returns a VirtualHardDisk object.

Notes

• Requires a VMM virtual hard disk object, which can be retrieved by using the Get-SCVirtualHardDisk cmdlet.

Related Links

• Compress-SCVirtualDiskDrive
• Convert-SCVirtualDiskDrive
• Expand-SCVirtualDiskDrive
• Get-SCVirtualDiskDrive
• Get-SCVirtualHardDisk
• Move-SCVirtualHardDisk
• New-SCVirtualDiskDrive
• Remove-SCVirtualDiskDrive
• Remove-SCVirtualHardDisk
• Set-SCVirtualDiskDrive