Vim Cluster Vsan Vc Disk Management System Query Disk Mappings

Vim Cluster Vsan Vc Disk Management System Query Disk Mappings
Get detailed information of vSAN disk groups managed by specified host, for each disk group, includes: Disk structure, presents as disk for cache tier, and disks for capacity tier; Whether is in-use for vSAN I/O by this host; Whether is all flash disk group; Whether vSAN deduplication and compression are enabled on this disk group.

Get detailed information of vSAN disk groups managed by specified host, for each disk group, includes: Disk structure, presents as disk for cache tier, and disks for capacity tier; Whether is in-use for vSAN I/O by this host; Whether is all flash disk group; Whether vSAN deduplication and compression are enabled on this disk group.

Request
URI
POST
https://{vcenter-host}/sdk/vim25/{release}/vsan/VimClusterVsanVcDiskManagementSystem/{moId}/QueryDiskMappings
COPY
Path Parameters
string
moId
Required

The unique identifier for the managed object to which the method attaches; the serialized managed object reference for a request has the form moType/moId, in this case VimClusterVsanVcDiskManagementSystem/{moId}.

string
release
Required

The vSphere release schema. The current specification covers vSphere 9.1.0.0 APIs.

Request Body
QueryDiskMappingsRequestType of type(s) application/json
Required

Show optional properties

{
    "host": {}
}
{
    "host": {
        "_typeName": "string",
        "type": "string",
        "value": "string"
    }
}
host
Required

Target host to query.

Required privileges: System.Read

Authentication
This operation uses the following authentication methods.
Responses
200

List of DiskMapInfoEx, please reference to VimVsanHostDiskMapInfoEx.

[
    {
        "_typeName": "string",
        "mapping": {
            "_typeName": "string",
            "ssd": {
                "_typeName": "string",
                "deviceName": "string",
                "deviceType": "string",
                "key": "string",
                "uuid": "string",
                "descriptor": [
                    {
                        "_typeName": "string",
                        "quality": "string",
                        "id": "string"
                    }
                ],
                "canonicalName": "string",
                "displayName": "string",
                "lunType": "string",
                "vendor": "string",
                "model": "string",
                "revision": "string",
                "scsiLevel": 0,
                "serialNumber": "string",
                "durableName": {
                    "_typeName": "string",
                    "namespace": "string",
                    "namespaceId": 0,
                    "data": [
                        0
                    ]
                },
                "alternateName": [
                    {
                        "_typeName": "string",
                        "namespace": "string",
                        "namespaceId": 0,
                        "data": [
                            0
                        ]
                    }
                ],
                "standardInquiry": [
                    0
                ],
                "queueDepth": 0,
                "operationalState": [
                    "string"
                ],
                "capabilities": {
                    "_typeName": "string",
                    "updateDisplayNameSupported": false
                },
                "vStorageSupport": "string",
                "protocolEndpoint": false,
                "perenniallyReserved": false,
                "clusteredVmdkSupported": false,
                "applicationProtocol": "string",
                "dispersedNs": false,
                "deviceReservation": "string",
                "capacity": {
                    "_typeName": "string",
                    "blockSize": 0,
                    "block": 0
                },
                "devicePath": "string",
                "ssd": false,
                "localDisk": false,
                "physicalLocation": [
                    "string"
                ],
                "emulatedDIXDIFEnabled": false,
                "vsanDiskInfo": {
                    "_typeName": "string",
                    "vsanUuid": "string",
                    "formatVersion": 0
                },
                "scsiDiskType": "string",
                "usedByMemoryTiering": false
            },
            "nonSsd": [
                {
                    "_typeName": "string",
                    "deviceName": "string",
                    "deviceType": "string",
                    "key": "string",
                    "uuid": "string",
                    "descriptor": [
                        {
                            "_typeName": "string",
                            "quality": "string",
                            "id": "string"
                        }
                    ],
                    "canonicalName": "string",
                    "displayName": "string",
                    "lunType": "string",
                    "vendor": "string",
                    "model": "string",
                    "revision": "string",
                    "scsiLevel": 0,
                    "serialNumber": "string",
                    "durableName": {
                        "_typeName": "string",
                        "namespace": "string",
                        "namespaceId": 0,
                        "data": [
                            0
                        ]
                    },
                    "alternateName": [
                        {
                            "_typeName": "string",
                            "namespace": "string",
                            "namespaceId": 0,
                            "data": [
                                0
                            ]
                        }
                    ],
                    "standardInquiry": [
                        0
                    ],
                    "queueDepth": 0,
                    "operationalState": [
                        "string"
                    ],
                    "capabilities": {
                        "_typeName": "string",
                        "updateDisplayNameSupported": false
                    },
                    "vStorageSupport": "string",
                    "protocolEndpoint": false,
                    "perenniallyReserved": false,
                    "clusteredVmdkSupported": false,
                    "applicationProtocol": "string",
                    "dispersedNs": false,
                    "deviceReservation": "string",
                    "capacity": {
                        "_typeName": "string",
                        "blockSize": 0,
                        "block": 0
                    },
                    "devicePath": "string",
                    "ssd": false,
                    "localDisk": false,
                    "physicalLocation": [
                        "string"
                    ],
                    "emulatedDIXDIFEnabled": false,
                    "vsanDiskInfo": {
                        "_typeName": "string",
                        "vsanUuid": "string",
                        "formatVersion": 0
                    },
                    "scsiDiskType": "string",
                    "usedByMemoryTiering": false
                }
            ]
        },
        "isMounted": false,
        "unlockedEncrypted": false,
        "isAllFlash": false,
        "isDataEfficiency": false,
        "encryptionInfo": {
            "_typeName": "string",
            "encryptionEnabled": false,
            "kmsProviderId": {
                "_typeName": "string",
                "id": "string"
            },
            "kekId": "string",
            "hostKeyId": "string",
            "dekGenerationId": 0,
            "changing": false,
            "eraseDisksBeforeUse": false,
            "wrappedDek": "string",
            "dekId": "string",
            "oldWrappedDek": "string",
            "oldDekId": "string",
            "kekVerifier": "string",
            "dekVerifier": "string",
            "oldDekVerifier": "string",
            "iv": "string",
            "syncing": false
        },
        "dataEfficiencyConfig": {
            "_typeName": "string",
            "dedupEnabled": false,
            "compressionEnabled": false
        },
        "diskgroupCapability": [
            "string"
        ]
    }
]
array of object
Optional

DiskMapInfoEx is used to present information of a Virtual disk group.

It extended vim.vsan.host.DiskMapInfo, added fields all-flash and space efficiency settings on this disk group.


500

VsanFault: If below issues exist:

  1. Specified host doesn't exist;
  2. Specified host is not connected to vCenter server;
  3. Any unexpected runtime error;
Returns VsanFault of type(s) application/json
This response body class contains all of the following: VimFault 
{
    "_typeName": "string",
    "faultCause": {
        "_typeName": "string",
        "faultCause": "MethodFault Object",
        "faultMessage": [
            {
                "_typeName": "string",
                "key": "string",
                "arg": [
                    {
                        "_typeName": "string",
                        "key": "string",
                        "value": {
                            "_typeName": "string"
                        }
                    }
                ],
                "message": "string"
            }
        ]
    },
    "faultMessage": [
        {
            "_typeName": "string",
            "key": "string",
            "arg": [
                {
                    "_typeName": "string",
                    "key": "string",
                    "value": {
                        "_typeName": "string"
                    }
                }
            ],
            "message": "string"
        }
    ]
}

Code Samples
COPY
                    curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{"host":"{}"}' https://{api_host}/sdk/vim25/{release}/vsan/VimClusterVsanVcDiskManagementSystem/{moId}/QueryDiskMappings
On This Page
V San Service Api Operations
POST
Vim Cluster Vsan Vc Disk Management System Vsan Add Storage Pool Disk
POST
Vim Cluster Vsan Vc Disk Management System Vsan Delete Storage Pool Disk
POST
Vim Cluster Vsan Vc Disk Management System Initialize Disk Mappings
POST
Vim Cluster Vsan Vc Disk Management System Query Cluster Data Efficiency Capacity State
POST
Vim Cluster Vsan Vc Disk Management System Query Disk Mappings
POST
Vim Cluster Vsan Vc Disk Management System Query Vsan Managed Disks
POST
Vim Cluster Vsan Vc Disk Management System Rebuild Disk Mapping
POST
Vim Cluster Vsan Vc Disk Management System Remove Disk Ex
POST
Vim Cluster Vsan Vc Disk Management System Remove Disk Mapping Ex
POST
Vim Cluster Vsan Vc Disk Management System Retrieve All Flash Capabilities
POST
Vim Cluster Vsan Vc Disk Management System Unmount Disk Mapping Ex
POST
Vim Cluster Vsan Vc Disk Management System Vsan Unmount Storage Pool Disks