configure_results_export

This command defines the results export to Guardium® aggregators or central managers.

This API is available in Guardium V11.2 and later.

REST API syntax

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

GuardAPI syntax

configure_results_export parameter=value

Parameters

Parameter Value type Description
destHost String Required. The target destination host name.
passwd String Required. Password for userName on the target destination host.
port Integer Required. Port on the target destination server.
protocol String Required. Valid values:
  • SCP
  • FTP
ssh_key_active Boolean Enables data transfer using the SSH key. Enable the SSH key feature with the CLI command store system scp-ssh-key-mode on. Generate ssh-key pairs and copy the public part of the key, public-transfer-key, to the remote host. For more information, see Enabling ssh-key pairs for data archive, data export, data mart. Valid values:
  • 0: Disable
  • 1: Enable
Default = 0
transferMethod String Required. Valid values:
  • SCP
  • FTP
targetDir String Required. The target directory on the target destination server.
userName String Required. User name with write access for the target destination server.
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 configure exporting of results older than one day, and not older than two days, using FTP, and where both username and password are admin:

grdapi configure_results_export destHost=<hostname of target> targetDir=<path to target directory> port=1111 userName=admin passwd=admin protocol=FTP