Return Runtime Status Information for a Node (Deprecated)

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.
This api is deprecated, use GET /api/v1/transport-nodes/<node-id>/status to
get status information of a node with constraint FN is converted to TN.

Request:

Method:

GET

URI Path(s):

/api/v1/fabric/nodes/<node-id>/status

Request Headers:

n/a

Query Parameters:

DataSourceParameters+

Name	Description	Type	Notes
source	The data source, either realtime or cached. If not provided, cached data is returned.	DataSourceType

Request Body:

n/a

Example Request:

GET https://<nsx-mgr>/api/v1/fabric/nodes/90b3ee63-82fe-11e5-b403-fd59414c0c52/status

Successful Response:

Response Code:

200 OK

Response Headers:

Content-type: application/json

Response Body:

NodeStatus+

NodeStatus (schema)

Name	Description	Type	Notes
external_id	HostNode external id	string
host_node_deployment_status	Install/Uninstall status of deployment. 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. After all fabric level operations are done for an edge node, this value indicates transport node related configuration issues and state as relevant.	string	Readonly Enum: NOT_PREPARED, INSTALL_IN_PROGRESS, INSTALL_FAILED, INSTALL_SUCCESSFUL, UNINSTALL_IN_PROGRESS, UNINSTALL_FAILED, UNINSTALL_SUCCESSFUL, UNINSTALL_SCHEDULED, 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, HOST_DISCONNECTED, POWERED_OFF, TRANSPORT_NODE_SYNC_PENDING, TRANSPORT_NODE_CONFIGURATION_MISSING, EDGE_HARDWARE_NOT_SUPPORTED, MULTIPLE_OVERLAY_TZS_NOT_SUPPORTED, TN_OVERLAY_TZ_IN_USE_BY_EDGE_CLUSTER, TZ_ENDPOINTS_NOT_SPECIFIED, NO_PNIC_PREPARED_IN_EDGE, APPLIANCE_INTERNAL_ERROR, VTEP_DHCP_NOT_SUPPORTED, UNSUPPORTED_HOST_SWITCH_PROFILE, UPLINK_HOST_SWITCH_PROFILE_NOT_SPECIFIED, HOSTSWITCH_PROFILE_NOT_FOUND, LLDP_SEND_ENABLED_NOT_SUPPORTED, UNSUPPORTED_NAMED_TEAMING_POLICY, MULTIPLE_UPLINKS_IN_NAMED_TEAMING_NOT_SUPPORTED_IF_UPLINK_IN_DEFAULT_TEAMING, LBSRCID_NOT_SUPPORTED_FOR_EDGE_VM, LACP_NOT_SUPPORTED_FOR_EDGE_VM, STANDBY_UPLINKS_NOT_SUPPORTED_FOR_EDGE_VM, MULTIPLE_ACTIVE_UPLINKS_NOT_SUPPORTED_FOR_EDGE, UNSUPPORTED_LACP_LB_ALGO_FOR_NODE, EDGE_NODE_VERSION_NOT_SUPPORTED, NO_PNIC_SPECIFIED_IN_TN, INVALID_PNIC_DEVICE_NAME, TRANSPORT_NODE_READY, UNSUPPORTED_DEFAULT_TEAMING_POLICY, MPA_DISCONNECTED, VM_NETWORK_EDIT_PENDING, VM_RENAME_PENDING, VM_CONFIG_EDIT_PENDING, VM_NETWORK_EDIT_FAILED, VM_RENAME_FAILED, VM_CONFIG_EDIT_FAILED, VM_CONFIG_DISCREPANCY, VM_NODE_REFRESH_FAILED, VM_PLACEMENT_REFRESH_FAILED, REGISTRATION_TIMEDOUT, LOGICAL_SWITCH_NAMED_TEAMING_HAS_NO_PNIC_BACKING, UPLINK_FROM_TEAMING_POLICY_NOT_MAPPED
inventory_sync_paused	Is true if inventory sync is paused else false	boolean	Readonly
inventory_sync_reenable_time	Inventory sync auto re-enable target time, in epoch milis	EpochMsTimestamp	Readonly
last_heartbeat_timestamp	Timestamp of the last heartbeat status change, in epoch milliseconds.	EpochMsTimestamp	Readonly
last_sync_time	Timestamp of the last successful update of Inventory, in epoch milliseconds.	EpochMsTimestamp	Readonly
lcp_connectivity_status	Indicates the fabric node's LCP<->CCP channel connectivity status, UP, DOWN, DEGRADED, UNKNOWN.	string	Readonly Enum: UP, DOWN, DEGRADED, UNKNOWN Default: "UNKNOWN"
lcp_connectivity_status_details	Details, if any, about the current LCP<->CCP channel connectivity status of the fabric node.	array of ControlConnStatus	Readonly Default: "[]"
maintenance_mode	Indicates the fabric node's status of maintenance mode, OFF, ENTERING, ON, EXITING.	string	Readonly Enum: OFF, ENTERING, ON, EXITING
mpa_connectivity_status	Indicates the fabric node's MP<->MPA channel connectivity status, UP, DOWN, UNKNOWN.	string	Readonly Enum: UP, DOWN, UNKNOWN
mpa_connectivity_status_details	Details, if any, about the current MP<->MPA channel connectivity status of the fabric node.	string	Readonly
software_version	Software version of the fabric node.	string	Readonly
system_status	Node status properties	NodeStatusProperties	Readonly

Example Response:

{ "last_heartbeat_timestamp": 1446675283540, "lcp_connectivity_status": "UP", "mpa_connectivity_status": "UP", "system_status": { "mem_used": 2551264, "system_time": 1446649452000, "file_systems": [ { "file_system": "root", "total": 32768, "used": 476, "type": "ramdisk", "mount": "/" }, { "file_system": "etc", "total": 28672, "used": 220, "type": "ramdisk", "mount": "/etc" }, { "file_system": "opt", "total": 32768, "used": 1040, "type": "ramdisk", "mount": "/opt" }, { "file_system": "var", "total": 49152, "used": 1196, "type": "ramdisk", "mount": "/var" }, { "file_system": "tmp", "total": 262144, "used": 24136, "type": "ramdisk", "mount": "/tmp" }, { "file_system": "hostdstats", "total": 302080, "used": 2072, "type": "ramdisk", "mount": "/var/lib/vmware/hostd/stats" } ], "load_average": [ 0.17000000178813934, 0.17000000178813934, 0.15000000596046448 ], "swap_total": 0, "mem_cache": 0, "cpu_cores": 16, "source": "cached", "mem_total": 25119208, "swap_used": 0, "uptime": 7213000 }, "last_sync_time": 1473837914408, "mpa_connectivity_status_details": "Client is responding to heartbeats", "software_version": "1.1.0.0.0.3195008", "host_node_deployment_status": "INSTALL_SUCCESSFUL", "lcp_connectivity_status_details": [ { "control_node_ip": "192.168.110.34", "failure_status": "UNKNOWN_FAILURE_STATUS", "status": "UP" } ], "inventory_sync_paused": false }

Return Runtime Status Information for a Node (Deprecated)

Request:

DataSourceParameters (schema)

Example Request:

Successful Response:

NodeStatus (schema)

Example Response:

Required Permissions:

Feature:

Additional Errors: