PUT Vsphere Vc Hostname Hosts Esxi Host

Update ESXi host configuration with the specified hostname in the specified vCenter Server.

Request

URI

PUT

https://{api_host}/api/v2/vsphere/{vcHostname}/hosts/{esxiHost}

COPY

Path Parameters

string

esxiHost

Required

Hostname of ESXi host

string

vcHostname

Required

vCenter Server hostname

Request Body

Show optional properties

{
    "configure": false
}

{
    "configure": true,
    "syslogProtocol": "TCP"
}

boolean

configure

Required

Indicates whether to configure the ESXi host or remove configuration.

string

syslogProtocol

Optional

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

Possible values are : udp, tcp, ssl,

Authentication

This operation uses the following authentication methods.

Bearer

Responses

200

Operation doesn't return any data structure

Response Headers

string

Warning

Additional information about the life-cycle status of the API.

string

VMware-LI-API-Status

Indicates the life-cycle status of the API.

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

Specified ESXi host is not available under specified vSphere instance.

Configuration with specified vCenter Server hostname 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 PUT -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{"configure:"boolean"}' https://{api_host}/api/v2/vsphere/{vcHostname}/hosts/{esxiHost}

Deprecated

On This Page

Description

Request

Path Parameters

Request Body

Authentication

Response

200 Response Body

Errors

Vsphere Operations

GET