GuardAPI Health Functions

Use these GuardAPI commands to configure the disk and DB health analyzer.

enable_health_analyzer

Starts the Disk and DB Health Analyzer. The analyzer sends alerts when the system predicts that a DB size or files on disk (/var) will reach 50% in the next 14 days, by default. It runs at a predefined schedule Whenever you enable the Disk and DB Health Analyzer it reverts to its default start run time of 05:07:07.

grdapi enable_health_analyzer

disable_health_analyzer

Stops the Disk and DB Health Analyzer.

grdapi disable_health_analyzer

get_all_modifiable_guard_params

This generic grdapi command returns all parameters and their values that can be modified by the command modify_guard_param.

Parameters Value Type Description
paramlike

string

Any number or characters

Returns all parameters that match the provided string. If not provided, all modifiable parameters are returned.
paramdesclike

string

Any number or characters

Returns all parameters that match the description provided. If not provided, all modifiable parameters are returned.
api_target_host string

api_target_host is an optional parameter that specifies target hosts where the API executes.  It accepts the following 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.

Example:

grdapi get_all_modifiable_guard_params paramlike=health_analyze

Returns the parameter name, parameter description, parameter type and parameter value of all modifiable parameters that contain the phrase "health_analyze" as shown in Table 1.

get_guard_param

This generic grdapi command returns the current value of the specified parameter.

Parameters Value Type Description
paramName string The name of the parameter.

You must provide either a parameter name or parameter description.
paramdesc string The parameter description.

You must provide either a parameter name or parameter description.
api_target_host string

api_target_host is an optional parameter that specifies target hosts where the API executes.  It accepts the following 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.

Syntax:

grdapi get_guard_param paramName=parameter
Example:
grdapi get_guard_param paramName="HEALTH_ANALYZER_VAR_SAMPLE_DAYS"

modify_guard_param

Use this generic grdapi command to update values of modifiable parameters.

Parameters Value Type Description
paramName string Required. The name of the modifiable parameter.
paramValue string Required. New value for the modifiable parameter.
api_target_host string

api_target_host is an optional parameter that specifies target hosts where the API executes.  It accepts the following 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.

Syntax:

grdapi modify_guard_param paramName=parameter paramValue=value

Where paramName is one of the parameters described in Table 1.

Use these parameters to configure the disk and database health analyzer alerts.
Note: Exercise caution when modifying these parameters; the alert paradigm is sensitive to small changes.
Table 1. Modifiable parameters for health analyzer functions
Modifiable parameter Value Description
HEALTH_ANALYZER_DB_LOOKAHEAD_DAYS integer Alerts are sent if the predicted HEALTH_ANALYZER_DB_USAGE_THRESHOLD will occur in the next HEALTH_ANALYZER_DB_LOOKAHEAD_DAYS. Default = 14.
HEALTH_ANALYZER_DB_SAMPLE_DAYS integer Number of immediately preceding days that the DB growth is monitored, in order to predict future usage. Default = 7.
HEALTH_ANALYZER_DB_USAGE_THRESHOLD integer. 1-100 The DB size threshold (in %) at which an alert is sent. Default = 50. 100% size varies according to the Guardium system type (50% of /var for collector, and 75% of /var for aggregator).
HEALTH_ANALYZER_VAR_LOOKAHEAD_DAYS integer Alerts are sent if the predicted HEALTH_ANALYZER_VAR_USAGE_THRESHOLD will occur in the next HEALTH_ANALYZER_VAR_LOOKAHEAD_DAYS. Default = 14.
HEALTH_ANALYZER_VAR_SAMPLE_DAYS integer Number of days the /var growth is monitored, in order to predict future usage. Default = 7.
HEALTH_ANALYZER_VAR_USAGE_THRESHOLD integer. 1-100 The /var size threshold (in %) at which an alert is sent. Default = 50.