Configurable Properties
Following are the configurable properties which can be configured in
collation.properties
1. BigFix feature enabled
| Property Name | Possible Values | Description | Mandatory |
|---|---|---|---|
| com.collation.bigfix.enabled | true/false | If true, BigFix feature will be enabled. After setting this property to true, TADDM restart is needed. | Y |
2. BigFix server
| Property Name | Possible Values | Description | Mandatory |
|---|---|---|---|
| com.collation.bigfix.host | IP or FQDN | IP or FQDN of the BigFix Server. | Y |
| com.collation.bigfix.port |
<port no> Default=52311 |
Port at which TADDM will send request to BigFix server. | N |
| com.collation.bigfix.uid | <userid> | User id to access BigFix server console. | Y |
| com.collation.bigfix.pwd | <password> | password to access BigFix server console. Will be stored in encrypted form. | Y |
| com.collation.bigfix.connectTo | <time_period> Default=20 sec | TADDM will wait for this period in sec before HTTP/RestAPI connect timeout. | N |
| com.collation.bigfix.responseTo | <time_period> Default=20 sec | TADDM will wait for this period in sec before HTTP response timeout. | N |
| com.collation.bigfix.site.type | <site_type> Default=custom | Type of the Site at BigFix server with which TADDM will connect. | N |
| Visibility.Control.Automation | <site_name> Default=TADDM | Name of the Site at BigFix server with which TADDM will connect. | N |
| com.collation.bigfix.aasdpkgmaxsize | <Request Package size> Default=1024 | Maximum allowed Request Package generated by BigFix discovery script. | N |
3. Big Server Certificate
| Property Name | Possible Values | Description | Mandatory |
|---|---|---|---|
| com.collation.bigfix.certificate.type | <PKCS12/JKS> Default=JKS | Supported Client certificate Type. | N |
| com.collation.bigfix.certificate.file | <Path> | Client Certificate File Location. | N |
| com.collation.bigfix.certificate.pwd | <Password> | Password of Client Certificate | N |
4. BigFix Server DB
| Property Name | Possible Values | Description | Mandatory |
|---|---|---|---|
| com.collation.bigfix.db.type | MSSQL or DB2 | Type of the DB used by BigFix server.; MSSQL for Windows based BigFix server or DB2 for Linux based. | Y |
| com.collation.bigfix.db.host | IP or FQDN | IP or FQDN of the BigFix DB. | Y |
| com.collation.bigfix.db.port | <port no> | Port at which TADDM will connect with BigFix DB. | Y |
| com.collation.bigfix.db.dbname | <db name> | Name of the BigFix DB. | Y |
| com.collation.bigfix.db.domain | <user domain> | Domain of user, Mandatory in case of Windows based Authentication. | N |
| com.collation.bigfix.db.domain | <userid> | User id to access the BigFix DB. | Y |
| com.collation.bigfix.db.pwd | <password> | Password to access the BigFix DB; will be stored in encrypted form. | Y |
Note:
- In case of TADDM-DB connection break, TADDM will try to reconnect as per the “com.collation.bigfix.result.wait” setting.
- In case of any change in the above settings, TADDM restart is required.
5. TADDM - Result Fetching or Processing thread
| Property Name | Possible Values | Description | Mandatory |
|---|---|---|---|
| com.collation.bigfix.result.wait | <value in sec>Default=60 sec | When “com.collation.bigfix.enabled” is enabled, Results Fetching Thread will be spawned to periodically fetch the discovery result files from BigFix server. “Results Fetching thread” will fetch the result packages from BigFix server as per the periodicity (defined in seconds) configured. | N |
| com.ibm.cdb.discover.asd.autodiscovery.enabled | True/false | If true, will enable the thread to process the stored ASD results files | Y |
| com.ibm.cdb.discover.asd.ProcessUnreachableIPs | True/false | The thread will process the ASD result for target that are unreachable. | Y |
| com.ibm.cdb.discover.asd.AsyncDiscoveryResultsDirectory | Path Default = var/asdd | path where results files are to be kept. Path is configurable, but is set to var/asdd by default. | N |
| com.ibm.cdb.discover.asd.autodiscovery.asdScope | <scope name> Default = ASD | The thread will pick the target mentioned in this scope to process result file. If this property is not mentioned, default ASD scope is processed. | N |
| com.ibm.cdb.discover.asd.autodiscovery.asdProfile | <profile name>Default = ASD |
The thread will pick the sensors mentioned in this profile to process result file. If this property is not mentioned, default ASD profile is processed. |
N |
| com.ibm.cdb.discover.asd.autodiscovery.filesThreshold | <file threshold>Default=20 | Minimum Number of files required by thread, to start processing them. The thread will process the result if either the File threshold or Time threshold is met. | N |
| com.ibm.cdb.discover.asd.autodiscovery.timeThreshold | <time threshold>Default=60sec | Time threshold after which thread will process the result files, even if File Threshold is not met. | N |
Note: 1. BigFix Discovery results will arrive asynchronously on TADDM server, and whenever
one of the property (com.ibm.cdb.discover.asd.autodiscovery.filesThreshold,
com.ibm.cdb.discover.asd.autodiscovery.timeThreshold) is met, then bunch of result files available
will be processed and this will create a fresh “Discovery History” entry. These properties shall be
finetuned as per the specific requirements to control the number of “Discovery History”
entries.
6. Cleanup
| S.No | Resources | TADDM Server | BES Root Server | BES Enspoint | |||
|---|---|---|---|---|---|---|---|
| Created | Cleanup | Created | Cleanup | Created | Cleanup | ||
| 1. | Request Package | Y | N1 | Y | N2 | Y | Y |
| 2. | Task | - | - | Y | Y 4 | - | - |
| 3. | Action | - | - | Y | Y 3 | - | - |
| 4. | Result Package | Y | Y | Y | Y | Y | Y |
| 5. | Fileset | - | - | - | - | Y | Y |
Note:
- Request Package Cleanup on TADDM server is not supported
- Request Package cleanup on BES Root server is not supported. (Request package may get reused during rediscovery)
- Only Actions that were created by TADDM and which are in Expired state will be considered for cleanup (Except for Action created with name TADDMCLEANUP).
- Tasks created by TADDM will be remove, only when all actions associated with that task are already removed.
- Tasks created by TADDM will be remove, only when all actions associated with that task are
already removed.
- To exclude a specific task and its associated actions from cleanup (for Rediscovery support), retainBigFixTask.sh/.bat can be used as per details below:
Usage: ./retainBigFixTask.sh <TaskName> <enable/disable>
Cleanup on TADDM Server
| Property Name | Possible Values | Description | Mandatory |
|---|---|---|---|
| com.collation.bigfix.taddm.cleanup.volume | <limit size with suffix> | <Limited size after which the old processed files will be removed e.g. 50MB, 2GB, etc> | N |
| com.collation.bigfix.taddm.cleanup.time | <limit time with suffix> | <To check the processed files older than configured units e.g. 1D, 5H, 30M, etc> | N |
| com.collation.bigfix.taddm.cleanup.runtime | No of minutes | TADDM cleanup thread will wait for configured no. of minutes after run. | N |
Note:
- Result files cleanup on TADDM server will be done, only when atleast one of the properties (com.collation.bigfix.taddm.cleanup.volume, com.collation.bigfix.taddm.cleanup.time) is configured.
Cleanup on Endpoint
| Property Name | Possible Values | Description | Mandatory |
|---|---|---|---|
| com.collation.bigfix.endpoint.cleanup | <Y or N><Default=Y> | When set to Y, it will remove the request package zip, Extracted Request Package directory and newly created Result package zip from endpoint | N |
Cleanup on BigFix Root Server
| Property Name | Possible Values | Description | Mandatory |
|---|---|---|---|
| com.collation.bigfix.root.cleanup.interval | <no of days> <Default=1> | Periodicity of running the cleanup task to remove Result packages, Tasks and Expired Actions from BES Root Server. | N |
| com.collation.bigfix.root.cleanup.days | <no of days> <Default=5> | Result files older than given number of days will be considered for removal. | N |
7. Custom Relevance
| Property Name | Possible Values | Description | Mandatory |
|---|---|---|---|
| com.collation.bigfix.relevance.appendscope | true/false<Default=true> |
If true, then custom Relevance query will be used, in addition to the specified scope If false, then only Custom Relevance query will be used, instead of specified scope |
N |
| com.collation.bigfix.relevance | True/false | Relevance query for identifying a set of endpoints for given discovery. e.g. to discover
endpoints with computer names starting with “nc04”, add this property in
This will enable inclusion of
endpoints whose computer names start with “nc04” along with the scope (depending on the value of the
property |
N |
8. Bigfix Package Temp Path Settings
| Property Name | Possible Values | Description | Mandatory |
|---|---|---|---|
| com.collation.bigfix.action.enable.os | <action script for the configured os><Default=Windows, AIX, Linux, SunOS> | Action script for the configured OS will be included in the Bigfix ActionScript | N |
| com.collation.bigfix.temp.Windows | Request Package Path<Default=C:\Windows\Temp> | Path which will be used for the ASD Request Package. *Note: “\” would be required to give as “\\” in windows path. | N |
| com.collation.asd.temp.Windows | Result Package Path <Default=C:\Windows\Temp> | Path which will be used for the ASD Result Packages. | N |
| com.collation.asd.temp.Unix | Result Package Path <Default=/tmp> | Path which will be used for the ASD Result Package. | N |
| com.collation.bigfix.temp.Linux | Result Package Path <Default=/tmp> | Path which will be used for the ASD Request Package. | N |
| com.collation.bigfix.temp.SunOS | Result Package Path <Default=/tmp> | Path which will be used for the ASD Request Package. | N |
| com.collation.bigfix.temp.AIX | Result Package Path <Default=/tmp> | Path which will be used for the ASD Request Package. | N |
| com.collation.asd.temp.Linux | Result Package Path <Default is value of property com.collation.asd.temp.Unix> | Path which will be used for the ASD Result Package. | N |
| com.collation.asd.temp.SunOS | Result Package Path <Default is value of property com.collation.asd.temp.Unix> | Path which will be used for the ASD Result Package. | N |
| com.collation.asd.temp.AIX | Result Package Path <Default is value of property com.collation.asd.temp.Unix> | Path which will be used for the ASD Result Package. | N |
Note: Based on the above configured Temp path, the folder will be created on target
endpoints, if it does not exists. E.g., In case of Windows 2003, default Temp path of
“C:\Windows\Temp\” will be used and this folder will get created during the discovery.