set_stap_debug

This command configures the level of detail written to the S-TAP debug log.

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_debug

GuardAPI syntax

set_stap_debug parameter=value

Parameters

Parameter Value type Description
stapDebugInterval Integer Required.
stapDebugLevel Integer Required. Level of debug log.
Unix: Logs are stderr.txt, guard_stap.fam.txt located in the directory specified in tap_log_dir parameter (by default: /tmp/guard_stap). Valid values:
  • 0: Disable
  • 1: Basic debug
  • 4: Verbose debug
  • 6: Appserver debug
  • 10: Exit engine debug. Debug information is logged in both S-TAP log and db2_exit log (db2diag.log).
  • 11: exit engine debug. Debug information is only logged in db2_exit log (db2diag.log).
Windows:Leave at 0 unless directed by IBM® Technical Support.
  • 0: Only critical error information. Two start-up debug logs, containing only messages that are related to S-TAP startup, are always generated and saved in bin\..\logs. Filename syntax: startup_hostname_timestamp.new and startup_hostname_timestamp.old. Files from bin\..\logs get uploaded automatically if upload_feature is on.
  • 1: All previous messages plus repeatable critical error information. Two "normal" debug logs are saved in bin\StapBuffer. Filename syntax: stap_hostname_timestamp.new and stap_hostname_timestamp.old (from the previous S-TAP session, if it exists). Files from bin\StapBuffer are not uploaded.
  • 2: Not used.
  • 3: All messages from level 1, plus brief information about packets sent to a Guardium® system
  • 4: All messages from level 3, plus local sniffing log.
  • 5: All messages from level 4, plus network sniffing log.
  • 6: All messages from level 5, plus heartbeat receiving log.
  • 7: All messages from level 6, plus miscellaneous debugging information.
stapDebugOn Boolean Required. Valid values:
  • 0 (false)
  • 1 (true)
Default = 1 (true)
stapHost String Required.
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

grdapi set_stap_debug stapDebugInterval= stapDebugLevel=1 stapDebugOn=1 stapHost=9.12.56.158