ELM Server Registry Entries

<< Click to Display Table of Contents >>

Navigation:  Technical Resources > Registry Entries >

ELM Server Registry Entries

 

ELM Server Registry Keys

HKEY_LOCAL_MACHINE \ SOFTWARE\ TNT Software \  \ 7.5.0 \ Settings

OR if 64bit Operating System

HKEY_LOCAL_MACHINE\SOFTWARE\Wow6432Node\TNT Software\ELM Enterprise Manager\7.5.0\Settings

Name
Type
Default Value
Restart Required
Description

AgentHeartbeatInSeconds
REG_DWORD
60 (seconds)
ELM Server restart required
This sets the interval used by ELM Agent for checking in with the ELM Server. The ELM Server uses this heartbeat check to provide At-a-Glance <%Z_AT_A_GLANCE%> Agent status information.

Name
Type
Default Value
Restart Required
Description

AutoAddParsedAgents
REG_DWORD
0
ELM Server restart required
This automatically adds virtual agents to the ELM server when parsing computer names from Syslog messages.  A license is required for each computer name parsed.

Name
Type
Default Value
Restart Required
Description

CacheDataTrigger
REG_DWORD
60 (minutes)
ELM Server restart required
Interval for cached data window in minutes.
Applies to EEM, ELM, and EVM only.

Name
Type
Default Value
Restart Required
Description

ContinuePruneOnArchiveError
REG_DWORD
0
ELM Server restart required
This setting controls continued processing if an error occurs when moving events from the primary to the archive database.  Setting it to 0 will stop the archiving process, and is intended to prevent any data loss.  Setting it to 1 will continue the archiving process, but may result in data loss.  With either setting, if an error occurs, ELM will write error event 5219 to the Windows application log on the ELM Server computer.

Name
Type
Default Value
Restart Required
Description

ForwardELMServerNotification_Category
String Value
null
ELM Server restart required
This setting allows you to re-write an Event category when using a Forward to ELM server notification method.  Replace "ForwardELMServerNotification" with the name of your pre-configured Forward to ELM Server notification method.  Ex: You setup a Forward to ELM Server type notification method called "Forward to Central Office".  The registry entry would then be Forward to Central Office_Category and the value would be set to how you want the category re-written.

Name
Type
Default Value
Restart Required
Description

ForwardEventLicense
String Value
null
ELM Server restart required
Assigns a specific license type to Auto Add agents.  Default is null.  ex: 7521 = Network license

Name
Type
Default Value
Restart Required
Description

FTPMonitorTakeActionAtEachInterval
REG_DWORD
0
ELM Server restart required
This modifies the default behavior <%Z_DEFAULT_MI_BEHAVIOR%> of the FTP Monitor.  By creating this key and setting the value to 1, you can force the FTP Monitor to execute its configured Action(s) at each interval, regardless of state changes.

<%REG_VIRTUAL_SERVICE%>

Name
Type
Default Value
Restart Required
Description

LicenseEventInXml
REG_DWORD
0
No
If set to 1, changes the event output for license changed (Event ID 5226), Agent added (Event ID 5229), and Agent deleted (Event ID 5230) to XML format for debugging purposes.

Name
Type
Default Value
Restart Required
Description

MaxNotificationQueueEntriesPerItem
REG_DWORD
50000
ELM Server restart required
Number of pending notifications that can be in the Notification queue for an individual Notification Method. If a Method creates more than the default or registry configured number of Notifications, then the ELM Server will generate error 5104 and discard all pending notifications for the one Notification Method. Pending notifications queued for other Notification Methods, even if they are the same type, will not be deleted. Increasing this value will increase memory requirements of the ELM Server process.  Maximum value is 2147483647 (MAX_INT).

Name
Type
Default Value
Restart Required
Description

MaxNumRecordsReadBeforeForceSend
REG_DWORD
1000
No
This value is used for Event Monitors and Event Collectors. This is the maximum number of event log records that will be read in a single monitor item interval.

<%REG_VIRTUAL_SERVICE%>

Name
Type
Default Value
Restart Required
Description

MaxPagerMsgLength
REG_DWORD
240
No
The maximum message size for TAP (Telocator Alphanumeric Protocol) is 250 bytes, and for SMS (Short Message Service) it's 160 bytes. Service providers are free to implement their own interpretation of these protocols, and 240 bytes has proven to be successful in practice.

Name
Type
Default Value
Restart Required
Description

MaxSyslogMessageQueueSize
REG_DWORD
500000
No
This key controls the number of  TCP or UDP syslog messages the ELM Syslog Receiver will hold in memory. Limiting this queue will limit how much virtual memory (perfmon: process/private bytes) ELM will use. When the queue limit is reached, the queue is purged and informational event 5050 from EEMSVR is generated: SyslogMessageQueue reached max size, syslog message not accepted.

Name
Type
Default Value
Restart Required
Description

MonitorNumLoggingChars
REG_DWORD
512
ELM Server restart required
This key controls the number of bytes that TNTDiag will capture for Monitor Item activity.  Use the Server registry key when the Monitor Items are assigned to Virtual Agents.

Name
Type
Default Value
Restart Required
Description

NormalShutdown
REG_DWORD
1
No
Users should not change this registry entry.  This value is set internally by the ELM Server. A value of 1 indicates a normal shutdown. When the ELM Server service is restarted, this flag is removed from the registry. Before a Service Agent or the ELM Advisor will attempt to restart a stopped ELM Server, it will read the registry to see if this flag is present. If the flag exists, the Service Agent or ELM Advisor will not attempt to restart the ELM Server. If the flag does not exist, the Service Agent or ELM Advisor will attempt to restart the ELM Server (if configured to do so).

Name
Type
Default Value
Restart Required
Description

NumSyslogEventsDroppedBeforeLoggingEvent
REG_DWORD
10
ELM Server restart required
This key controls the number of syslog messages that will be dropped before the ELM Server writes event log message 5050. It can be used to minimize the number of events the ELM Server writes if many syslog messages are dropped from the syslog message queue. Restarting the ELM Server or changing this registry entry will reset the internal counter. The first time a syslog message is dropped, an event 5050 is generated. After that, the counter starts.

Name
Type
Default Value
Restart Required
Description

PortMonitorTakeActionAtEachInterval
REG_DWORD
0
ELM Server restart required
This modifies the default behavior <%Z_DEFAULT_MI_BEHAVIOR%> of the TCP Port Monitor.  By creating this key and setting the value to 1, you can force the Port Monitor to execute its configured Action(s) at each interval, regardless of state changes.

<%REG_VIRTUAL_SERVICE%>

Name
Type
Default Value
Restart Required
Description

RealTimeEventViewUpdates
REG_DWORD
1
ELM Server restart required
This value is set through the Options tab of the ELM Control Panel applet. Specifies whether real-time streaming of new events is enabled (1) or disabled (0).

Name
Type
Default Value
Restart Required
Description

SaveInterval
REG_DWORD
15
ELM Server restart required
Users should not change this registry entry.  Interval number of seconds ELM Server waits before checking for configuration changes. If changes are found, then they will be written to the ELM Server .dat file.

Name
Type
Default Value
Restart Required
Description

ServerName
REG_SZ
< NetBIOS Name of the ELM Server computer >
ELM Server restart required
When the ELM Server service starts, this name is loaded into memory. Once loaded, this name will be passed to Service Agents as the name they should use for the ELM Server. The name is passed when an Agent configuration is updated, or when a new Agent is installed.

Name
Type
Default Value
Restart Required
Description

ShowServerMonitor
REG_DWORD
0
ELM Server restart required
If set to 1, the ELM Server monitor item is displayed in the Console.

Name
Type
Default Value
Restart Required
Description

SMTPEmailNotificationTimeOut
REG_DWORD
60
ELM Server restart required
Specifies the number of seconds the ELM Server will wait for a SMTP Server to respond when using the SMTP e-mail Notification Method.  The minimum timeout is set to 5 seconds. The maximum timeout value is specified by the SMTPMaxTimeoutInSeconds registry key.

Name
Type
Default Value
Restart Required
Description

SMTPMaxTimeoutInSeconds
REG_DWORD
300
ELM Server restart required
Specifies the maximum number of seconds ELM will wait for an SMTP Server to respond.  This entry sets an upper bound which limits both the ELM SMTP Monitor and the ELM SMTP Notification Method.  The minimum timeout is set to 5 seconds.  The maximum timeout value is 4,294,967,295 seconds.

Name
Type
Default Value
Restart Required
Description

SMTPWaitForPreEHLOGreetingInSeconds
REG_DWORD
0
ELM Server restart required
When the ELM Server connects to an SMTP server, this entry adds a delay, in seconds, after connecting and before sending EHLO.  This setting affects all SMTP E-mail Notification Methods, and all SMTP Monitor Items.

Name
Type
Default Value
Restart Required
Description

SQLExpressMaxSizeR2
REG_DWORD
10140
No
Specified in MB, any SQL Express 2008 R2 or SQL Express 2012 database of this size or larger will be rolled over to a new database.  This number can be reduced to roll over the database earlier to avoid conflicts with SQL Express reaching its maximum size limit.

Name
Type
Default Value
Restart Required
Description

SyslogMaxNumThreads
REG_DWORD
10
Yes
The number of workers threads that processes the syslog queue.  Set the value to number of worker threads.

Name
Type
Default Value
Restart Required
Description

TrustedServers
REG_SZ
<IP Address>
No
This value is set through the Forwarded Events tab of the ELM Control Panel applet. The Event Forward Notification Method Wizard will attempt to create this value on the receiving ELM Server. If this fails, use the ELM Control Panel applet.  IP addresses of sending ELM Servers that are not in this list will be ignored by the receiving ELM Server.

Name
Type
Default Value
Restart Required
Description

UseShellExecuteForScripts
REG_DWORD
0
No
This value will alter the method used by the Run Action in Monitor Items assigned to Virtual Agents and the Command Script Notification Method.  Setting it to 1 will enable script execution on a remote system, but will disable environment variable expansion.

Name
Type
Default Value
Restart Required
Description

ValidateTablesOnCreation
REG_DWORD
1
ELM Server restart required
If set to 1, the SQL validation scripts will only be run at database creation, except for INTERNAL.PR_MaintainAllPartitions.sql.

Name
Type
Default Value
Restart Required
Description

ViewListSendAdvises
REG_String
No Value
ELM Server restart required
Semicolon delimited string of Event View names to receive real time ELM console updates.

Name
Type
Default Value
Restart Required
Description

WarnIfLessThanNumLicenses
REG_DWORD
0
No
Set the value that an event should be written if X is exceeded. So, if you have 20 licenses, and you set it to 5, after the 6th is taken it'll write an event out.

Name
Type
Default Value
Restart Required
Description

WebPageMonitorCaseInsensitive
REG_DWORD
0
No
Specifies whether the fetched web pages are treated as case-sensitive (0) or not (1).

<%REG_VIRTUAL_SERVICE%>

Name
Type
Default Value
Restart Required
Description

WriteEventOnAgentAdd
REG_DWORD
0
No
If set to 1, if an Agent is added to the Server, an event will be written out.

Name
Type
Default Value
Restart Required
Description

WriteEventOnAgentDelete
REG_DWORD
0
No
If set to 1, if an Agent that is reporting to the Server is deleted, an event will be written out.