Cleanup agents properties

The cleanup agents remove the orphaned aliases and configuration items, or fix the missing rows in the tables. Most of them read properties that are defined in the collation.properties file.

AliasesCleanupAgent

The agent removes aliases from the ALIASES table that no longer match the CI naming attributes. It also removes aliases and rows in the PERSOBJ table which do not have any corresponding CIs. The agent reads the following properties from the collation.properties file:

com.ibm.cdb.topomgr.topobuilder.deleteAliasesWithoutMaster: The default value is true.; The property specifies whether the aliases that do not have the corresponding master alias are deleted from the ALIASES table. By default, the deletion is enabled.
com.ibm.cdb.topomgr.topobuilder.max.row.fetch: The default value is 1000.; The property configures the batch size used to fetch aliases from the ALIASES table.; If you set the property to -1, the agent does not verify the aliases.
com.ibm.cdb.topomgr.topobuilder.max.row.delete: The default value is 5000.; The property configures the batch size used to delete aliases.; If you set the property to -1, the agent does not remove aliases but only reports the corrupted ones.
com.ibm.cdb.topomgr.topobuilder.agents.AliasesCleanupAgent.maxNumberOfMastersToScan: The default value is 1000.; The property configures the number of CIs that require aliases verification during a single run of the agent.
com.ibm.cdb.topomgr.topobuilder.cleanupOrphanedAliasesAndPersobj: The default value is true. The agent runs the cleanup.; The property enables or disables the cleanup of those aliases in the ALIASES table and GUIDs in the PERSOBJ table which do not have any corresponding CIs.
com.ibm.cdb.topomgr.topobuilder.DelayToRemoveAliases: The default value is 12 (hours). The orphaned aliases that are older than 12 hours are removed by the agent.; The property defines the time in hours after which the aliases without a corresponding CI are removed by the agent. It protects new aliases that might not have a corresponding CI because the CI storing is not complete.; Use this property with caution. Do not set it to a smaller value.

AliasesJnTableCleanupAgent

This agent removes old rows from the ALIASES_JN table. This table contains the history of changes to the ALIASES table. It is used to find potential over merges of configuration items in the database. The agent reads the following properties from the collation.properties file:

com.ibm.cdb.topomgr.topobuilder.agents.AliasesJnTableCleanupAgent.maxRow: The default value is 5000. It is advised not to change the default value.; This property specifies the maximum number of rows that are deleted at a time by the agent.

com.ibm.cdb.topomgr.topobuilder.agents.AliasesJnTableCleanupAgent.removeOlderThanDays: The default value is 30 (days).; This property removes rows that are older than the specified time. By default, it removes rows that are older than 30 days.; If you set this property to 0 or a lower value, the agent is disabled.

com.ibm.cdb.topomgr.topobuilder.agents.AliasesJnTableCleanupAgent.timeout: The default value is 1800 (seconds).; This property specifies time, after which the agent times out. If the specified time is not enough to delete all old rows, the agent attempts to delete them the next time it runs.

DependencyCleanupAgent

The agent removes the dormant Relationship objects. The agent reads the following properties from the collation.properties file:

com.ibm.cdb.topomgr.topobuilder.agents.DependencyCleanupAgent.timeout: The default value in seconds is 600. After this time, the agent stops removing the objects, even if there are still some left.
com.ibm.cdb.topomgr.topobuilder.agents.DependencyCleanupAgent.removeOlderThanDays: The default value in days is 90. The Relationship objects, which are older than the specified value are treated as dormant objects.

ObjectsWithoutAliasesCleanupAgent

The agent removes the CIs that do not have the aliases in the ALIASES table. The agent reads the following property from the collation.properties file:

com.ibm.cdb.topomgr.topobuilder.agents.ObjectsWithoutAliasesCleanupAgent.maxToRemove: The default value is 1000; The property limits the number of CIs that the agent removes during one run. If you set the property to -1, the agent exits without performing any cleanup, and shows the ObjectsWithoutAliasesCleanupAgent is disabled message.

PersobjCleanupAgent

The agent fixes all missing rows in the PERSOBJ table. It does not use any configuration in the collation.properties file. The agent shows the summary of how many rows were fixed, like in the following example:

2012-08-22 18:12:21,500 TopologyBuilder [TopologyBuilderEngineThread$Cleanup@4.0]
INFO agents.PersobjCleanupAgent - Fixed 10 rows in PERSOBJ table

StorageExtentCleanupAgent

The agent removes the dormant StorageExtent objects. The agent reads the following properties from the collation.properties file:

com.ibm.cdb.topomgr.topobuilder.agents.StorageExtentCleanupAgent.timeout: The default value in seconds is 1800. After this time, the agent stops removing the objects, even if there are still some left.
com.ibm.cdb.topomgr.topobuilder.agents.StorageExtentCleanupAgent.removeOlderThanDays: The default value in days is 1. The StorageExtent objects, which are more than 1 day older than their parent ComputerSystems are treated as dormant objects.

VlanInterfaceCleanupAgent

The agent removes the dormant VlanInterface objects. The agent reads the following properties from the collation.properties file:

com.ibm.cdb.topomgr.topobuilder.agents.VlanInterfaceCleanupAgent.timeout: The default value in seconds is 1800. After this time, the agent stops removing the objects, even if there are still some left.
com.ibm.cdb.topomgr.topobuilder.agents.VlanInterfaceCleanupAgent.removeOlderThanDays: The default value in days is 1. The VlanInterface objects which are more than 1 day older than their parent Vlans are treated as dormant objects.