Get All vCenter Server Settings

This API retrieves details of all the vCenter Servers that are available in vCenter Chargeback Manager.

Syntax

The syntax for calling this API is:

GET <Base_URL>/vCenterServers

A sample API call is as follows:

GET https://123.123.123.123/vCenter-CB/api/vCenterServers

User Privilege

You can only view the vCenter Servers on which you have Read privilege.

Request Body Parameters

This API call does not take any input parameters.

API Response

If the request succeeds, the API returns an XML with the following details of all vCenter Servers that are available in vCenter Chargeback Manager.

XPath

Type

Min Occurs

Max Occurs

Description

VCenterServers/VCenterServer

 

0

unbounded

This is the vCenter Server element

VCenterServers/VCenterServer/@id

xs:int

1

1

The vCenter Server identifier. This ID will be the same as the vCenterServer Id specified in the API URL.

VCenterServers/VCenterServer/Url

xs:string

1

1

URL with IP address (or host name) and port number of the vCenter Server

VCenterServers/VCenterServer/LastSynchronizationTime

xs:long

1

1

Long integer identifying the time of last synchronization. A value of 0 indicates that the vCenter Server is not synchronized with the vCenter Chargeback Manager.

VCenterServers/VCenterServer/Name

xs:string

1

1

Short name for the vCenter Server

VCenterServers/VCenterServer/Description

xs:string

0

1

A description of the vCenter Server

VCenterServers/VCenterServer/UserName

xs:string

1

1

Login name of the user with which the vCenter Server is added to vCenter Chargeback Manager

VCenterServers/VCenterServer/PluginRegistered

xs:boolean

1

1

Whether the vCenter Chargeback Manager is registered as a plugin to this vCenter Server

VCenterServers/VCenterServer/StatsSync

xs:boolean

1

1

Whether statistics from the vCenter Server database are replicated in the vCenter Chargeback Manager database

VCenterServers/VCenterServer/DataSourceUrl

xs:string

1

1

URL with IP address (or host name) of the vCenter Server database

VCenterServers/VCenterServer/DataSourceName

xs:string

1

1

Name of the vCenter Server database

VCenterServers/VCenterServer/DataSourceUserName

xs:string

0

1

Login name of the user to authenticate with the vCenter Server database. The user name parameter will be absent if the authentication type is Windows authentication.

VCenterServers/VCenterServer/DataSourceAuthType/@id

xs:integer

1

1

Integer identifying the authorization type of the vCenter Server database

VCenterServers/VCenterServer/DataSourceAuthType/Name

xs:string

1

1

Name of the authorization type of the vCenter Server database.

VCenterServers/VCenterServer/DataSourceType/@id

xs:integer

1

1

Integer identifying the type of the vCenter Server database

VCenterServers/VCenterServer/DataSourceType/Name

xs:string

 

 

Name of the vCenter Server datasource name

VCenterServers/VCenterServer/Version

xs:string

1

1

Version of vCenter Server.

A sample response is provided here.