Data Object - CnsEntityMetadata(vim.cns.EntityMetadata)

Property of
CnsVolumeMetadata
Extended by
CnsKubernetesEntityMetadata
Extends
DynamicData
See also
KeyValue
Since
vSAN API vSAN 6.7U3

Data Object Description

Base data object that represents the metadata associated with an entity in container orchestrators like Kubernetes, Docker swarm etc.

Properties

Name Type Description
clusterId*xsd:string

Represents the container orchestrator cluster the entity belongs to. This is a mandatory field as the VolumeMetadata.containerCluster is deprecated.
This field points to a cluster in vim.cns.VolumeMetadata.containerClusterArray

Since vSAN API 7.0
delete*xsd:boolean

If not set, False is assumed.
  • True indicates that the EntityMetadata should be deleted in VolumeManager.Update API.
  • False indicates that the EntityMetadata should be added or replaced in VolumeManager.Create, VolumeManager.Update APIs.
entityNamexsd:string

Represents the name of entity.
labels*KeyValue[]

Labels for this entity.
Labels are opaque to CNS and it will neither try to parse the key nor the value. A maximum of 32 labels will be supported for each entity. Label key should be less than 320 bytes and value should be less than 64 bytes.
If the constraints are not honored, then InvalidArgument will be thrown.
Properties inherited from DynamicData
None
*Need not be set
Show WSDL type definition