schedule_generate_mongo_filter_job

This API defines the lists of groups IDs of the users, objects, and commands that are used to create a Guardium universal connector filter for MongoDB.

The groups in this API are used to continuously update the value of the GIM parameter GUC_AUDIT_LOG_FILTER. The GIM parameter specifies which events to include in the data forwarded to the Guardium universal connector.

This API is available in Guardium V11.3 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/scheduleGenerateMongoFilterJob

GuardAPI syntax

schedule_generate_mongo_filter_job parameter=value

Parameters

Parameter Value type Description
clientIp String The IP of the GIM client whose GIM parameter GUC_AUDIT_LOG_FILTER gets updated.
commandGroupId String String of comma separated IDs of groups whose members specify tuples of DB name and command to be included in the native log audit that is forwarded to the Guardium universal connector. If this parameter is not required for the filter, use usersGroupId="".
cronStr String Optional. Cron string that defines when to run the code that updates the filter in the GIM parameter GUC_AUDIT_LOG_FILTER.
Default is every night at 00:15: “0 15 0 * * ? *”
objectsGroupId String String of comma separated IDs of groups whose members specify the tuples of DB name and collection to be included in the native log audit that is forwarded to the Guardium universal connector. If this parameter is not required for the filter, use usersGroupId="".
startTime Date When to start the scheduling.
Default: now (null)
usersGroupId String String of comma separated IDs of groups whose members specify the tuples of DB Name and user name to be included in the native log audit that is forwarded to the Guardium universal connector. If this parameter is not required for the filter, use usersGroupId="".
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

grdapi schedule_generate_mongo_filter_job clientIp="9.42.135.95" usersGroupId="20000,20001" objectsGroupId="20004,20005" commandGroupId="20002,20003"