pause_or_resume_scenarios

This command allows you to manage and schedule Discover Sensitive Data scenarios in batch. You can specify a set of scenarios by using a pattern, and then pause, restart, and preview the output.

This API is available in Guardium v11.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/schedule

GuardAPI syntax

pause_or_resume_scenarios parameter=value

Parameters

Parameter Value type Description
pause Boolean Required. Acts the same way as Activate schedule in the Discover Sensitive Data Scenario definition. Valid values:
  • 0 (false, pause a running job)
  • 1 (true, resume a paused schedule)

Default = 1 (true)
preview Boolean Run the command without applying any changes to see which scenarios are selected for a given scenarioNamePattern and make changes as needed. Valid values:
  • 0 (false)
  • 1 (true)

Default = 0 (false)
scenarioNamePattern String Required. Specify Discover Sensitive Data scenario names using MySQL patterns. For example, underscores ( _ ) and percent signs (%) are accepted, but an asterisk ( * ) is not.

All scenarios that meet the specified criteria run when pause = 1.
verbose Boolean Controls the amount of nformation displayed in the output. Valid values:
  • 0 (false, less verbose)
  • 1 (true, more verbose)

Default = 0 (false)
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.