CnsVolume

CnsVolume
CnsVolume

Data object captures all details about container volume.

This is used strictly for Query CnsQueryVolume / QueryAll CnsQueryAllVolume result.

This structure may be used only with operations rendered under /vsan.

AllOf
This class requires all of the following:
JSON Example
{
    "_typeName": "string",
    "volumeId": {
        "_typeName": "string",
        "id": "string"
    },
    "datastoreUrl": "string",
    "name": "string",
    "volumeType": "string",
    "storagePolicyId": "string",
    "metadata": {
        "_typeName": "string",
        "containerCluster": {
            "_typeName": "string",
            "clusterType": "string",
            "clusterId": "string",
            "vSphereUser": "string",
            "clusterFlavor": "string",
            "clusterDistribution": "string",
            "delete": false
        },
        "entityMetadata": [
            {
                "_typeName": "string",
                "entityName": "string",
                "labels": [
                    {
                        "_typeName": "string",
                        "key": "string",
                        "value": "string"
                    }
                ],
                "delete": false,
                "clusterId": "string"
            }
        ],
        "containerClusterArray": [
            {
                "_typeName": "string",
                "clusterType": "string",
                "clusterId": "string",
                "vSphereUser": "string",
                "clusterFlavor": "string",
                "clusterDistribution": "string",
                "delete": false
            }
        ]
    },
    "backingObjectDetails": {
        "_typeName": "string",
        "capacityInMb": 0
    },
    "complianceStatus": "string",
    "datastoreAccessibilityStatus": "string",
    "healthStatus": "string"
}
volumeId
Required

Unique identifier and datastore information for the volume.

string
datastoreUrl
Optional

URL for datastore where the volume resides.

This is the URL from summary.

string
name
Optional

Name of the volume.

Name size is limited to 80 bytes. CNS will not try to enforce uniqueness for volume name. Different container orchestrator clusters can create volumes with same name. Uniqueness within a container orchestrator cluster, if needed, should be enforced by the cluster orchestrator during volume creation.

string
volumeType
Optional

Type of this volume.

See CnsVolumeTypeEnum for all supported types and valid values for this field.

string
storagePolicyId
Optional

Storage policy associated with the container volume.

metadata
Optional

Metadata for this volume.

backingObjectDetails
Optional

Additional information about the backing object for this volume, specific to volume type.

See CnsBackingObjectDetails and its child-classes for more information.

string
complianceStatus
Optional

Storage policy compliance status of the volume.

This will be one of the compliance status exposed by SPBM. See PbmComplianceStatusEnum.

string
datastoreAccessibilityStatus
Optional

Deprecated since vSphere 7.0 in favor of healthStatus.

Datastore accessibility status of the volume.

This will be one of the datastore accessibility status exposed by SPBM. See PbmEntityHealthDatastoreAccessibilityStatusEnum.

string
healthStatus
Optional

Health status of the volume.

This will be one of the health status exposed by SPBM. See healthStatus.

Property Of