patch_install

Use this API to install a Guardium patch. The patch number is required.

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

GuardAPI syntax

patch_install parameter=value

Parameters

Parameter Value type Description
mode String Valid values:
  • local_only
  • pull_only
  • pull_install
patch_date Date A date and time in the format yyyy-mm-dd hh:mm:ss or a relative time such as NOW +2 HOUR.
  • If patch_date is left blank or contains a date in the past, then Guardium installs the patch within 5 minutes after the command is called.
  • If patch_date is a future date and time, then the patch is installed within 5 minutes of the assigned date and time.

For more information about date formats, see Dates and Timestamps.

patch_number Integer Required.
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

The following examples install patch number 4000 onto the test.guard.ibm.com machine in four hours. The first example uses the GuardAPI, the second example shows the REST API.

grdapi patch_install patch_number=4000, api_target_host=test.guard.ibm.com patch_date="NOW +4 HOUR"
 curl -k --header "Authorization: Bearer ed272932-28e6-4b56-80a3-664e5e0220de" -i -H "Content-type: application/json" -X PUT -d '
{"patch_number":"4000", "api_target_host": "test.guard.ibm.com", "patch_date:"NOW +4 HOUR"}