add_group_to_quick_search

This command adds groups to the quick search facet drop-down menus, so that you can select the groups for filtering the investigation dashboard results.

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

GuardAPI syntax

add_group_to_quick_search parameter=value

Parameters

Parameter Value type Description
facet String Required. The facet of the group you are adding. Valid values:
  • DB_USER
  • OS_USER
  • OBJECT
  • VERB
  • FAM_COMMAND
  • SERVER_IP
group_description String Required. Group name you are adding, of the specified facet type.
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

To add server_group5 to the quick search:

add_group_to_quick_search facet=SERVER_IP group_description=server_group5