get_purge_batch_size

This API returns the current setting for the purge batch size on one or more Guardium® systems. The batch size is the incrementation in which purges are processed.

This API is available in Guardium V9.5 and later.

GuardAPI syntax

get_purge_batch_size parameter=value

Parameters

Parameter Value type Description
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

To view the current purge batch size:

grdapi get_purge_batch_size

Sample output:

ID=0 
Purge Batch Size = 300000 
ok