configure_export

This command defines the data export to a Guardium® aggregator or central manager.

This API is available in Guardium V9.5 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/configure_export

GuardAPI syntax

configure_export parameter=value

Parameters

Parameter Value type Description
aggHost String Required. The target aggregator hostname.
aggSecHost String The secondary target aggregator hostname.
exportOlderThan Integer Required. The export includes data older than this number of days. For example, to export yesterday’s data and older data, set exportOlderThan to 1.
exportValues Integer Required. Whether the export data includes values from SQL strings. Valid values:
  • 0: no. Values are replaced with question mark characters in the export, and are not available as part of a restore operation.
  • 1: yes
ignoreOlderThan Integer Required. Together with exportOlderThan, specifies the time interval of data to export: data that is older than this value, in days, is not exported.
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 export data older than one day, but not older than 2 days, without the SQL strings, to the specified aggregator:

grdapi configure_export aggHost=<full path to target aggregator> exportOlderThan=1 exportValues=0 ignoreOlderThan=2