Purge History - BlueCat Address Manager - 9.0.0

Address Manager API Guide

Locale
English (United States)
Product name
BlueCat Address Manager
Version
9.0.0

Run the purge function.

Output / Response

Returns 0 (zero) when the purge service has successfully completed.

The following codes will be returned if you specify the waitOption parameter to true. These returning codes will be logged in the /var/log/jetty/server.log file:
  • 33 – <untilWhenTimestamp> is either empty or does not contain a hyphen and no valid value found in either of the two numeric alternatives.
  • 35 – <untilWhenTimestamp> contains a hyphen but is not a valid timestamp.
The details of the output or the reason for failure will be logged in /tmp/purge_results.out.

API Call:

int purgeHistoryNow( String untilWhenTimestamp, int numberOfDaysToKeep, int numberOfMonthsToKeep, boolean waitOption )
Note: This API method will examine each of the following three retention-period specifying parameters in sequential order to decide which parameter value it will use to run the purge service. The first valid parameter will be used:
  1. untilWhenTimestamp
  2. numberOfDaysToKeep
  3. numberOfMonthsToKeep
Parameter Description
untilWhenTimestamp The string specifying the point in time after which history is to be preserved. The valid timestamp pattern is YYYY-MM[-DD[ HH:MM:SS[.mmm]]]. Set this parameter with an empty string ("") if you are using either numbeOfDaysToKeep or numberOfMonthsToKeep. Using this parameter will not archive any data.
numberOfDaysToKeep The number of days for which the data will be preserved in the database. The valid value for this parameter is between 1 and 3650. Set this parameter to -1 if you are using either untilWhenTimestamp or numberOfMonthsToKeep. Using this parameter will archive all history that will be purged and overwrite existing archive files in the /data/Archive directory.
numberOfMonthsToKeep The number of months for which the data will be preserved in the database. The valid value for this parameter is between 0 to infinite months. Set this parameter to -1 if you are using either untilWhenTimestamp or numberOfDaysToKeep. Using this parameter will not archive any data.
waitOption The Boolean value. If set to true, the purge will be performed and the result will be returned when completed. The default value is false.