If you’re looking at upgrading to vSphere, one thing that may come in handy is an easy and flexible way to move custom fields from your old vCenter to your new one. With PowerCLI this is quite easy… except for one thing: there is no Get-CustomField cmdlet! The why is a long story but it turns out it’s pretty easy to write just such a thing. In fact here it is:
|
1 |
<span style="color: #cc6633;">function</span> Get-CustomField { |
|
1 |
param($item) |
|
1 |
  |
|
1 |
foreach ($cf in $item.CustomFields) { |
|
1 |
<span style="color: #0000ff;">if</span> ($cf.Value) { |
|
1 |
$field = <span style="color: #006080;">""</span> | Select Key, Value, EntityName |
|
1 |
$field.Key = $cf.Key |
|
1 |
$field.Value = $cf.Value |
|
1 |
$field.EntityName = $item.Name |
|
1 |
Write-Output $field |
|
1 |
} |
|
1 |
} |
|
1 |
} |
Not too hard at all, really. So how do we use this? One nice feature of PowerCLI that often gets overlooked is its ability to connect to multiple vCenters at once and manage them all. We can take advantage of this to connect to both our old vCenter and our new one, and move the values directly between them. The way this works is to store the output of Connect-VIServer in a variable, then pass this variable to later cmdlets to specify the server you want to manage. For example:
|
1 |
$server1 = Connect-VIServer vcserver1 |
|
1 |
$server2 = Connect-VIServer vcserver2 |
This next bit of code will take all custom fields on all VMs in vcserver1 and transfer them to vcserver2. This assumes the VMs already exist in both locations.
|
1 |
$fields = Get-VM -server $server1 | Foreach { Get-CustomField $_ } |
|
1 |
$vms = Get-VM -server $server2 |
|
1 |
foreach ($field in $fields) { |
|
1 |
$vm = $vms | Where { $_.Name -eq $field.EntityName } |
|
1 |
Set-CustomField -Entity $vm -Name $field.Key -Value $field.Value |
|
1 |
} |
That’s really all there is to it. If you need to transfer custom fields on more than just VMs, say maybe you also have fields on ESX hosts, you can use a more general bit of code that will do this for all types of objects. I’ve added that example to my script repository and you can download it here.
