Configuring the collation.properties file entries

This topic lists the collation.properties file entries that the IBM® DB2® sensor uses.

The DB2 sensor that is running on a Windows system (Db2WindowsSensor) uses the following property:
com.collation.discover.agent.Db2WindowsAgent.sshSessionCommandTimeout =300000
The default value is 300000. The value must be an integer.

This property specifies the maximum amount of time (in milliseconds) that the DB2 sensor can run the db2dfind command on a Windows system.

To be effective, the value of this property should be:
  • Greater than the value of the com.collation.SshSessionCommandTimeout property, which controls the time that is allowed for the SSH command to run on the Windows gateway. If the value of the Db2WindowsAgent.sshSessionCommandTimeout property is less than the value of the com.collation.SshSessionCommandTimout property, the com.collation.SshSessionCommandTimout value is used.
  • Less than the value of the com.collation.discover.agent.Db2Sensor.timeout property (or com.collation.discover.DefaultAgentTimeout if the DB2-specific timeout is not set). Because the sensor can stop before it finishes collecting information, the value of the Db2Sensor timeout property should be greater than the com.collation.discover.agent.Db2WindowsAgent.sshSessionCommandTimeout property.
If needed, you can change the values of the com.collation.SshSessionCommandTimeout and com.collation.discover.agent.Db2Sensor.timeout properties. The com.collation.discover.agent.Db2Sensor.timeout property is specific to the DB2 sensor, and overrides the value of the com.collation.discover.DefaultAgentTimeout property.
For the following properties, you can also specify an IP address, as shown in the following example:
com.collation.discover.agent.DB2Agent.db2findscript.1.2.3.4=sudo
com.collation.discover.agent.DB2Agent.db2findscript=sudo
This value enables access to the db2find.sh script executed during the discovery using the sudo command.
com.collation.discover.agent.DB2Agent.db2findschemascript=sudo
This value enables access to the db2findschema.sh script executed during the discovery using the sudo command.
com.collation.discover.agent.DB2Agent.systemcommand=sudo
This value enables access to the system command executed during the discovery using the sudo command.