delete_inactive_stap

Use this command to delete an inactive S-TAP® (or all S-TAPs) on the specified S-TAP host, or all hosts, on one or all collectors that send data to the specified S-TAP host.

To identify inactive S-TAPs, use the API command list_staps or view the report Inactive S-TAPs Since.

Table 1. stapHost and api_target_host values and the resulting affected S-TAPs
stapHost api_target_host Command affects:
specific S-TAP host specific target host / collector S-TAP on the collector
all specific target host / collector All S-TAPs on the collector
specific S-TAP host all_managed S-TAP on all collectors
all all_managed All S-TAPs on all collectors

This API is available in Guardium V10.1.4 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/delete_inactive_stap

GuardAPI syntax

delete_inactive_stap parameter=value

Parameters

Parameter Value type Description
force Boolean Valid values:
  • 0 (false)
  • 1 (true)

Default = 0 (false)
stapHost String Valid values:
  • specific S-TAP host
  • all
api_target_host String Specifies where the API executes. Valid values:
  • all_managed: execute on all managed units but not 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.

Examples

To delete inactive S-TAPs that are configured to send data to the Guardium system on which you enter the command:

grdapi delete_inactive_stap