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

OK

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_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"
}
string
mpa_connectivity_status
Optional

Indicates the fabric node's MP<->MPA channel connectivity status, UP, DOWN, UNKNOWN.

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

Details, if any, about the current LCP<->CCP channel connectivity status of the fabric node.

string
mpa_connectivity_status_details
Optional

Details, if any, about the current MP<->MPA channel connectivity status of the fabric node.

string
external_id
Optional

HostNode external id

string
software_version
Optional

Software version of the fabric node.

string
maintenance_mode
Optional

Indicates the fabric node's status of maintenance mode, OFF, ENTERING, ON, EXITING.

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

Is true if inventory sync is paused else false

NodeStatusProperties
system_status
Optional

system_status

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

Indicates the fabric node's LCP<->CCP channel connectivity status, UP, DOWN, DEGRADED, UNKNOWN.

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

This enum specifies the current nsx install state for host node or current deployment and ready state for edge node. The ready status 'NODE_READY' indicates whether edge node is ready to become a transport node. The status 'EDGE_CONFIG_ERROR' indicates that edge hardware or underlying host is not supported.

Possible values are : NOT_PREPARED, INSTALL_IN_PROGRESS, INSTALL_FAILED, INSTALL_SUCCESSFUL, UNINSTALL_IN_PROGRESS, UNINSTALL_FAILED, UNINSTALL_SUCCESSFUL, UPGRADE_IN_PROGRESS, UPGRADE_FAILED, PENDING_UPGRADE, NOT_AVAILABLE, VM_DEPLOYMENT_QUEUED, VM_DEPLOYMENT_IN_PROGRESS, VM_DEPLOYMENT_FAILED, VM_POWER_ON_IN_PROGRESS, VM_POWER_ON_FAILED, REGISTRATION_PENDING, NODE_NOT_READY, NODE_READY, VM_POWER_OFF_IN_PROGRESS, VM_POWER_OFF_FAILED, VM_UNDEPLOY_IN_PROGRESS, VM_UNDEPLOY_FAILED, VM_UNDEPLOY_SUCCESSFUL, EDGE_CONFIG_ERROR, VM_DEPLOYMENT_RESTARTED, REGISTRATION_FAILED,

400
Returns BadRequest of type(s) application/json
This response body class contains all of the following: RelatedApiError , InlineApiError1 
{
    "module_name": "string",
    "error_message": "string",
    "error_code": 0,
    "details": "string",
    "related_errors": [
        {
            "module_name": "string",
            "error_message": "string",
            "error_code": 0,
            "details": "string"
        }
    ]
}

403
Returns Forbidden of type(s) application/json
This response body class contains all of the following: RelatedApiError , InlineApiError1 
{
    "module_name": "string",
    "error_message": "string",
    "error_code": 0,
    "details": "string",
    "related_errors": [
        {
            "module_name": "string",
            "error_message": "string",
            "error_code": 0,
            "details": "string"
        }
    ]
}

404

Not Found

Operation doesn't return any data structure

412
Returns PreconditionFailed of type(s) application/json
This response body class contains all of the following: RelatedApiError , InlineApiError1 
{
    "module_name": "string",
    "error_message": "string",
    "error_code": 0,
    "details": "string",
    "related_errors": [
        {
            "module_name": "string",
            "error_message": "string",
            "error_code": 0,
            "details": "string"
        }
    ]
}

500
Returns InternalServerError of type(s) application/json
This response body class contains all of the following: RelatedApiError , InlineApiError1 
{
    "module_name": "string",
    "error_message": "string",
    "error_code": 0,
    "details": "string",
    "related_errors": [
        {
            "module_name": "string",
            "error_message": "string",
            "error_code": 0,
            "details": "string"
        }
    ]
}

503
Returns ServiceUnavailable of type(s) application/json
This response body class contains all of the following: RelatedApiError , InlineApiError1 
{
    "module_name": "string",
    "error_message": "string",
    "error_code": 0,
    "details": "string",
    "related_errors": [
        {
            "module_name": "string",
            "error_message": "string",
            "error_code": 0,
            "details": "string"
        }
    ]
}

On This Page
Fabric Operations
POST
Add Compute Manager
POST
Add Node
POST
Create Compute Collection Fabric Template
DELETE
Delete Compute Collection Fabric Template
DELETE
Delete Compute Manager
DELETE
Delete Node
GET
Get Compute Collection Fabric Template
GET
Get Compute Manager State
GET
Get Fabric Node Modules
GET
Get Fabric Node State
POST
Host Prep Discovered Node Hostprep
GET
List Compute Collection Fabric Templates
GET
List Compute Collection Physical Network Interfaces
GET
List Compute Collections
GET
List Compute Managers
GET
List Discovered Nodes
GET
List Fabric Node Interfaces
GET
List Node Capabilities
GET
List Nodes
GET
List Vifs
GET
List Virtual Machines
POST
Perform Action On Compute Collection
POST
Perform Host Node Upgrade Action Upgrade Infra
POST
Perform Node Action
GET
Read Compute Collection
GET
Read Compute Manager
GET
Read Compute Manager Status
GET
Read Discovered Node
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 Restart Inventory Sync
PUT
Update Compute Collection Fabric Template
PUT
Update Compute Manager
PUT
Update Node
POST
Update Virtual Machine Tags Update Tags