VsanQueryObjectIdentitiesRequestType

VsanQueryObjectIdentitiesRequestType
VsanQueryObjectIdentitiesRequestType

The parameters of VsanQueryObjectIdentities.

JSON Example
{
    "cluster": {
        "_typeName": "string",
        "type": "string",
        "value": "string"
    },
    "objUuids": [
        "string"
    ],
    "objTypes": [
        "string"
    ],
    "includeHealth": false,
    "includeObjIdentity": false,
    "includeSpaceSummary": false,
    "extraQuerySpec": {
        "_typeName": "string",
        "knownSpbmProfileUuids": [
            "string"
        ]
    }
}
cluster
Optional

vSAN cluster. Ignored if called against host.

Required privileges: System.Read

array of string
objUuids
Optional

The vSAN object UUIDs for querying. Unset to query all of vSAN objects

array of string
objTypes
Optional

Querying the vSAN objects with given types, only the object whose type in this list will be returned. All of available object types include 'vmswap', 'vdisk', 'namespace', 'vmem', 'stats', 'other', 'iscsiHome', 'iscsiLun', 'iscsiTarget' and 'fileShare'. Unset to query all of vSAN objects with any type

boolean
includeHealth
Optional

If the result includes the object health status. Default is False

boolean
includeObjIdentity
Optional

If the result includes all of the object identity. Default is True if it's unset

boolean
includeSpaceSummary
Optional

If the result includes the vSAN space consumption summarizing by object type. Currently, it's not supported to include both of space summary and object identity in the result. Default is false.

extraQuerySpec
Optional

This parameter only takes effect for host level API. The vSAN object identity query spec to specify detailed query specification like remote vSAN or VMFS datastores. If no extraQquerySpec is specified, the original logic to return all identities of local vSAN datastores will be applied. Note for any nonlocal vsan datastores provided, all the specified filter like objUuids, objTypes, include* won't take affect.

Parameter To