General Data Collection Advanced Parameters
Warning: Making changes to Advanced Parameters should not be undertaken unless the user understands the impact of the parameter changes. If undesired results occur, revert the settings and contact APTARE Global Support Services or visit the APTARE Community web site for further guidance.
The following advanced parameters apply to a variety of general collection functions, not necessarily associated with a particular subsystem.
Admin > Advanced > Parameters, described in Adding an Advanced Parameter. COMMAND_TIMEOUT
This parameter is shipped in the Portal software and is listed in the Add Advanced Parameter window.
Valid Values: Numeric value in milliseconds (Default = 30000)
Scope: This parameter can be configured at the Domain or Data Collector level, for an OS, or for a specific host.
Use this parameter to modify the wait time for a command to send a reply. This might be necessary when data collection times out and cannot complete. Typically, this advanced parameter will be used in large collection environments where factors such as network performance and the sheer amount of data can impact responses.
DATARCVR_READ_TIMEOUT
This parameter is shipped in the Portal software and is listed in the Add Advanced Parameter window.
Valid Values: Numeric value in seconds (Default = 600)
Scope: This parameter can be configured at the Domain or Data Collector level, for an OS, or for a specific host.
Use this parameter to modify the wait time for the data receiver to send a reply before the process times out. This might be necessary when data collection times out and cannot complete. Use this parameter if you are seeing data collection errors such as, Read timed out. You can increase the default time-out value for the connection time (in seconds) between the data collector and the data receiver. Assign this parameter to the problem collector. Typically, this advanced parameter will be used in large collection environments where factors such as network performance and the sheer amount of data can impact responses.
LOGGING_LEVEL
This parameter is shipped in the Portal software and is listed in the Add Advanced Parameter window.
Valid Values: ERROR, WARN, INFO (Default), DEBUG, TRACE
Scope: This parameter can be set at the Domain, Data Collector, and Host levels.
Use this parameter to set the minimum logging level for the specified collector subsystem. When configured without selecting any hosts, it sets the minimum logging level for all subsystems in the domain/collector. When hosts are selected, it sets the minimum logging level for when the selected hosts are being processed. Defaults to INFO. If set to a more restrictive level than the logging configuration it will have no effect. The use case is to temporarily increase the logging level for analysis and debugging.
METACOLLECTOR_MAX_THREADS
This parameter is shipped in the Portal software and is listed in the Add Advanced Parameter window.
Valid Values: Integer that represents the maximum number of threads (Default = 20)
Scope: This parameter can be set at the Domain and Data Collector levels.
Use this parameter to modify the maximum number of threads within a metadata collector. This thread pool manipulation enables changes to improve performance.
METACOLLECTOR_MIN_THREADS
This parameter is shipped in the Portal software and is listed in the Add Advanced Parameter window.
Valid Values: Integer that represents the minimum number of threads (Default = 5)
Scope: This parameter can be set at the Domain and Data Collector levels.
Use this parameter to modify the minimum number of threads within a metadata collector. This thread pool manipulation enables changes to improve performance.
PATH_CONTROL_PARAM
This parameter is shipped in the Portal software and is listed in the Add Advanced Parameter window.
Valid Values: Text value of find or all (Default = find)
Scope: This parameter can be set at the Domain or Data Collector level or for a specific OS, or for a specific host.
Use this parameter to control the path-finding mechanism in the Data Collector for host resources data collection.
• find = The Data Collector finds the command paths.
• all = The Data Collector tries all the command paths until successful and the find command will not be executed.
SSH_ALTERNATE_PKG_USE
This parameter is shipped in the Portal software and is listed in the Add Advanced Parameter window.
Valid Values: Y or N (Default = N)
Scope: This parameter can be set at the Data Collector level or for a specific host.
Use this parameter designate which SSH package should be used to connect to a host.
SSH_CHANNEL_WAIT_TIME
This parameter is shipped in the Portal software and is listed in the Add Advanced Parameter window.
Valid Values: Numeric value in milliseconds (Default = 1000)
Scope: This parameter can be set at the Data Collector level or for a specific host.
Use this parameter to specify the time to wait for the SSH channel to return data. Typically, this is used in large environments with heavy data collection.
SSH_CIPHERS
This parameter is shipped in the Portal software and is listed in the Add Advanced Parameter window.
Valid Values: Text (Default is a null value)
Scope: This parameter can be set at the Data Collector level or for a specific host.
Use this parameter to supply explicit ciphers to be used for the session encryption for SSH connections.
SSH_DEBUG
This parameter is shipped in the Portal software and is listed in the Add Advanced Parameter window.
Valid Values: Y or N (Default = N)
Scope: This parameter can be set at the Data Collector level or for a specific host.
Use this parameter to enable additional debugging for SSH.
SSH_PORT
This parameter is shipped in the Portal software and is listed in the Add Advanced Parameter window.
Valid Values: Numeric value (Default = 22)
Scope: This parameter can be set at the Domain or Data Collector level or for a specific OS, or for a specific host.
This parameter enables you to change the port used for SSH connections to a non-standard port.
Example:
<server>:1234
STDOUT_ERROR
This parameter is shipped in the Portal software and is listed in the Add Advanced Parameter window.
Valid Values: Text Value (Default = See below)
Scope: This parameter can be set at the Domain or Data Collector level or for a specific OS or host.
This parameter enables you to supply a list of messages that could be found in the standard output, which would be considered error messages.
Default messages for this advanced parameter:
command not found|Must have SuperUser privileges to execute this command|invalid options|No such file or directory|not allowed to execute|ermission denied|No authority to execute|No Adapters Found|need to be root|program must be run by root|Failed to open adapter port|Functionality may be unavailable|function not supported|cannot execute|Insufficient user privilege|SCSI failure
<server>:1234
STDOUT_FILTER_LIST
Valid Values: Text
Scope: This parameter can be set at the Domain or Data Collector level or for a specific OS or host.
This parameter enables you to supply a list of strings that are to be filtered from the STDOUT of a command. The value takes ~~ as a word delimiter and | as a line delimiter.
Example:
df:~~failed|error
In this example, a line containing (df: and failed) or error will get filtered from STDOUT.
TELNET_REPLY_DISCARD_MESSAGE
This parameter is shipped in the Portal software and is listed in the Add Advanced Parameter window.
Valid Values: Text value (Default = See below)
Scope: This parameter can be set at the Domain or Data Collector level or for a specific host.
This parameter enables you to provide a regular expression string that will be discarded in the Telnet output from hosts.
Default message for this advanced parameter:
Command.*performed by .*
THREAD_IDLE_TIMEOUT
This parameter is shipped in the Portal software and is listed in the Add Advanced Parameter window.
Valid Values: Numeric value in seconds (Default = 360)
Scope: This parameter can be set at the Domain or Data Collector level or for a specific host.
Use this parameter to modify the time-out period for data collection thread processing.
WMI_PROXY_VERSION_TIMEOUT
This parameter is shipped in the Portal software and is listed in the Add Advanced Parameter window.
Valid Values: Numeric value in seconds (Default = 7200000)
Scope: The scope for this parameter is at the Domain or Data Collector level. Domain is required, Data Collector is optional.
Use this parameter to modify the minimum time-out period for WMI Proxy data refresh for the collector.