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
`<operation-type>`	Defines the type of operation: `Cluster`	Yes
`<operation-name>`	Defines the name of operation: `Retrieve_Clusters`	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 elements required to execute the operation	Yes

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

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>

The following code sample shows the response for the sample Retrieve Clusters operation.

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>`	Configuration of the VMware High Availability service and VMware DRS.
`<drsRecommendation>`	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.
`<migrationHistory>`	The set of migration decisions that have recently been performed This list is populated only when DRS is in automatic mode
`<datastore>`	A collection of references to the datastore objects in this datacenter available in the ComputeResource
`<host>`	List of hosts that are part of this compute resource If the compute resource is a standalone type, this list contains just one element.
`<network>`	The subset of network objects available in the datacenter that is available in this ComputeResource. This property is computed as the aggregate set of networks available from all the hosts that are part of this compute resource.
`<resourcePool>`	Reference to root resource pool
`<environmentBrowser>`	The environment browser object that identifies the environments that are supported on this compute resource.
`<summary>`	Basic runtime information about a compute resource This information is used on summary screens and in list views.

Retrieve Clusters operation

Comments