modify_ef_mapping

This command modifies the table or column names used for an external feed mapping.

Sometimes the names generated by create_ef_mapping are not suitable for a particular database, and modify_ef_mapping can be used to adjust the names to fit database requirements. To protect predefined Guardium mappings, only mappings with an identification key greater than 20000 can be modified.

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

GuardAPI syntax

modify_ef_mapping parameter=value

Parameters

Parameter Value type Description
modifyObj String Required. Specifies the database object to modify. Use the list_ef_mapping command to see the table and column names for a mapping.
Valid values:
  • table
  • column
newName String Required. The new table or column name to use.
oldName String Required. The table or column name to modify.
reportName String Required. Name of the report mapping to modify.
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 change the table name from SESSIONS_PER_DAY to SESSIONS-PER-DAY in the Sessions per Day report mapping:
grdapi modify_ef_mapping reportName="Sessions per Day" modifyObj=table oldName=SESSIONS_PER_DAY newName=SESSIONS-PER-DAY