list_ef_mapping

This commands lists all external feed mappings or details about a specified mapping.

If run without any parameters, this function returns a list of all user-created mappings. If run with the reportName parameter, this function returns details of the specified mapping \such as the table and column names used by the external feed.

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/list_ef_mapping

GuardAPI syntax

list_ef_mapping parameter=value

Parameters

Parameter Value type Description
reportName String View details for the report mapping identified by reportName.
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

Use this command to view all user-created external feed mappings:
grdapi list_ef_mapping
Use this command to view details for the Sessions per Day mapping:
grdapi list_ef_mapping reportName="Sessions per Day"