update_quarantine_allowed_until

This command updates parameters to prevent a user from logging in after a specified length of time passes.

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

GuardAPI syntax

update_quarantine_allowed_until parameter=value

Parameters

Parameter Value type Description
allowedUntil String Required. The date and time to begin the quarantine in one of the following formats:
  • YYY-MM-DD hh:mm:ss
  • A relative time (such as NOW +1 HOUR)

For more information about relative time, see Relative to NOW.
dbUser String Required. The name of the database user to quarantine.
serverIp String Required. The server IP address.
serviceName String Required. The server name.
type String Required. If the database is not IBM Z® or IMS, specify normal. Valid values:
  • normal
  • DB2Z
  • IMS
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

The following command updates the time to start the quarantine for this user:

grdapi update_quarantine_allowed_until allowedUntil="NOW +2 HOUR" dbUser="Hadrian.Swall" serverIp="9.32.0.255" serviceName="company.ibm.com" type="normal"