Retrieve Selected Cluster Configuration Properties
The Retrieve Selected Cluster Configuration Properties operation retrieves selected properties for all virtual machines in a cluster.
The Retrieve Selected Cluster Configuration Properties operation enables you to specify properties that you want to retrieve.
The following table describes the elements for this request.
Element | Definition | Required |
---|---|---|
<operation-type> | Defines the type of the operation: Cluster | Yes |
<operation-name> | Defines the name of the operation: Retrieve_Selected_Cluster_Configuration_Properties | Yes |
<parameters> | Contains the elements required for the request | Yes |
<path-set-list> | Contains the <path-set> elements You can define more than one <path-set> element to retrieve the configuration properties of a specified cluster | Yes |
<path-set> | Specifies the actual cluster configuration properties to retrieve You can define more than one <path-set> element in the request. | Yes |
<prop-set> | Contains the <path-set> element required to run the request | Yes |
<spec-set> | Contains the <prop-set> element required to run the request | Yes |
<cluster-compute-resource> | Specifies the name of the cluster whose details are to be retrieved | Yes |
The following code sample shows the <items> XML for the Retrieve Selected Cluster Configuration Properties operation.
Sample <items> XML for the Retrieve Selected Cluster Configuration Properties operation
<item>
<parameters>
<cluster-compute-resource>TestCluster</cluster-compute-resource>
<spec-set>
<prop-set>
<path-set-list>
<!-- 1 or more repitition -->
<path-set>configuration</path-set>
<path-set>network</path-set>
<path-set>resourcePool</path-set>
<path-set>datastore</path-set>
</path-set-list>
</prop-set>
</spec-set>
</parameters>
</item>
</items>
The following code sample shows a sample adapter request for the Retrieve Selected Cluster Configuration Properties operation.
Sample adapter request for the Retrieve Selected Cluster Configuration Properties operation
<operation-type>Cluster</operation-type>
<operation-name>Retrieve_Selected_Cluster_Configuration_Properties</operation-name>
<parameters>
<cluster-compute-resource>TestCluster</cluster-compute-resource>
<spec-set>
<prop-set>
<path-set-list>
<!-- 1 or more repitition -->
<path-set>configuration</path-set>
<path-set>network</path-set>
<path-set>resourcePool</path-set>
<path-set>datastore</path-set>
</path-set-list>
</prop-set>
</spec-set>
</parameters>
</vmware-infrastructure-request>
The following code sample shows the adapter response for the Retrieve Selected Cluster Configuration Properties operation.
Adapter response for the request
<execution-duration>1578</execution-duration>
<status>success</status>
<messageBase64></messageBase64>
<data>
<vmware-infrastructure-response>
<metadata>
<status>success</status>
</metadata>
<RetrieveSelectedClusterConfigurationPropertiesResponse>
<returnval>
<ClusterComputeResource>domain-c7</ClusterComputeResource>
<propSet>
<name>configuration</name>
<ClusterConfigInfo>
<dasConfig>
<enabled>false</enabled>
<vmMonitoring>vmMonitoringDisabled</vmMonitoring>
<hostMonitoring>enabled</hostMonitoring>
<vmComponentProtecting>disabled</vmComponentProtecting>
<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>
<vmComponentProtectionSettings>
<vmStorageProtectionForAPD>disabled</vmStorageProtectionForAPD>
<enableAPDTimeoutForHosts>false</enableAPDTimeoutForHosts>
<vmTerminateDelayForAPDSec>180</vmTerminateDelayForAPDSec>
<vmReactionOnAPDCleared>none</vmReactionOnAPDCleared>
<vmStorageProtectionForPDL>disabled</vmStorageProtectionForPDL>
</vmComponentProtectionSettings>
</defaultVmSettings>
<hBDatastoreCandidatePolicy>allFeasibleDsWithUserPreference</hBDatastoreCandidatePolicy>
</dasConfig>
<drsConfig>
<enabled>true</enabled>
<enableVmBehaviorOverrides>true</enableVmBehaviorOverrides>
<defaultVmBehavior>fullyAutomated</defaultVmBehavior>
<vmotionRate>3</vmotionRate>
</drsConfig>
</ClusterConfigInfo>
</propSet>
<propSet>
<name>datastore</name>
<ArrayOfManagedObjectReference>
<Datastore>datastore-11</Datastore>
<Datastore>datastore-12</Datastore>
</ArrayOfManagedObjectReference>
</propSet>
<propSet>
<name>network</name>
<ArrayOfManagedObjectReference>
<Network>network-104</Network>
<Network>network-153</Network>
<Network>network-118</Network>
<Network>network-140</Network>
<Network>network-99</Network>
<Network>network-152</Network>
<Network>network-162</Network>
<Network>network-210</Network>
<Network>network-102</Network>
<Network>network-107</Network>
</ArrayOfManagedObjectReference>
</propSet>
<propSet>
<name>resourcePool</name>
<ResourcePool>resgroup-8</ResourcePool>
</propSet>
</returnval>
</RetrieveSelectedClusterConfigurationPropertiesResponse>
</vmware-infrastructure-response>
</data>
</adapter-response>