close_default_events

This command closes all of the events that are defined on a specific process, task, or execution for tasks of type report.

This command is useful if, for example, you have a task with a default event that returns numerous records, but the task cannot be signed unless all of the events are closed.

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

GuardAPI syntax

close_default_events parameter=value

Parameters

Parameter Value type Description
eventStatus String Required. A final event status (such as Done). Must be a valid status for the default event that is defined for this audit task.
execDate Date Required. The execution date and time in the format YYYY-MM-DD hh:mm:ss.
processDesc String Required. The name of the audit process.
taskDesc String Required. The name of the audit task.
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 close_default_events eventStatus=Done execDate="2020-03-01 08:00:00" 
processDesc="Audit Process" taskDesc="Task Description"