list_health_node

This command provides health and other information about the current machine. For a central manager, information also displays for all managed units.

For deployment health, the numbers are mapped as follows:
  • -1 - Unavailable
  • 0 - Healthy
  • 1 - Unknown/Stale
  • 2 - Medium severity
  • 3 - High severity

This API is available in Guardium V10.5 and later.

REST API syntax

This API is available as a REST service with the GET method. Call this API as follows: 
GET https://[Guardium hostname or IP address]:8443/restAPI/list_health_node

GuardAPI syntax

list_health_node parameter=value

Parameters

Parameter Value type Description
api_target_host String

Specifies the target hosts where the API executes. Valid values:
  • all_managed: execute on all managed units but not the central manager
  • all: execute on all managed units and the central manager
  • group:<group name>: execute on all managed units identified by <group name>
  • host name or IP address of a managed unit: specified from the central manager to execute on a managed unit.  For example, api_target_host=10.0.1.123.
  • host name or IP address of the central manager: specified from a managed unit to execute on the central manager. For example, api_target_host=10.0.1.123.

IP addresses must conform to the IP mode of your network. For dual IP mode, use the same IP protocol with which the managed unit is registered with the central manager. For example, if the registration uses IPv6, specify an IPv6 address. The hostname is independent of IP mode and can be used with any mode.

Example

grdapi list_health_node

Sample output: 

[{"id":0,"name":"my.system.com","unitHostIp":null,"type":"ag","patch":null,"status":0,"parent":"none","connectivity":0,"version":"11.2","exportsTo":[],"importsFrom":null,"osVersion":null,"unit_utilization_health_status":-1,"mus_staps_health_status":-1,"agg_health_status":-1,"stap_verification_status":-1,"ktapStatus":-1,"isCurrentUnit":true,"details":null}]