Browse
 
Tools
Rss Categories

manager.conf

Reference Number: AA-00654 Views: 3585 0 Rating/ Voters

The LumenVox Manager has a configuration file named manager.conf that contains various parameter settings that are described below.

The following parameters are parameter settings that can be applied to the LumenVox Manager. They can be controlled via the manager.conf file, located in the config directory of the Windows LumenVox installation folder. By default, this location is C:\Program Files\Lumenvox\Engine\config\.

In Linux, edit the manager.conf file in /etc/lumenvox/.


[SETTINGS]

This section contains global configuration settings for the LumenVox Manager


LOGGING_VERBOSITY

Controls the verbosity of event logging. This can be used to increase or decrease the amount of log events that are generated. Note that increasing logging verbosity uses more CPU, and should therefore be avoided wherever possible in production systems where optimal performance is critical. 

This setting was introduced with LumenVox version 14.1

Possible Values:

  1. Minimal logging - Logs only errors and critical issues.
  2. Medium logging - Logs all non-debug information as events occur
  3. Maximum logging - Logs all types of events. This will include any and all informational and debugging activity

Default: 1 (minimal logging)


Interval

Describes the interval in milliseconds between internal scan cycles. It is recommended that you do not adjust this without discussing with LumenVox Support

Default: 1000


EnableAuthentication

Defines whether username/password authentication is required for a LumenVox Dashboard to communicate with the LumenVox Manager.  This is importance since the Manager has the ability to stop and start services, which some users may wish to restrict.

Clearly if users do not want any external control over their system through the manager, then disabling the LumenVox Manager service is advised.

Possible Values:

  • 0 = No authentication required
  • 1 = Username/Password required

Default: 0


Username

When authentication mode is enabled, this value is required to remotely access the Manager.

This value must match the settings assigned to this machine in the LumenVox Dashboard

Default: LVAdmin


Password

When authentication mode is enabled, this value is required to remotely access the Manager.

This value must match the settings assigned to this machine in the LumenVox Dashboard

Default: LVPassword


ADMIN_PORT

The port used by the HTTP web administration Dashboard.

NOTE: A 's' suffix (such as 8080s) indicates SSL/HTTPS, which is strongly recommended

Default: 8080s


HTTP_LOGGING

Enables HTTP access logging to file.

Possible Values:

  • 0 = Disabled
  • 1 = Enabled

Default: 0


ACCESS_CONTROL_LIST

Specifies an optional access control list (ACL). ACL is a comma separated list of IP subnets, each subnet is prepended by '-' or '+' sign. Plus means allow, minus means deny. If subnet mask is omitted, like '-1.2.3.4', then it means single IP address. Masks may vary from 0 to 32 inclusive. Default setting is to allow all

Default


SSL_CERT_FILE

Specifies the SSL certificate (*.pem) file to use. By default a dummy certificate will be used. If specified, this should be the full path to a certificate (*.pem) file that should be used.

Default

Note: see our Resolving Dashboard Certificate Issues article that describes how to correctly configure and install these SSL certificates.

  New in 15.0.100  

SSL_PROTOCOL

Specifies the SSL Protocol to use. By default the TLSv1.2 protocol will be used, however this can be changed to TLSv1.1 or TLSv1 if preferred. Please exercise caution if changing this.

Possible Values:

  • TLSv1.2
  • TLSv1.1
  • TLSv1.0

Default: TLSv1.2


  New in 15.0.100  

CIPHER_LIST

Specifies the optional Cipher List to use. By default the list of ciphers used during SSL negotiation will be determined using the default openssl settings, however advanced users may choose to override this and supply their own list here.

Default


PROCESS_MONITOR_LIST

Specifies an optional comma delimited list of process names for which to monitor resources. The default value or an empty string monitors all LumenVox processes. A value of "none" can be used to disable all process monitoring. A single wildcard (*) is also accepted in the process name, e.g. "LV*" or "*server"

Default:  (this default will monitor all running LumenVox processes)


RESOURCE_LOG_INTERVAL

Specifies the frequency of snapshots taken for resource logging, in seconds.

Default: 60


LOG_FILE_MAX_AGE

Specifies the maximum age of log files (excluding resource logs), in days, before they are automatically removed from disk. Note that in version 14.1 and later, the manager will automatically skip over and not attempt to delete any log files located that are marked as read-only.

This must be an integer between 0 and 30 (days)

A value of 0 will disable log file cleanup.

Default: 0 (never removed)


RESOURCE_LOG_FILE_MAX_AGE

Specifies the maximum age of resource log files, in days, before they are automatically removed from disk.

This must be an integer between 0 and 30 (days)

A value of 0 will disable resource file cleanup

Default: 30


  New in 15.0.100  

RESPONSE_FILE_MAX_AGE

Specifies the maximum age of Response (.callsre) files, in days, before they are automatically removed from disk

This must be an integer between 0 and 100 (days)

A value of 0 will disable Response file cleanup

Default: 0  (disabled)


  New in 15.0.100  

GRAMMAR_CACHE_FILE_MAX_AGE

Specifies the maximum age of grammar cache files, in days, before they are automatically removed from disk. Note that enabling this will remove any cached client and ASR grammars that have remained unused for the specified amount of time. This may be particularly useful for users that have a number of dynamically generated grammars that may only be used a small number of times.

This must be an integer between 0 and 100 (days)

A value of 0 will disable cache file cleanup

Default: 0  (disabled)


  New in 15.0.100  

DNS_WARN_THRESHOLD

Specifies the maximum response time in milliseconds before a DNS lookup is shown as a warning when performing diagnostic tests. Any DNS responses that take more than this amount of time will be shown as a warning in the diagnostic report.

This must be an integer between 0 and 5000 milliseconds

Default: 500  (milliseconds)


  New in 15.0.100  

KPI_INTERVAL

Specifies the KPI logging interval in minutes. See the KPI logging article for more details on this functionality.

This must be an integer between 0 and 1440 (minutes)

A value of 0 will disable KPI logging.

Default: 0  (disabled)


  New in 15.0.100  

KPI_ROOT_FOLDER

Specifies the root folder to use when storing KPI data  See the KPI logging article for more details on this functionality.

This must be a valid folder in the local file system.

If no value is specified (the default) the LVLOGS folder will be used.

Default


  New in 15.0.100  

KPI_EXTEND_PATH

When enabled(1), KPI data will be stored in a folder location below the KPI_ROOT_FOLDER based on the current date and time.

When disabled(0), KPI data will be in KPI_ROOT_FOLDER.

Default:  0


  New in 15.0.100  

KPI_NODE_ID

Defines a Node-ID string to be recorded in the KPI logs that can be used to identify this system.

Typically this would be set to a unique string value so that the files can be identified as having come from this specific system.

Default: LumenVox


  New in 15.0.100  

KPI_LOG_MAX_AGE

Specifies the maximum age of KPI (.csv/.hdr) files, in days, before they are automatically removed from disk.

This must be an integer between 0 and 90 (days)

A value of 0 will disable KPI file cleanup

Default: 30


  New in 15.0.100  

KPI_LONG_TIME_FORMAT

When enabled(1), KPI data will use the longer time/date format in generated files. When disabled(0), a shorter numeric format will be used.

Possible Values:

  • 0 = short format (e.g. 201608211322)
  • 1 = long format (e.g. 08/21/2016 13:22:18)

Default: 1  (long format)


  New in 15.0.100  

KPI_HEADER_IN_CSV

When enabled(1), KPI header will be the first line of generated KPI .csv files. When disabled(0), a separate .hdr file for the header will be used.

Possible Values:

  • Disabled (0) = a separate .hdr file for the header will be produced.
  • Enabled (1) = KPI header will be the first line of generated KPI .csv files.

Default: 1  (enabled - header will be included in KPI .csv files)



[SNMP]

This section contains configuration settings for use with the Simple Network Management Protocol (SNMP) functionality

  New in 15.0.100  

AGENT_PORT

Defines the port number that will be used by the LumenVox Manager SNMP agent to process SNMP requests.

Typical values for this port setting:

  • 161      (SNMP)
  • 10161 (Secure SNMP).

Any valid port number may also be used.

A value of 0 will disable all SNMP functionality.

Default:  0  (SNMP disabled)


  New in 15.0.100  

TRAP_SERVERS

A list of SNMP Trap Servers that are to receive SNMP trap (alert) notifications.

This should be a semicolon separated list of server IP addresses. All listed servers will be sent trap messages when they are sent.

A value of empty-string will disable SNMP trap messages

Default:  


  New in 15.0.100  

TRAP_PORT

The port number used when sending SNMP trap messages to TRAP_SERVERS.

Note that currently, all trap messages will use SNMPv2c protocol

Default:  162


  New in 15.0.100  

NODE_ID

A custom string that can be used to identify the node that is sending SNMP Trap notifications.

This will be contained as part of each Trap notification

Default:  LumenVox


  New in 15.0.100  

SYSTEM_ID

Similar to NODE_ID, this is an optional string that may be used to identify the system/network that is sending Trap notifications.

This will be contained as part of each Trap notification message.

Default:  LUMENVOX


  New in 15.0.100  

HEARTBEAT_INTERVAL

The number of seconds between SNMP Heartbeat Trap messages that are sent out to TRAP_SERVERS.

Possible Values:

  • 0 - 1440 (seconds)

A value of 0 will disable the Heartbeat Trap mechanism.

Default:  0  (disabled)


  New in 15.0.100  

ENABLE_COMM_TRAPS

When enabled(1) communication errors between LumenVox services will be reported as Trap notifications to the specified SNMP TRAP_SERVERS when link failures are detected and also when they are restored (CLEAR Trap).

Possible Values:

  • 0 = Disabled (Traps won't be sent)
  • 1 = Enabled  (Trap alerts will be sent)

Default:  1  (enabled)

  New in 15.0.100  

ENABLE_LICENSE_TRAPS

When enabled(1) licensing errors detected on the LumenVox Media Server will be reported as Trap notifications to the specified SNMP TRAP_SERVERS when license failures are detected and also when they are restored (CLEAR Trap).

Possible Values:

  • 0 = Disabled (Traps won't be sent)
  • 1 = Enabled  (Trap alerts will be sent)

Default:  1  (enabled)


  New in 15.0.100  

CPU_MINOR_THRESHOLD

Specifies the percentage of system CPU use before an SNMP Trap notification is issued with MINOR severity.

Possible Values:

  • 0 - 100 (percent)

A value of - will disable this Trap.

Default:  0  (disabled)


  New in 15.0.100  

CPU_MAJOR_THRESHOLD

Specifies the percentage of system CPU use before an SNMP Trap notification is issued with MAJOR severity.

Possible Values:

  • 0 - 100 (percent)

A value of - will disable this Trap.

Default:  0  (disabled)


  New in 15.0.100  

CPU_CRIT_THRESHOLD

Specifies the percentage of system CPU use before an SNMP Trap notification is issued with CRIT severity.

Possible Values:

  • 0 - 100 (percent)

A value of - will disable this Trap.

Default:  0  (disabled)


  New in 15.0.100  

MEM_MINOR_THRESHOLD

Specifies the percentage of system memory use before an SNMP Trap notification is issued with MINOR severity.

Possible Values:

  • 0 - 100 (percent)

A value of - will disable this Trap.

Default:  0  (disabled)


  New in 15.0.100  

MEM_MAJOR_THRESHOLD

Specifies the percentage of system memory use before an SNMP Trap notification is issued with MAJOR severity.

Possible Values:

  • 0 - 100 (percent)

A value of - will disable this Trap.

Default:  0  (disabled)


  New in 15.0.100  

MEM_CRIT_THRESHOLD

Specifies the percentage of system memory use before an SNMP Trap notification is issued with CRIT severity.

Possible Values:

  • 0 - 100 (percent)

A value of - will disable this Trap.

Default:  0  (disabled)


  New in 15.0.100  

DISK_MINOR_THRESHOLD

Specifies the minimum GB of free disk space before an SNMP Trap notification is issued with MINOR severity.

Possible Values:

  • 0 - 10000000 (GB)

Default:  0  (disabled)


  New in 15.0.100  

DISK_MAJOR_THRESHOLD

Specifies the minimum GB of free disk space before an SNMP Trap notification is issued with MAJOR severity.

Possible Values:

  • 0 - 10000000 (GB)

Default:  0  (disabled)


  New in 15.0.100  

DISK_CRIT_THRESHOLD

Specifies the minimum GB of free disk space before an SNMP Trap notification is issued with CRIT severity.

Possible Values:

  • 0 - 10000000 (GB)

Default:  0  (disabled)


  New in 15.0.100  

COMMUNITY_STRING

Defines the COMMUNITY string used for SNMP access by the manager, often called the Public string.

This is also used when sending Trap notifications.

Default:  public



[LICENSE_SERVER]

This section contains configuration settings for use with the License Server

MaintenancePort

Describes the network port the Manager uses to communicate with the LumenVox License Server on the local machine. This must coincide with the port assigned in the License Server's configuration settings.

Default: 7569

MonitorService

Enables monitoring of the License Server service. This option was introduced in LumenVox 14.1 (January 2016)

  • 0 = Disabled (service will not be monitored)
  • 1 = Enabled (service will be monitored)

Default: 1 (service will be monitored)



[SRE_SERVER]

This section contains configuration settings for use with the Speech Engine

MaintenancePort

Describes the network port the Manager uses to communicate with the LumenVox SRE Server on the local machine. This must coincide with the port assigned in the SRE Server's configuration settings.

Default: 5730

MonitorService

Enables monitoring of the ASR (SRE) Server service. This option was introduced in LumenVox 14.1 (January 2016)

  • 0 = Disabled (service will not be monitored)
  • 1 = Enabled (service will be monitored)

Default: 1 (service will be monitored)


[TTS_SERVER]

This section contains configuration settings for use with the TTS Server

MaintenancePort

Describes the network port the Manager uses to communicate with the LumenVox TTS Server on the local machine. This must coincide with the port assigned in the TTS Server's configuration settings.

Default: 7579

MonitorService

Enables monitoring of the TTS Server service. This option was introduced in LumenVox 14.1 (January 2016)

  • 0 = Disabled (service will not be monitored)
  • 1 = Enabled (service will be monitored)

Default: 1 (service will be monitored)


[MEDIA_SERVER]

This section contains configuration settings for use with the Media Server

MaintenancePort

Describes the network port the Manager uses to communicate with the LumenVox Media Server on the local machine. This must coincide with the port assigned in the Media Server's configuration settings.

Default: 7590

MonitorService

Enables monitoring of the Media Server service. This option was introduced in LumenVox 14.1 (January 2016)

  • 0 = Disabled (service will not be monitored)
  • 1 = Enabled (service will be monitored)

Default: 1 (service will be monitored)


[CALL_INDEXER]

This section contains configuration settings for use with the Call Indexer

MaintenancePort

Describes the network port the Manager uses to communicate with the LumenVox Call Indexer on the local machine. This must coincide with the port assigned in the Call Indexer's configuration settings.

Default: 7595

MonitorService

Enables monitoring of the Call Indexer service. This option was introduced in LumenVox 14.1 (January 2016)

  • 0 = Disabled (service will not be monitored)
  • 1 = Enabled (service will be monitored)

Default: 0 (service will not be monitored)