Get Host Details

Table 1. API: GET Cisco Intersight Host Details
Element Description
API GetCiscoIntersightHost
Description API returns cisco intersight host details.
Method GET
URL Http(s)://{xx.xxxx.xx.xx:xxx}/v3/ciscoIntersight/vmware/provisioningEndPoints/{endpointId}/hosts
URL Parameters (fields in curly {} braces)
  • endpointId (Mandatory): Unique Identifier of Provisioning Endpoint. 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'"
  • Sort Order: To define sorting order either ASC (Ascending) or DESC (descending). E.g. Sortorder="ASC".
  • Page Number: To get the records for related page number. Eg. Pagenumber="1”
  • Page Size: To get the number of records on selected page. Eg. Pagesize="10”
  • For e.g. 
    {"filter": "moid=’ 62cbcfe76f72612d30b8839b’","sortorder": "desc", "pagenumber" : "1", "pagesize" : "10"}
Header
  • Authorization Key: The initial step that needs to be performed before consuming HCL BigFix CLM API 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 
xxxxxxxxxxxx
{
"totalRecords": 0,
"records": {
"moid": "string",
"name": "string",
"entityId": "string",
"objectType": "string",
"classId": "string",
"description": "string",
"connectionState": "string",
"cpuCores": 0,
"cpuSockets": 0,
"cpuSpeed": 0,
"dnsServers": {},
"memorySize": 0,
"hwPowerState": "string",
"hypervisorType": {},
"isSSHEnabled": true,
"maintenanceMode": true,
"model": "string",
"nptServers": {},
"serial": "string",
"storageAdapterCount": 0,
"tags": {},
"vendor": "string",
"cpuConsumedInHZ": 0,
"memoryConsumedInBytes": 0,
"cluster": {
"name": "string",
"moid": "string"
},
"organizations": [
{
"name": "string",
"moid": "string"
}
]
}
}
Response Parameters
  • Result:
  • moid
  • name
  • entityId
  • objectType
  • classId
  • description
  • connectionState
  • cpuCores
  • cpuSockets
  • cpuSpeed
  • dnsServers
  • memorySize
  • hwPowerState
  • hypervisorType
  • isSSHEnabled
  • maintenanceMode
  • model
  • nptServers
  • serial
  • storageAdapterCount
  • tags
  • vendor
  • cpuConsumedInBytes
  • memoryClusterInBytes
  • cluster
  • organizations