Data Object Description

Properties

Name	Type	Description
backingObjectDetails*	CnsBackingObjectDetails	Additional information about the backing object for this volume, specific to volume type. See CnsBackingObjectDetails and its child-classes for more information.
complianceStatus*	xsd:string	Storage policy compliance status of the volume. This will be one of the compliance status exposed by SPBM. See pbm.compliance.ComplianceResult.ComplianceStatus.
datastoreAccessibilityStatus*	xsd:string	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 pbm.compliance.EntityHealthStatus.DatastoreAccessibilityStatus.
datastoreUrl*	xsd:string	URL for datastore where the volume resides. This is the URL from Summary.
healthStatus*	xsd:string	Health status of the volume. This will be one of the health status exposed by SPBM. See pbm.compliance.EntityHealthStatus.healthStatus. *Since* vSAN API 7.0
metadata*	CnsVolumeMetadata	Metadata for this volume.
name*	xsd:string	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.
storagePolicyId*	xsd:string	Storage policy associated with the container volume.
volumeId	CnsVolumeId	Unique identifier and datastore information for the volume.
volumeType*	xsd:string	Type of this volume. See CnsVolumeType for all supported types and valid values for this field.
Properties inherited from DynamicData
None

Name

Type

Description

backingObjectDetails*

Additional information about the backing object for this volume, specific to volume type.
See CnsBackingObjectDetails and its child-classes for more information.

complianceStatus*

xsd:string

Storage policy compliance status of the volume.
This will be one of the compliance status exposed by SPBM. See pbm.compliance.ComplianceResult.ComplianceStatus.

datastoreAccessibilityStatus*

xsd:string

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 pbm.compliance.EntityHealthStatus.DatastoreAccessibilityStatus.

datastoreUrl*

xsd:string

URL for datastore where the volume resides.
This is the URL from Summary.

healthStatus*

xsd:string

Health status of the volume.
This will be one of the health status exposed by SPBM. See pbm.compliance.EntityHealthStatus.healthStatus.

Since vSAN API 7.0

metadata*

CnsVolumeMetadata

Metadata for this volume.

name*

xsd:string

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.

storagePolicyId*

xsd:string

Storage policy associated with the container volume.

volumeId

CnsVolumeId

Unique identifier and datastore information for the volume.

volumeType*

xsd:string

Type of this volume.
See CnsVolumeType for all supported types and valid values for this field.

Properties inherited from DynamicData

None

Need not be set

Show WSDL type definition

         <complexType xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vsan="urn:vsan" name="CnsVolume">
            <complexContent>
               <extension base="vsan:DynamicData">
                  <sequence>
                     <element name="volumeId" type="vsan:CnsVolumeId"/>
                     <element name="datastoreUrl" type="xsd:string" minOccurs="0"/>
                     <element name="name" type="xsd:string" minOccurs="0"/>
                     <element name="volumeType" type="xsd:string" minOccurs="0"/>
                     <element name="storagePolicyId" type="xsd:string" minOccurs="0"/>
                     <element name="metadata" type="vsan:CnsVolumeMetadata" minOccurs="0"/>
                     <element name="backingObjectDetails" type="vsan:CnsBackingObjectDetails" minOccurs="0"/>
                     <element name="complianceStatus" type="xsd:string" minOccurs="0"/>
                     <element name="datastoreAccessibilityStatus" type="xsd:string" minOccurs="0"/>
                     <element name="healthStatus" type="xsd:string" minOccurs="0"/>
                  </sequence>
               </extension>
            </complexContent>
         </complexType>

Data Object - CnsVolume(vim.cns.Volume)

Data Object Description