Delete - cleanupHistoricalData_1

Delete - cleanupHistoricalData

Description :

This command cleans up a specific type of historical data from the database. Historical data includes Compliance Job results, Audit Job results, snapshot results, job run events, job schedules, and the audit trail.

This command runs using the default cleanup values for retention time. Default retention times are:

For job schedules, job run events, and the audit trail: 14 days
For job results (of Compliance Jobs, Audit Jobs, and Snapshot Jobs): As set by the RESULTS_RETENTION_TIME property, for which the default is 0 (no deletion of job data). For more information about the RESULTS_RETENTION_TIME property and how to set it, see To set the retention period for job runs.

As the default, no maximum duration is applied to the cleanup operation, and it runs until it completes or is aborted.

objectName lets you specify the type of object you want to clean up. Use one of the following values for objectName:

AuditResult
ComplianceResult
SnapshotResult
AuditTrail
jobRunEvent
JobSchedule

Return type : java.lang.Object

Command Input :

Variable Name	Variable Type	Description
objectName	String	The name of the object to clean up.

Example

The following example shows how to clean up audit results from the database.

Script

blcli Delete cleanupHistoricalData AuditResult