Vsan Site Maintenance System Vsan Enter Site Maintenance Mode

Put all hosts in a fault domain into maintenance mode.

This operation puts the hosts on this fault domain into the maintenance mode, and guarantees the consistencies for all objects within this fault domain. A precheck will be performed as part of this fault domain maintenance workflow. Upon success, all VMs in this fault domain will be powered off or migrated to the other fault domain.

Required privileges: Host.Config.Storage

Request

URI

POST

https://{vcenter-host}/sdk/vim25/{release}/vsan/VsanSiteMaintenanceSystem/{moId}/VsanEnterSiteMaintenanceMode

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

string

release

Required

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

Request Body

VsanEnterSiteMaintenanceModeRequestType of type(s) application/json

Required

Show optional properties

{
    "faultDomainName": "string",
    "cluster": {}
}

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

string

faultDomainName

Required

The fault domain name to enter maintenance mode.

cluster

Required

The cluster containing the fault domain to enter maintenance mode.

Authentication

This operation uses the following authentication methods.

Session

Responses

200

the task tracking the enter fault domain maintenance workflow.

Returns MoRefTask of type(s) application/json

This response body class contains all of the following: MoRefExtensibleManagedObject

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

500

VsanFault: If any runtime error is hit.

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 '{"faultDomainName":"string","cluster":"{}"}' https://{api_host}/sdk/vim25/{release}/vsan/VsanSiteMaintenanceSystem/{moId}/VsanEnterSiteMaintenanceMode

On This Page

Description

Request

Path Parameters

Request Body

Authentication

Response

200 Response Body

Errors

V San Service Api Operations

POST

Vsan Site Maintenance System Vsan Enter Site Maintenance Mode