Retrieve ESX Hosts operation

The Retrieve ESX Hosts operation retrieves the known ESX hosts and configuration on a VMware VirtualCenter, filtered by the specified cluster.

The following table describes the elements for this request.

Adapter request elements for Retrieve ESX Hosts operation

Element	Definition	Required
<operation-type>	Defines the type of operation: Host	Yes
<operation-name>	Defines the name of operation: Retrieve_ESX_Hosts	Yes
<soap-url>	Specifies the URL for the remote SOAP service running on the VMware VirtualCenter If the <soap-url> element is not specified, the request uses the VirtualCenter Server details specified in the adapter configuration. Default format for HTTPS: https://<hostName>:<port>/sdk/vim Default format for HTTP: http://<hostName>:<port>/sdk/vim Note If you want to use an HTTP value, you might need to change the configuration of the VMware Infrastructure application.	No
<transport>	Specifies the transport protocol for the message If the <transport> element is not provided, the request uses the VirtualCenter Server details specified in the adapter configuration. Valid values: https-rpc (default), http-rpc Note If the value of the <transport> element is https-rpc, you must install the security certificate for the VMware Virtual Center to the keystore of the peer on which the adapter is enabled.	No
<user-name>	Specifies the user name that is used for HTTP basic authentication on the VMware Virtual Center If no user name is specified, the request is executed with the user name that is specified in the configuration.	No
<password>	Specifies the password corresponding to <user-name>	Conditional; required if <user-name> is specified
<parameters>	Contains the <host-system> element required to execute the operation	Yes
<cluster-compute-resource>	Specifies the name of the cluster from which to retrieve ESX Hosts The operation retrieves known ESX hosts and configuration on a VMware VirtualCenter, filtered by the specified cluster compute resource. If no value is specified, the operation retrieves all known hosts configured on the VMware VirtualCenter. Valid value: String	No

The following code sample shows a sample adapter request for the Retrieve ESX Hosts operation.

Sample adapter request for Retrieve ESX Hosts operation

<vmware-infrastructure-request>
<operation-type>Host</operation-type>
<operation-name>Retrieve_ESX_Hosts</operation-name>
<soap-url></soap-url>
<transport></transport>
<user-name></user-name>
<password></password>
<parameters>
<cluster-compute-resource>TestCluster</cluster-compute-resource>
</parameters>
</vmware-infrastructure-request>

The following figure shows the response for the sample Retrieve ESX Hosts operation.

Sample adapter response for Retrieve ESX Hosts operation

<vmware-infrastructure-response>
<metadata>
   <status>success</status>
</metadata>
<RetrieveESXHostsResponse>
   <returnval>
     <HostSystem>xyz.bmc.com</HostSystem>
     <propSet>
       <name>parent</name>
       <ClusterComputeResource>TestCluster</ClusterComputeResource>
     </propSet>
     <propSet>
       <name>summary</name>
       <HostListSummary>
         <HostSystem>xyz.bmc.com</HostSystem>
         <hardware>
           <vendor>Dell Inc.</vendor>
           <model>PowerEdge 1950</model>
           <uuid>44454c4c-3200-1035-8044-b2c04f314431</uuid>
           <memorySize>34359377920</memorySize>
           <cpuModel>Intel®) Xeon®) CPU L5320 @ 1.86GHz</cpuModel>
           <cpuMhz>1862</cpuMhz>
           <numCpuPkgs>2</numCpuPkgs>
           <numCpuCores>8</numCpuCores>
           <numCpuThreads>8</numCpuThreads>
           <numNics>2</numNics>
           <numHBAs>1</numHBAs>
         </hardware>
         <runtime>
           <connectionState>connected</connectionState>
           <inMaintenanceMode>false</inMaintenanceMode>
           <bootTime>2009-09-03T16:37:20.193435Z</bootTime>
         </runtime>
         <config>
           <name>abc.bmc.com</name>
           <port>443</port>
           <product>
             <name>VMware ESX Server</name>
             <fullName>VMware ESX Server 3.5.0 build-110268</fullName>
             <vendor>VMware, Inc.</vendor>
             <version>3.5.0</version>
             <build>110268</build>
             <localeVersion>INTL</localeVersion>
             <localeBuild>000</localeBuild>
             <osType>vmnix-x86</osType>
             <productLineId>esx</productLineId>
             <apiType>HostAgent</apiType>
             <apiVersion>2.5u2</apiVersion>
           </product>
           <vmotionEnabled>false</vmotionEnabled>
         </config>
         <quickStats>
           <overallCpuUsage>1952</overallCpuUsage>
           <overallMemoryUsage>10669</overallMemoryUsage>
           <distributedCpuFairness>2360</distributedCpuFairness>
           <distributedMemoryFairness>719</distributedMemoryFairness>
         </quickStats>
         <overallStatus>green</overallStatus>
         <rebootRequired>false</rebootRequired>
       </HostListSummary>
     </propSet>
   </returnval>
</RetrieveESXHostsResponse>
</vmware-infrastructure-response>

The following code sample describes the adapter response elements.

Adapter response elements for the Retrieve ESX Hosts operation

Element	Definition
<HostSystem>	Name of the ESX Host configured on the VMware Virtual Center Server
ClusterComputeResource	Represents the cluster to which the host system belongs
<HostListSummary>	Basic host statistics including basic configuration, hardware, and runtime information. The rebootRequired flag indicates whether the host requires a reboot due to a configuration change.

Retrieve ESX Hosts operation

On this page