enable_outliers_detection_cross_cm_collector

Run on a central manager to enable outliers on the specified collector(s) in this central manager's environment. This is for use in a multi-central manager environment; the collector is in this central manager's environment but the data is sent to an aggregator in another central manager's environment.

This API is available in Guardium V10.6 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/enableOutliersDetectionCrossCMOnCollector

GuardAPI syntax

enable_outliers_detection_cross_cm_collector parameter=value

Parameters

Parameter Value type Description
collector_host_names String The collectors whose analytic data is getting sent to an aggregator outside of ts central environment.
DAM_FAM String The type of outlier data. Valid values:
  • DAM
  • FAM
extraction_start date in the 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.
group_descs String  
schedule_start   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 collectors coll1a, coll2a, run this command on the central manager of the collectors:

enable_outliers_detection_cross_cm_collector collector_host_names=coll1a,coll2a