add_ranger_config

Use this command to define a Ranger on an Ambari server for Hadoop monitoring.

This command requires valid administrative authority on the Ambari server such as an admin or service administrator account. The Ambari administrator must restart the affected Hadoop components, so that the changes take effect.

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

GuardAPI syntax

add_ranger_config parameter=value

Parameters

Parameter Value type Description
clusterName String Required. Ambari cluster name.
hostname String Required. Hostname or IP address of the Ambari server.
password String Required. Password for the admin user specified by userName
port Integer Port on the Ambari server for the user interface. Default = 8080.
sslEnabled Boolean Sets whether SSL is enabled for communication with this Ranger. Valid values:
  • 0 (false)
  • 1 (true)

Default = 0 (false)
userName String Required. Ambari server username; must be an admin or service admin user.
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 define a ranger cluster

grdapi add_ranger_config hostname=hw-cl4-05 userName=admin port=8080 password=xxxxx clusterName=Cluster4
Sample output:
ID=0Configuration for Cluster:  Cluster4 added.

REST API example

curl -k --header "Authorization:Bearer <access token>" -i -H "Content-Type: application/json" -X POST -d '{hostname="hw-cl4-05", userName="admin", port=8080, password="admin", clusterName="Cluster4"}' https://<Guardium server name>:8443/restAPI/add_ranger_config
Sample output:
[{"id": 2,
"clusterName": "Cluster4",
"serverHost": "hw-cl4-05",
"serverPort": 8080,
"userName": "admin",
"lastRefresh": "2016-09-27 11:31:03",
"status": []}]