list_policy

This command displays a list of available policies or displays details about a single policy.

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

GuardAPI syntax

list_policy parameter=value

Parameters

Parameter Value type Description
detail Boolean Display details about a policy (or all policies if you do not specify a policyDesc). Valid values:
  • 0 (false)
  • 1 (true)

Default = 1 (true)
policyDesc String The name of one policy to display. If not specified, Guardium returns information about all available 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 examples

Display details for a specific policy:

grdapi list_policy policyDesc="Hadoop Policy"

Display a detailed list of available policies:

grdapi list_policy

Display a list of available policy names (without details):

grdapi list_policy detail=false