Delete - cleanupHistoricalData_3


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 Job results, Patching Job results, Deploy Job results, job run events, job schedules, and the audit trail.

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

  • AuditResult
  • ComplianceResult
  • SnapshotResult
  • PatchResult
  • Deploy
  • 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.

retentionTime

java.lang.Integer

Retention time in days, if applicable. The minimum retention time is 3 days.

Note: This variable is applied only to object types AuditTrail, JobRunEvent, and JobSchedule.

duration

java.lang.Integer

Maximum duration for the operation in minutes.

roleName

String

Delete objects limited to a specific role, if applicable.

Example

The following example shows how to clean up historical data from the database.

Script

blcli Delete cleanupHistoricalData AuditResult 10 600 SampleRole



 

Tip: For faster searching, add an asterisk to the end of your partial query. Example: cert*