Configuring for script-based discovery

To run a script-based discovery, you must first configure the discovery.

In comparison to regular sensors, sensors that are run in the script-based mode are more apparent, which means that all commands that the sensor uses are in one script, which you can view. For the list of the sensors that support script-based mode, and the restrictions that apply to some of the sensors, see Sensors that support script-based and asynchronous discovery.

Configure the sensor in one of the following ways:
  • Enabling all sensors that support script-based discovery
    To globally enable all sensors that support script-based discovery, open the collation.properties file and set the value of the com.ibm.cdb.discover.PreferScriptDiscovery property to true.
  • Enabling all sensors that support script-based discovery in a specific discovery profile
    For a specific discovery profile, to enable all sensors that support script-based discovery, complete the following steps:
    1. In the Discovery Management Portal, select the discovery profile for which you want to enable script-based mode.
    2. In the Platform Properties tab, set the value of the com.ibm.cdb.discover.PreferScriptDiscovery property to true.
  • Enabling a sensor that supports script-based discovery in a discovery profile
    In a discovery profile, to enable a specific sensor that supports script-based discovery, update the configuration of that sensor in the respective discovery profile. Complete the following steps:
    1. In Discovery Management Portal, go to the discovery profile that contains the sensor that you want to enable.
    2. In the Sensor Configuration tab, select the sensor and click New.
    3. In the Create Configuration window, specify the name of the configuration and select the Perform Script Based Discovery option.
    4. Click OK to save the configuration.
Configuring TADDM to select non-default users for the discovery
By default, only the user that is requested by the script is used for the discovery. If you have problems with running a discovery with the default user and you have another user that has all required permissions, you can configure TADDM to select this user for the discovery.
Note: Use the following configuration with caution. If a user that does not have all required permissions is used for a discovery, the discovery might fail, or some of the targets might not be discovered.
In the plugin.xml file that you can find in a package for each sensor in the COLLATION_HOME/osgi/plugins directory, edit the script node definition, for example, like in the plugin.xml snippet of IBM WebSphere MQ Server sensor:
<scriptset>
   <ostype>AIX</ostype>
   <mainScript name="sensorCommon.sh" />
   <script name="script.sh" authClassName="com.collation.platform.security.auth.MQServerAuth" authMode="preferred" hostAuthFallback="true”/>
</scriptset>
The following properties can be defined:
authMode
Defines how TADDM approaches entries in the Access List for the type that is specified by authClassName. The following values are available:
  • single - only a user that is requested by the script is used. This is the default value.
  • preferred - first a user who is preferred by the script is used, but if it is not available or fails, the remaining Access List entries of the defined type are used.
  • regular - Access List entries are used in their specified order without checking the user preference.
hostAuthFallback
Defines whether, in case of problems with establishing connection to the target for a specific authClassName or the preferred user, or both, TADDM falls back to the session that is established by the generic user that is used for connecting to the target. The following values are available:
  • false - the default value.
  • true.