execute_assessment

This command submits a security assessment to run.

This command is equivalent to running Run Once Now from the Security Assessment Finder. Submitting the job places the process on the Guardium® Job Queue, from where the system runs a single job at a time.

You can see the job Status and the Process Run ID from the Guardium Job Queue.

Note: A Security Assessment must exist before you call this API.

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_assessment

GuardAPI syntax

execute_assessment parameter=value

Parameters

Parameter Value type Description
assessmentDescription String Required. The name of the assessment 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_assessment assessmentDesc="assessment1"