Retrieve Host Memory Usage operation

The Retrieve Host Memory Usage operation enables you to retrieve the memory size and current memory usage for the specified host system.

The following table describes the elements for the adapter request.

Adapter request elements for the Retrieve Host Memory Usage operation

Element	Definition	Required
<operation-type>	Defines the type of operation: Host	Yes
<operation-name>	Defines the name of operation: Retrieve_Host_Memory_Usage	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
<host-system>	DNS name of the host for which the network configuration details are to be retrieved Valid values: dns name	Yes

The following code sample shows the sample adapter request for the Retrieve Host Memory Usage operation.

Sample adapter request for the Retrieve Host Memory Usage operation

<vmware-infrastructure-request>
   <operation-type>Host</operation-type>
   <operation-name>Retrieve_Host_Memory_Usage</operation-name>
   <soap-url></soap-url>
   <transport></transport>
   <user-name></user-name>
   <password></password>
   <parameters>
<host-system>xyz.bmc.com</host-system>
   </parameters>
</vmware-infrastructure-request>

The following code sample shows the response for the sample Retrieve Host Memory Usage operation.

Sample adapter response for the Retrieve Host Memory Usage operation

    <vmware-infrastructure-response>
     <metadata>
       <status>success</status>
     </metadata>
     <RetrieveHostMemoryUsage>
       <returnval>
         <HostSystem>host-649</HostSystem>
         <propSet>
           <name>hardware.memorySize</name>
           <val>111663587328</val>
         </propSet>
         <propSet>
           <name>summary.quickStats.overallMemoryUsage</name>
           <val>56573820928</val>
         </propSet>
         <propSet>
           <name>systemResources.config.memoryAllocation.reservation</name>
           <val>98249</val>
         </propSet>
       </returnval>
     </RetrieveHostMemoryUsage>
   </vmware-infrastructure-response>

The following table shows the response elements for the Retrieve Host Memory Usage operation:

Adapter response elements for the Retrieve Host Memory Usage operation

Element	Definition
<name>	Contains specific physical memory properties on the host system <memorySize>: Contains the total amount of physical memory available on the host system, in bytes <overallMemoryUsage>: Contains the physical memory usage of the host system, in bytes. This element is available only if the host is connected. <reservation>: Contains the physical memory reserved on the host for allocation to VMs, in MB

Retrieve Host Memory Usage operation

On this page