Retrieve Cluster Configuration operation

Unknown macro: {multi-excerpt} The Retrieve Cluster Configuration operation retrieves the configuration details of a cluster including Distributed Resource Scheduler (DRS) settings.

Unknown macro: {multi-excerpt} The following table describes the elements for this request.

Unknown macro: {multi-excerpt}

Adapter request elements for the Retrieve Cluster Configuration operation

Element	Definition	Required
`<operation-type>`	Defines the type of the operation: `Cluster`	Yes
`<operation-name>`	Defines the name of the operation: `Retrieve_Cluster_Configuration`	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 `<cluster-compute-resource>` element required to execute the operation	Yes
`<cluster-compute-resource>`	Specifies the name of the cluster whose details are to be retrieved Valid value: Any string	Yes

Unknown macro: {multi-excerpt} The following code sample shows a sample adapter request for the Retrieve Cluster Configuration operation.

Unknown macro: {multi-excerpt}

Sample adapter request for the Retrieve Cluster Configuration operation

<vmware-infrastructure-request>
    <operation-type>Cluster</operation-type>
    <operation-name>Retrieve_Cluster_Configuration</operation-name>
    <soap-url></soap-url>                    
    <transport></transport>
    <username></username>
    <password></password>
    <parameters>
        <cluster-compute-resource>DRS Cluster TEST</cluster-compute-resource>
   </parameters>
</vmware-infrastructure-request>

Unknown macro: {multi-excerpt} The following code sample shows the response for the sample Retrieve Cluster Configuration operation.

Unknown macro: {multi-excerpt}

Sample adapter response for the Retrieve Cluster Configuration operation

<vmware-infrastructure-response>
    <metadata>
        <status>success</status>
    </metadata>
    <RetrieveClusterConfigurationResponse>
    <returnval>
    <ClusterComputeResource>DRS Cluster TESTdomain</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>configurationEx</name>
            <ClusterConfigInfoEx>
              <vmSwapPlacement>vmDirectory</vmSwapPlacement>
              <spbmEnabled>true</spbmEnabled>
              <dasConfig>
                <enabled>false</enabled>
                <vmMonitoring>vmMonitoringDisabled</vmMonitoring>
                <hostMonitoring>enabled</hostMonitoring>
                <failoverLevel>1</failoverLevel>
                <ClusterFailoverLevelAdmissionControlPolicy>
                  <failoverLevel>1</failoverLevel>
                </ClusterFailoverLevelAdmissionControlPolicy>
                <admissionControlEnabled>true</admissionControlEnabled>
                <defaultVmSettings>
                  <restartPriority>medium</restartPriority>
                  <isolationResponse>none</isolationResponse>
                  <vmToolsMonitoringSettings>
                    <enabled>true</enabled>
                    <vmMonitoring>vmMonitoringOnly</vmMonitoring>
                    <clusterSettings>true</clusterSettings>
                    <failureInterval>30</failureInterval>
                    <minUpTime>120</minUpTime>
                    <maxFailures>3</maxFailures>
                    <maxFailureWindow>3600</maxFailureWindow>
                  </vmToolsMonitoringSettings>
                </defaultVmSettings>
                <option>
                  <key>das.ignoreRedundantNetWarning</key>
                  <value>true</value>
                </option>
                <hBDatastoreCandidatePolicy>allFeasibleDsWithUserPreference</hBDatastoreCandidatePolicy>
              </dasConfig>
              <dasVmConfig>
                <VirtualMachine>vse-PRIVATE  192 (1f973cc0-3b25-4eab-afbb-74c730a73206)-0</VirtualMachine>
                <restartPriority>high</restartPriority>
                <dasSettings>
                  <restartPriority>high</restartPriority>
                  <isolationResponse>clusterIsolationResponse</isolationResponse>
                  <vmToolsMonitoringSettings></vmToolsMonitoringSettings>
                </dasSettings>
              </dasVmConfig>
              <dasVmConfig>
                <VirtualMachine>vse-jaitestnw (e4873847-0bd7-48af-a44e-3270c850104f)-0</VirtualMachine>
                <restartPriority>high</restartPriority>
                <dasSettings>
                  <restartPriority>high</restartPriority>
                  <isolationResponse>clusterIsolationResponse</isolationResponse>
                  <vmToolsMonitoringSettings></vmToolsMonitoringSettings>
                </dasSettings>
              </dasVmConfig>
              <drsConfig>
                <enabled>true</enabled>
                <enableVmBehaviorOverrides>true</enableVmBehaviorOverrides>
                <defaultVmBehavior>manual</defaultVmBehavior>
                <vmotionRate>3</vmotionRate>
              </drsConfig>
              <drsVmConfig>
                <VirtualMachine>Test-VM1</VirtualMachine>
                <enabled>true</enabled>
                <behavior>manual</behavior>
              </drsVmConfig>
              <dpmConfigInfo>
                <enabled>false</enabled>
                <defaultDpmBehavior>automated</defaultDpmBehavior>
                <hostPowerActionRate>3</hostPowerActionRate>
              </dpmConfigInfo>
              <ClusterVmGroup>
                <name>BMCVmDRSGroup</name>
                <VirtualMachine>win2k8-64bit-vcenter-server</VirtualMachine>
                <VirtualMachine>Cloneed-win2k8-vm</VirtualMachine>
              </ClusterVmGroup>
              <ClusterHostGroup>
                <name>BMCHostDRSGroup</name>
                <HostSystem>xyz.bmc.com</HostSystem>
              </ClusterHostGroup>
            </ClusterConfigInfoEx>
          </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>domain-c614</ClusterComputeResource>
            <Alarm>alarm-1</Alarm>
            <overallStatus>gray</overallStatus>
            <time>2009-08-24T14:12:24.171875Z</time>
        </AlarmState>
        <AlarmState>
            <key>alarm-104.domain-c614</key>
            <ClusterComputeResource>domain-c614</ClusterComputeResource>
            <Alarm>alarm-104</Alarm>
            <overallStatus>gray</overallStatus>
            <time>2009-08-24T14:12:24.296875Z</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>xyz.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-3587</Network>
        </ArrayOfManagedObjectReference>
    </propSet>
    <propSet>
        <name>overallStatus</name>
        <ManagedEntityStatus>green</ManagedEntityStatus>
    </propSet>
    <propSet>
        <name>parent</name>
        <Folder>group-h4</Folder>
    </propSet>
    <propSet>
        <name>permission</name>
        <ArrayOfPermission>
          <Permission>
               <ClusterComputeResource>domain-c614</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>29930</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>
    </RetrieveClusterConfigurationResponse>
</vmware-infrastructure-response>

Unknown macro: {multi-excerpt} The following table describes the response elements.

Unknown macro: {multi-excerpt}

Adapter response elements for the Retrieve Cluster Configuration operation

Element	Definition
`<configuration>`	Configuration of the VMware HA service (HA) and VMware DRS
`<drsRecommendation>`	If DRS is enabled, this element returns a 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 been recently performed

Retrieve Cluster Configuration operation

Comments