Vsan Vc Cluster Config System Vsan Cluster Get Claimed Capacity

Vsan Vc Cluster Config System Vsan Cluster Get Claimed Capacity

Get total raw capacity in bytes for all disks claimed in a vSAN cluster.

In the case of ESA, that includes all disks in the storage pool. In the case of OSA, that includes the capacity tier disks but not the cache disks as the latter does not contribute to capacity. The same value is reported to the licensing service for capacity entitlement purposes. Note that it differs from vSAN datastore capacity in two ways. First, it is based on raw capacity reported by the disk vendor, which includes any and all overhead reserved internally by vSAN. Secondly, it reflects the cluster configuration, which is not affected by the runtime state of the cluster, such as disk health, host health, and network partition. The claimed capacity is initialized in an async process after enabling vSAN, so it is possible that the claimed capacity value is not ready yet when vSAN is still in initialization phase. In this case, API caller can retry in a short period of time.

Since: 8.0.0.4

Request
URI
POST
https://{api_host}/sdk/vim25/{release}/vsan/VsanVcClusterConfigSystem/{moId}/VsanClusterGetClaimedCapacity
COPY
Path Parameters
string
moId
Required

The unique identifier for the managed object to which the method attaches; the serialized managed object reference for a request has the form moType/moId, in this case VsanVcClusterConfigSystem/{moId}.

string
release
Required

The vSphere release schema. The current specification covers vSphere 9.0.0.0 APIs.


Request Body
VsanClusterGetClaimedCapacityRequestType of type(s) application/json
Required
"VsanClusterGetClaimedCapacityRequestType Object"
cluster
Required

The target vCenter cluster.

Required privileges: System.Read

Authentication
This operation uses the following authentication methods.
Responses
200

The total claimed disk capacity in raw bytes.

Returns integer of type(s) application/json
Operation doesn't return any data structure

500

InvalidState: if the capacity value has not been initialized.

NotSupported: if the cluster has not enabled vSAN.

Returns MethodFault of type(s) application/json
This response body class contains all of the following: InlineMethodFault0
"MethodFault Object"
faultCause
Optional

Fault which is the cause of this fault.

array of object
faultMessage
Optional

Message which has details about the error Message can also contain a key to message catalog which can be used to generate better localized messages.


Code Samples
COPY
                    curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '[{}]' https://{api_host}/sdk/vim25/{release}/vsan/VsanVcClusterConfigSystem/{moId}/VsanClusterGetClaimedCapacity