Get Baremetal Server Status

Get Baremetal Server Status
Get baremetal server status

Returns the status of the baremetal server.

Request
URI
GET
https://{api_host}/baremetal/servers/{server-id}/status
COPY
Path Parameters
string
server-id
Required

Baremetal server ID.


Authentication
This operation uses the following authentication methods.
Responses
200

OK

Returns BaremetalServerStatus of type(s) application/json
This response body class contains all of the following: InlineBaremetalServerStatus0 , InlineBaremetalServerStatus1
{
    "_create_user": "string",
    "_create_time": 0,
    "_last_modified_user": "string",
    "_last_modified_time": 0,
    "_revision": 0,
    "_resource_type": "string",
    "_system_owned": false,
    "id": "string",
    "display_name": "string",
    "description": "string",
    "site_ids": [
        "string"
    ],
    "lcm_status": "string",
    "lcm_error": "string",
    "lcm_operation": "string",
    "os_details": "string",
    "agent_version": "string",
    "state": "string",
    "connectivity_status": "string",
    "is_agent_local_uninstall": false,
    "config": {
        "interfaces": [
            {
                "interface_name": "string",
                "interface_id": "string",
                "is_mgmt_interface": false,
                "mac_address": "string",
                "address_bindings": [
                    "string"
                ],
                "admin_status": "string"
            }
        ]
    },
    "controller": {
        "controller_ip": "string",
        "controller_id": "string"
    },
    "agent_health": {
        "connectivity": {
            "controller_connectivity_status": "string",
            "orchestrator_connectivity_status": "string",
            "metrics_service_connectivity_status": "string"
        },
        "agents_status": {
            "operational_status": "string",
            "operational_message": "string"
        },
        "overall_agent_health": "string"
    },
    "last_operation_info": "string"
}

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/{server-id}/status