Global Configuration Variables

Home  Previous  Next

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.

The following table recapitulates 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.

Variable

Description

AlertActions

List of alert actions to be executed by Hardware Sentry upon a hardware failure.

Default: A PATROL event and an annotation on the parameter.

automaticReinitialization

If set to 1, triggers a re-initialization of the KM, as if the “Reinitialize KM” KM Command had been invoked. The discovery checks this variable every hour (by default) and deletes it before performing the re-initialization.

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)

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.

debugFile

File path for the debug output when the debug mode is enabled.

Default: Not set

debugMode

When set to ‘1’, enables the debug mode of Hardware Sentry.

Default: Not set

debugSize

Maximum size of the debug file. When the maximum size is reached, the KM empties the debug output file and starts logging in the debug output again.

Default: Not set

defaultCommandTimeout

Timeout in seconds used when Hardware Sentry executes an OS Command.

Default: 30. Unit: seconds

defaultReinitializationOptions

List of default options to be executed by Hardware Sentry on reinitialization. The default values are: 0=unchecked; 1=checked

resetThresholds

resetThresholdManagementMode

resetAlertActions

resetOtherAlertSettings

resetDebugMode

resetRemovedPausedObjectList

resetReport

resetSecuritySettings

resetPreselectedConnectors

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}

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.

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: Net set.

disableMissingDeviceDetection

When set to ‘1’, disables the missing device detection mechanism of Hardware Sentry. By default, Hardware Sentry 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.

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 following format:

<parameterName>;<alarm1ThresholdValue>;<alarm1Type>;<alarm1NTimes>;<alarm2ThresholdValue>;<alarm2Type>;<alarm2NTimes>
<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 error is encountered
RecoverableErrorCount;1;WARN;2;2;ALARM;1 -> Trigger a warning if 1 recoverable error is encountered twice in a row, alarm after 2

forceSnmpSerialization

When set to ‘1’, forces the serialization of the SNMP requests made by Hardware Sentry. As Hardware Sentry 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 be 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.

migrationDone

Variable used internally by the KM. Do not change this value.

noMissingDeviceDetectionClasses

List of the 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

pathToAWK

Path to the nawk or awk executable.

Default on Windows: Default: Not set (assumed %PATROL_HOME%\bin\nawk.exe).

Default on UNIX: Default: Not set (assumed /usr/bin/nawk or /usr/bin/awk).

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 ‘none’, no internal message at all.

This doesn’t affect the reporting of actual hardware problems.

Default: all

remoteCommandTimeout

Number of seconds after which a remote OS command execution will be killed

Default: Not set (assumed 60 seconds).

removedObjectList

List of instances that have been removed from the monitoring environment through the Remove KM Command.

reportHostList

List of hosts for which a report should be written.

reportFilename

Report file name

reportFolder

Path to the folder where the report will be written

reportScheduledDays

Day of the week/month when a report should be written

reportScheduledTime

Time of the day at which the report should be written

reportScheduledToStart

Type of Hardware Health Report scheduling. Possible values are:

Never: No report is written

Hourly: Writes a report every hour

Daily: Writes a report every day

Weekly: Writes a report every week

Monthly: Writes a report every month

Default: Never.

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 messages (problems and informational messages).

When set to ‘problems’, only errors and problems.

When set to ‘none’, no internal message at all.

This doesn’t affect the reporting of actual hardware problems.

Default: All

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)

staticThresholdsParameterList

List of parameters for which custom thresholds have been set through the Modify Thresholds KM command.

tableJoinTimeout

Timeout in seconds when performing a Table Join

Default: 60

telnetConnectionMethod

Default (Windows): Java (if configured in the KM)

Note: If the PATROL agent version is 3.6.011 or later the connection method used by the KM is 'sopen'; otherwise it is left blank

Default (UNIX): Telnet

ThresholdManagementMode

Specifies how Hardware Sentry should manage the alert thresholds on parameters. Please read carefully the Hardware Sentry User Guide for more information on this topic.

Possible values:

‘as’ (through PATROL for Event Management)

‘tuning’ (through the standard "Override parameter" mechanism)

‘none’ (No threshold is set by Hardware Sentry)

Default: ‘Tuning’

ucsJarPath

Path to the JAR file used by the KM to perform UCS XML API calls on UNIX and Linux systems.

Default: Not set (use the default UCS client provided with the KM).

ucsTimeout

Timeout in seconds when performing a UCS queries.

Default: Not set (assumed 60 seconds).

unexpectedStatusManagement

Type of alert triggered by Hardware Sentry when an unknown status is returned when collecting device information. If the Internal notification is to be triggered as well, separate the values by ';'.

To trigger an Internal KM Issue notification set the second value to '1' . Or set it to '0' if you do not want to trigger the notification.

Example: Trigger a WARNING and no Internal KM Issue notification: 1;0

Ignore status and do not feed parameter but trigger an Internal KM Issue notification: IGNORE;1

Default value: 0;0 (Consider the status to be OK and do not trigger an Internal KM Issue notification).

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

wbemJarPath

Path to the jar file used by Hardware Sentry to execute WBEM queries.

Default: $PATROL_HOME/bin/MS_HW_wbemHttpClient.jar

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).

The following configuration variables are stored in the folder SENTRY/MATSYA/.

Variable

Description

debugMode

When set to '1', enables the debug mode of the Sentry collection Hub.

Default: Not set

heapSizeMax

Maximum heap size in megabytes allocated to JVM applications.

Default: 128 MB

heapSizeMin

Minimum heap size in megabytes allocated to JVM applications.

Default: 128 MB

DebugFolder

Path to the folder where the debug output files will be stored (when debug mode is enabled)

Default: Not set (output to the System Output Window).

javaPassword

Password for the specific account used to run Java.

Default path: /SENTRY/MATSYA/

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 for the specific account used to run Java.

Default path: /SENTRY/MATSYA/.

overrideJavaCommandLine

To supersede the usual command line to run the JAR file.

Default: Not set.