populate_group_from_query

This command populates a group from an existing query.

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

GuardAPI syntax

populate_group_from_query parameter=value

Parameters

Parameter Value type Description
activateSchedule Boolean Actives the schedule specified by cronString. Valid values:
  • 0 (false)
  • 1 (true)

Default = 1 (true)
clearGroup Boolean Required. Valid values:
  • 0 (false). Append new members to the group.
  • 1 (true). Clear the existing members from the group before adding new members.
cronString String The schedule to run the query as a cron string. For example, to run the query every day at 2 AM:
0 2 * * *
.
groupDesc String Required. A description of this group.
queryColumns String Required. The names of the columns to import into the group as a comma-separated string. For tuples, specify one column per tuple.
queryName String Required. The name of the query to use for populating the group. The query must already exist.
queryParams String Parameters for the query (specified as a key = value pair). For example,
QUERY_FROM_DATE=NOW -3 DAY,QUERY_TO_DATE=NOW
startDate Date The date to start using this API, based on the value of cronString.
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.