CnsQueryFilter

CnsQueryFilter
CnsQueryFilter

Filter object to query matching volumes.

Every property criteria that is specified through array, like labels, datastores and so on will add complexity in retrieving the query result, and it should be minimal (preferrably less than or equal to 10). The query may be slow or fail if this guideline is not honored. All string matchings will be absolute, unless specified.

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

AllOf
This class requires all of the following:
JSON Example
{
    "_typeName": "string",
    "volumeIds": [
        {
            "_typeName": "string",
            "id": "string"
        }
    ],
    "names": [
        "string"
    ],
    "containerClusterIds": [
        "string"
    ],
    "storagePolicyId": "string",
    "datastores": [
        {
            "_typeName": "string",
            "type": "string",
            "value": "string"
        }
    ],
    "labels": [
        {
            "_typeName": "string",
            "key": "string",
            "value": "string"
        }
    ],
    "complianceStatus": "string",
    "datastoreAccessibilityStatus": "string",
    "cursor": {
        "_typeName": "string",
        "offset": 0,
        "limit": 0,
        "totalRecords": 0
    },
    "healthStatus": "string"
}
array of CnsVolumeId
volumeIds
Optional

Volume identifiers to be queried.

A maximum of 1000 volume ids can be provided.

array of string
names
Optional

Volume names to be queried.

Currently only full string match will be supported. No regex or substring matching will be done.

array of string
containerClusterIds
Optional

Container orchestrator cluster identifiers.

string
storagePolicyId
Optional

Storage policy id associated with volume.

This will be matched to the actual storage policy attached with the volume.

array of MoRefDatastore
datastores
Optional

Volumes located on this Datastore will be returned.

array of KeyValue
labels
Optional

Labels to be matched for this volume.

Label key and value should be an exact match. All volumes that match any of the labels will be returned in the result.

string
complianceStatus
Optional

Storage policy compliance status of the volume.

This must be one of the compliance status exposed by SPBM. See VsanComplianceStatusEnum.

string
datastoreAccessibilityStatus
Optional

Deprecated since vSphere 7.0 in favor of healthStatus.

Datastore accessibility status of the volume.

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

cursor
Optional

Cursor object, pointing to desired range of results.

string
healthStatus
Optional

Health status of the volume.

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

Property Of
Used By