PATCH Vsphere UUID Hosts Batch

Batch configure/unconfigure ESXi hosts in case when automatic configuration is disabled and specific hosts are selected.

Request

URI

PATCH

https://{api_host}/api/v2/vsphere/{UUID}/hosts/batch

COPY

Path Parameters

string

UUID

Required

vCenter Server UUID

Request Body

Show optional properties

{
    "configure": false,
    "esxiHosts": [
        {}
    ]
}

{
    "configure": true,
    "syslogProtocol": "TCP",
    "esxiHosts": [
        "example-esxi-hostname",
        "example-esxi-hostname1"
    ]
}

boolean

configure

Required

Indicates whether to configure the ESXi hosts or remove configuration.

string

syslogProtocol

Optional

Syslog protocol used for configuring ESXi hosts. Default protocol is UDP.

Possible values are : udp, tcp, ssl,

array of string

esxiHosts

Required

ESXi host names whose configuration will be updated

Authentication

This operation uses the following authentication methods.

Bearer

Responses

201

Successfully updated specified ESXi host configurations

Operation doesn't return any data structure

207

Partial success - not all configurations are updated successfully

Operation doesn't return any data structure

400

The request failed because the request body either did not contain valid JSON, or did not match the required JSON format.

Returns error of type(s) application/json

{
    "errorMessage": "Invalid request body.",
    "errorCode": "JSON_FORMAT_ERROR",
    "errorDetails": {
        "reason": "..."
    }
}

string

errorMessage

Required

A message describing the error.

string

errorCode

Optional

A code representing the type of error.

Possible values are : LIMIT_ERROR, FIELD_ERROR, TEST_ERROR, JSON_FORMAT_ERROR, LICENSE_ERROR, VSPHERE_INTEGRATION_ERROR, VROPS_INTEGRATION_ERROR, UPGRADE_ERROR, SEARCH_ERROR, AGENT_ERROR, RBAC_COMMON_ERROR, RBAC_USERS_ERROR, RBAC_GROUPS_ERROR, RBAC_ADGROUPS_ERROR, RBAC_DATASETS_ERROR, RBAC_VIDM_GROUPS_ERROR, RBAC_VIDB_GROUPS_ERROR, SECURITY_ERROR, DEPLOYMENT_ERROR, SUPPORT_BUNDLE_ERROR, LOAD_BALANCER_ERROR, VIDM_ERROR, VIDB_ERROR, QUERY_ERROR, SSL_CERTIFICATE_ERROR, PROXY_ERROR,

object

errorDetails

Optional

Dynamic error details, where the field name can vary depending on the request field and error code.

401

Operation doesn't return any data structure

404

Configuration with specified vCenter Server UUID does not exist.

Operation doesn't return any data structure

440

Operation doesn't return any data structure

500

Internal error while processing the client request

Returns error of type(s) application/json

{
    "errorMessage": "The operation failed due to an internal error."
}

string

errorMessage

Required

A message describing the error.

string

errorCode

Optional

A code representing the type of error.

object

errorDetails

Optional

Dynamic error details, where the field name can vary depending on the request field and error code.

Code Samples

COPY

                    curl -X PATCH -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{"configure:"boolean","esxiHosts":["string"]}'

On This Page

Description

Request

Path Parameters

Request Body

Authentication

Response

201 Response Body

207 Response Body

Errors

Vsphere Operations

GET Vsphere Vc Hostname

Deprecated

PUT

PUT Vsphere Vc Hostname

Deprecated

DELETE

DELETE Vsphere Vc Hostname

Deprecated

GET

GET Vsphere Vc Hostname Hosts

Deprecated

PUT

PUT Vsphere Vc Hostname Hosts

Deprecated

GET

GET Vsphere Vc Hostname Hosts Esxi Host

Deprecated

PUT

PUT Vsphere Vc Hostname Hosts Esxi Host

GET Vsphere UUID Hosts

PUT

PUT Vsphere UUID Hosts

GET

GET Vsphere UUID Hosts Esxi Host

PUT

PUT Vsphere UUID Hosts Esxi Host

PATCH

PATCH Vsphere UUID Hosts Batch

POST

POST Vsphere Testconnection