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

Set preferred Fault Domain for a vSAN stretched cluster.

This API could set/reconfigure preferred Fault Domain setting.

Request

URI

POST

https://{vcenter-host}/sdk/vim25/{release}/vsan/VimClusterVsanVcStretchedClusterSystem/{moId}/VSANVcSetPreferredFaultDomain

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

Request Body

VSANVcSetPreferredFaultDomainRequestType of type(s) application/json

Required

Show optional properties

{
    "cluster": {},
    "preferredFd": "string"
}

{
    "cluster": {
        "_typeName": "string",
        "type": "string",
        "value": "string"
    },
    "preferredFd": "string",
    "witnessHost": {
        "_typeName": "string",
        "type": "string",
        "value": "string"
    }
}

cluster

Required

Target vSAN stretched cluster;

Required privileges: Host.Inventory.EditCluster

string

preferredFd

Required

The user friendly name of preferred Fault Domain;

witnessHost

Optional

The witness host to apply preferred Fault Domain setting; if it is not specified, will take the in-use witness host configured at cluster side.

Authentication

This operation uses the following authentication methods.

Session

Responses

200

vim.Task

Returns MoRefTask of type(s) application/json

This response body class contains all of the following: MoRefExtensibleManagedObject

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

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: MethodFault

{
    "_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 '{"cluster":"{}","preferredFd":"string"}' https://{api_host}/sdk/vim25/{release}/vsan/VimClusterVsanVcStretchedClusterSystem/{moId}/VSANVcSetPreferredFaultDomain

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