rule_info_from_policy

This command displays information about all of the rules that make up a specified policy.

This API is available in Guardium V11.3 and later.

REST API syntax

This API is available as a REST service with the GET method. Call this API as follows:

GET https://[Guardium hostname or IP address]:8443/restAPI/ruleInfoFromPolicy

GuardAPI syntax

rule_info_from_policy parameter=value

Parameters

Parameter Value type Description

policyDesc String Required. The name of the policy.

Parameter	Value type	Description
policyDesc	String	Required. The name of the policy.
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.

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

GuardAPI example:

> grdapi rule_info_from_policy policyDesc="Copy of Basel II [template]"

REST API example:

curl -k --header "Authorization:Bearer 57c9bcc5-b7af-441b-a836-94d72c28174c" -i -H "Content-Type: application/json" -X GET "https://example.com:8443/restAPI/ruleInfoFromPolicy/?policyDesc=testPol"