Configuration Variables

This section lists the configuration variables you can use in PATROL and TrueSight.

For PATROL

This section lists the configuration variables used by Hardware Sentry KM for PATROL. Configuration variables are stored in the PATROL Agent configuration and can be managed through:

  • PATROL Configuration Manager (PCM)
  • wpconfig.exe (Windows)
  • xpconfig (UNIX/Linux)

Global configuration variables are stored under the /SENTRY/HARDWARE folder in the configuration tree.

Host-specific variables are stored under the /SENTRY/HARDWARE/<hostname> folder in the configuration tree.

By default, variables for the local host are stored under /SENTRY/HARDWARE/localhost.

This folder cannot be removed from the configuration tree of Hardware Sentry KM for PATROL.

Global Configuration Variables

The configuration variables listed below apply to all of the monitored hosts. They are stored under /SENTRY/HARDWARE in the PATROL Agent’s configuration.

Variable Description
AlertActions List of alert actions to be executed by {project.description} upon a hardware or connector failure. Default: A PATROL specific event and an annotation on the parameter.
automaticReinitialization If set to 1, triggers a re-initialization of the KM. The discovery checks this variable every minute and deletes it before performing the re-initialization.
collectionHubHeapSizeMax Maximum heap size in megabytes allocated to the Java Collection Hub. Default: Not set (assumed 512 MB).
collectionHubHeapSizeMin Minimum heap size in megabytes allocated to Java Collection Hub. Default: Not set (assumed 128 MB).
collectionHubOverrideJavaCommandLine Command line used by the KM to launch the Java Collection Hub. Default: Not set. This variable should only be set if instructed by Sentry Support.
collectTimeout Maximum time in seconds the collectors wait for the previous collection to complete. When this timeout is reached, it means the previous collection did not complete in a timely fashion. An error message is displayed in the System Output Window and the next collection is canceled. Default: Not set (assumed 300 seconds).
connectorMaxOCC N Times value for connector status parameters.
currentVersion Indicates the version level of the configuration. This should always match with the KM version. The KM uses this variable to perform migration operations on the configuration variables. The variable is automatically set by the KM during its initialization.
deactivatedDeviceClassList List of classes that are deactivated, for which no discovery and no collection will be performed. Use this variable to completely disable the monitoring of a specific type of objects.
deactivatePowerConsumptionEstimation If set to ‘1’, deactivates the power consumption estimation calculated by enclosureColl. If a value is provided by the manufacturer agent, or if a default wattage is set, these values will still be used to populate the MS_HW_REPORT/PowerConsumption parameter. Default: Unset (power consumption estimation is activated).
debugEndTime Specifies when the debug mode will be disabled. Format required: YYYY/MM/DD HH:MM:SS.
debugHostList List of host IDs for which the debug mode is enabled. This list is automatically deleted when the Debug Mode is set to Off (0).
debugMode When set to ‘1’, enables the debug mode of Hardware Sentry KM for PATROL. Default: Not set.
defaultCommandTimeout Timeout in seconds used when Hardware Sentry KM for PATROL executes an OS Command. Default: 30. Unit: seconds.
defaultReinitializationOptions List of default options to be executed by Hardware Sentry KM for PATROL on reinitialization: resetThresholds, resetThresholdManagementMode, resetAlertActions, resetOtherAlertSettings, resetDebugMode, resetRemovedPausedObjectList, resetReport, resetSecuritySettings, resetPreselectedConnectors. The default values are: 0=unchecked; 1=checked. Insert a colon “;” between the variable and its value: “resetThresholds;1”; and if you enter multiple variables, they need to be separated by a carriage return. Example: “resetThresholds;1” will display the remove thresholds option selected by default in the Reinitialize KM wizard.
dirCommand OS Command used to list the files in a directory. This command is used to find the installed connectors in the “hdfPath” directory. Default: On Windows: dir /A:-D /B /O:-D /T:W /S %{FOLDERPATH}; on UNIX/Linux: ls -atpR1 %{FOLDERPATH}
disableDebugSNMPWalk When set to 1, prevents the KM from performing an SNMP dump of the monitored systems in debug mode. Default: Not set.
disableForcedDefaultAccount When set to 1, prevents the KM from explicitly using the /AgentSetup/defaultAccount credentials when running external commands. Default: Not set.
disableI2D If set to 1, no MetaTokenID and no MetaFQDN information will be set in the PATROL namespace for any host.
disableJavaInformationMessage When set to 1, suppresses the warning message displayed after changing the Java configuration settings. Default: Not set.
disableJRECheck To disable the validation tests of the JRE used by the KM to run Java code and therefore force the KM to use a non-Sun or non-Oracle JRE.
disableLocalhost When set to 1, disables the default monitoring of the local host by the KM. To remove the monitoring of the local host, all of the /SENTRY/HARDWARE/localhost/… configuration variables need to be removed and the disableLocalhost variable must be set to 1 to prevent Hardware Sentry KM for PATROL from restoring the variables for the monitoring of the local host. Default: Not set.
disableMissingDeviceDetection When set to ‘1’, disables the missing device detection mechanism of Hardware Sentry KM for PATROL. By default, Hardware Sentry KM for PATROL raises an alarm for devices that were discovered and that are no longer discovered. Default: Not set.
disablePslExecuteBugWorkaround When set to ‘1’, disables the workaround in the KM for a bug in the PslExecute() PSL function. If the KM detects that the version of the PATROL Agent is affected by the PslExecute() bug, it uses an alternate technique to create asynchronous threads with the event_trigger() function and the RemPsl standard event. The disablePslExecuteBugWorkaround variable disables this workaround. Default: Not set.
discoveryInterval Interval in seconds at which discoveries are performed. Default: 3600 s (1 hour)
discreteMaxOCC N Times value for discrete parameters.
enabledProtocols Comma separated list of enabled protocols. Possible values: OSCOMMAND, HTTP, SNMP, WMI, WBEM, IMPI, UCS. Note: If the WMI protocol is selected for a remote Windows host, the configuration variable will list “OSCOMMAND,WMI”. If the SSH protocol is selected for a remote Linux, UNIX, Storage, system, etc. the configuration variable will list “OSCOMMAND”.
errorCountAutoResetTimeout Time in seconds after which the alerts on the ErrorCount parameters (MS_HW_PHYSICALDISK, MS_HW_LOGICALDISK, MS_HW_MEMORY, MS_HW_ROBOTICS, MS_HW_TAPEDRIVE) are automatically acknowledged and reset. Default: Not set (assumes a manual acknowledge is required through a KM Command).
errorCountParametersThresholds Thresholds are set per parameter, one parameter threshold per line, using the Format <parameterName>;<alarm1ThresholdValue>;<alarm1Type>;<alarm1NTimes>;<alarm2ThresholdValue>;<alarm2Type>;<alarm2NTimes> where parameterName is DeviceNotReadyErrorCount, MediaErrorCount, NoDeviceErrorCount, HardErrorCount, IllegalRequestErrorCount, RecoverableErrorCount or TransportErrorCount; alarm1ThresholdValue is the threshold for the ALARM1 range; alarm1Type is the type of the alert for ALARM1 (VOID, OK, WARN or ALARM) ; alarm1NTimes is the number of times the parameter must stay in the ALARM1 range before triggering an alert (default: 1) ; alarm2ThresholdValue is the threshold for the ALARM2 range; alarm2Type is the type of the alert for ALARM2 (VOID, OK, WARN or ALARM); alarm2NTimes is the number of times the parameter must stay in the ALARM2 range before triggering an alert (default: 1). Example: MediaErrorCount;1;ALARM;1 -> Trigger an alarm if one or more media errors are encountered; RecoverableErrorCount;1;WARN;2;2;ALARM;1 -> Trigger a warning if 1 recoverable error is encountered twice in a row, alarm after 2
exportScheduling Time when the reports will be generated. Format required: HH:MM:SS.
findWbemNamespaceTimeout Number of seconds after which Hardware Sentry KM for PATROL stops trying to get a server namespace via WBEM. Default: 1200s.
forceClassicConfigMode When the KM is used with BMC TrueSight OM, all the KM configuration menus are disabled in the PATROL Consoles. To enable them, set the forceClassicConfigMode variable to 1. Default: 0.
forceSnmpSerialization When set to ‘1’, forces the serialization of the SNMP requests made by Hardware Sentry KM for PATROL . As Hardware Sentry KM for PATROL is a multi-threaded program, it can send several SNMP requests at the same time on multi-processor computers. Some poorly written SNMP agents may not support this. Default: Not set.
globalDiscoveryTimeout Maximum time in seconds the main discovery process waits for the previous discovery to complete. When this timeout is reached, it means the previous discovery did not complete in a timely fashion. An error message is displayed in the System Output Window and the next discovery is canceled. Default: Not set (assumed 600 seconds).
hdfPath Alternate path where the connector files (*.hdf) are stored. Default: Not set (assumed $PATROL_HOME/lib/MS_HW_hdf).
individualDiscoveriesTimeout Maximum time in seconds the class-specific discovery processes wait for the previous discovery to complete. When this timeout is reached, it means the previous discovery did not complete in a timely fashion. An error message is displayed in the System Output Window and the next discovery is canceled. Default: Not set (assumed 300 seconds).
interactiveCommandTimeout Reserved for future use. Default: Not set (assumed 15 seconds).
intrusionDetectionAlert Alert settings for enclosure intrusion detection. Possible values are: Never: No alert will ever be triggered even if the chassis is opened; Always: An alert will always be triggered when the enclosure is opened; Default: An alert will be triggered only if a previously closed enclosure is detected open.
ipmiTimeout Time in seconds after which IPMI queries are considered as failed. Default value: Not set (assumed 300 seconds).
ipmitoolPath Indicates the path to the ipmitool utility on Linux and Solaris systems. This can be used if the KM cannot find the location of the ipmitool utility automatically. Default: Not set.
javaPassword Password associated to the javaUsername variable.
javaPath Path to the folder containing the Java executable used by the Collection Hub. Default: Not set (The KM will search for a suitable JRE automatically).
javaUsername Username used to launch the Java Collection Hub. Default: Not set.
json2CSVTimeout Number of seconds after which the conversion of a JSON request output to CSV will be stopped as the timeout is reached.Default: Not set.
maxConcurrentCollectThreadsPerHost Maximum number of collect threads that can run concurrently for each monitored host. Default: 15.
maxConcurrentDiscoveryThreads Maximum number of concurrent discovery threads. Default: 10.
noMissingDeviceDetectionClasses List of classes that will not trigger missing device alerts. Typically, the related classes are MS_HW_LOGICALDISK, MS_HW_VOLTAGE, MS_HW_TEMPERATURE, MS_HW_ENCLOSURE, MS_HW_LED
numericMaxOCC N Times value for numeric parameters.
pathToAWK Path to the nawk or awk executable.
pathToAWKUnix Same as pathToAWK, but only applicable to UNIX agents.
pathToAWKWindows Same as pathToAWK, but only applicable to Windows agents.
pausedObjectList Lists the PATROL object path of paused objects.
pemMessages How much internal information should be sent as PATROL events. When set to ‘all’, all internal Hardware Sentry KM for PATROL messages (problems and informational messages). When set to ‘problems’, only errors and problems. When set to ‘nothing’, no internal message at all. Please note that This does not affect the reporting of actual hardware problems. Default: nothing.
presentMaxOCC N Times value for Present parameters.
rediscoverHosts Forces a discovery for each specified host. Hosts must be identified with their PATROL IDs and separated by commas. Default: Not set. Note: This variable deletes the list of current devices (including the missing ones) for the provided hosts, removes the host instances and triggers a discovery. If the automaticReinitialization configuration variable is set to ‘1’, the rediscoverHosts variable will be ignored and removed from the configuration.
remoteCommandMaxConnectionsPerHost Maximum number of SSH sessions opened at once for a single host. Default: Not set (assumed 5).
remoteCommandTimeout Number of seconds after which a remote OS command execution will be killed. Default: Not set (assumed 60 seconds).
removeAllThresholds When set to ‘1’, deletes all thresholds from the configuration at the next discovery (every hour by default). Note: Default thresholds will then be re-added (except if the “ThresholdsManagementMode” variable is set to “none”).
removedObjectList List of instances that have been removed from the monitoring environment through the Remove KM Command.
removeMissingDevices Number of seconds after which the missing device should be removed. An empty value means the device will never be deleted. A ‘0’ value means the device will be deleted right away. Default: empty.
removeMissingDevicesOnStartup When set to ‘1’, deletes previously-discovered devices whose ID numbers have changed after a reboot operation. This setting prevents false ‘missing device’ alerts to be triggered. Note: Devices that went missing during the startup (reboot) operation will not be reported as missing. Default: 0.
scheduledReports List of reports that will be automatically generated. Possible values: ENERGY_USAGE to generate an energy usage report (power consumption), ETHERNET_FIBER_PORT_ACTIVITY to generate a network traffic report, HARDWARE_INVENTORY to generate a report on the hardware components. Note: Values must be delimited by carriage returns (/n).
snmpTimeout Timeout in seconds when performing SNMP queries. Only applicable when forced SNMP serialization has been enabled (/SENTRY/HARDWARE/forceSnmpSerialization). Default: Not set (assumed 60 seconds).
snmpWalkMaxItems Maximum number of variables that can be processed by a single SNMP walk operation. Default: Not set.
sowMessages How much internal information should be displayed in the System Output Window in the PATROL Console. When set to ‘all’, all internal Hardware Sentry KM for PATROL messages (problems and informational messages). When set to ‘problems’, only errors and problems. When set to ‘none’, no internal message at all. Please note that this does not affect the reporting of actual hardware problems. Default: All.
sshClientJarPath Path to the SSH client JAR file. Default: Not set. This variable should only be set if instructed by Sentry Support.
sshCommandJarPath Path to the SSH command JAR file. Default: Not set. This variable should only be set if instructed by Sentry Support.
startupDelay Allows the administrator to specify the number of seconds that Hardware Sentry KM for PATROL will wait before starting its platform detection and discovery. This variable may be useful on fast booting computers where the PATROL Agent starts before other important instrumentation services, which causes false alerts. Default: Not set (zero).
tableJoinTimeout Timeout in seconds when performing a Table Join. Default: 60.
ThresholdsManagementMode Specifies how Hardware Sentry KM for PATROL should manage the alert thresholds on parameters. Possible values are: ‘as’ (through PATROL for Event Management), ‘tuning’ (through the standard “Override parameter” mechanism), ‘none’ (No threshold is set by Hardware Sentry KM for PATROL). Default: ‘tuning’.
trimFromDisplayName Lists all characters that will be removed from object display names. Example: :(-_ . Default: “,” (comma)
ucsJarPath Path to the Cisco UCS client JAR file. Default: Not set. This variable should only be set if instructed by Sentry Support.
ucsTimeout Timeout in seconds when performing a UCS queries. Default: Not set (assumed 60 seconds).
ucsVbsPath Path to the Cisco UCS Windows client. Default: Not set. This variable should only be set if instructed by Sentry Support.
unexpectedStatusManagement Type of alert triggered by Hardware Sentry KM for PATROL when an unknown status is returned when collecting device information. If the Internal notification is to be triggered as well, separate the values by ‘;’. Default value: 0 (OK). Note: Relates to the unexpectedStatusInternalIssueNotification configuration variable.
unexpectedStatusInternalIssueNotification Indicates whether or not an internal KM issue notification will be triggered when an unknown status is returned for a device. Default: 1 (A notification is triggered). Note: Relates to the unexpectedStatusManagement configuration variable.
UNIXConsoleMode When set to ‘1’, makes Hardware Sentry KM for PATROL use short display name for the icons in the PATROL Consoles. This can be useful for UNIX PATROL Classic Consoles but this flag affects every console connected to the agent. Default: Not set.
useExternalAwk Forces the KM to use the AWK command line in separate processes instead of the internal (Java-based) AWK library. Default: 0.
wbemTimeout Timeout in seconds for a WBEM query to complete. Default: Not set (assumed 60 seconds).
wmiScriptPath Path to the script used by the KM to perform WMI queries on Windows. Default: Not set (use the default WMI client provided with the KM).

Host-Specific Configuration Variables

The configuration variables listed below are used by {project.description} for each monitored system. They are stored under /SENTRY/HARDWARE/<hostID> in the PATROL Agent’s configuration.

Variable Description
associatedFQDN Replaces the device MetaFQDN by the provided FQDN to attach the system to a device in TrueSight.
connectorSelectionFileNames File name of a connector or of a comma-separated list of connectors (for host groups) that will be used or not by Hardware Sentry KM for PATROL according to the option selected in connectorSelectionMode.
connectorSelectionMode Determines how Hardware Sentry KM for PATROL selects hardware connectors. Possible values: 0: automatic. Let Hardware Sentry KM for PATROL select the proper connectors; 1: exclude specified connectors; 2: pre-selected. List of connectors that Hardware Sentry KM for PATROL will use. Default: 0 (automatic)
defaultWattage Assumed power consumption in Watts of the monitored server. This value will be used instead of the measured or estimated value. Use this variable to override a PowerConsumption parameter value that seems unlikely.
forceWbemNamespace Forces the use of a specific WBEM namespace instead of letting the KM decide the suitable namespace. Default: Not set.
forceWmiNamespace Forces the use of a specific WMI namespace instead of letting the KM decide the suitable namespace. Default: Not set
hostname Real host name or IP address to be used to communicate with the remote host. Default: Not set (will use hostID).
ipmiPassword Encrypted password used for IPMI-over-LAN connections.
ipmitoolCommand To override the command line used by the KM to perform IPMI requests on Linux and Solaris systems. The specified command needs to provide the exact command to be executed with the following macros: %{IPMICOMMAND} (will be replaced with “mc info”, “sdr”, “fru”, etc. at run time); %{USERNAME}; %{PASSWORD}. Example: /usr/bin/ipmitool %{COMMAND} –u %{USERNAME} –p %{PASSWORD}. Default: Not set (the KM will find the suitable ipmitool command to run automatically).
ipmiUsername Username used for IPMI-over-LAN connections. Default: Not set (no IPMI-over-LAN query will be done).
networkLinkAlarmType Type of alert for the LinkStatus parameter of the MS_HW_NETWORK class. Possible values are: OK, WARN, ALARM. Default: Not set (assumed WARN)
networkLinkDuplexAlarmType Type of alert for the DuplexMode parameter of the MS_HW_NETWORK class. Possible values are: OK, WARN, ALARM. Default: Not set (assumed WARN).
networkLinkDuplexSetting Indicates when the KM needs to trigger an alert on the DuplexMode parameter of the MS_HW_NETWORK class: NEVER (will never trigger an alert on DuplexMode), DEFAULT (will trigger an alert only when LinkStatus downgrades from Plugged to Unplugged), ALWAYS (will trigger an alert for all interfaces that are unplugged), Default: Not set (assumed DEFAULT).
networkLinkSetting Indicates when the KM needs to trigger an alert on the LinkStatus parameter of the MS_HW_NETWORK class: NEVER (will never trigger an alert on LinkStatus); DEFAULT (will trigger an alert only when a full-duplex running adapter downgrades to half-duplex); ALWAYS (will trigger an alert for all adapters not operating in full-duplex mode). Default: Not set (assumed DEFAULT).
networkLinkSpeedAlarmType Type of the alert for the LinkSpeed parameter of the MS_HW_NETWORK class. Possible values are: OK; WARN; ALARM. Default: Not set (assumed WARN).
networkLinkSpeedMinimum Minimum accepted LinkSpeed value when networkLinkSpeedSetting is configured to “ALWAYS”.
networkLinkSpeedSetting Indicates when the KM needs to trigger an alert on the LinkSpeed parameter of the MS_HW_NETWORK class: NEVER (will never trigger an alert on LinkSpeed); DEFAULT (will trigger an alert only when LinkSpeed downgrades from a higher speed to a slower speed); ALWAYS (will trigger an alert for all interfaces that are slower than the value indicated by the networkLinkSpeedMinimum configuration variable). Default: Not set (assumed DEFAULT).
operatingSystemType Specifies the type of the monitored platform. Possible values are HP (for HP-UX); Linux; Network (for network switches); NT (for Windows); OOB (for management cards, chassis and VMware ESX); OSF1 (for HP Tru64); RS6000 (for IBM AIX); SOLARIS (for Sun/Oracle Solaris); Storage (for disk arrays, SAN switches and tape libraries); VMS (for OpenVMS).
osCommandKeyFile Path to the OpenSSH PrivateKeyFile.
osCommandPassword PSL encrypted password, or passphrase, for the user account used to launch external commands (local or remote). Default: Not set.
osCommandUsername User account used by Hardware Sentry KM for PATROL to launch external commands. Default: Not set (will use the PATROL Agent default account for local commands).
snmpCommunity (SNMP v1 or 2c) SNMP community string used by Hardware Sentry KM for PATROL to make SNMP queries. Default: Not set (let Hardware Sentry KM for PATROL decide for localhost, no SNMP queries will be performed on remote systems).
snmpPort SNMP port used by Hardware Sentry KM for PATROL to perform SNMP queries. Default: 161
snmpVersion SNMP Version (1, 2c or 3). Default: 1
snmpTimeout (SNMP v2c or 3) Number of seconds Hardware Sentry KM for PATROL will wait for an SNMP response. This timeout covers all the sub-queries that compose the ‘parent’ query. Default: 120. Note: Timeout for SNMP v1 is set through the PATROL Agent Configuration variable /snmp/default_timeout.
snmpUsername (SNMP v3) Username to use to perform the SNMP query.
snmpAuthenticationProtocol (SNMP v3) Protocol to be used to authenticate the SNMP v3 messages. Possible values: “MD5” or “SHA”. Default: None
snmpAuthenticationPassword (SNMP v3) Password to be used to authenticate SNMP v3 messages.
snmpContextName Context name accessible to the SNMP entity.
snmpPrivacyProtocol (SNMP v3) Privacy protocol to be used to encrypt SNMP v3 messages. Possible values: “DES” or “AES”.Default: None
snmpPrivacyPassword (SNMP v3) User’s privacy Password associated with the privacy protocol. Privacy password to be used to encrypt/decrypt SNMP v3 messages.
snmpRetryIntervals Specifies the interval (in milliseconds) at which the SNMP client must retry its requests until a response is received or the timeout is reached. (Comma-separated list of intervals in milliseconds). Example: snmpRetryIntervals == 1000,5000,10000,15000 for the SNMP client to retry after 1 sec, then after 5 secs, then after 10 secs. After 15 seconds, a timeout error will be triggered. Empty = Not set.
sudoCommand Syntax of the sudo command (including its full path and optional arguments) that will be used by Hardware Sentry KM for PATROL to launch the external commands specified in the useSudoCommandList variable. Default: Path to the sudo utility if available in the $PATH
ucsPassword Encrypted password for the Cisco UCS XML API calls.
ucsSsl Whether the KM should use HTTP or HTTPS (encrypted) for the Cisco UCS XML API calls. Possible values: 0 (non-encrypted), 1 (encrypted). Default: Not set (assumed 1, encrypted).
ucsUsername Username used to perform Cisco UCS XML API calls. Default: Not set (no UCS XML API call will be done).
useSudoCommandList Line-separated list of commands that will be launched by Hardware Sentry KM for PATROL through the sudo utility. Please use the graphical user interface to set this variable properly.
wbemEncryption Use of encryption when performing WBEM queries. Possible values are: ‘0’ (no encryption), ‘1’ (encrypt data). Default: 0 (no encryption). Note: The port usually used to encrypt data for WBEM queries is 5989.
wbemMultitierAuthenticationServer Specifies the authentication server when multi-tier authentication is required for WBEM queries. This variable is typically used to connect to VMware ESX hosts where pre-authentication through VMware vCenter is required. In this case, this variable will contain the hostname of the VMware vCenter.
wbemPassword Encrypted password used to perform WBEM queries.
wbemPort Port used to perform WBEM queries. Default: 5988.
wbemUsername Username used to perform WBEM queries. Default: Not set (no WBEM query will be done).
wmiPassword Encrypted password used to perform WMI queries to the remote host.
wmiUsePatrolDefaultAccount When set to 1, tells the KM to use the security token of the PATROL Agent’s default account to connect to remote systems with WMI when the wmiUsername variable is empty. Default: Not set (assumed 0, where the KM does not perform any WMI query if wmiUsername is empty).
wmiUsername Username used to perform WMI queries to the remote host. Default: Not set (no WMI query will be performed, unless wmiUsePatrolDefaultAccount is set to 1).

For TrueSight

Global Configuration Variables

This section lists the configuration variables used by Hardware Sentry globally, i.e that apply to all of the monitored hosts. These configuration variables are stored under /SENTRY/HARDWARE in the PATROL Agent’s configuration and can be managed through the Configuration Variables pane.

These variables should only be set when instructed by Sentry Software Support.

To manage configuration variables

  1. Log on to the TrueSight console.
  2. Edit your Hardware monitoring policy.
  3. Click the Configuration Variables tab.
  4. Click Add Configuration Variable.

    Managing Configuration Variables

Variables Description
automaticReinitialization If set to 1, triggers a re-initialization of Hardware Sentry. The discovery checks this variable every minute and deletes it before performing the re-initialization.
collectionHubHeapSizeMax Maximum heap size in megabytes allocated to the Java Collection Hub. Default: Not set (assumed 128 MB).
collectionHubHeapSizeMin Minimum heap size in megabytes allocated to Java Collection Hub.Default: Not set (assumed 128 MB).
collectionHubOverrideJavaCommandLine Command line used by Hardware Sentry to launch the Java Collection Hub. This variable should only be set if instructed by Sentry Support.
collectTimeout Maximum time in seconds the collectors wait for the previous collection to complete. When this timeout is reached, it means the previous collection did not complete in a timely fashion. Default: Not set (assumed 300 seconds).
currentVersion Indicates the version level of the configuration. This should always match with the version of Hardware Sentry. Hardware Sentry uses this variable to perform migration operations on the configuration variables. The variable is automatically set during its initialization.
deactivatedDeviceClassList List of monitor types that are deactivated, for which no discovery and no collection will be performed. Use this variable to completely disable the monitoring of a specific type of objects.
deactivatePowerConsumptionEstimation If set to ‘1’, deactivates the power consumption estimation calculated by enclosureColl. If a value is provided by the manufacturer agent, or if a default wattage is set, these values will still be used to populate the Hardware Report/Power Consumption attribute. Default: Unset (power consumption estimation is activated).
debugHostList List of host IDs for which the debug mode is enabled. This list is automatically deleted when the Debug Mode is set to Off (0).
defaultCommandTimeout Timeout in seconds used when Hardware Sentry executes an OS Command. Default: 30. Unit: seconds
dirCommand OS Command used to list the files in a directory. This command is used to find the installed connectors in the “hdfPath” directory. Default: On Windows: dir /A:-D /B /O:-D /T:W /S %{FOLDERPATH}; On UNIX/Linux: ls -atpR1 %{FOLDERPATH}
disableDebugSNMPWalk When set to 1, prevents Hardware Sentry from performing an SNMP dump of the monitored systems in debug mode. Default: Not set.
disableForcedDefaultAccount When set to 1, prevents Hardware Sentry from explicitly using the /AgentSetup/defaultAccount credentials when running external commands.Default: Not set.
disableI2D If set to 1, no MetaTokenID and no MetaFQDN information will be set in the PATROL namespace for any host.
disableJRECheck When set to 1, disables the validation tests of the JRE used by Hardware Sentry to run Java code. This can be used to force Hardware Sentry to use a non-Sun or non-Oracle JRE.
disablePslExecuteBugWorkaround When set to ‘1’, deactivates the workaround for a bug in the PslExecute() PSL function. If Hardware Sentry detects that the version of the PATROL Agent is affected by the PslExecute() bug, it uses an alternate technique to create asynchronous threads with the event_trigger() function and the RemPsl standard event. The disablePslExecuteBugWorkaround variable disables this workaround.
enabledProtocols Comma separated list of enabled protocols. Possible values: OSCOMMAND, HTTP, SNMP, WMI, WBEM, IMPI, UCS. Note: If the WMI protocol is selected for a remote Windows host, the configuration variable will list “OSCOMMAND,WMI”. If the SSH protocol is selected for a remote Linux, UNIX, Storage, system, etc. the configuration variable will list “OSCOMMAND”.
findWbemNamespaceTimeout Number of seconds after which a TrueSight OM - Hardware stops trying to get a server namespace via WBEM. Default value: 1200.
forceClassicConfigMode When set to 1, Hardware Sentry switches to Classic Mode, which means that it can only be operated from a PATROL Console. All the configured policies will then be ignored. Default: 0.
forceSnmpSerialization Maximum time in seconds the main discovery process waits for the previous discovery to complete. When this timeout is reached, it means the previous discovery did not complete in a timely fashion. Default: Not set (assumed 600 seconds).
globalDiscoveryTimeout Maximum time in seconds the main discovery process waits for the previous discovery to complete. When this timeout is reached, it means the previous discovery did not complete in a timely fashion. Default: Not set (assumed 600 seconds).
hdfPath Alternate path where the connector files (*.hdf) are stored. Default: Not set (assumed $PATROL_HOME/lib/MS_HW_hdf)
individualDiscoveriesTimeout Maximum time in seconds the monitor type-specific discovery processes wait for the previous discovery to complete. When this timeout is reached, it means the previous discovery did not complete in a timely fashion. Default: Not set (assumed 300 seconds).
intrusionDetectionAlert Alert settings for enclosure intrusion detection. Possible values are: Never, no alert will ever be triggered even if the enclosure is opened; Always, an alert will always be triggered when the enclosure is opened; Default, an alert will be triggered only if a previously closed enclosure is detected open
ipmiTimeout Time in seconds after which IPMI queries are considered as failed. Default value: Not set (assumed 300 seconds).
ipmitoolPath Indicates the path to the ipmitool utility on Linux and Solaris systems. This can be used if Hardware Sentry cannot find the location of the ipmitool utility automatically. Default: Not set.
javaPassword Password associated to the javaUsername variable. Default: Not set (Hardware Sentry will search for a suitable JRE automatically).
javaPath Path to the folder containing the Java executable used by the Collection Hub.
javaUsername Username used to launch the Java Collection Hub. Default: Not set.
json2CSVTimeout Number of seconds after which the conversion of a JSON request output to CSV will be stopped as the timeout is reached.Default: Not set.
maxConcurrentCollectThreadsPerHost Maximum number of collect threads that can run concurrently for each monitored host. Default: 15.
maxConcurrentDiscoveryThreads Maximum number of concurrent discovery threads. Default: 10.
noMissingDeviceDetectionClasses List of monitor types that will not trigger “missing device” alerts. Typically, the related monitor types are: Hardware Logical Disk, Hardware Voltage, Hardware Temperature, Hardware Enclosure,Hardware LED.
pathToAWK Path to the nawk or awk executable.
pathToAWKUnix Same as pathToAWK, but only applicable to UNIX agents.
pathToAWKWindows Same as pathToAWK, but only applicable to Windows agents.
pausedObjectList Lists the PATROL object path of paused objects.
pemMessages How much internal information should be sent as PATROL events. When set to ‘all’, all internal Hardware Sentry messages (problems and informational messages); when set to ‘problems’, only errors and problems; when set to ‘nothing’, no internal message at all. Please note that this does not affect the reporting of actual hardware problems. Default: nothing.
rediscoverHosts Forces a discovery for each specified host. Hosts must be identified with their PATROL IDs and separated by commas. Default: Not set. Note: This variable deletes the list of current devices (including the missing ones) for the provided hosts, removes the host instances and triggers a discovery. If the automaticReinitialization configuration variable is set to ‘1’, the rediscoverHosts variable will be ignored and removed from the configuration.
remoteCommandMaxConnectionsPerHost Maximum number of SSH sessions opened at once for a single host. Default: Not set (assumed 5).
remoteCommandTimeout Number of seconds after which a remote OS command execution will be killed. Default: Not set (assumed 60 seconds).
removeAllThresholds When set to ‘1’, deletes all thresholds from the configuration at the next discovery (every hour by default). Note: Default thresholds will then be re-added (except if the “ThresholdsManagementMode” variable is set to “none”).
snmpTimeout Timeout in seconds when performing SNMP queries. Only applicable when forced SNMP serialization has been enabled (/SENTRY/HARDWARE/forceSnmpSerialization). Default: 60 seconds.
snmpWalkMaxItems Maximum number of variables that can be processed by a single SNMP walk operation. Default: Not set.
sshClientJarPath h to the SSH client JAR file. Default: Not set. This variable should only be set if instructed by Sentry Support.
sshCommandJarPath Path to the SSH command JAR file. Default: Not set. This variable should only be set if instructed by Sentry Support.
startupDelay Allows the administrator to specify the number of seconds that TrueSight OM - Hardware will wait before starting its platform detection and discovery. This variable may be useful on fast booting computers where the PATROL Agent starts before other important instrumentation services, which causes false alerts. Default: Not set (zero).
tableJoinTimeout Timeout in seconds when performing a Table Join. Default: 60.
ThresholdsManagementMode Specifies how Hardware Sentry should manage the alert thresholds on attributes. Possible values: ‘as’ (through PATROL for Event Management), ‘tuning’ (through the standard “Override attribute” mechanism), ‘none’ (No threshold is set by Hardware Sentry). Default: ‘Tuning’.
trimFromDisplayName Lists all characters that will be removed from object display names. Example: :(-_ Default: “,” (comma)
ucsJarPath Path to the Cisco UCS client JAR file. Default: Not set. This variable should only be set if instructed by Sentry Support.
ucsTimeout Timeout in seconds when performing a UCS queries. Default: Not set (assumed 60 seconds).
ucsVbsPath Path to the Cisco UCS Windows client. Default: Not set. This variable should only be set if instructed by Sentry Support.
UNIXConsoleMode When set to ‘1’, makes Hardware Sentry use short display name for the icons in the PATROL Consoles. This can be useful for UNIX PATROL Classic Consoles but this flags affects every console connected to the agent. Default: Not set.
useExternalAwk Forces the KM to use the AWK command line in separate processes instead of the internal (Java-based) AWK library. Default: 0.
wbemTimeout Timeout in seconds for a WBEM query to complete. Default: Not set (assumed 60 seconds).
wmiScriptPath Path to the script used to perform WMI queries on Windows. Default: Not set (use the default WMI client provided with the KM).
  1. Enter the configuration variable you wish to use.
  2. In the Operation list, select the operation that you want to perform on the configuration variable. The supported operations are as follows:

    • REPLACE: Replaces the current value of the variable on the BMC PATROL Agent if the variable already exists. If the variable does not exist, a new variable is created with the specified value.
    • DELVAR: Deletes the variable from the BMC PATROL Agent
    • DELETE: Deletes the value of the variable, and the variable remains empty..
  3. Specify the Value that you want to configure for the variable.

  4. Click OK to validate.

Host-Specific Configuration Variables

The following table contains the list of the additional configuration variables that can be added to a device. Refer to the Configuring Local Hosts Monitoring or Configuring Remote Hosts Monitoring sections for detail). These variables will be applied to a single supervised host or device.

These configuration variables are stored under /SENTRY/HARDWARE/<hostID> in the PATROL Agent’s configuration.

These variables should only be set when instructed by Sentry Software Support.

Variables Description
associatedFQDN Replaces the device MetaFQDN by the provided FQDN to attach the system to a device in TrueSight.
defaultWattage Assumed power consumption in Watts of the monitored server. This value will be used instead of the measured or estimated value. Use this variable to override a Power Consumption attribute value that seems unlikely.
forceWmiNamespace Forces the use of a specific WMI namespace instead of letting Hardware Sentry decide the suitable namespace. Default: Not set
ipmitoolCommand To override the command line used by Hardware Sentry to perform IPMI requests on Linux and Solaris systems. The specified command needs to provide the exact command to be executed with the following macros: %{IPMICOMMAND} (will be replaced with “mc info”, “sdr”, “fru”, etc. at run time), %{USERNAME}, %{PASSWORD}. Example: /usr/bin/ipmitool %{COMMAND} –u %{USERNAME} –p %{PASSWORD}. Default: Not set (Hardware Sentry will find the suitable ipmitool command to run automatically).
networkLinkAlarmType Type of alert for the Link Status attribute of the Hardware Sentry monitor type. Possible values are: OK, WARN, ALARM. Default: Not set (assumed WARN)
networkLinkDuplexAlarmType Type of alert for the Duplex Mode attribute of the Hardware Network monitor type. Possible values are: OK, WARN, ALARM. Default: Not set (assumed WARN).
networkLinkDuplexSetting Indicates when Hardware Sentry needs to trigger an alert on the Duplex Mode attribute of the Hardware Network monitor type: NEVER (will never trigger an alert on Duplex Mode), DEFAULT (will trigger an alert only when Link Status downgrades from Plugged to Unplugged), ALWAYS (will trigger an alert for all interfaces that are unplugged). Default: Not set (assumed DEFAULT).
networkLinkSetting Indicates when Hardware Sentry needs to trigger an alert on the Link Status attribute of the TrueSight Hardware Network monitor type: NEVER (will never trigger an alert on Link Status), DEFAULT (will trigger an alert only when a full-duplex running adapter downgrades to half-duplex), ALWAYS (will trigger an alert for all adapters not operating in full-duplex mode). Default: Not set (assumed DEFAULT).
networkLinkSpeedAlarmType Type of the alert for the Link Speed** attribute of the Hardware Network monitor type. Possible values are: OK, WARN, ALARM. Default: Not set (assumed WARN).
networkLinkSpeedMinimum Minimum accepted Link Speed value when networkLinkSpeedSetting is configured to “ALWAYS”.
networkLinkSpeedSetting Indicates when Hardware Sentry needs to trigger an alert on the Link Speed attribute of the Hardware Network monitor type: NEVER (will never trigger an alert on Link Speed), DEFAULT (will trigger an alert only when Link Speed downgrades from a higher speed to a slower speed), ALWAYS (will trigger an alert for all interfaces that are slower than the value indicated by the networkLinkSpeedMinimum configuration variable). Default: Not set (assumed DEFAULT).
snmpRetryIntervals Specifies the interval (in milliseconds) at which the SNMP client must retry its requests until a response is received or the timeout is reached. (Comma-separated list of intervals in milliseconds). Example: snmpRetryIntervals == 1000,5000,10000,15000 for the SNMP client to retry after 1 sec, then after 5 secs, then after 10 secs. After 15 seconds, a timeout error will be triggered. Empty = Not set.
wmiUsePatrolDefaultAccount When set to 1, tells Hardware Sentry to use the security token of the PATROL Agent’s default account to connect to remote systems with WMI when the wmiUsername variable is empty. Default: Not set (assumed 0, where Hardware Sentry does not perform any WMI query if wmiUsername is empty).