aggregation

12.1 and later This API command is used to archive the data and export it.

REST API syntax

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

GuardAPI syntax

aggregation parameter=value

Parameters

Parameter Value type Description
from String

The from parameter should be less than to parameter, and should be earlier than the current date.
to String The to parameter should be earlier than the current date.
type String Valid values:
  • export
  • archive
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

The following command runs the export job.
grdapi aggregation type=export from=2024-01-01 to=2024-01-02
ID=0
Executing export using default interval
The following command runs the archive job.
grdapi aggregation type=archive from=2023-12-20 to=2024-01-02
ID=0
The following command runs the archive job. If no from and to dates are provided, the default settings are used.
grdapi aggregation type=archive
ID=0
Executing archive job