PUT Vsphere Vc Hostname

PUT Vsphere Vc Hostname

Update the integration configuration settings for vCenter Server with the specified hostname.

Request
URI
PUT
https://{api_host}/api/v2/vsphere/{vcHostname}
COPY
Path Parameters
string
vcHostname
Required

vCenter Server hostname

Query Parameters
boolean
showDetails
Optional
Constraints: default: false

Show more details for vCenter Server and ESXi hosts configuration.


Request Body
{
    "acceptCert": true,
    "username": "exampleVCUsername",
    "password": "exampleVCPassword",
    "syslogProtocol": "tcp",
    "vsphereEventsEnabled": true,
    "configureEsxiHostsAutomatically": false,
    "target": "exampleVIP.ip.or.fqdn",
    "userTags": "tag1=value1,tag2=value2"
}
boolean
acceptCert
Optional

Automatically accept not trusted vCenter Server certificates. Default value is false

string
username
Optional

The vCenter Server username

string
password
Optional

The vCenter Server password

string
syslogProtocol
Optional

Syslog protocol used for ESXi hosts configuration.

Possible values are : udp, tcp, ssl,
boolean
vsphereEventsEnabled
Optional

Collect vCenter Server events, tasks, and alarms.

boolean
configureEsxiHostsAutomatically
Optional

Configure ESXi hosts and turn on auto-configuration. Auto-configuration will periodically try to configure ESXi hosts that are not configured yet.

string
target
Optional

Target for vCenter Server and ESXi hosts logs. This can be VMware Aria Operations for Logs master node or one of the virtual IP addresses.

string
userTags
Optional

User tags used for vCenter Server integration

Authentication
This operation uses the following authentication methods.
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

Not found.

"Not Found"

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.

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.


Code Samples
COPY
                    curl -X PUT -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{}' https://{api_host}/api/v2/vsphere/{vcHostname}