Registry Settings

This document describes the registry settings you can customize according to the requirements of your installation.

System Management Hub provides the user with a web interface to add, delete, or modify registry keys. For details on this feature, see Working with the Registry under Web Interface.


Registry Master Key

Master Key HKEY_LOCAL_MACHINE\\SOFTWARE\\Software AG\\System Management Hub

Section and Key Names

The section names and key names are identical on every platform. Only the following keys are customizable:

Global

The section name is Global.

Key Description
ArgLogDir as String

"\Software AG_directory\InstanceManager\log" as default

Config_Edit as String

"1" as default

Def_Agents_Path as String

the default agent path

Install_Path as String

the base directory for the current installation

Language as String

predefined I18N support; currently only the English version, "EN", is supported.

PKCS12File as String

"\Software AG_directory\InstanceManager\files\server.p12" as default

PKCS12Pass as String

PKCS12 paasword field

Rgs_Edit as String

enable/disable registry editing on the local machine
0 disable (default)
1 enable

Rot_View as String

enable/disable
0 disable (default)
1 enable

Sag_User_Name as String (UNIX only)

pre-defined user ID for the execution of all managed products; set by the installation procedure

SSL as String

enable/disable
0 disable (default)
1 enable

SSL_Server_Cnf as String

"\Software AG_directory\InstanceManager\files\ssl\server.cnf" as default

Support_Data_Path as String

defines the default directory location for EPOST support files. "\Software AG_directory\InstanceManager\DiagnosticFiles" as default

Use_ICU as String

enable/disable
0 disable (default)
1 enable

Version as String

the current main version

Windows_Network_Logon as String

enable/disable
0 disable (default)
1 enable

Xds_Edit as String

enable/disable
0 disable (default)
1 enable

Client/Server Layer Server

The section name is CSLayerServer.

Key Description
Agent_Maximum_XML as String

"3000000" as default

Agent_stderr as String

controls diagnostics trace facilities within the agents
"0" - disabled (default)
"1" - enable trace, write trace data fo file (defined by user)
"2" - enable trace, write trace data to STDERR
"3" - enable trace, write trace data to BOTH file and STDERR

Agent_stderr_directory as String

defines the directory where agent trace (if enabled) is written. "\Software AG_directory\InstanceManager\log" as default

Agent_Timeout as String

"1800000" as default

Agent_tmp_directory as String

defines the directory used by agents when they need to create temporary files or data during processing. "\Software AG_directory\InstanceManager\tmp" as default

AutomatedScheduler as String

enable/disable
0 disable (default)
1 enable

AutomatedTasks as String

enable/disable
0 disable (default)
1 enable

Config_Edit as String

enable/disable
0 disable (default)
1 enable

Http as String

built-in HTTP mode
"0" - disabled (default)
"1" - enabled

Http_Port as String

10015 (default)
System Management Hub HTTP port

JRE_Path as String

the full path of the used native JVM library (jvm.dll, libjvm.so)

Java as String

Java bridge mode
"0" - disabled
"1" - enabled (default)

Java_Agents as String

the full path of the Java plug-in

Java_Image as String

"\Software AG_directory\jvm\jvm160_32\bin" as default

Java_Switch as String

enable/disable
0 disable (default)
1 enable

Java_Wrapper as String

"\Software AG_directory\InstanceManager\bin\argjwrapper.exe" as default

New_StartAgent as String

"0" - to use old agent invocation
"1" - to use new agent invocation (default)

SIN_Config_File as String

"\Software AG_directory\InstanceManager\conf\cim_jaas.properties" as default

Security as String

"0" (disabled)
"1" - logging through the local FTP daemon; an FTP daemon must be available on the same machine
"2" - use the native user authentication provided by the operating system (default)

Snmp as String

Snmp interface control
"0" - disabled
"1" - enabled (default)

Snmp_Interface as String

the full path of the Snmp plug-in

Snmp_Port as String

"10016" (default)
the SNMP port

Tcp_Ip_Port as String

10012 (default)
System Management Hub server port

Tcp_Ip_Queue_Size as String

pre-defined queue size, default "100"

Tcp_Ip_Recv_Timeout as String

pre-defined timeout in seconds for the TCP/IP recv call, default "180"

Template_Agent_Enabled as String

enable/disable
false - disable
true - enable (default)

Trace as String

controls trace file
"0" - disabled (default)
"1" - enable trace, write trace data to file (defined by user)
"2" - enable trace, write trace data to STDERR
"3" - enable trace, write trace data to BOTH file and STDERR

Trace_Byte_Level as String

controls trace of TCP/IP and IPC communication, active only if Trace is enabled
"0" - disabled (default)
"1" - enabled

User_Cmd as String

user command control
"0" - disabled
"1" - enabled (default)

Management Independent Layer

The section name is MILayer.

Key Description
Batch as String

built-in batch processing mode
"0" - disabled
"1" - enabled (default)

Config_Edit as String

enable/disable
"0" - disabled
"1" - enabled (default)

Hostlist_Path as String

the directory of the host list configuration file (hostlist.xml)

Http_Port as String

"10010" (default)
The Software AG Runtime HTTP port

Snmp as String

SNMP interface control
"0" - disabled
"1 " - enabled (default)

Snmp_Interface as String

the full path of the SNMP plug-in

Snmp_Port as String

"10018" (default)
the SNMP port

Snmp_Proxy_Port as String

"10019" (default)
the SNMP proxy port

SupportPlugIn as String

support plug-in control
"0" - disabled
"1" - enabled (default)

Support_session_timeout as String

Timeout for an inactive support session in seconds, for example, 300 (default is 900)

Tcp_Ip_Port as String

"10013" (default)
The Software AG Web Server port

Tcp_Ip_Recv_Timeout as String

pre-defined timeout in seconds for the TCP/IP recv call, default 180

Url as String

"localhost " (default)
the URL or IP address of the Software AG Runtime external HTTP server, for example, http.softwareag.com, if Software AG Runtime uses an external HTTP server, this key must point to the HTTP host machine.

HTTP Layer

The section name is HTTPLayer.

Key Description
Trace as String

control trace file generation for the internal HTTP server
"0" - disabled (default)
"1" - enabled

Batch Layer Client

The section name is BatchLayerClient.

Key Description
Tcp_Ip_Recv_Timeout as String

pre-defined timeout in seconds for the TCP/IP recv call, default "60000"

Event Layer Server

The section name is EventLayer.

Key Description
Config_Edit as String

enable/disable
"0" - disabled
"1" - enabled (default)

Logging_Path as String

the logging path for event messages

RefreshRate as String

"5" (default)
defines the default rate (in seconds) between page updates for running jobs when displayed by the Events and Job Monitor agent

ShowDebug as String

controls the display of additional diagnostics and trace information in the event log display messages
"0" - disabled (default)
"1" - enabled

ShutdownTimeout as String

delay for registered plug-ins to shut down
in seconds (default is "900")

Snmp as String

SNMP interface control
0 disabled
1 enabled (default)

Snmp_Interface as String

the full path of the Snmp plug-in

Snmp_Port as String

"10017" (default)
the SNMP port

Tcp_Ip_Port as String

"10014 " (default)
The Event Dispatcher server port

Tcp_Ip_Queue_Size as String

pre-defined queue size (default "100")

Tcp_Ip_Recv_Timeout as String

pre-defined timeout in seconds for the TCP/IP recv call, default "60"

Trace as String

controls trace file
"0" - disabled (default)
"1" - enabled

Cleanup Intervals

The section name is EventLayer\Cleanup.

Key Description
Info as String, single value between 1 and 59 (see note and table below)

"30" (default)
The number of days to retain messages of type Info

Warning as String, single value between 1 and 59 (see note and table below)

"30" (default)
The number of days to retain messages of type Warning

Error as String, single value between 1 and 59 (see note and table below)

"30" (default)
The number of days to retain messages of type Error

Fatal as String, single value between 1 and 59 (see note and table below)

"30" (default)
The number of days to retain messages of type Fatal

Note:
A single value of 60 or greater specifies a clean-up interval in seconds. A single value of 59 or less specifies a clean-up interval in days.

The clean-up interval can be specified in a DD HH:MM:SS format. The following formats are supported:

Time Format Example Meaning
SS 61 61 seconds. For backward compatibility if the single value is less than 60, the value is assumed to be days.
MM:SS 10:20 10 minutes, 20 seconds
HH:MM:SS 1:10:20 1 hour, 10 minutes and 20 seconds
DD HH:MM:SS 5 1:10:20 5 days, 1 hour, 10 minutes and 20 seconds

SNMP Layer

The section name is SNMPLayer.

Key Description
Config_Edit as String

enable/disable
"0" - disabled
"1" - enabled (default)

Mib_Path as String

the path of the internal MIB mapping configuration

NotificationContext as String

"public" as default

NotificationProtocol as String

enable/disable
"0" - disabled (default)
"1" - enabled

ReadCommunity as String

"public" as default

ReadWriteCommunity as String

"private" as default

ThreadModel as String

enable/disable
"0" - disabled (default)
"1" - enabled

Trace as String

control trace file for the Snmp plug-ins
"0 "disabled (default)
1 enabled

TraceSnmp as String

control trace file for the Snmp engine
"0" - disabled (default)
"1" - enabled

TraceSnmpAgent as String

control trace file for the Snmp MIBs
"0" - disabled (default)
"1" - enabled

TraceSnmpAgentDebugFilter as String

"6" as default

TraceSnmpAgentErrorFilter as String

"5" as default

TraceSnmpAgentEventFilter as String

"5" as default

TraceSnmpAgentInfoFilter as String

"5" as default

TraceSnmpAgentWarningFilter as String

"5" as default

Update_Timeout as String

pre-defined timeout in seconds for the update process for the internal MIB tables, default 65

Java Layer

The section name is CSLayerServer.

Java Parameters

The section name is CSLayerServer\JVM_Parameters.

The section includes the list of the JVM parameters, name=value.

Java Agents

The section name is CSLayerServer\Java_Agents.

The section includes the list of the agent packages, package_descriptor=package_full_path

Net Drives

The section name is CSLayerServer\NetDrives.

Session Termination Callbacks

The section name is CSLayerServer\Session_Callbacks.

This section includes a list of plug-ins for use by the Client/Server Layer server.

Syslog Parameters (UNIX only)

System Management Hub provides the facility to use syslog on UNIX systems for event messages. You can configure the message severity that is written to syslog with the registry string value "Logmask" under:

HKEY_LOCAL_MACHINE\SOFTWARE\Software AG\System Management Hub\EventLayer\Syslog

This value consists of a combination of the following characters that generate the desired level of logging:

Syslog Severity Table
Character Severity Syslog Severity Default
F ARGUS_SV_SEVERE_ERROR LOG_CRIT X
E ARGUS_SV_ERROR LOG_ERR X
W ARGUS_SV_WARNING LOG_WARNING  
I ARGUS_SV_INFO LOG_INFO  
J Open Job Messages of all severities Appropriate LOG_severity  

If any of these characters are present in this registry value, the event (or job information) is written in the syslog. To disable, set this value to an empty string.

Example: Logmask = EFW logs only warning and error messages.

UNIX Syslog

The syslogd daemon writes the syslog. When syslogd starts up, it reads its configuration file (the file /etc/syslog.conf) to determine what kind of events to log and where to log them.

For detailed information about your current configuration file (the parameters of the syslog.conf file), run man syslog.conf.

There is no standard for the message output file and no utility to automatically read the correct file.

Start of instruction setTo read the syslog:

  1. Open the file /etc/syslog.conf and check if there are any messages.

  2. As a root user (or a user with root permissions), open the plain text syslog output file in any editor or run "cat", "more", "less", etc.

  3. Select "Software AG".

For more information on logging on UNIX, see UNIX Logging Facility.