set_purge_batch_size

This API sets the batch size that is used during purge of data.

When purging a large number of records (10 million or higher), a large batch size setting (500k to 1 million) is the most effective way to purge. Using a smaller batch size or NULL causes the purge to take hours longer. Smaller purges finish quickly, so a large batch size setting is only relevant for large purges. You might need to make a tradeoff in performance and disk space usage. Setting the batch to a larger number increases the speed of the purge but consumes more disk space. Using a low batch size decreases the speed of the purge but does not consume as much disk space.

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

GuardAPI syntax

set_purge_batch_size parameter=value

Parameters

Parameter Value type Description
batchSize Long Required. Number of records. Default = 200000.
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 increase the purge batch size from the default (200000) to 300000:

grdapi set_purge_batch_size batchSize=300000