Hyper-V How To: Get a Custom KVPS using Script

  • Article

Some friends here on the Hyper-V team shared a PowerShell 2.0 script for getting a custom KVPS:

# Get Custom KVPs

param(
    [string]$vmName = $(throw "Must specify virtual machine name")
)

$vm = gwmi -namespace root\virtualization Msvm_ComputerSystem -filter "ElementName='$vmName'"

# Get the associated KVP Exchange component
$kvp = gwmi -namespace root\virtualization `
    -query "Associators of {$vm} where ResultClass=Msvm_KvpExchangeComponent"

# Pull the Guest Exchange Items from XML into a hash
$kvpHash = @{}
if($kvp.GuestExchangeItems){
    ([xml]("<xml>"+$kvp.GuestExchangeItems+"</xml>")).xml.instance | `
        foreach{$kvphash.add($_.property[4].value,$_.property[1].value)}
}
return $kvpHash

 

For more info on how to use PS cmdlets see: https://www.microsoft.com/technet/scriptcenter/topics/msh/cmdlets/index.mspx

See also James O’Neil’s New and improved PowerShell Library for Hyper-V. Now with more functions and... documentation!

For all 35 sample Hyper-V PS1 scripts in a zipfile, go to: Hyper-V%20PowerShell%20Example%20Scripts.zip-download