Use this command to configure a data archive.
This API is available in Guardium V9.5 and later.
REST API syntax
PUTmethod. Call this API as follows:
PUT https://[Guardium hostname or IP address]:8443/restAPI/configure_archive
|accessKey||String||Required for Cleversafe; and for Amazon S3 when authType=Security-Credentials or authType=IAM-Role. Identifies user as the party responsible for service requests. It needs to be included it in each request. It is not confidential and does not need to be encrypted. (20-character, alphanumeric sequence).|
|archiveOlderThan||Integer||Required. Specifies the number of days, older than which data is archived. For example, to archive data starting with yesterday’s data, set this value to 1.|
|archiveValues||Integer|| Required. Specify whether the archive data includes values from SQL strings. Valid values:
|authType||String||Required for Amazon S3 only. Valid values:
|bucketName||String||Required for Amazon S3 and Cleversafe only. The unique bucket name.|
|destHost||String||Required for SCP, SFTP, Cleversafe only. Valid values:
|ignoreOlderThan||Integer||Required. Together with archiveOlderThan, specifies the time interval of data to archive: data that is older than this value, in days, is not exported.|
|passwd||String||Required for SCP, SFTP. Valid values: Password for the target archive server.|
|passwdRetype||String||Required for SCP, SFTP. Password for the target archive server.|
|port||Integer||Required for SCP, SFTP only. Port on the target archive server.|
|protocol||String||Required. Protocol of the target destination.
For valid values, call configure_archive
from the command line with
|region||String||Required for Amazon S3 only.
|retention||Integer||Required for Centera only. Number of days to retain the archive data on the target archive server.|
|roleARN||String||Required for Amazon S3 when authType=IAM-Role. The Amazon resource name (ARN) specifying this role.|
|secretKey||String||Required for Amazon S3 and Cleversafe only. The Secret Access Key is associated with the Access Key ID, used to calculate the digital signature that needs to be included in the request. (Only the user and AWS should have this 40-character sequence. )|
|targetDir||String||Required for SCP, SFTP, Cleversafe only. Valid values:
|userName||String||Required for SCP, SFTP only. User name for the target archive server.|
Specifies the target hosts where the API executes. Valid values:
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.
To configure archive of data, with SQL strings, older than one day and younger than 2 days, on an SFTP server:
grdapi configure_archive archiveOlderThan=1 archiveValues=1 destHost=<full path to target archive host> ignoreOlderThan=2 passwd=pass1 passwdRetype=pass1 port=0 protocol=SFTP targetDir=/archive/dir