update_user_db

This command applies all recent changes to the active User-DB association map.

After you run some commands, you also need to run update_user_db to apply the changes.

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

GuardAPI syntax

update_user_db 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.

GuardAPI example

After you run some commands, such as create_allowed_db, you must run update_user_db.

grdapi create_allowed_db userName=Fred serverIp=192.168.1.1 instanceName=test

Sample output

ID=1
When complete, in order for synchronization to take effect, run update_user_db
ok
grdapi update_user_db
ID=0
A background process updates the database. The results are not immediate.
ok