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
Request Body
ReadNodesStatusRequestParameters of type(s) application/json
Required 
{
    "node_ids": [
        "string"
    ]
}
array of string
node_ids
Required

A comma separated list of request Node Ids.

Authentication
This operation uses the following authentication methods.
Responses
200

Success

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_cache": 0,
                "swap_total": 0,
                "system_time": 0,
                "cpu_cores": 0,
                "uptime": 0,
                "mem_used": 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

results


default

Unexpected error

Returns ApiError of type(s) application/json 
{
    "module_name": "string",
    "error_message": "string",
    "error_code": 0
}
string
module_name
Optional

module_name

string
error_message
Optional

error_message

integer As int64 As int64
error_code
Optional

error_code


On This Page
Fabric Operations
POST
Add Node
DELETE
Delete Node
GET
Get Fabric Node Modules
GET
Get Fabric Node State
GET
List Fabric Node Interfaces
GET
List Node Capabilities
GET
List Nodes
GET
List Vifs
GET
List Virtual Machines
POST
Perform Host Node Upgrade Action
POST
Perform Node Action
GET
Read Fabric Node Interface
GET
Read Fabric Node Interface Statistics
GET
Read Node
GET
Read Nodes Status
GET
Read Node Status
POST
Restart Inventory Sync
PUT
Update Node
POST
Update Virtual Machine Tags