PowerShell management Library for Hyper-V

New Post: I get only the initial list after registering the library

eduardo7095 — Thu, 04 Dec 2008 01:09:06 GMT

I get the list of commands after issuing: .\hyperv\hyperv.ps1

VM Functions added

Name
----
Add-VMDISK
Add-VMDRIVE
Add-VMFloppyDisk
Add-VMNewHardDisk
Add-VMNIC
Add-VMSCSIController
Apply-VMSnapshot
Choose-VM
choose-VMExternalEthernet
Choose-VMNIC
Choose-VMSnapshot

...

After that, any command Get-VM for example will give the following error.

The term 'Get-VM' is not recognized as a cmdlet, function, operable program, or script file. Verify the term and try ag
ain.
At line:1 char:6
+ Get-VM <<<<

Thanks.

Created Issue: New-VMSnapshot does not support -Wait

perb — Mon, 24 Nov 2008 15:51:03 GMT

As the title says, here is the fixed version:

Filter New-VMSnapshot
{Param( $VM , $Server=".", [switch]$Wait)
if ($VM -eq $null) {$VM=$_ }
if ($VM -is [String]) {$VM=(Get-VM -Name $VM -Server $server) }
if ($VM -is [Array]) {$VM | ForEach-Object {New-VMSnapshot -VM $_} }
if ($VM -is [System.Management.ManagementObject]) {
#We are going to invoke CreateVirtualSystemSnapshot. Following from MSDN
#CreateVirtualSystemSnapshot. (
# [in] CIM_ComputerSystem Ref SourceSystem, // Reference to the virtual computer system to be snapshotted.
# [out] CIM_VirtualSystemSettingData Ref SnapshotSettingData, //The CIM_VirtualSystemSettingData instance that was created to represent the snapshot.
# [out] CIM_ConcreteJob Ref Job );
#If this method is executed synchronously, it returns 0 if it succeeds.
#If this method is executed asynchronously, it returns 4096 and the Job output parameter can be used to track the progress of the asynchronous operation.
# Any other return value indicates an error.
# Virtual system Setting data never seems to be set.
$arguments=($VM,$Null,$null)
$VSMgtSvc=Get-WmiObject -ComputerName $VM.__server -NameSpace "root\virtualization" -Class "MsVM_virtualSystemManagementService"
$result=$VSMgtSvc.psbase.invokeMethod("CreateVirtualSystemSnapshot",$arguments)
if ($Wait) {test-wmijob $arguments[2] -wait -Description "Snapshoting VM $($vm.elementName)"}
else{ "Snapshoting VM '$($vm.elementName)': "+ $ReturnCode[[string]$result] | Out-host
$arguments[2] }
$vm=$null
}
}

Created Issue: Add support for KVP / Data Exchange

perb — Thu, 20 Nov 2008 09:21:15 GMT

Thanks for a great toolkit!!!

What I am missing is support for KVP / Data Exchange. I created my own "hack" based on the following postings from Taylor Brown. I am attaching this code if you wan't to have a look

http://blogs.msdn.com/taylorb/archive/2008/07/09/hyper-v-wmi-kvp-exchange-aka-data-exchange-retrieving-and-modifying-parent-host-kvp-s.aspx
http://blogs.msdn.com/taylorb/archive/2008/07/06/hyper-v-wmi-kvp-exchange-aka-data-exchange-adding-new-items-from-parent-host.aspx

New Post: commands are doing nothing

Fileman — Fri, 24 Oct 2008 10:12:13 GMT

As Administrator, hyper-v RTM, No output from any script, List-VM, Kill-VM, etc....

Commented Issue: Difficult to determine parent VHD file of VM if it has snapshots

agacos — Tue, 14 Oct 2008 22:50:49 GMT

If you have a VM with snapshots, running get-vmdisk will show you the latest info for the snapshot and point to an avhd, not the parent vhd.
Comments: ** Comment from web user: agacos **

This is how I would do it in C++:
1. Query WMI ParentChildSettingData to get the VM and snapshot instance ID relationships.
2. Query WMI Msvm_ResourceAllocationSettingData to get the list of vhd and snapshot paths of each VM.
3. Based from data above, I should be able to get the vhd path of a snapshotted VM.

Example:
Msvm_ParentChildSettingData

Antecedent: \\MGHV\root\virtualization:Msvm_VirtualSystemSettingData.InstanceID="Microsoft:8F413EBA-EDD2-4D82-9285-93DBF619BAE6" <<<<<<<<<<< use this InstanceID to get the VHD path in Msvm_ResourceAllocationSettingData
Dependent: \\MGHV\root\virtualization:Msvm_VirtualSystemSettingData.InstanceID="Microsoft:81657DD1-6CED-4433-A7A5-CB07AA481581"

Msvm_ResourceAllocationSettingData

Address:
AllocationUnits: Disks
AutomaticAllocation: True
AutomaticDeallocation: True
Caption: Hard Disk Image
Connection: D:\Snapshots\W2K3-cluster-node01\Snapshots\81657DD1-6CED-4433-A7A5-CB07AA481581\W2K3-cluster-node01_6F8500CD-1958-4B75-AC89-FCED9B8E1058.avhd
ConsumerVisibility: 3
Description: Settings for the Microsoft Hard Disk Image.
ElementName: Hard Disk Image
HostResource:
InstanceID: Microsoft:81657DD1-6CED-4433-A7A5-CB07AA481581\83F8638B-8DCA-4152-9EDA-2CA8B33039B4\0\0\L
Limit: 1
MappingBehavior:
OtherResourceType:
Parent: \\MGHV\root\virtualization:Msvm_ResourceAllocationSettingData.InstanceID="Microsoft:81657DD1-6CED-4433-A7A5-CB07AA481581\\83F8638B-8DCA-4152-9EDA-2CA8B33039B4\\0\\0\\D"
PoolID: Microsoft:70BB60D2-A9D3-46aa-B654-3DE53004B4F8\Root
Reservation: 1
ResourceSubType: Microsoft Virtual Hard Disk
ResourceType: 21
VirtualQuantity: 1
Weight: 0

Address:
AllocationUnits: Disks
AutomaticAllocation: True
AutomaticDeallocation: True
Caption: Hard Disk Image
Connection: E:\Hyper-V\W2K3-cluster-node01\W2K3-cluster-node01.vhd <<<<<<<<<<<<<< our vhd path
ConsumerVisibility: 3
Description: Settings for the Microsoft Hard Disk Image.
ElementName: Hard Disk Image
HostResource:
InstanceID: Microsoft:8F413EBA-EDD2-4D82-9285-93DBF619BAE6\83F8638B-8DCA-4152-9EDA-2CA8B33039B4\0\0\L <<<<<<<< instance if from Msvm_ParentChildSettingData
Limit: 1
MappingBehavior:
OtherResourceType:
Parent: \\MGHV\root\virtualization:Msvm_ResourceAllocationSettingData.InstanceID="Microsoft:8F413EBA-EDD2-4D82-9285-93DBF619BAE6\\83F8638B-8DCA-4152-9EDA-2CA8B33039B4\\0\\0\\D"
PoolID: Microsoft:70BB60D2-A9D3-46aa-B654-3DE53004B4F8\Root
Reservation: 1
ResourceSubType: Microsoft Virtual Hard Disk
ResourceType: 21
VirtualQuantity: 1
Weight: 0

New Post: Export-VM does not copy vhd file to export folder

pyong — Fri, 03 Oct 2008 20:43:32 GMT

The 1st time I did a "Export-VM" it created 3 folders: Snapshot, Virtual Harddrive, and Virtual Machine.

Everytime after that it only creates the Virtual Machine folder, the Virtual Harddrive folder does not get created and the vhd file does not get copied to the export folder.

Commented Issue: Difficult to determine parent VHD file of VM if it has snapshots

robhu — Fri, 03 Oct 2008 18:47:07 GMT

If you have a VM with snapshots, running get-vmdisk will show you the latest info for the snapshot and point to an avhd, not the parent vhd.
Comments: ** Comment from web user: robhu **

The reason I wanted this was so I could easily delete a VM and the main Diff VHD that goes with it. I can then delete the VM which will delete all the snapshots that go with it, and then I could delete the main Diff. Otherwise, I have to go through each Snapshot until I get to the one that points the main Diff VHD.

Perhaps more information is returned in the get-vmdisk function which will include all linked VHDs back to the main VHD. So it returns the DiskPath to the current VHD (or AVHD) that it's linked to, and then either through another switch parameter or not it will also display which VHD (or AVHD) that is up the chain from that one until and repeat until it reaches the end of the chain.

Commented Issue: Difficult to determine parent VHD file of VM if it has snapshots

jamesone — Tue, 30 Sep 2008 09:26:42 GMT

If you have a VM with snapshots, running get-vmdisk will show you the latest info for the snapshot and point to an avhd, not the parent vhd.
Comments: ** Comment from web user: jamesone **

That is correct behavior. Ahvd is attached to the VM, the parent of the avhd will be the original VHD (or an intermediate aVHD) - in a similar way to a differencing disk.

I'm not sure of the best way to handle this because anything that assumes the disk gives complete information is going to come unstuck when there is a snapshot or a differencing disk in use. If places where you'd expect a disk to be returned if multiple disks are returned that would also cause confusion.

I'll give it some thought but any suggestions on the best way to handle it would be gratefully recieved.

Commented Issue: Delete multiple (all) snapshots of a VM

jamesone — Tue, 30 Sep 2008 09:20:55 GMT

It doesn't appear it's possible to delete all snapshots of a VM because the remove-vmsnapshot function doesn't wait for each operation to complete (ie. via a -wait like other functions). So while jobs are created to delete multiple snapshots, only the first job successfully completes.
Comments: ** Comment from web user: jamesone **

Good catch, I'll fix that for next release

Created Issue: Difficult to determine parent VHD file of VM if it has snapshots

robhu — Tue, 23 Sep 2008 00:09:36 GMT

If you have a VM with snapshots, running get-vmdisk will show you the latest info for the snapshot and point to an avhd, not the parent vhd.

Created Issue: Delete multiple (all) snapshots of a VM

robhu — Tue, 23 Sep 2008 00:07:28 GMT

New Post: commands are doing nothing

jamesone — Mon, 15 Sep 2008 20:09:30 GMT

If you are not logged on as THE administrator, you need to run powershell elevated.

There are examples for each command in the script, proper documentation is being worked on.

It also FAILS if you are running the beta of hyper-V

New Post: commands are doing nothing

tommew — Mon, 15 Sep 2008 14:31:17 GMT

Hi folks,

I was trying again to get these tools running.
I opened a powershell and loaded the script first.

But calling things like this:
Start-VM myvm01

or like this:
Ping-VM myvm02

are not working

The only Call that worked was:
New-VM myvm03

The vm myvm03 was created.

Is the a manual, a wiki or so? I am willing to help testing.

Cheers Thomas

New Post: Totally confused

Dirge — Fri, 12 Sep 2008 18:46:05 GMT

Thanks it was the "..\" that was the problem it seems. I was only using ".\" before which looked exactly the same as far as output was concerned, but obviously did not have the same effects.

Much appreciated.

New Post: command are doing nothing

tommew — Fri, 12 Sep 2008 10:27:22 GMT

Thanks to the PSHyperv team first.

I loaded the hyperv.ps1 but if I call Ping-VM <vmname> or Get-VMState <vmname> there is not output at all.
Any ideas to figure out pshyperv is working?

I am fighting the freebsd shutdown problem Luka mentioned here http://luka.manojlovic.net/2008/07/18/hyper-v-freebsd-shutdown-problem-workaround.
So first I want to try the original pshyperv - later on Luka's version containing the Kill-VM.

Thomas

New Post: Totally confused

tommew — Fri, 12 Sep 2008 10:20:50 GMT

J.

try to call . .\hyperv.ps1 ftom the folder the zip was extraced to. notice the dot+space+dot+slash.

I short manual can also be found here
http://luka.manojlovic.net/2008/07/18/hyper-v-freebsd-shutdown-problem-workaround

thomas

New Post: Totally confused

Dirge — Thu, 11 Sep 2008 04:04:31 GMT

I hope someone can point me in the right direction as I can’t figure out how to get this to work at all.

I have run the registry file, and run the script hyperv.ps1 and it looks like it has finished successfully, but if I type any of the functions I get something like this:

The term 'get-vm' is not recognized as a cmdlet, function, operable program, or script file. Verify the term and try again.

At line:1 char:7

+ get-vm <<<<

Am I doing something wrong? I am a complete PowerShell newbie so I would not be surprised if I have missed something important, but I have been unable to figure out what it is...

BTW in case this is the cause, I am running PowerShell on Windows 2008 Server Core 64bit which I installed following these instructions: http://dmitrysotnikov.wordpress.com/2008/05/15/powershell-on-server-core/

Thanks in advance J

Commented Feature: Add Get-VMSummaryInformation

12055 — Wed, 27 Aug 2008 21:42:02 GMT

I wrote the following to get a few additional statistics (I also posted it on MSDN documentation). It could use some cleanup but may be helpful for someone. Strange how the API keeps the same information (number of cpus, uptime, etc.) in a bunch of different places....

function Get-VirtualSystemManagementService
{
return gwmi -class "Msvm_VirtualSystemManagementService" -namespace "root\virtualization"
}

function Get-VirtualMachine([string] $Name="")
{
$query = "select * from Msvm_ComputerSystem where ElementName='" + $Name + "'"
return gwmi -namespace "root\virtualization" -query $query
}

function Get-VirtualMachineSettingData([string] $Name="")
{
$virtualMachine = Get-VirtualMachine($Name)
$query = "ASSOCIATORS OF {" + $virtualMachine.__Path + "} WHERE resultClass = Msvm_VirtualSystemsettingData"
return gwmi -query $query -namespace "root\virtualization"
}

function Get-VirtualMachineSummaryInformation([string] $Name="")
{
$requestedProperties = 0,1,2,3,4,5,6,7,100,101,102,103,104,105,106,107,108,109
$service = Get-VirtualSystemManagementService
$settings = Get-VirtualMachineSettingData($Name)
$summaryList = $service.GetSummaryInformation($settings.__PATH, $requestedProperties)
foreach($summary in $summaryList.SummaryInformation)
{
return $summary
}
}

Usage:

$results = Get-VirtualMachineSummaryInformation("WinXPx32")

Displaying Output:

"Name: " + $results.Name
"ElementName: " + $results.ElementName
"MemoryUsage: " + $results.MemoryUsage
"GuestOperatingSystem: " + $results.GuestOperatingSystem
"HealthState: " + $results.HealthState
"Heartbeat: " + $results.Heartbeat
"Notes: " + $results.Notes
"NumberOfProcessors: " + $results.NumberOfProcessors
"ProcessorLoad: " + $results.ProcessorLoad
"UpTime: " + $results.UpTime

Sample Output:

Name: B0C19E9D-C09F-46FD-B548-D8249032A485
ElementName: WinXPx32
MemoryUsage: 2048
GuestOperatingSystem: Microsoft Windows XP
HealthState: 5
Heartbeat: 2
Notes:
NumberOfProcessors: 1
ProcessorLoad: 0
UpTime: 5865112
Comments: ** Comment from web user: 12055 **

Cool, I was wondering what a good work around would be for the fact that the results were not a proper object.

Commented Issue: Add Get-VMSummaryInformation

jamesone — Tue, 26 Aug 2008 23:50:37 GMT

I will add the code to the next release. I've reworked it somewhat and it now looks like this .
Filter Get-VirtualMachineSummaryInformation
{param ($vm , $Server=".")
if ($vm -eq $null) {$vssd=Get-VMSettingData $_ $Server}
else {$vssd=Get-VMSettingData $vm $server}
$settingPath = @()
$vssd | foreach-object {$settingPath += $_.__Path ; $Server=$_.__Server}
$arguments=@($SettingPath, @(0,1,2,3,4,100,101,102,103,104,105,106,107,108), $null)
$VSMgtSvc=Get-WmiObject -computerName $Server -NameSpace "root\virtualization" -Class "MsVM_virtualSystemManagementService"
$result=$VSMgtSvc.psbase.InvokeMethod("GetSummaryInformation",$arguments)
if ($Result -eq 0) {$arguments[2] | foreach-object {
$SiObj = New-Object -TypeName System.Object
Add-Member -inputObject $siObj -MemberType NoteProperty -Name "Name" -Value $_.name
Add-Member -inputObject $siObj -MemberType NoteProperty -Name "ElementName" -Value $_.elementname
Add-Member -inputObject $siObj -MemberType NoteProperty -Name "CreationTime" -Value $_.CreationTime
Add-Member -inputObject $siObj -MemberType NoteProperty -Name "EnabledState" -Value $_.EnabledState
Add-Member -inputObject $siObj -MemberType NoteProperty -Name "EnabledStateText" -Value (convert-vmState($_.EnabledState))
Add-Member -inputObject $siObj -MemberType NoteProperty -Name "Notes" -Value $_.Notes
Add-Member -inputObject $siObj -MemberType NoteProperty -Name "CPUCount" -Value $_.NumberOfProcessors
Add-Member -inputObject $siObj -MemberType NoteProperty -Name "CPULoad" -Value $_.ProcessorLoad
Add-Member -inputObject $siObj -MemberType NoteProperty -Name "CPULoadHistory" -Value $_.ProcessorLoadHistory
Add-Member -inputObject $siObj -MemberType NoteProperty -Name "MemoryUsage" -Value $_.MemoryUsage
Add-Member -inputObject $siObj -MemberType NoteProperty -Name "Heartbeat" -Value $_.Heartbeat
Add-Member -inputObject $siObj -MemberType NoteProperty -Name "HeartbeatText" -Value @{2="OK"; 6="Error"; 12="No Contact";13="Lost Communication"}[[int]$_.Heartbeat]
Add-Member -inputObject $siObj -MemberType NoteProperty -Name "Uptime" -Value $_.UpTime
Add-Member -inputObject $siObj -MemberType ScriptProperty -Name "UptimeFormatted" -Value {if ($This.uptime -gt 0) {([datetime]0).addmilliseconds($This.UpTime).tostring("hh:mm:ss")} else {0} }
Add-Member -inputObject $siObj -MemberType NoteProperty -Name "GuestOS" -Value $_.GuestOperatingSystem;
Add-Member -inputObject $siObj -MemberType NoteProperty -Name "Snapshots" -Value $_.Snapshots.count
Add-Member -inputObject $siObj -MemberType NoteProperty -Name "Jobs" -Value $_.AsynchronousTasks
$siObj } }
else {"Get Summary info :" + $ReturnCode[[string]$result] | Out-host }
}

Released: 0.95a Beta (Aug 19, 2008)

Tue, 26 Aug 2008 19:32:05 GMT

Several minor bugs have been fixed, including 2 which were in the non -a release and there is more consistency with parameter passing.

where a command had a MachineName parameter it is now simply Name.

Get-VMDrive has been renamed Get-VMDriveByController, and Get-VMDisk has been renamed Get-VMDiskByDrive
The old List-VMState and List-VMDisk have become Get-VMState and Get-VMdisk

A Get-VMJpeg function has been added to get snapshots

Functions have been added to support the creation of Network interfaces, Choose-VMExternalEthernet, New-VMExternalSwitch, VMNewIntrnalSwitch, New-VMPrivateSwitch

Get-VMNic will return Legacy and VMBus NICs if neither type is specified (previously -Legacy and -Vmbus needed to used)

New VHD functions have been added for Expand-VHD, Convert-VHD, Test-VHD, Merge-VHD

Apply-snapshot now supports -Force and -Restart switches.

A bug in the reg file has been fixed - there was a space missing before /C

This is now "feature complete". I'm aware there are still several places where functions should be able to accept an array or piped input can not do so. I'm going to try to tidy-up those items and finalize the examples embedded in the script and move onto to documenting the code.

Many thanks to the 700 people who downloaded the previous version. Because of the number of chnages I'd really value any feedback, bug reports etc. before declaring this to be the final version.