execute_incidentGenProcess_byDetails

This command generates incidents based on a defined query (by query name) against the policy violations log.

Use the parameters to filter for specific incidents. This command is the equivalent of running Run Once Now from the Incident Generation Process page.

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

GuardAPI syntax

execute_incidentGenProcess_byDetails parameter=value

Parameters

Parameter Value type Description
categoryName String The incident category name.
queryName String Required. The name of the query.
severity String The incident severity.
threshold Integer Threshold.
user String The username.
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.

GuardAPI example

grdapi  execute_incidentGenProcess_byDetails  queryName="Policy Violation Count" user=admin severity=info