Get Baremetal Server Summary

Get Baremetal Server Summary
Get summary of Baremetal servers

Returns aggregated statistics on baremetal servers.

Request
URI
GET
https://{api_host}/baremetal/servers-summary
COPY
Authentication
This operation uses the following authentication methods.
Responses
200

OK

Returns BaremetalServersSummary of type(s) application/json 
{
    "agent_health_status": {
        "num_ok": 0,
        "num_disconnected": 0,
        "num_degraded": 0
    },
    "operational_status": {
        "success": 0,
        "failed": 0,
        "in_progress": 0,
        "num_upgrade_failed": 0,
        "num_offboard_failed": 0
    },
    "version_stats": {
        "latest_version": "string",
        "latest_version_count": 0,
        "upgrade_needed_count": 0,
        "upgrade_in_progress_count": 0
    },
    "total_server_count": 0
}
object
agent_health_status
Optional

The baremetal servers agent health status summary.

object
operational_status
Optional

The baremetal servers operational status summary.

object
version_stats
Optional

Summary for baremetal servers version stats.

integer As int64 As int64
total_server_count
Optional

Total number of baremetal servers.


default

Error response on API failure.

Returns Error of type(s) application/json 
{
    "error_code": 0,
    "module_name": "string",
    "error_message": "string"
}
integer
error_code
Required

HTTP Status or Application error code.

string
module_name
Optional

Module where the error happened.

string
error_message
Required

Message describing the error.


Code Samples
COPY
                    curl -H 'Authorization: <value>' https://{api_host}/baremetal/servers-summary
On This Page
Baremetal Security Operations
GET
Get Baremetal Controller List
GET
Get Baremetal Controller Status
GET
Get Baremetal Server Status
GET
Get Baremetal Server List
POST
Perform Baremetal Servers Action
GET
Get Baremetal Server
DELETE
Uninstall Baremetal Server
GET
Get Baremetal Server Installer Bundle
GET
Get Registration Token
DELETE
Delete Registration Token
GET
Get Registration Token Status
GET
Get Registration Token Statuses
POST
Create Registration Token
GET
Get Registration Tokens
GET
Get Baremetal Services Status
GET
Get Baremetal Server Summary
POST
Query Baremetal Server Details
GET
Get Baremetal Task Status