create_entry_location

This command adds an archive catalog entry to the catalog location table.

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

GuardAPI syntax

create_entry_location parameter=value

Parameters

Parameter Value type Description
entryType String Required. The type of archive file. Valid values:
  • CollectorDataArchive
  • AggDataArchive
  • AggResultArchive
fileName String Required. The name of the archive file in one of these formats:
  • <day of data>-<Guardium system name>-w<time of zip>-d<execution date>.dbdump.enc
  • <day of data>-<Guardium system name>-w<time of zip>-d<execution date>.agg.<sql ver>tar.gc.enc
hostName String Required. The hostname or IP address.
password String The user's password.
  • Amazon S3: Secret Access Key
  • IBM COS: Secret Access Key
  • IBM Cloud: X-Auth-Key
path String Required. The path to the archive directory.
  • Amazon S3: bucket name
  • IBM COS: bucket name
  • EMC Centera: Centera clipID
  • FTP: Specify the directory relative to the FTP account home directory.
  • SCP: Specify the directory as an absolute path.
  • IBM Cloud: Container
  • TSM: path
processDesc String Required when the entryType = AggResultArchive.
retention Integer The number of days to keep the entry in the catalog.

Default = 365
storageSystem String Required. The type of archive storage system. For valid values, call create_entry_location from the command line with --help=true.
user String The user account to access the host.
  • Amazon S3, Cleversafe: Access Key ID
  • Softlayer: X-Auth-User
Attention: For storageSystem type FTP, the user value cannot include any of the following characters: ! " $ & ' ( ) ; \ |
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.

GuardAPI Example

grdapi create_entry_location entryType=CollectorDataArchive  
fileName=733392-a1.corp.com-w20071223.133546-d2007-12-27.dbdump.enc password=somePassword 
user=someUser path=/var/dump/ hostName=192.168.1.241 storageSystem=scp