You can monitor tunnel health of a hypervisor to see any problem using REST API.

The status shows four states:

  • Up: All components are healthy.

  • Degraded: Some components are unhealthy.

  • Down: All components are unhealthy.

  • Disabled: The component for which you want the status is disabled by the administrator.

You can monitor status for the following components:

  1. Physical NIC (pNIC):

    • With a link aggregation group (LAG) mode:

      • pNIC status is up, when all the uplinks belong to a LAG are up.

      • pNIC status is down, when all the uplinks belong to a LAG are down.

      • pNIC status is degraded, when few uplinks belong to a LAG are up and few are down.

    • With non-LAG mode:

      • pNIC status is shown as up or down.

  2. Tunnel: Tunnel networking connectivity status.

    • Tunnel status is up, when all tunnels for the hypervisor are up.

    • Tunnel status is down, when all tunnels for the hypervisor are down.

    • Tunnel status is degraded, when few tunnels are up and few are down.

  3. Control plane status: Connection status between hypervisor and controllers.

  4. Management plane status: Connection status between hypervisor and management plane.

Use the following APIs to monitor tunnel health of the hypervisor:

  • To view overall status of the host: GET /api/2.0/vdn/host/status.

  • To view tunnel summary for a specific host: GET /api/2.0/vdn/host/<host-id>/status.

  • To view tunnel status for a specific host: GET /api/2.0/vdn/host/<host-id>/tunnel.

  • To view status of all hosts with tunnel connections to the given host: GET /api/2.0/vdn/host/<host-id>/remote-host-status.

  • To retrieve the BFD global configuration: GET /api/2.0/vdn/bfd/configuration/global.

  • To change BFD configuration for the health monitoring: PUT /api/2.0/vdn/bfd/configuration/global. You can also disable BFD from monitoring tunnel health of the hypervisor.

  • To retrieve status information about pNIC: GET /api/2.0/vdn/pnic-check/configuration/global.

  • To change pNIC configuration for the health monitoring: PUT /api/2.0/vdn/pnic-check/configuration/global. You can also disable pNIC from monitoring tunnel health of the hypervisor.

For more information on API, refer to NSX API Guide.