Query Baremetal Server Details

Query Baremetal Server Details
Query baremetal servers with details using filters.

Returns the list of baremetal servers with their associated configs and statuses based on the provided filter criteria.

Request
URI
POST
https://{api_host}/baremetal/servers-status-detail
COPY
Request Body

Filter criteria for querying baremetal servers with details.

BaremetalServerDetailsRequest of type(s) application/json
Required  
This request body class requires all of the following: ListRequestParameters , InlineBaremetalServerDetailsRequest1 
{
    "site_ids": [
        "string"
    ],
    "offset": 0,
    "page_size": 0,
    "sort_ascending": false,
    "sort_by": "string",
    "display_name": [
        "string"
    ],
    "os_details": [
        "string"
    ],
    "agent_version": [
        "string"
    ],
    "agent_health": [
        "string"
    ],
    "last_operation_info": [
        "string"
    ]
}
Authentication
This operation uses the following authentication methods.
Responses
200

OK

Returns BaremetalServerDataList of type(s) application/json
This response body class contains all of the following: ListResult , InlineBaremetalServerDataList1 
{
    "offset": 0,
    "number_of_results": 0,
    "total_result_count": 0,
    "total_pages": 0,
    "sort_ascending": false,
    "sort_by": "string",
    "results": [
        {
            "_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",
                        "interface_type": "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"
        }
    ]
}

400

Bad Request - Invalid filter parameters or request body

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.


401

Unauthorized

Returns Unauthorized 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.


403

Forbidden

Returns Forbidden 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.


412

Precondition Failed

Returns PreconditionFailed 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.


428

Precondition Required

Returns PreconditionRequired 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.


429

Too Many Requests

Returns TooManyRequests 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.


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 -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{}' https://{api_host}/baremetal/servers-status-detail
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 Baremetal Server Windows Agent 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