POST Vsphere

POST Vsphere

Add new integration configuration to vCenter Server.

Request
URI
POST
https://{api_host}/api/v2/vsphere
COPY
Query Parameters
boolean
showDetails
Optional
Constraints: default: false

Show more details for vCenter Server and ESXi hosts configuration.

Request Body
vsphere.post.request of type(s) application/json
Optional 
{
    "acceptCert": true,
    "hostname": "example-vc.eng.vmware.com",
    "username": "exampleVCUsername",
    "password": "exampleVCPassword",
    "syslogProtocol": "tcp",
    "vsphereEventsEnabled": true,
    "configureEsxiHostsAutomatically": false,
    "target": "exampleVIP.ip.or.fqdn",
    "userTags": "tag1=value1,tag2=value2"
}
Authentication
This operation uses the following authentication methods.
Responses
201

Successfully added new vCenter Server integration configuration.

Returns vsphere.post.response of type(s) application/json 
{
    "hostname": "vSphere-hostname",
    "username": "vSphere-username",
    "passwordSet": true,
    "syslogProtocol": "tcp",
    "esxiHostsConfigured": true,
    "configureNewEsxiHostsAutomatically": true,
    "vsphereEventsEnabled": true,
    "target": "exampleVIP.ip.or.fqdn",
    "collectionStatus": "Error",
    "collectionStatusDetails": "vCenter Server SSL Certificate is not trusted",
    "uuid": "00000000-0000-0000-0000-000000000000",
    "userTags": "tag1=value1,tag2=value2",
    "details": {
        "info": "info",
        "warning": "warning"
    }
}

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

409

Configuration with specified vCenter Server hostname already exists.

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.

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 POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '[{}]' https://{api_host}/api/v2/vsphere
On This Page
Vsphere Operations
GET
GET Vsphere
POST
POST Vsphere
DELETE
DELETE Vsphere
GET
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
Deprecated
GET
GET Vsphere UUID
PUT
PUT Vsphere UUID
DELETE
DELETE Vsphere UUID
GET
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