Getting value for the VirtualGuestDestination element

You can get the VirtualGuestDestination element values for the following environments:

• VMware destination
• IBM destination
• Oracle Solaris destination
• Citrix destination
• RHEV destination
• Hyper-V destination

VMware destination

The VirtualGuestDestination element can be a cluster, ESX host, or resource pool. To get the VirtualGuestDestination element values, use the listVirtualEntitiesByEntityManagerServerIdAndEntityType command, passing in the following strings for EntityType:

• If the destination is a cluster, use VMwareCluster.
• If the destination is an ESX host, use VMwareESXServer.
• If the destination is a resource pool, use VMwareResourcePool.

The following example shows you how to get the VirtualGuestDestination element value for a cluster:

1. Get the server ID of the vCenter server, as described in Getting the server ID - vCenter server. For the purpose of this example, assume the server ID is 1.

2. Use the listVirtualEntitiesByEntityManagerServerIdAndEntityType command to get the VirtualGuestDestination element value for the cluster. This command takes 2 arguments — ServerId and EntityType. You already have the ServerId (1). Because you want a cluster, you specify VMwareCluster as EntityType:

   Command	Virtualization listVirtualEntitiesByEntityManagerServerIdAndEntityType 1 VMwareCluster
   Output format	Name::EntityKey
   Output example	MyCluster::1 VMWareCluster domain-c192

   The VirtualGuestDestinationelement uses the EntityKey, so in this example you would specify the following:

   <VirtualGuestDestination>1 VMWareCluster domain-c192</VirtualGuestDestination>

IBM destination

The VirtualGuestDestination element uses the server ID of an IBM Frame. To get the ID of the IBM Frame, use the listVirtualEntityManagers command, pass in an EntityType argument that specifies an IBM Frame (ManagedSystem):

The VirtualGuestDestination element uses the server ID, so in this example you would specify the following:

Oracle Solaris destination

The VirtualGuestDestination element uses the server ID of a Solaris Global Zone.
 To get the ID of the zone, use the listVirtualEntityManagers command, passing in an EntityType argument that specifies a Solaris Global Zone (SolarisGlobalZone):

The VirtualGuestDestination element uses the server ID, so in this example you would specify:

Citrix destination

The VirtualGuestDestination element is either a pool or a XenServer host. To get the VirtualGuestDestination element values, use the listVirtualEntitiesByEntityManagerServerIdAndEntityType command, passing in the following strings for EntityType:

• If the destination is a pool, use CitrixXenServerPool.
• If the destination is an XenServer host, use CitrixXenServerHost.

The following example shows you how to get the VirtualGuestDestination element value for a XenServer host:

1. Get the server ID of the XenServer. To do this, use the listVirtualEntityManagers command, passing in the EntityTypeargument CitrixXenServer:

   Command	Virtualization listVirtualEntityManagers CitrixXenServer
   Output format	ServerId::ServerName
   Output example	1::MyXenServer

2. Use the listVirtualEntitiesByEntityManagerServerIdAndEntityType command to get the VirtualGuestDestination element value for the XenServer host. This command takes 2 arguments — ServerId and EntityType. You already have the ServerId (1). Because you want a XenServer host, you specify CitrixXenServerHost as EntityType:

   Command	Virtualization listVirtualEntitiesByEntityManagerServerIdAndEntityType 1 CitrixXenServerHost
   Output format	Name::EntityKey
   Output example	MyXenServer::1 CitrixXenServerHost pun-blg-xen02.myCompany.com

   The VirtualGuestDestinationelement uses the EntityKey, so in this example you would specify the following:

   <VirtualGuestDestination>1 CitrixXenServerHost pun-blg-xen02.myCompany.com</VirtualGuestDestination>

RHEV destination

The VirtualGuestDestination element can be a cluster or a host. To get the VirtualGuestDestination element values, use the listVirtualEntitiesByEntityManagerServerIdAndEntityType command, passing in the following strings for EntityType:

• If the destination is a cluster, use Cluster.
• If the destination is a host, use Host.

The following example shows how to get the VirtualGuestDestination element value for a cluster:

1. Get the server ID of the RHEVManager server, as described in To get the server ID - RHEVManager. For the purpose of this example, assume the server ID is 1.

2. Use the listVirtualEntitiesByEntityManagerServerIdAndEntityType command to get the VirtualGuestDestination element value for the cluster. This command takes 2 arguments — ServerId and EntityType. You already have the ServerId (1). Because you want a cluster, you specify Cluster as EntityType:

   Command	Virtualization listVirtualEntitiesByEntityManagerServerIdAndEntityType 1 Cluster
   Output format	Name::EntityKey
   Output example	MyCluster::1 Cluster 0

   The VirtualGuestDestinationelement uses the EntityKey, so in this example you would specify the following:

   <VirtualGuestDestination>1 Cluster 0</VirtualGuestDestination>

Hyper-V destination

The VirtualGuestDestination element is the Hyper-V host.

1. Get the server ID of the Hyper-V host, as described in To get the server ID - Microsoft Virtual Machine Manager. For the purpose of this example, assume the server ID is 1.

2. Use the listVirtualEntitiesByEntityManagerServerIdAndEntityType command to get the VirtualGuestDestination element value for the Hyper-V host. This command takes 2 arguments — ServerId and EntityType. You already have the ServerId (1). Because you want a Hyper-V host, you specify Host as EntityType:

   Command	Virtualization listVirtualEntitiesByEntityManagerServerIdAndEntityType 1 Host
   Output format	Name::EntityKey
   Output example	MyHyperVHost::102 Host MyHyperVHost

   The VirtualGuestDestinationelement uses the EntityKey, so in this example you would specify the following:

   <VirtualGuestDestination>102 Host MyHyperVHost</VirtualGuestDestination>