update_ranger_service

Use this command to update the Ranger service that is mapped to an S-TAP®.

This command requires valid administrative authority on the Ambari server such as an admin or service administrator account. After running the command, 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 PUT method. Call this API as follows:

PUT https://[Guardium hostname or IP address]:8443/restAPI/update_ranger_service

GuardAPI syntax

update_ranger_service parameter=value

Parameters

Parameter	Value type	Description
clusterName	String	Required. Ambari cluster name.
port	Integer	Port on the Ambari server for monitoring.
serviceName	String	Required. Name of the service. Valid values: hdfs hive hbase kafka solr storm
stapHostName	String	Required. Host name or IP of the S-TAP that receives the log4j audit messages from the Ranger.
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 change the port for this ranger to 5534:

grdapi update_ranger_service clusterName=Cluster4 serviceName=HDFS stapHostName="<Guardium host>" port=5534

Sample output:

ID=0
The Hadoop service configuration has been changed. Ask the Hadoop administrator to restart the Hadoop service to activate the changes.
HDFS Monitoring Enabled on <Guardium host>:5534
Note: Only one port can be configured per S-TAP host. Changing the port here will update it automatically for all Hadoop services configured to this S-TAP.