enable_outliers_detection_agg

Run this API on a central manager to enable outliers detection on the specified aggregator.

It also schedules the datamart that sends outlier data from the collectors (that are in this CM) to the aggregator. It does not enable outlier mining on the collectors.

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

REST API syntax

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

GuardAPI syntax

enable_outliers_detection_agg parameter=value

Parameters

Parameter Value type Description
aggregator_host_name String Required. Outliers detection is enabled on this aggregator.
DAM_FAM String Optional. Specifies the type of outliers. Valid values:
  • DAM
  • FAM
The default is DAM.
extraction_start date in format: yyyy-mm-dd hh:mm:ss Use if you want to delay the start of data extraction. When not specified, data extractions starts immediately.
schedule_interval String Ignored.
schedule_start Date Ignored.
schedule_units String Ignored.
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.

Examples

To enable outliers detection on the aggregator agg-sw, run this command on the central manager of aggregator agg-sw:
grdapi enable_outliers_detection_agg aggregator_host_name=agg-sw