list_ranger_staps

This command lists all S-TAPs that are eligible for Ranger configuration or are currently configured for Ranger integration. (All S-TAPs that are not configured for Kafka (Cloudera integration).)

This API is available in Guardium V10.1.4 and later.

REST API syntax

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

GuardAPI syntax

list_ranger_staps parameter=value

Parameters

Parameter Value type Description
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.

GrdAPI example

To find databases that host Ranger-configured S-TAPs that report to this Guardium® system:

grdapi list_ranger_staps
System output:
ID=0
<DB server name>:5556
<DB server name>:5555

REST API example

To find databases that host Ranger-configured S-TAPs that report to the specified Guardium system:

curl -k -i --heade-492d-b3ef-23d1b073eb05" https://<Guardium server name>:8443/restAPI/list_ranger_staps
System output, which only displays S-TAPs with stapStatus=2, meaning the S-TAP is active and properly synchronized:
[
{
"id": 18,
"name": "<DB server>",
"value": "<DB server>",
"port": "5534",
"stapStatus": 2
},
{
"id": 24,
"name": "<DB server>",
"value": "<DB server>",
"port": "5534",
"stapStatus": 2
},
{
"id": 25,
"name": "<DB server>",
"value": "<DB server>",
"port": "5555",
"stapStatus": 2
}