list_entry_location

This command returns a specific catalog entry if you include a file name. If you do not specify the file name, it returns details of all the catalog entries for this host and path.

This API is available in Guardium V9.5 and later.

REST API syntax

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

GuardAPI syntax

list_entry_location parameter=value

Parameters

Parameter Value type Description
fileName String Specifies the file location for this archive location. If omitted, the command returns details of all the catalog entries on the specified hostname and path.
hostName String Required. The hostname or IP address.
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
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 list_entry_location path=/mnt/nfs/archive_results/ hostName=192.168.1.33