Read Nodes Status

Read Nodes Status

Returns connectivity, heartbeat, and version information about all fabric nodes (host or edge).

Request
URI
GET
https://nsxmanager.your.domain/api/v1/fabric/nodes/status
COPY
Query Parameters
string
node_ids
Required

List of requested Nodes.


Authentication
This operation uses the following authentication methods.
Responses
200

OK

Returns NodeStatusListResult of type(s) application/json
{
    "results": [
        {
            "mpa_connectivity_status": "string",
            "lcp_connectivity_status_details": [
                {
                    "status": "string",
                    "control_node_ip": "string",
                    "failure_status": "string"
                }
            ],
            "mpa_connectivity_status_details": "string",
            "external_id": "string",
            "software_version": "string",
            "maintenance_mode": "string",
            "inventory_sync_paused": false,
            "system_status": {
                "load_average": [
                    "number"
                ],
                "swap_used": 0,
                "mem_used": 0,
                "swap_total": 0,
                "system_time": 0,
                "cpu_cores": 0,
                "uptime": 0,
                "mem_cache": 0,
                "mem_total": 0,
                "file_systems": [
                    {
                        "mount": "string",
                        "total": 0,
                        "type": "string",
                        "file_system": "string",
                        "used": 0
                    }
                ],
                "source": "string"
            },
            "inventory_sync_reenable_time": 0,
            "lcp_connectivity_status": "string",
            "last_heartbeat_timestamp": 0,
            "last_sync_time": 0,
            "host_node_deployment_status": "string"
        }
    ]
}
array of NodeStatus
results
Required

Node Status list results


400
Returns BadRequest of type(s) application/json
{
    "details": "string",
    "related_errors": [
        "ApiError Object"
    ],
    "module_name": "string",
    "error_message": "string",
    "error_code": 0
}
object
error_data
Optional

Additional data about the error

string
details
Optional

Further details about the error

array of ApiError
related_errors
Optional

Other errors related to this error

string
module_name
Optional

The module name where the error occurred

string
error_message
Optional

A description of the error

integer As int64 As int64
error_code
Optional

A numeric error code


403
Returns Forbidden of type(s) application/json
{
    "details": "string",
    "related_errors": [
        "ApiError Object"
    ],
    "module_name": "string",
    "error_message": "string",
    "error_code": 0
}
object
error_data
Optional

Additional data about the error

string
details
Optional

Further details about the error

array of ApiError
related_errors
Optional

Other errors related to this error

string
module_name
Optional

The module name where the error occurred

string
error_message
Optional

A description of the error

integer As int64 As int64
error_code
Optional

A numeric error code


404

Not Found

Operation doesn't return any data structure

412
Returns PreconditionFailed of type(s) application/json
{
    "details": "string",
    "related_errors": [
        "ApiError Object"
    ],
    "module_name": "string",
    "error_message": "string",
    "error_code": 0
}
object
error_data
Optional

Additional data about the error

string
details
Optional

Further details about the error

array of ApiError
related_errors
Optional

Other errors related to this error

string
module_name
Optional

The module name where the error occurred

string
error_message
Optional

A description of the error

integer As int64 As int64
error_code
Optional

A numeric error code


500
Returns InternalServerError of type(s) application/json
{
    "details": "string",
    "related_errors": [
        "ApiError Object"
    ],
    "module_name": "string",
    "error_message": "string",
    "error_code": 0
}
object
error_data
Optional

Additional data about the error

string
details
Optional

Further details about the error

array of ApiError
related_errors
Optional

Other errors related to this error

string
module_name
Optional

The module name where the error occurred

string
error_message
Optional

A description of the error

integer As int64 As int64
error_code
Optional

A numeric error code


503
Returns ServiceUnavailable of type(s) application/json
{
    "details": "string",
    "related_errors": [
        "ApiError Object"
    ],
    "module_name": "string",
    "error_message": "string",
    "error_code": 0
}
object
error_data
Optional

Additional data about the error

string
details
Optional

Further details about the error

array of ApiError
related_errors
Optional

Other errors related to this error

string
module_name
Optional

The module name where the error occurred

string
error_message
Optional

A description of the error

integer As int64 As int64
error_code
Optional

A numeric error code