Vim Cluster Vsan Vc Disk Management System Query Vsan Managed Disks

Get detailed information of all vSAN managed disks, which include disk groups, storage pool disks in vSAN datastore and all of vSAN direct storages for the specified host.

The output can be filtered to show only disk group or storage pool disks or vSAN direct disks. It can also be filtered to show details for an individual disk on the host by specifying filter criteria through VimVsanHostQueryVsanDisksSpec. The API QueryDiskMappings will be deprecated and replaced with this API.

Request

URI

POST

https://{api_host}/sdk/vim25/{release}/vsan/VimClusterVsanVcDiskManagementSystem/{moId}/QueryVsanManagedDisks

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.0.0.0 APIs.

Request Body

QueryVsanManagedDisksRequestType of type(s) application/json

Required

"QueryVsanManagedDisksRequestType Object"

host

Required

Target host to query.

Required privileges: System.Read

filterSpec

Optional

Specification to filter vSAN disks. This spec can be used to filter query results by disktype types (diskGroup/storagePool/directDisk) or by diskName. If this spec is not specified, it will return all vSAN disks in the cluster. Refer VimVsanHostQueryVsanDisksSpec for more details.

Authentication

This operation uses the following authentication methods.

Session

Responses

200

All of vSAN managed disks including vSAN disk groups and vSAN direct storages

This response body class contains all of the following: VimVsanHostVsanManagedDisksInfo

{
    "0": "V",
    "1": "i",
    "2": "m",
    "3": "V",
    "4": "s",
    "5": "a",
    "6": "n",
    "7": "H",
    "8": "o",
    "9": "s",
    "10": "t",
    "11": "V",
    "12": "s",
    "13": "a",
    "14": "n",
    "15": "M",
    "16": "a",
    "17": "n",
    "18": "a",
    "19": "g",
    "20": "e",
    "21": "d",
    "22": "D",
    "23": "i",
    "24": "s",
    "25": "k",
    "26": "s",
    "27": "I",
    "28": "n",
    "29": "f",
    "30": "o",
    "31": " ",
    "32": "O",
    "33": "b",
    "34": "j",
    "35": "e",
    "36": "c",
    "37": "t"
}

500

VsanFault: If below issues exist:

Specified host doesn't exist;
Specified host is not connected to vCenter server;
Any unexpected runtime error;

Returns VsanFault of type(s) application/json

"VsanFault Object"

Code Samples

COPY

                    curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '[{}]' https://{api_host}/sdk/vim25/{release}/vsan/VimClusterVsanVcDiskManagementSystem/{moId}/QueryVsanManagedDisks

On This Page

Description

Request

Path Parameters

Request Body

Authentication

Response

200 Response Body

Errors

V San Service Api Operations

POST

Vim Cluster Vsan Vc Disk Management System Vsan Add Storage Pool Disk