CnsVolumeMetadata

CnsVolumeMetadata
CnsVolumeMetadata

Data object that represents metadata associated with a container volume.

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

AllOf
This class requires all of the following:
JSON Example
{
    "_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
        }
    ]
}
containerCluster
Required

Deprecated as of vSphere 7.0. Use CnsEntityMetadata to refer to the container cluster the entity belongs to.

Represents the container orchestrator cluster where the volume is used.

Volume metadata will be associated with the container volume for this container cluster during volume create and update operations. In case the block container volume is created in one container cluster but used in a different container cluster (static volume provisioning use case), an update volume operation with a new container cluster will replace the old entry.

entityMetadata
Optional

All the entity metadata associated with the container volume within a container orchestrator like Kubernetes.

containerClusterArray
Optional

Represents list of all container orchestrator clusters where the volume is used.

This field is mandatory in versions that support it.