GET Vsphere

GET Vsphere

Get all vCenter Server integration configurations.

Request
URI
GET
https://{api_host}/api/v2/vsphere
COPY
Authentication
This operation uses the following authentication methods.
Responses
200

Successfully retrieved vCenter Server integration configurations.

Returns vsphere.all.get.response of type(s) application/json
{
    "vCenterServers": [
        {
            "hostname": "vSphere-hostname1",
            "username": "vSphere-username1",
            "syslogProtocol": "tcp",
            "esxiHostsConfigured": true,
            "configureNewEsxiHostsAutomatically": true,
            "passwordSet": 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"
        },
        {
            "hostname": "vSphere-hostname2",
            "username": "vSphere-username2",
            "syslogProtocol": "udp",
            "esxiHostsConfigured": false,
            "configureNewEsxiHostsAutomatically": false,
            "passwordSet": true,
            "vsphereEventsEnabled": true,
            "target": "exampleVIP1.ip.or.fqdn",
            "collectionStatus": "Collecting",
            "uuid": "00000000-0000-0000-0000-000000000000",
            "userTags": "tag1=value1,tag2=value2"
        }
    ]
}

401
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 -H 'Authorization: <value>' https://{api_host}/api/v2/vsphere