session_inference_control

Use the session_inference_control command to start or stop Session Inference.

Use session_inference_control to start or stop Session Inference from the command line. For more information, see Session Inference control.

This API is available in Guardium V11.0 and later.

REST API syntax

This API is available as a REST service with the POST method. Call this API as follows:
POST https://[Guardium hostname or IP address]:8443/restAPI/session_inference

GuardAPI syntax

session_inference_control parameter=value

Parameters

Parameter Value type Description
action String Required. Action can be:
  • start: Start the session inference servlet.
  • stop: Stop the session inference servlet.
api_target_host String

Required for GRDAPI. For REST APIs, this parameter is optional. If not specified for a REST API, defaults to the localhost.

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.

Examples

To start Session Inference from the command line with a GuardAPI:

test.swg.usma.ibm.com> grdapi session_inference_control action=start api_target_host=127.0.0.1