policy_install

This command installs one or more policies.

Specify multiple policies by using a pipe ( | ) character as a delimiter between policy names. Specify the policies in the order that you want to install them.
Note: If you change one or more policies, you must reinstall all policies.

This API is available in Guardium V9.5 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/policy_install

GuardAPI syntax

policy_install parameter=value

Parameters

Parameter Value type Description
policy String Required. The name of the policy or policies to install. Use a pipe ( | ) character to separate multiple policies.
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 example installs three policies. 

grdapi policy_install policy="policy 20|policy 30|policy 40"