Retrieve Clusters operation
The Retrieve Clusters operation retrieves all known clusters and configuration on a VMware VirtualCenter.
The following table describes the elements for this request.
Adapter request elements for the Retrieve Clusters operation
Element |
Definition |
Required |
---|---|---|
|
Defines the type of operation: |
Yes |
|
Defines the name of operation: |
Yes |
|
Specifies the URL for the remote SOAP service running on the VMware VirtualCenter Note If you want to use an HTTP value, you might need to change the configuration of the VMware Infrastructure application. |
No |
|
Specifies the transport protocol for the message Note If the value of the |
No |
|
Specifies the user name that is used for HTTP basic authentication on the VMware Virtual Center |
No |
|
Specifies the password corresponding to |
Conditional; required if |
|
Contains the elements required to execute the operation |
Yes |
Sample adapter request for the Retrieve Clusters operation
<vmware-infrastructure-request> <operation-type>Cluster</operation-type> <operation-name>Retrieve_Clusters</operation-name> <soap-url></soap-url> <transport></transport> <user-name></user-name> <password></password> <parameters></parameters> </vmware-infrastructure-request>
Sample adapter response for the Retrieve Clusters operation
<vmware-infrastructure-response> <metadata> <status>success</status> </metadata> <RetrieveClustersResponse> <returnval> <ClusterComputeResource>Testcluster</ClusterComputeResource> <propSet> <name>configIssue</name> <ArrayOfEvent></ArrayOfEvent> </propSet> <propSet> <name>configStatus</name> <ManagedEntityStatus>green</ManagedEntityStatus> </propSet> <propSet> <name>configuration</name> <ClusterConfigInfo> <dasConfig> <enabled>false</enabled> <failoverLevel>1</failoverLevel> <admissionControlEnabled>true</admissionControlEnabled> </dasConfig> <drsConfig> <enabled>true</enabled> <defaultVmBehavior>fullyAutomated</defaultVmBehavior> <vmotionRate>3</vmotionRate> </drsConfig> </ClusterConfigInfo> </propSet> <propSet> <name>customValue</name> <ArrayOfCustomFieldValue></ArrayOfCustomFieldValue> </propSet> <propSet> <name>datastore</name> <ArrayOfManagedObjectReference></ArrayOfManagedObjectReference> </propSet> <propSet> <name>declaredAlarmState</name> <ArrayOfAlarmState> <AlarmState> <key>alarm-1.domain-c1500</key> <ClusterComputeResource>Testcluster</ClusterComputeResource> <Alarm>alarm-1</Alarm> <overallStatus>gray</overallStatus> <time>2009-11-17T06:48:19.109375Z</time> </AlarmState> </ArrayOfAlarmState> </propSet> <propSet> <name>disabledMethod</name> <ArrayOfString></ArrayOfString> </propSet> <propSet> <name>drsRecommendation</name> <ArrayOfClusterDrsRecommendation></ArrayOfClusterDrsRecommendation> </propSet> <propSet> <name>effectiveRole</name> <ArrayOfInt> <int>1</int> </ArrayOfInt> </propSet> <propSet> <name>host</name> <ArrayOfManagedObjectReference></ArrayOfManagedObjectReference> </propSet> <propSet> <name>migrationHistory</name> <ArrayOfClusterDrsMigration></ArrayOfClusterDrsMigration> </propSet> <propSet> <name>name</name> <val>Testcluster</val> </propSet> <propSet> <name>network</name> <ArrayOfManagedObjectReference></ArrayOfManagedObjectReference> </propSet> <propSet> <name>overallStatus</name> <ManagedEntityStatus>green</ManagedEntityStatus> </propSet> <propSet> <name>parent</name> <Folder>host</Folder> </propSet> <propSet> <name>permission</name> <ArrayOfPermission></ArrayOfPermission> </propSet> <propSet> <name>recentTask</name> <ArrayOfManagedObjectReference></ArrayOfManagedObjectReference> </propSet> <propSet> <name>resourcePool</name> <ResourcePool>resgroup-1502</ResourcePool> </propSet> <propSet> <name>summary</name> <ClusterComputeResourceSummary> <totalCpu>0</totalCpu> <totalMemory>0</totalMemory> <numCpuCores>0</numCpuCores> <numCpuThreads>0</numCpuThreads> <effectiveCpu>0</effectiveCpu> <effectiveMemory>0</effectiveMemory> <numHosts>0</numHosts> <numEffectiveHosts>0</numEffectiveHosts> <overallStatus>green</overallStatus> <currentFailoverLevel>-1</currentFailoverLevel> <numVmotions>0</numVmotions> </ClusterComputeResourceSummary> </propSet> <propSet> <name>triggeredAlarmState</name> <ArrayOfAlarmState></ArrayOfAlarmState> </propSet> </returnval> <returnval> <ClusterComputeResource>R1</ClusterComputeResource> <propSet> <name>configIssue</name> <ArrayOfEvent></ArrayOfEvent> </propSet> <propSet> <name>configStatus</name> <ManagedEntityStatus>green</ManagedEntityStatus> </propSet> <propSet> <name>configuration</name> <ClusterConfigInfo> <dasConfig> <enabled>false</enabled> <failoverLevel>1</failoverLevel> <admissionControlEnabled>true</admissionControlEnabled> </dasConfig> <drsConfig> <enabled>true</enabled> <defaultVmBehavior>fullyAutomated</defaultVmBehavior> <vmotionRate>3</vmotionRate> </drsConfig> </ClusterConfigInfo> </propSet> <propSet> <name>customValue</name> <ArrayOfCustomFieldValue></ArrayOfCustomFieldValue> </propSet> <propSet> <name>datastore</name> <ArrayOfManagedObjectReference></ArrayOfManagedObjectReference> </propSet> <propSet> <name>declaredAlarmState</name> <ArrayOfAlarmState> <AlarmState> <key>alarm-5.domain-c4676</key> <ClusterComputeResource>R1</ClusterComputeResource> <Alarm>alarm-5</Alarm> <overallStatus>gray</overallStatus> <time>2009-11-17T06:48:19.125Z</time> </AlarmState> </ArrayOfAlarmState> </propSet> <propSet> <name>disabledMethod</name> <ArrayOfString></ArrayOfString> </propSet> <propSet> <name>drsRecommendation</name> <ArrayOfClusterDrsRecommendation></ArrayOfClusterDrsRecommendation> </propSet> <propSet> <name>effectiveRole</name> <ArrayOfInt> <int>1</int> </ArrayOfInt> </propSet> <propSet> <name>host</name> <ArrayOfManagedObjectReference></ArrayOfManagedObjectReference> </propSet> <propSet> <name>migrationHistory</name> <ArrayOfClusterDrsMigration></ArrayOfClusterDrsMigration> </propSet> <propSet> <name>name</name> <val>Ranga</val> </propSet> <propSet> <name>network</name> <ArrayOfManagedObjectReference></ArrayOfManagedObjectReference> </propSet> <propSet> <name>overallStatus</name> <ManagedEntityStatus>green</ManagedEntityStatus> </propSet> <propSet> <name>parent</name> <Folder>host</Folder> </propSet> <propSet> <name>permission</name> <ArrayOfPermission></ArrayOfPermission> </propSet> <propSet> <name>recentTask</name> <ArrayOfManagedObjectReference></ArrayOfManagedObjectReference> </propSet> <propSet> <name>resourcePool</name> <ResourcePool>resgroup-4678</ResourcePool> </propSet> <propSet> <name>summary</name> <ClusterComputeResourceSummary> <totalCpu>0</totalCpu> <totalMemory>0</totalMemory> <numCpuCores>0</numCpuCores> <numCpuThreads>0</numCpuThreads> <effectiveCpu>0</effectiveCpu> <effectiveMemory>0</effectiveMemory> <numHosts>0</numHosts> <numEffectiveHosts>0</numEffectiveHosts> <overallStatus>green</overallStatus> <currentFailoverLevel>-1</currentFailoverLevel> <numVmotions>0</numVmotions> </ClusterComputeResourceSummary> </propSet> <propSet> <name>triggeredAlarmState</name> <ArrayOfAlarmState></ArrayOfAlarmState> </propSet> </returnval> <returnval> <ClusterComputeResource>DRS Cluster TEST</ClusterComputeResource> <propSet> <name>configIssue</name> <ArrayOfEvent></ArrayOfEvent> </propSet> <propSet> <name>configStatus</name> <ManagedEntityStatus>green</ManagedEntityStatus> </propSet> <propSet> <name>configuration</name> <ClusterConfigInfo> <dasConfig> <enabled>false</enabled> <failoverLevel>1</failoverLevel> <admissionControlEnabled>true</admissionControlEnabled> </dasConfig> <drsConfig> <enabled>true</enabled> <defaultVmBehavior>manual</defaultVmBehavior> <vmotionRate>3</vmotionRate> </drsConfig> </ClusterConfigInfo> </propSet> <propSet> <name>customValue</name> <ArrayOfCustomFieldValue></ArrayOfCustomFieldValue> </propSet> <propSet> <name>datastore</name> <ArrayOfManagedObjectReference> <Datastore>datastore-11</Datastore> <Datastore>datastore-13</Datastore> <Datastore>datastore-15</Datastore> </ArrayOfManagedObjectReference> </propSet> <propSet> <name>declaredAlarmState</name> <ArrayOfAlarmState> <AlarmState> <key>alarm-1.domain-c614</key> <ClusterComputeResource>DRS Cluster TEST</ClusterComputeResource> <Alarm>alarm-1</Alarm> <overallStatus>gray</overallStatus> <time>2009-11-17T06:48:19.09375Z</time> </AlarmState> </ArrayOfAlarmState> </propSet> <propSet> <name>disabledMethod</name> <ArrayOfString></ArrayOfString> </propSet> <propSet> <name>drsRecommendation</name> <ArrayOfClusterDrsRecommendation></ArrayOfClusterDrsRecommendation> </propSet> <propSet> <name>effectiveRole</name> <ArrayOfInt> <int>1</int> </ArrayOfInt> </propSet> <propSet> <name>environmentBrowser</name> <EnvironmentBrowser>envbrowser-614</EnvironmentBrowser> </propSet> <propSet> <name>host</name> <ArrayOfManagedObjectReference> <HostSystem>dev1.bmc.com</HostSystem> </ArrayOfManagedObjectReference> </propSet> <propSet> <name>migrationHistory</name> <ArrayOfClusterDrsMigration></ArrayOfClusterDrsMigration> </propSet> <propSet> <name>name</name> <val>DRS Cluster TEST</val> </propSet> <propSet> <name>network</name> <ArrayOfManagedObjectReference> <Network>network-3570</Network> <Network>network-17</Network> </ArrayOfManagedObjectReference> </propSet> <propSet> <name>overallStatus</name> <ManagedEntityStatus>green</ManagedEntityStatus> </propSet> <propSet> <name>parent</name> <Folder>host</Folder> </propSet> <propSet> <name>permission</name> <ArrayOfPermission> <Permission> <ClusterComputeResource>DRS Cluster TEST</ClusterComputeResource> <principal>qauser</principal> <group>false</group> <roleId>1</roleId> <propagate>true</propagate> </Permission> </ArrayOfPermission> </propSet> <propSet> <name>recentTask</name> <ArrayOfManagedObjectReference></ArrayOfManagedObjectReference> </propSet> <propSet> <name>resourcePool</name> <ResourcePool>resgroup-616</ResourcePool> </propSet> <propSet> <name>summary</name> <ClusterComputeResourceSummary> <totalCpu>14896</totalCpu> <totalMemory>34359377920</totalMemory> <numCpuCores>8</numCpuCores> <numCpuThreads>8</numCpuThreads> <effectiveCpu>14430</effectiveCpu> <effectiveMemory>29922</effectiveMemory> <numHosts>1</numHosts> <numEffectiveHosts>1</numEffectiveHosts> <overallStatus>green</overallStatus> <currentFailoverLevel>-1</currentFailoverLevel> <numVmotions>0</numVmotions> </ClusterComputeResourceSummary> </propSet> <propSet> <name>triggeredAlarmState</name> <ArrayOfAlarmState></ArrayOfAlarmState> </propSet> </returnval> </RetrieveClustersResponse> </vmware-infrastructure-response>
The following table describes the response elements.
Adapter response elements for the Retrieve_Clusters operation
Element |
Definition |
---|---|
|
Configuration of the VMware High Availability service and VMware DRS. |
|
If DRS is enabled, this returns the set of recommended migrations from the DRS module. Even if DRS is enabled, the current set of recommendations may be empty, since there may be no recommended migrations at this time. If DRS is not enabled, always returns an empty list. |
|
The set of migration decisions that have recently been performed |
|
A collection of references to the datastore objects in this datacenter available in the ComputeResource |
|
List of hosts that are part of this compute resource |
|
The subset of network objects available in the datacenter that is available in this ComputeResource. |
|
Reference to root resource pool |
|
The environment browser object that identifies the environments that are supported on this compute resource. |
|
Basic runtime information about a compute resource |
Comments
Log in or register to comment.