Mode valueCommand executedWhat it doesHISTORY

Delete cleanupHistoricalData

Cleans up TrueSight Server Automation historical data based on retention time.

• A default retention time of 14 days is used for the following types of historical data: job run events, job schedules, audit trail, and shared data (generic asset data from Audit Jobs and Snapshot Jobs).
• For job results (of Compliance Jobs, Audit Jobs, Snapshot Jobs, Patching Jobs, Deploy Jobs, Old Version Component, and Old Version Job), retention is set by a job property named RESULTS_RETENTION_TIME, for which the default is 0 (no deletion of job data).

HISTORY_O Delete cleanupHistoricalData

Cleans up TrueSight Server Automation historical data for the specified OBJECT_TYPE (a required argument) based on retention time.

• A default retention time of 14 days is used for the following types of historical data: job run events, job schedules, audit trail, and shared data (generic asset data from Audit Jobs and Snapshot Jobs).
• For job results (of Compliance Jobs, Audit Jobs, Snapshot Jobs, Patching Jobs, Deploy Jobs, Old Version Component, and Old Version Job), retention is set by a job property named RESULTS_RETENTION_TIME, for which the default is 0 (no deletion of job data).

HISTORY_RDR

Delete cleanupHistoricalData

Cleans up TrueSight Server Automation objects for RoleName based on retention time. The RoleName parameter can be literally null to cleanup data from all roles.

• Retention time is set by the RetentionTime parameter for the following types of historical data: job run events, job schedules, audit trail, and shared data (generic asset data from Audit Jobs and Snapshot Jobs). The default retention time is 14 days and the minimum value allowed is 3 days.
• For job results (of Compliance Jobs, Audit Jobs, Snapshot Jobs, Patching Jobs, and Deploy Jobs), retention is set by a job property named RESULTS_RETENTION_TIME, for which the default is 0 (no deletion of job data).

HISTORY_ORDR

Delete cleanupHistoricalData

Cleans up TrueSight Server Automation historical data for objects of the specified ObjectType and RoleName, based on retention time.

• Retention time is set by the RetentionTime parameter for the following types of historical data: job run events, job schedules, audit trail, and shared data (generic asset data from Audit Jobs and Snapshot Jobs). The default retention time is 14 days and the minimum value allowed is 3 days.
• For job results (of Compliance Jobs, Audit Jobs, Snapshot Jobs, Patching Jobs, and Deploy Jobs), retention is set by a job property named RESULTS_RETENTION_TIME, for which the default is 0 (no deletion of job data).

RETENTION

Delete executeRetentionPolicy

Marks entries for deletion based on retention time in the TrueSight Server Automation database. It marks old job runs and automatically created jobs and depot objects.CLEAN_DB

Delete cleanupDatabase

Deletes database rows for objects that have been previously marked for deletion.

Note: Certain objects are not deleted due to potential object dependencies. The cleanup process deletes all top-level model objects of the classes listed in the hk_allowed_classes database table, as well as all their child classes (which are not listed in this table). BMC recommends that you do NOT modify the contents of the hk_allowed_classes table.

CLEAN_DB_TL

Delete cleanupDatabase

Performs a TrueSight Server Automation Database cleanup with the duration limitation specified in the MaxDuration parameter.CLEAN_SHARED_OBJECTS

Delete hardDeleteAllSharedObjects

Deletes database rows for shared data objects with the duration limitation specified in MaxDuration parameter. It includes data for shared files, checksum files, ACL entries, and internal values generated by TrueSight Server Automation.CLEAN_FS

Delete cleanupFileServer

Cleans all the unused files from the temporary file storage on the Application Server and from the following directories in the file server:

• agentbundles - Contains agent-related files
• blpackages - Contains the BLdeploy XML file used for BLPackages
• files - Contains files related to Audit and Snapshot jobs
• imported - This directory is cleaned up when the associated object data in TrueSight Server Automation is deleted
• patch - Contains files related to patch analysis and catalogs
• scripts - Contains NSH scripts, for example, chef and puppet packager and DB_FS_Cleanup
• tmp - Contains temporary files

Note:

You typically use the file server cleanup after running a database cleanup. In this way, you first remove objects from the database, and then you remove the actual underlying file system objects from the file server. Before running the file server cleanup, ensure that the database cleanup has completed.

When a Custom Package Deploy Job runs, it creates a subdirectory under the BLPackage directory for every iteration. Even after the job run history is removed by the retention policy, these directories still exist. These directories are not removed by the cleanup script.

CLEAN_FS_TL

Delete cleanupFileServer

Performs a File Server cleanup with the duration limitation specified in the MaxDuration parameter.CHECK_FS

Delete checkFileServerIntegrity

Performs a File Server integrity check.

Note that this mode is NOT included in Typical mode. If you want to check the integrity of the file server, you must run this mode separately.

CLEAN_AGENT

Delete cleanupAgent

Cleans up old temporary files on a target server (agent) that are older than the RetentionTime parameter value. This includes old files that were created by Deploy Jobs in the Transactions directory (especially rollback files) and in the Staging directory.

 Click here for more information about these directories...

The Transactions directory is either rscdInstallDirectory/Transactions or as specified by the server's TRANSACTIONS_DIR property (see Configuring the location of the transactions directory). Within the Transactions directory, the contents of the following directories are not touched during cleanup: mnt, locks, database, events, and logs.

The Staging directory is specified by the server's STAGING_DIR property.  

Note that this mode is NOT included in Typical mode. To clean up your agents, you must remember to schedule a separate job with this mode. The standard recommended frequency for this cleanup is once a month. For best results, keep agent cleanup separate from database cleanup (for example, do not include these two types of cleanup jobs in one batch job).

CLEAN_ALL_AS

Delete cleanupAllAppServerCaches

Deletes old temporary files on all the Application Servers that are currently up and running (and accessible). It removes files older than the RetentionTime parameter value.

Note that this mode is NOT included in Typical mode. To clean up your Application Servers, you must remember to schedule a separate job with this mode. For example, in the example of a standard weekly cleanup plan Application Server cleanup is planned to run on a monthly basis, and in the example cleanup plan for large operational environments Application Server cleanup is planned to run on a daily basis.

CLEAN_AS

Delete cleanupAppServerCache

Deletes old temporary files on a specific Application Server (any files older than the RetentionTime parameter value).

Note that this mode is NOT included in Typical mode. If you want to clean up a specific Application Server, you must run this mode separately.

CLEAN_REPEATER

Delete cleanupRepeater

Cleans up files from the staging directory of a repeater server. This cleanup removes files that have not been accessed for the RetentionTime parameter value until a specified maximum cache size (the TargetSize parameter) is reached on the target repeater server.

This command does not delete the lost and found directory.

Note that this mode is NOT included in Typical mode. To clean up the repeater server, you must remember to schedule a separate job with this mode. The standard recommended frequency for this cleanup is once a month. For best results, keep the cleanup of the repeater server separate from database cleanup (for example, do not include these two types of cleanup jobs in one batch job).