create_ef_mapping

This command creates an external feed mapping and populates tables based on a specified report.

Each mapping has a name stored in EF_MAP_TYPE_HDR.EF_TYPE_DESC, and that name is identical to the value of the reportName parameter. The target table name is also be based on the reportName parameter, with underscores added between the words. For example, the report My Report becomes MY_REPORT.

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

REST API syntax

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

GuardAPI syntax

create_ef_mapping parameter=value

Parameters

Parameter Value type Description
reportName String Required. Name of the report to use for external feed mapping. This parameter also determines the name of the mapping and the target table name.
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 create a mapping for the Sessions per Day report:
grdapi create_ef_mapping reportName="Sessions per Day"