NodeStatus

NodeStatus
NodeStatus

Runtime status information of the fabric node.

JSON Example
{
    "external_id": "string",
    "host_node_deployment_status": "string",
    "inventory_sync_paused": false,
    "inventory_sync_reenable_time": 0,
    "last_heartbeat_timestamp": 0,
    "last_sync_time": 0,
    "lcp_connectivity_status": "string",
    "lcp_connectivity_status_details": [
        {
            "control_node_ip": "string",
            "failure_status": "string",
            "status": "string"
        }
    ],
    "maintenance_mode": "string",
    "mpa_connectivity_status": "string",
    "mpa_connectivity_status_details": "string",
    "software_version": "string",
    "system_status": {
        "cpu_cores": 0,
        "cpu_sockets": 0,
        "cpu_usage": {
            "avg_cpu_core_usage_dpdk": "number",
            "avg_cpu_core_usage_non_dpdk": "number",
            "highest_cpu_core_usage_dpdk": "number",
            "highest_cpu_core_usage_non_dpdk": "number"
        },
        "dfw_heap_memory_usage": [
            {
                "description": "string",
                "name": "string",
                "total_mb": 0,
                "usage_pct": "number",
                "used_mb": 0
            }
        ],
        "disk_space_total": 0,
        "disk_space_used": 0,
        "dpdk_cpu_cores": 0,
        "dpus": [
            {
                "cpu_cores": 0,
                "dpu_alias": "string",
                "dpu_id": "string",
                "load_average": [
                    "number"
                ],
                "mem_cache": 0,
                "mem_total": 0,
                "mem_used": 0
            }
        ],
        "edge_mem_usage": {
            "cache_usage": "number",
            "datapath_mem_usage_details": {
                "datapath_heap_usage": "number",
                "datapath_mem_pools_usage": [
                    {
                        "description": "string",
                        "name": "string",
                        "usage": "number"
                    }
                ],
                "highest_datapath_mem_pool_usage": "number",
                "highest_datapath_mem_pool_usage_names": [
                    "string"
                ]
            },
            "datapath_total_usage": "number",
            "swap_usage": "number",
            "system_mem_usage": "number"
        },
        "file_systems": [
            {
                "file_system": "string",
                "mount": "string",
                "total": 0,
                "type": "string",
                "used": 0
            }
        ],
        "hostname": "string",
        "load_average": [
            "number"
        ],
        "mem_cache": 0,
        "mem_total": 0,
        "mem_used": 0,
        "non_dpdk_cpu_cores": 0,
        "remote_logging_server_configured": false,
        "source": "string",
        "swap_total": 0,
        "swap_used": 0,
        "system_time": 0,
        "uptime": 0
    }
}
string
external_id
Optional

HostNode external id

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. After all fabric level operations are done for an edge node, this value indicates transport node related configuration issues and state as relevant.

Possible values are : NOT_PREPARED, INSTALL_IN_PROGRESS, INSTALL_FAILED, INSTALL_SUCCESSFUL, INSTALL_SKIPPED, UNINSTALL_IN_PROGRESS, UNINSTALL_FAILED, UNINSTALL_SUCCESSFUL, UNINSTALL_SCHEDULED, UNINSTALL_SKIPPED, 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, REPLACE_FAILED, DELETE_VM_IN_REDEPLOY_FAILED, DEPLOY_VM_IN_REDEPLOY_FAILED, INSUFFICIENT_RESOURCES_IN_EDGE_NODE_FOR_SERVICE, UNABLE_TO_DELETE_EDGE_NODE_VM_INTERNAL_ERROR, RETRYING_REPLACE, DUPLICATE_PNICS_IN_TEAMINGS_WITH_MULTIPLE_UPLINKS_AND_FAILOVER_ORDER, DUPLICATE_VLANS_SHARING_SAME_PNIC, DELETE_IN_PROGRESS, DELETE_FAILED_FOR_DIFFERENT_MOREF_ID, DELETE_FAILED_ON_VM_NOT_FOUND, DELETE_FAILED_FOR_NON_LCM_EDGE, REDEPLOY_ACTIVITY_SCHEDULED, REPLACE_ACTIVITY_SCHEDULED, REDEPLOY_ACTIVITY_IN_PROGRESS, REPLACE_ACTIVITY_IN_PROGRESS, REDEPLOY_ACTIVITY_SUCCESSFUL, REPLACE_ACTIVITY_SUCCESSFUL, REDEPLOY_ACTIVITY_FAILED, VM_REDEPLOY_FAILED, REDEPLOYED_VM_REGISTRATION_PENDING, REPLACE_ACTIVITY_FAILED, REPLACED_RPC_CLIENT_OF_TN, VM_RESOURCE_RESERVATION_EDIT_PENDING, VM_RESOURCE_RESERVATION_FAILED, ADVANCED_CONFIG_EDIT_PENDING, ADVANCED_CONFIG_EDIT_FAILED, COMPUTE_MANAGER_NOT_FOUND, UPT_MODE_REALIZATION_POLL_TIMED_OUT, DATAPATH_CONFIGURATION_EDIT_FAILED, MAINTENANCE_MODE_ENABLED, ERROR_IN_ENABLE_MAINTENANCE_MODE, ERROR_IN_DISABLE_MAINTENANCE_MODE, CONFIGURE_UPT_ON_VM_FAILED, VM_VERSION_IS_UPT_INCOMPATIBLE, EDGE_NODE_SETTINGS_MISMATCH_RESOLVE, EDGE_VM_VSPHERE_SETTINGS_MISMATCH_RESOLVE, EDGE_NODE_SETTINGS_AND_VSPHERE_SETTINGS_ARE_CHANGED_RESOLVE, EDGE_VSPHERE_LOCATION_MISMATCH_RESOLVE, DUPLICATE_VLANS_SHARING_SAME_PNICMULTIPLE_UPLINKS_IN_NAMED_TEAMING_NOT_SUPPORTED_IF_UPLINK_IN_DEFAULT_TEAMING,
boolean
inventory_sync_paused
Optional

Is true if inventory sync is paused else false

integer As int64 As int64
inventory_sync_reenable_time
Optional

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

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
lcp_connectivity_status
Optional
Constraints: default: UNKNOWN

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

Possible values are : UP, DOWN, DEGRADED, UNKNOWN,
lcp_connectivity_status_details
Optional
Constraints: default:

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

string
maintenance_mode
Optional

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

Possible values are : OFF, ENTERING, ON, EXITING, ENABLED, DISABLED,
string
mpa_connectivity_status
Optional

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

Possible values are : UP, DOWN, UNKNOWN,
string
mpa_connectivity_status_details
Optional

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

string
software_version
Optional

Software version of the fabric node.

system_status
Optional

Node status properties