Nihar Shah Senior Development Lead Microsoft Corporation ES10.

Developing Solutions For Windows Server 2008 Hyper-V Using WMI

Nihar ShahSenior Development LeadMicrosoft Corporation

ES10

Overview Virtual Machines Virtual Machine Management Use Case – Creating a Virtual Machine Virtual Devices Resource Pools Use Case – Attaching a VHD to a Virtual Machine Networking Use Case – Configuring Networking Q & A

Agenda

To provide a detailed overview of the WMI object model in Windows Server 2008 Hyper-V

To communicate “best practices” when programming against the Hyper-V WMI API

To develop an understanding of how to perform common tasksusing Windows Server 2008 Hyper-V

Goals

overview

Version 2.12e of the DMTF standard Concrete subclasses use the Msvm_ prefix

Windows Server 2008 Hyper-V


Snapshots Point-in-time representation of a VM

Configuration Disk Runtime state





Applying a snapshot Snapshot is unaffected “Current” configuration for the VM is overwritten Disk and runtime state are copied





Applying a snapshot Snapshot is unaffected “Current” configuration for the VM is overwritten Disk and runtime state are copied

Typically read-only


virtual machines

Virtual Machine Object Model

LogicalDevice

Virtual Device in the VM

LogicalDevice


ComputerSystem

Virtual Machine(Child Partition)

LogicalDevice


VirtualSystemSettingData

Current Settings for the Virtual Machine

SystemDevice VirtualSystemSettingDataComponent

SettingsDefineState


Snapshot Settings for the Virtual Machine

ElementSettingData

VirtualSystemSettingDataComponent

ResourceAllocationSettingData

Current Settings for the Virtual Device


Snapshot Settings for the Virtual Device

VirtualSystemGlobalSettingData

Global Settings for the Virtual Machine

SettingsDefineState

Virtual Machine

LogicalDevice


LogicalDevice


LogicalDevice





SettingsDefineState



ElementSettingData








SettingsDefineState

ComputerSystem


Virtual Machine Settings

LogicalDevice


LogicalDevice


ComputerSystem


LogicalDevice



SettingsDefineState








SettingsDefineState

VirtualSystemSettingDataCurrent Settings for the

Virtual Machine

VirtualSystemSettingDataSnapshot Settings for the

Virtual Machine

ElementSettingData

Global Virtual Machine Settings

LogicalDevice


LogicalDevice


ComputerSystem


LogicalDevice





SettingsDefineState



ElementSettingData






SettingsDefineState


Global Settings for theVirtual Machine

Virtual Device

ComputerSystem





SettingsDefineState



ElementSettingData








SettingsDefineState

LogicalDevice


LogicalDevice


LogicalDevice


Virtual Device Settings

SettingsDefineState

LogicalDevice


LogicalDevice


ComputerSystem


LogicalDevice



Current Settings for theVirtual Machine

SystemDeviceVirtualSystem

SettingDataComponent

SettingsDefineState


Snapshot Settings for theVirtual Machine

ElementSettingData



Current Settings for theVirtual Device




Global Settings for theVirtual Machine

Msvm_ComputerSystem Represents either a physical or virtual machine

Msvm_HostedDependency Antecedent – Physical Machine Dependent – Virtual Machine

Virtual Machine

ComputerSystem


HostedDependency

ComputerSystem

Physical Machine(Parent Partition)

Msvm_ComputerSystem EnabledState RequestStateChange()

“Enabled” “Disabled” “Paused” “Suspended” “Reset”

ProcessID

Virtual Machine

Msvm_VirtualSystemSettingData (VSSD) Current or snapshot settings for the VM

Associations Msvm_SettingsDefineState Msvm_ElementSettingData

SettingType Current = ‘3’ Snapshot = ‘5’


ComputerSystem




SettingsDefineState



ElementSettingData

Msvm_VirtualSystemSettingData BIOS settings NUMA settings Notes Parent


Msvm_VirtualSystemSettingData BIOS settings NUMA settings Notes Parent

Msvm_VirtualSystemGlobalSettingData ElementName Automatic startup/shutdown/recovery actions ScopeOfResidence ExternalDataRoot SnapshotDataRoot


virtual machine management

Msvm_VirtualSystemManagementService Methods for managing virtual machine elements

Virtual machines Devices Snapshots

Virtual Machine Management

Msvm_VirtualSystemManagementService Methods for managing virtual machine elements

Virtual machines Devices Snapshots

Embedded instances Intrinsic ‘Put’ and ‘Delete’ operations not supported CIM-XML format .NET -

ManagementObject.GetText(TextFormat.WmiDtd20) PowerShell - $obj.PsBase.GetText(1)


Asynchronous operations Return code

0 – Succeeded synchronously



0 – Succeeded synchronously 4096 – Operation started

CIM_ConcreteJob object indicates progress, completion status, and rich error information



0 – Succeeded synchronously 4096 – Operation started

CIM_ConcreteJob object indicates progress, completion status, and rich error information

Any other return code indicates an error Invalid parameter Insufficient memory Invalid virtual machine state


Create Virtual Machine

use case


# Get Msvm_VirtualSystemGlobalSettingData class definition$wmiClassString = "\\svr\root\virtualization:Msvm_VirtualSystemGlobalSettingData"$wmiClass = [WMIClass]$wmiClassString



#Create a local instance of the class$vsgsd = $wmiClass.CreateInstance()$vsgsd.psbase.Properties.Item("ElementName").value = "MyVM"




# Serialize $vsgsd into an embedded instance$embeddedInstance = $vsgsd.psbase.GetText(1)





# Get Msvm_VirtualSystemManagementService instance$managementService = gwmi Msvm_VirtualSystemManagementService -namespace "root\virtualization" -ComputerName “svr“





# Get Msvm_VirtualSystemManagementService instance$managementService = gwmi Msvm_VirtualSystemManagementService -namespace "root\virtualization" -ComputerName "svr"

# Create the virtual machine$result = $managementService.DefineVirtualSystem( $embeddedInstance, $null)

ConcreteJob Handling

# If ReturnValue = 4096, the operation is handled asynchronouslyif ($result.ReturnValue -eq 4096){}


# If ReturnValue = 4096, the operation is handled asynchronouslyif ($result.ReturnValue -eq 4096){ $job=[WMI]$result.job

# Loop while JobState = 3 ("Starting") or 4 ("Running") while ($job.JobState -eq 3 -or $job.JobState -eq 4) { }}



# Loop while JobState = 3 ("Starting") or 4 ("Running") while ($job.JobState -eq 3 -or $job.JobState -eq 4) { write-host $job.PercentComplete start-sleep 1 $job=[WMI]$Result.job }}



# Loop while JobState = 3 ("Starting") or 4 ("Running") while ($job.JobState -eq 3 -or $job.JobState -eq 4) { write-host $job.PercentComplete start-sleep 1 $job=[WMI]$Result.job }

# Indicate whether the operation succeeded if ($job.JobState -eq 7) write-host "Virtual machine created.“ else write-host $job.GetError}

virtual devices

CIM_LogicalDevice Only surfaced when the VM is powered on

Running/Paused/Transitional states Associations

Msvm_SystemDevice Msvm_SettingsDefineState

Emulated versus Synthetic devices

Virtual Devices

LogicalDevice


SystemDevice

ComputerSystem


CIM_ResourceAllocationSettingData (RASD) Current or snapshot settings for a device Associated with “current” or “snapshot”

instance of Msvm_VirtualSystemSettingData



Current Settings for theVirtual Machine








Current Settings for theVirtual Device

CIM_ResourceAllocationSettingData Always present in a VM Device type

ResourceType ResourceSubType OtherResourceType




Virtual machine connectivity Parent Address




Virtual machine connectivity Parent Address

Physical machine connectivity HostResource[] Connection[]


resource pools

Resource Pool Object Model

AllocationCapabilities

Capabilities for the Virtual Resources in the Pool


Default Values for Each Property

ResourcePool

Pool of Resources Which May Be Allocated to a VM


Minimum Values for Each Property


Maximum Values for Each Property


Increment Values for Each Property

ElementCapabilities

SettingsDefineCapabilities

Get instance of CIM_ResourcePool

Resource Pool Usage

Get instance of CIM_ResourcePool Navigate to “Default” RASD

Resource Pool Usage

Get instance of CIM_ResourcePool Navigate to “Default” RASD Modify RASD values

Respect minimum, maximum, and increment values specified in the other RASD instances

Resource Pool Usage



Convert RASD into an embedded instance

Resource Pool Usage



Convert RASD into an embedded instance Call AddVirtualSystemResources method

to add the device to a virtual machine

Resource Pool Usage

Add Storage to a Virtual Machine

use case

Pass-through Storage Controller Disk Drive

Connected directly to physical storage volume

Storage Types

Pass-through Storage Controller Disk Drive

Connected directly to physical storage volume Virtual Hard Disk (VHD)

Controller Disk Drive Logical Disk

Connected to VHD file

Storage Types

Get Existing IDE Controller

# Get the virtual machine object$Vm = Get-WmiObject -Namespace "root\virtualization" –Query "SELECT * From Msvm_ComputerSystem WHERE ElementName='MyVM'"



# Get the current VM settings object$Vssd = Get-WmiObject -Namespace "root\virtualization" –Query "ASSOCIATORS OF {$Vm} WHERE AssocClass=Msvm_SettingsDefineState ResultClass=Msvm_VirtualSystemSettingData"



# Get the current VM settings object$Vssd = Get-WmiObject -Namespace "root\virtualization" –Query "ASSOCIATORS OF {$Vm} WHERE AssocClass=Msvm_SettingsDefineState ResultClass=Msvm_VirtualSystemSettingData"

# Get the settings for IDE controller 0 on the VM$IdeRasd = (Get-WmiObject -Namespace "root\virtualization" -Query "ASSOCIATORS OF {$Vssd} WHERE AssocClass=Msvm_VirtualSystemSettingDataComponent ResultClass=Msvm_ResourceAllocationSettingData" | Where-Object {$_.ResourceType –eq 5 -and $_.Address –eq 0})

Get Default Disk Drive Settings

$DrivePool = Get-WmiObject -Namespace "root\virtualization" -Query "SELECT * FROM Msvm_ResourcePool WHERE ResourceType=22 AND ResourceSubType='Microsoft Synthetic Disk Drive'"



$DriveCaps = Get-WmiObject –Namespace "root\virtualization" –Query "ASSOCIATORS OF {$DrivePool} WHERE AssocClass=Msvm_ElementCapabilities ResultClass=Msvm_AllocationCapabilities"



$DriveCaps = Get-WmiObject –Namespace "root\virtualization" –Query "ASSOCIATORS OF {$DrivePool} WHERE AssocClass=Msvm_ElementCapabilities ResultClass=Msvm_AllocationCapabilities"

$DriveRasd = Get-WmiObject -Namespace "root\virtualization" -Query "REFERENCES OF {$DriveCaps} WHERE ResultClass=Msvm_SettingsDefineCapabilities" | Where-Object {$_.ValueRole -eq 0} | ForEach-Object {[Wmi]$_.PartComponent})

Configure And Add Disk Drive

# Configure the drive as the first device on the IDE controller$DriveRasd.Parent = $IdeRasd.__Path$DriveRasd.Address = 0



# The AddVirtualSystemResources method takes an array of embedded instances of CIM_ResourceAllocationSettingData$RasdArray = [string[]]@($DriveRasd.PSBase.GetText(1))



# The AddVirtualSystemResources method takes an array of embedded instances of CIM_ResourceAllocationSettingData$RasdArray = [string[]]@($DriveRasd.PSBase.GetText(1))

# Add the disk drive to the virtual machine$result = $ManagementService.AddVirtualSystemResources($Vm, $RasdArray)

Pass-through Storage HostResource[0] property on disk drive RASD

Attaching Storage To A Disk Drive


Virtual Hard Disk Add LogicalDisk device




Find ResourcePool for VHDs ResourceType = 21 (“Storage Extent”) ResourceSubType =

“Microsoft Virtual Hard Disk”





“Microsoft Virtual Hard Disk” Navigate to “Default” RASD





“Microsoft Virtual Hard Disk” Navigate to “Default” RASD Configure settings

Parent = Object path of disk drive RASD Connection[0] = File system path to VHD file





“Microsoft Virtual Hard Disk” Navigate to “Default” RASD Configure settings

Parent = Object path of disk drive RASD Connection[0] = File system path to VHD file

Call AddVirtualSystemResources


ComputerSystem


LogicalDevice

IDE Controller



SettingsDefineState

SettingsDefineState


Settings for the IDE Controller

LogicalDevice

Disk Drive

LogicalDevice

Logical Disk(Virtual Hard Disk)


Settings for the Disk Drive


Settings for the Logical Disk


SettingsDefineState

SettingsDefineState

SystemDevice


networking

Networking Object Model

External (Physical)Internal (Parent)Virtual MachineComputerSystem


EthernetPort

Virtual NIC Device

SystemDevice

SwitchLANEndpoint

Protocol Endpoint Used To Connect Two Networking Ports

SwitchPort

Port on the Virtual Switch

VirtualSwitch

Virtual Switch Device

HostedAccessPoint

VmLANEndpoint


DeviceSAPImplementation

ActiveConnection

SwitchPort


ExternalEthernetPort

Physical NIC Device

SwitchLANEndpoint


InternalEthernetPort

Internal NIC Used to Describe Connectivity into the Host OS

HostedAccessPoint

SwitchPort


GlobalEthernetPortSAPImplementation

ActiveConnection ActiveConnection





EthernetPort

Virtual NIC Device

SystemDevice

SwitchLANEndpoint


SwitchPort


VirtualSwitch

Virtual Switch DeviceHosted

AccessPoint

VmLANEndpoint



ActiveConnection

SwitchPort



Physical NIC Device

SwitchLANEndpoint




HostedAccessPoint

SwitchPort








EthernetPort

Virtual NIC Device

SystemDevice

SwitchLANEndpoint


SwitchPort


VirtualSwitch


HostedAccessPoint

VmLANEndpoint



ActiveConnection

SwitchPort



Physical NIC Device

SwitchLANEndpoint




HostedAccessPoint

SwitchPort






Internal (Parent)Virtual MachineComputerSystem


EthernetPort

Virtual NIC Device

SystemDevice

SwitchLANEndpoint


SwitchPort


VirtualSwitch


HostedAccessPoint

VmLANEndpoint



ActiveConnection

SwitchPort



Physical NIC Device

SwitchLANEndpoint




HostedAccessPoint

SwitchPort





External (Physical)

External (Physical)Virtual MachineComputerSystem


EthernetPort

Virtual NIC Device

SystemDevice

SwitchLANEndpoint


SwitchPort


VirtualSwitch


HostedAccessPoint

VmLANEndpoint



ActiveConnection

SwitchPort



Physical NIC Device

SwitchLANEndpoint




HostedAccessPoint

SwitchPort





Internal (Parent)





EthernetPort

Virtual NIC Device

SystemDevice

SwitchLANEndpoint


SwitchPort


VirtualSwitch


HostedAccessPoint

VmLANEndpoint



ActiveConnection

SwitchPort



Physical NIC Device

SwitchLANEndpoint




HostedAccessPoint

SwitchPort





Networking

use case

Create Virtual Switch

# Get an instance of the virtual switch management service$VirtualSwitchService = get-wmiobject –class "Msvm_VirtualSwitchManagementService" –namespace "root\virtualization" -computername "MyServer"

Create Virtual Switch

# Get an instance of the virtual switch management service$VirtualSwitchService = get-wmiobject –class "Msvm_VirtualSwitchManagementService" –namespace "root\virtualization" -computername "MyServer“

# Create a virtual switch$ReturnObject = $VirtualSwitchService.CreateSwitch( [guid]::NewGuid().ToString(), "My Switch", 1024, "")$CreatedSwitch = [WMI]$ReturnObject.CreatedVirtualSwitch

Create Switch Ports

# Create internal switch port$ReturnObject = $VirtualSwitchService.CreateSwitchPort($CreatedSwitch, [guid]::NewGuid().ToString(), "Internal Switch Port", "")$InternalSwitchPort = [WMI]$ReturnObject.CreatedSwitchPort

Create Switch Ports

# Create internal switch port$ReturnObject = $VirtualSwitchService.CreateSwitchPort($CreatedSwitch, [guid]::NewGuid().ToString(), "Internal Switch Port", "")$InternalSwitchPort = [WMI]$ReturnObject.CreatedSwitchPort

# Create external switch port$ReturnObject = $VirtualSwitchService.CreateSwitchPort($CreatedSwitch, [guid]::NewGuid().ToString(), "External Switch Port", "")$ExternalSwitchPort = [WMI]$ReturnObject.CreatedSwitchPort

# Create VM switch port$ReturnObject = $VirtualSwitchService.CreateSwitchPort($CreatedSwitch, [guid]::NewGuid().ToString(), "MyVm Switch Port", "")$VmSwitchPort = [WMI]$ReturnObject.CreatedSwitchPort

Setup Switch

# Find an unbound physical NIC$PhysicalNic = get-wmiobject -namespace "root\virtualization" -Query "SELECT * FROM Msvm_ExternalEthernetPort WHERE IsBound=False" -computername "MyServer" | select –first 1

Setup Switch

# Find an unbound physical NIC$PhysicalNic = get-wmiobject -namespace "root\virtualization" -Query "SELECT * FROM Msvm_ExternalEthernetPort WHERE IsBound=False" -computername "MyServer" | select –first 1

# Call SetupSwitch to create internal and external connectivity$result = $VirtualSwitchService.SetupSwitch( $ExternalSwitchPort, $InternalSwitchPort, $PhysicalNic, [guid]::NewGuid().ToString(), "Internal Ethernet Port")

Connect Virtual Machine

$NicPool = Get-WmiObject -Namespace "root\virtualization" -Query "SELECT * FROM Msvm_ResourcePool WHERE ResourceType=10 AND ResourceSubType='Microsoft Emulated Ethernet Port'"

$NicCaps = Get-WmiObject –Namespace "root\virtualization" –Query "ASSOCIATORS OF {$NicPool} WHERE AssocClass=Msvm_ElementCapabilities ResultClass=Msvm_AllocationCapabilities"

$NicRasd = Get-WmiObject -Namespace "root\virtualization" -Query "REFERENCES OF {$NicCaps} WHERE ResultClass=Msvm_SettingsDefineCapabilities" | Where-Object {$_.ValueRole -eq 0} | ForEach-Object {[Wmi]$_.PartComponent})

Connect Virtual Machine

# Configure the settings for the virtual NIC$NicRasd.Connection[0] = $VmSwitchPort.__Path

# The AddVirtualSystemResources method takes an array of embedded instances of CIM_ResourceAllocationSettingData$RasdArray = [string[]]@($NicRasd.PSBase.GetText(1))

# Add the virtual NIC to the VM$result = $ManagementService.AddVirtualSystemResources($Vm, $RasdArray)

following up

Additional sessions Enabling Test Automation Using

Windows Server 2008 Hyper-V Thursday, Oct. 30th, 12:00 – 1:15 PM Room 403AB

Visit the hands-on-lab! Get hands on experience programming against

the Hyper-V WMI APIs with members of the Hyper-V team to answer your questions

Following Up

Evals & Recordings

Please fill

out your

evaluation for

this session at:

This session will be available as a recording at:

www.microsoftpdc.com

Please use the microphones provided

Q&A

© 2008 Microsoft Corporation. All rights reserved. Microsoft, Windows, Windows Vista and other product names are or may be registered trademarks and/or trademarks in the U.S. and/or other countries.The information herein is for informational purposes only and represents the current view of Microsoft Corporation as of the date of this presentation. Because Microsoft must respond to changing market

conditions, it should not be interpreted to be a commitment on the part of Microsoft, and Microsoft cannot guarantee the accuracy of any information provided after the date of this presentation. MICROSOFT MAKES NO WARRANTIES, EXPRESS, IMPLIED OR STATUTORY, AS TO THE INFORMATION IN THIS PRESENTATION.

Nihar Shah Senior Development Lead Microsoft Corporation ES10.

Documents