APIs for NSX Edge and Tier-0 Monitoring

Products

VMware NSX

Issue/Introduction

This article describes NSX APIs that can be used to monitor Edge availability and Tier-0 status, and samples of their outputs.

Environment

VMware NSX

Resolution

Tier-0 and Edge State API

API used: GET /api/v1/infra/tier-0s/state

This API reports the realization state of the Tier-0 gateway and its associated Edge TransportNodes.

Sample Output: Both Edges Up

tier0_state:

state: in_sync

details:

sub_system_type: TransportNode state: in_sync

tier0_status:

per_node_status:

high_availability_status: STANDBY

high_availability_status: ACTIVE

Sample Output: One Edge Down

tier0_state:

state: unknown

details:

sub_system_type: TransportNode state: in_sync

sub_system_type: TransportNode state: unknown

failure_message: Unable to collect status for one transport node

tier0_status:

per_node_status:

high_availability_status: ACTIVE

high_availability_status: UNKNOWN

Sample Output: Both Edges Down

tier0_state:

state: unknown

details:

sub_system_type: TransportNode state: unknown

failure_message: Unable to collect status for all transport nodes

tier0_status:

per_node_status:

high_availability_status: ACTIVE

high_availability_status: STANDBY

BGP Neighbor Status API

API used: GET /policy/api/v1/infra/tier-0s/locale-services/default/bgp/neighbors/status

This API reports BGP neighbor status for Edge nodes reachable by NSX Manager.

Sample Output: Both Edges Up

results:

connection_state: ESTABLISHED

connection_state: ESTABLISHED result_count: 2

Sample Output: One Edge Down

results:

connection_state: ESTABLISHED result_count: 1

Sample Output: Both Edges Down

results: [] result_count: 0

NOTE:

While these APIs can contribute to monitoring the status of NSX Edge nodes and Tier-0 gateways, they are not a substitute or replacement for full system monitoring provided by Aria Operations for Networks.

Additional Information

For reference about API and API parameters see:

NSX-T Data Center REST API
For additional design or implementation guidance, contact Broadcom Professional Services.