audit_series_define

March 26, 2020 Contributors

Name

audit_series_define — Define an named audit series

Synopsis

#include "modules/validate/audit_series.h"

| int **audit_series_define** ( | name, |   |
|   | type, |   |
|   | interval, |   |
|   | num_windows, |   |
|   | serialize, |   |
|   | replicate, |   |
|   | persisted); |   |

const char * <var class="pdparam">name</var>;
const char * <var class="pdparam">type</var>;
int <var class="pdparam">interval</var>;
int <var class="pdparam">num_windows</var>;
int <var class="pdparam">serialize</var>;
char * <var class="pdparam">replicate</var>;
int <var class="pdparam">persisted</var>;

Description

Note

This reference page was automatically generated from functions found in the header files in the development branch. The function described here may not exist in generally available versions of Momentum, and may change in behavior when it is generally available. Consult your vendor for definitive advice on the use of this function.

Define an named audit series.

It should be called only once for a named series.

Parameters

name
  • name of the series.
type
  • type of the series. It should be "cidr", "cidr_ipv6", or "string".
interval
  • the time window size in seconds.
num_windows
  • the number of windows in the series.
serialize
  • if != 0, the series will be written to log.
replicate
  • if = "cluster", the series will be replicated across cluster. if = "manager", the series will be replicated to manager only.
persisted
  • if != 0, the series will will be persisted and survive the restart.

Return Values

one of the audit_series_return_code.

**Configuration Change. ** This feature is available starting from Momentum 3.1.