Read Node Status

Read Node Status

Returns connectivity, heartbeat, and version information about a fabric node (host or edge). Note that the LCP connectivity status remains down until after the fabric node has been added as a transpot node and the NSX host switch has been successfully installed. See POST /api/v1/transport-nodes.

Request
URI
GET
https://nsxmanager.your.domain/api/v1/fabric/nodes/{node-id}/status
COPY
Path Parameters
string
node-id
Required

node-id

Query Parameters
string
source
Optional

Data source type.

Possible values are : realtime, cached,
Authentication
This operation uses the following authentication methods.
Responses
200

Success

Returns NodeStatus of type(s) application/json 
{
    "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"
}
string
mpa_connectivity_status
Optional

mpa_connectivity_status

Possible values are : UP, DOWN, UNKNOWN,
array of ControlConnStatus
lcp_connectivity_status_details
Optional

lcp_connectivity_status_details

string
mpa_connectivity_status_details
Optional

mpa_connectivity_status_details

string
external_id
Optional

external_id

string
software_version
Optional

software_version

string
maintenance_mode
Optional

maintenance_mode

Possible values are : OFF, ENTERING, ON, EXITING,
boolean
inventory_sync_paused
Optional

inventory_sync_paused

system_status
Optional

Node status properties

integer As int64 As int64
inventory_sync_reenable_time
Optional

Inventory sync auto re-enable target time, in epoch milis

string
lcp_connectivity_status
Optional

lcp_connectivity_status

Possible values are : UP, DOWN, DEGRADED, UNKNOWN,
integer As int64 As int64
last_heartbeat_timestamp
Optional

Timestamp of the last heartbeat status change, in epoch milliseconds.

integer As int64 As int64
last_sync_time
Optional

Timestamp of the last successful update of Inventory, in epoch milliseconds.

string
host_node_deployment_status
Optional

host_node_deployment_status

Possible values are : NOT_PREPARED, INSTALL_IN_PROGRESS, INSTALL_FAILED, INSTALL_SUCCESSFUL, UNINSTALL_IN_PROGRESS, UNINSTALL_FAILED, UNINSTALL_SUCCESSFUL, UPGRADE_IN_PROGRESS, PENDING_UPGRADE, NOT_AVAILABLE,

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