Vim Cluster Vsan Vc Stretched Cluster System VSAN Vc Get Preferred Fault Domain

Query configuration of preferred Fault Domain of specified cluster.

If call this API against vSAN service of version 6.5 and before, additional privilege Host.Inventory.EditCluster is required, please be noted.

Request

URI

POST

https://{api_host}/sdk/vim25/{release}/vsan/VimClusterVsanVcStretchedClusterSystem/{moId}/VSANVcGetPreferredFaultDomain

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 VimClusterVsanVcStretchedClusterSystem/{moId}.

string

release

Required

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

Request Body

VSANVcGetPreferredFaultDomainRequestType of type(s) application/json

Required

"VSANVcGetPreferredFaultDomainRequestType Object"

cluster

Required

Target cluster to query.

Required privileges: System.Read

Authentication

This operation uses the following authentication methods.

Session

Responses

200

VSANPreferredFaultDomainInfo which contains preferred Fault Domain's user friendly name and UUID. If specified cluster is not vSAN stretched cluster, both fields will be unset.

This response body class contains all of the following: VimClusterVSANPreferredFaultDomainInfo

{
    "0": "V",
    "1": "i",
    "2": "m",
    "3": "C",
    "4": "l",
    "5": "u",
    "6": "s",
    "7": "t",
    "8": "e",
    "9": "r",
    "10": "V",
    "11": "S",
    "12": "A",
    "13": "N",
    "14": "P",
    "15": "r",
    "16": "e",
    "17": "f",
    "18": "e",
    "19": "r",
    "20": "r",
    "21": "e",
    "22": "d",
    "23": "F",
    "24": "a",
    "25": "u",
    "26": "l",
    "27": "t",
    "28": "D",
    "29": "o",
    "30": "m",
    "31": "a",
    "32": "i",
    "33": "n",
    "34": "I",
    "35": "n",
    "36": "f",
    "37": "o",
    "38": " ",
    "39": "O",
    "40": "b",
    "41": "j",
    "42": "e",
    "43": "c",
    "44": "t"
}

500

InvalidState: If any host in target cluster is not connected to vCenter server;

VsanFault: If any unexpected runtime fault is met.

Returns VimFault of type(s) application/json

This response body class contains all of the following: InlineVimFault0

"VimFault Object"

Code Samples

COPY

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

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 Stretched Cluster System VSAN Vc Add Witness Host