execute_cls_process

This command submits classification processes to the job queue.

Using execute_cls_process is equivalent to using Run Now from the Run discovery panel of the Discover Sensitive Data tool. It submits the process to the Guardium Job Queue which runs a single job at a time. Administrators can view the job status at Discover > Classification > Guardium Job Queue

Create a classification process before using this command.

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_cls_process

GuardAPI syntax

execute_cls_process parameter=value

Parameters

Parameter Value type Description
processName String Required. The name of the classification process to run.
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_cls_process processName=APITEST_Clps_10001_1