Get Vcenter Hosts

Table 1. API: Get Vcenter Clusters
Element Description
API GetallHosts
Description This API Returns Vcenter host(s) exist in Endpoint.
Method GET
URL Http(s)://{xx.xxxx.xx.xx:xxx}/v3/Vcenter/provisioningEndPoints/{endpointId}/hosts?queryParams={"filter":"","sortby":"","sortorder":"","pagenumber":"1","pagesize":"20000" }
URL Parameters (fields in curly {} braces)
  • endpointId(Mandatory): This is a unique identifier of Cloud Endpoint created in HCL BigFix CLM. It can be any value either PlatformEntityId or Name of the Platform available on Manage Provisioning Platform screen.
  • queryParams (Optional): It is used for filtering and sorting of records. It has three properties which are as follows:
  • filter: To filter records based on column name received from output. E.g. Filter="keyname='keyvalue'"
  • sortby: To sort the data based on column name. E.g. Sortby="keyname"
  • sortorder: To define sorting order either ASC (Ascending) or DESC (descending). E.g. Sortorder="ASC".
  • Pagenumber: To see the results based on Page Number. (by default it should be 1).
  • Pagesize: Number of records that need to get fitted in each page (by default it should be 20000).
  • For e.g.
    {"filter": "text='secondry-compute'","sortby": "text","sortorder": "desc", "pagenumber":"1","pagesize":"20000"}
Header
  • Authorization Key : The initial step that needs to be performed before consuming HCL BigFix CLM APIs is to obtain the Token Value for an authorization key. Once a Token value is obtained, it remains valid for all API calls made in a session. For more information on how to do that, refer Token API description.
  • Content-type: application/json
Response
{
"totalRecords": 3,
"records": [
{
"actualIdOnEnvironment": "2090",
"name": "xxxxxx",
"clusterActualId": "16281",
"clusterName": "SB-Compute-Cluster",
"associatedServicePlans": [
{
"servicePlanId": "1",
"servicePlanName": "platinum"
},
{
"servicePlanId": "2",
"servicePlanName": "silver"
}
],
"freeCpu": 26,
"usedCpu": 74,
"freeMemoryPercentage": 8,
"usedMemoryPercentage": 92,
"totalMemoryMB": 522749.063,
"totalCpu": 36,
"cpuMhz": 2300
},
{
"actualIdOnEnvironment": "904",
"name": "indrcesxi01.com",
"clusterActualId": "16281",
"clusterName": "SB-Compute-Cluster",
"associatedServicePlans": [
{
"servicePlanId": "1",
"servicePlanName": "platinum"
},
{
"servicePlanId": "2",
"servicePlanName": "silver"
}
],
"freeCpu": 26,
"usedCpu": 74,
"freeMemoryPercentage": 4,
"usedMemoryPercentage": 96,
"totalMemoryMB": 522749.063,
"totalCpu": 36,
"cpuMhz": 2300
},
{
"actualIdOnEnvironment": "911",
"name": "xxxxxx",
"clusterActualId": "16260",
"clusterName": "SB-Management-Cluster",
"associatedServicePlans": [
{
"servicePlanId": "1",
"servicePlanName": "platinum"
}
],
"freeCpu": 96,
"usedCpu": 4,
"freeMemoryPercentage": 78,
"usedMemoryPercentage": 22,
"totalMemoryMB": 522749.063,
"totalCpu": 36,
"cpuMhz": 2300
}
]
}
  • Response Parameters
  • totalRecords
  • records –json of below keys
  • actualIdOnEnvironment
  • name
  • actualIdOnEnvironment
  • clusterActualId
  • clusterName
  • associatedServicePlans
  • freeCpu
  • usedCpu
  • freeMemoryPercentage
  • usedMemoryPercentage
  • totalMemoryMB
  • totalCpu
  • cpuMhz