Check Overall System Health of
vCenter Server
Last Updated December 16, 2024

vCenter Server
provides a composite health indicator that enables you to test a single value that represents the health of all system components. This procedure shows how to test the composite health indicator.
Verify that you have an active authenticated session with
vCenter Server
. This procedure assumes that the session ID is present in the security context of a stub configuration.
The value of the overall system health indicator reflects the strongest trouble indication among the
vCenter Server
components. If any component has a
red
indicator, the overall system health indicator is
red
, else if any component has an
orange
indicator, the overall system health indicator is
orange
, and so on.
A
gray
value for any component indicates that data for the subsystem is unknown. If one or more components have a
gray
value, but all other subsystems are
green
, then the overall system health indicator is
gray
rather than
green
. However, if any component has a definite trouble indication, the overall system health indicator reflects the strongest trouble indication among the components.
  1. Create an interface stub or REST path that uses the stub configuration.
  2. Invoke the
    health.system
    method.
  3. Format and display the resulting value.