restart_stap

This command restarts the S-TAP on the specified database server.

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/stap

GuardAPI syntax

restart_stap parameter=value

Parameters

Parameter Value type Description
restartMode Integer Controls the S-TAP behavior when it receives a restart command. Valid values:
  • 0: Restarts the S-TAP
  • 1: Requests new collectors from the central manager (enterprise load balancer), and does not restart the S-TAP
Default = 0
stapHost String Required. Hostname
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.

Examples

To restart the S-TAP® on the database server with the IP address 9.42.29.158:

grdapi restart_stap stapHost=9.42.29.158