Retrieve Cluster Datastore Configuration operation

The Retrieve Cluster Datastore Configuration operation retrieves the datastore configuration of a cluster including total space and free space.

The following table describes the elements for this request.

Adapter request elements for the Retrieve Cluster Datastore 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_Datastore_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 datastore configuration details are to be retrieved Valid value: Any string	Yes

The following code sample shows a sample adapter request for the Retrieve Cluster Datastore Configuration operation.

Sample adapter request for the Retrieve Cluster Datastore Configuration operation

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

The following code sample shows the response for the sample Retrieve Cluster Datastore Configuration operation.

Sample adapter response for the Retrieve Cluster Datastore Configuration operation

<vmware-infrastructure-response>
    <metadata>
        <status>success</status>
    </metadata>
    <RetrieveClusterDatastoreConfigurationResponse>
        <returnval>
            <Datastore>datastore-11</Datastore>
            <propSet>
                <name>summary</name>
                <DatastoreSummary>
                    <Datastore>datastore-11</Datastore>
                    <name>dev15 disk1</name>
                    <url>sanfs://vmfs_uuid:470e81f0-32b2d06a-a25c-0019b9e1c5fe/</url>
                    <capacity>65229815808</capacity>
                    <freeSpace>6728712192</freeSpace>
                    <accessible>true</accessible>
                    <multipleHostAccess>false</multipleHostAccess>
                    <type>VMFS</type>
                </DatastoreSummary>
            </propSet>
        </returnval>
        <returnval>
            <Datastore>datastore-13</Datastore>
            <propSet>
                <name>summary</name>
                <DatastoreSummary>
                    <Datastore>datastore-13</Datastore>
                    <name>dev15 disk2</name>
                    <url>sanfs://vmfs_uuid:478d1b24-552c354d-c670-0019b9e1c5fe/</url>
                    <capacity>73282879488</capacity>
                    <freeSpace>14814281728</freeSpace>
                    <accessible>true</accessible>
                    <multipleHostAccess>false</multipleHostAccess>
                    <type>VMFS</type>
                </DatastoreSummary>
            </propSet>
        </returnval>
        <cluster-compute-resource>DRS Cluster TEST</cluster-compute-resource>
    </RetrieveClusterDatastoreConfigurationResponse>
</vmware-infrastructure-response>

The following table describes the response elements.

Adapter response elements for the Retrieve Cluster Datastore Configuration operation

Element	Definition
`<accessible>`	The connectivity status of this datastore A value of false, meaning the datastore is not accessible and the this datastore capacity and free space properties cannot be validated.
`<capacity>`	Maximum capacity of this datastore, in bytes
`<freeSpace>`	Available space of this datastore, in bytes
`<multipleHostAccess>`	If it set to true, means more than one host in the datacenter has been configured with access to the datastore
`<name>`	The name of the datastore
`<type>`	Type of file system volume, such as VMFS or NFS

Retrieve Cluster Datastore Configuration operation

Comments