[cmserviceagent]

cmport

cmport

The port number on the local machine where the Resource Manager will make a connection to contact the Cluster Manager on the local machine

Default value

6001

Takes effect After restart

[ems]

log_sinks

Log Sinks

List of one more pipe-delimited identifiers for log sinks that should be loaded upon initialization of the GVP Logging Service.

Valid values

MFSINK or TRAPSINK

Default value

MFSINK|TRAPSINK

Takes effect At start/restart

logconfig.MFSINK

MF Sink Log Filter

Controls the log messages that are sent to the MF sink. The format is 'levels|moduleIDs|specifierIDs' (repeated if necessary). The values between the pipes can be in the format: 'm-n,o,p' (ie "0-4, 5,6"). The wildcard character '*' can also be used to indicate all valid numbers. Example: '*|*|*' indicates that all log messages should be sent to the sink. Alternatively, '0,1|0-10|*|4|*|*' indicates that CRITICAL(0) and ERROR(1) level messages with module IDs in the range 0-10 will be sent to the sink; and all INFO(4) level messages will be sent as well.

Valid values

Pipe delimited ranges for log levels, module IDs and specifier IDs. Ranges can be comma separated integers or range of integers or '*'.

Default value

0-3,5|*|*

Takes effect immediately

metricsconfig.MFSINK

MF Sink Metrics Filter

Specifies the metrics that are delivered to the MF Sink. '*' indicates that all metrics will be sent to the sink. Alternatively, '5-10,50-55,70,71' indicates that metrics with IDs 5,6,7,8,9,10,50,51,52,53,54,55,70 and 71 will be sent to the MF sink.

Valid values

Comma separated list of metric values or ranges. A metric value must be between 0 and 141 inclusive. The values '*' and blank are also allowed.

Default value

0-15,19-41,43,52-56,72-74,76-81,127,129,130,132-141

Takes effect immediately

ors.reportinginterval

OR reporting interval

Interval (seconds) accumulated operational reports are submitted to the Reporting Server

Valid values

An integer between 1-299 inclusive.

Default value

60

Takes effect At start/restart

rc.batch_size

Upstream Batch Size

The number of upstream messages queued up by the reporting client before sending them up to the reporting server. A higher batch size (e.g. 50 records) will lessen bandwidth constraints, at the cost of making sending data at larger intervals.

Valid values

An integer between 1-5000 inclusive.

Default value

500

Takes effect At start/restart

rc.cdr.batch_size

CDR Batch Size

The number of CDR messages queued up by the reporting client before sending them up to the reporting server. A higher batch size (e.g. 50 records) will lessen bandwidth constraints, at the cost of making sending CDR data at larger intervals.

Valid values

An integer between 1-5000 inclusive.

Default value

500

Takes effect At start/restart

rc.cdr.local_queue_path

Persistent DB File for CDR Data

The full path of the local database file used to locally persist data for CDRs.

Valid values

Path to the DB file.

Default value

$InstallationRoot$\config\cdrQueue.db

Takes effect At start/restart

rc.cdr.msg_broker_uri

Reporting Server Message Broker for CDR

The URI for the Reporting Server's JMS Message Broker (CDR)

Valid values

A URI

Default value

tcp://$ReportingServerHostname$:61616

Takes effect At start/restart

rc.local_queue_path

Persistent DB File for Upstream Logging

The full path of the local database file used to locally persist data for upstream logging to the GVP Reporting Client.

Valid values

Path to the DB file.

Default value

$InstallationRoot$\config\reportingClientQueue.db

Takes effect At start/restart

rc.msg_broker_uri

Reporting Server Message Broker for Upstream Logging

The URI for the Reporting Server's JMS Message Broker

Valid values

A URI

Default value

tcp://$ReportingServerHostname$:61616

Takes effect At start/restart

rc.ors.local_queue_path

Persistent DB File for OR Data

The full path of the local database file used to locally persist data for Operational Reporting.

Valid values

Path to the DB file.

Default value

$InstallationRoot$\config\cdrQueue.db

Takes effect At start/restart

rc.ors.msg_broker_uri

Reporting Server Message Broker for Operational Reporting

The URI for the Reporting Server's JMS Message Broker (OR)

Valid values

A URI

Default value

tcp://$ReportingServerHostname$:61616

Takes effect At start/restart

trace_flag

Trace Flag

Flag specifying whether debug level logging is enabled. When enabled (flag is set to TRUE), debug level logs will be processed and filtered like other log levels. When the flag is set to FALSE, debug level log messages will never be processed.

Valid values

  • FALSE
  • TRUE

Default value

FALSE

Takes effect immediately

[log]

all

Output for level all

Specifies the outputs to which an application sends all log events. The log output types must be separated by a comma when more than one output is configured.

Valid values

  • stdout Log events are sent to the Standard output (stdout).
  • stderr Log events are sent to the Standard error output (stderr).
  • network Log events are sent to Message Server, which can reside anywhere on the network. Message Server stores the log events in the Log Database. Setting the all log level option to the network output enables an application to send log events of the Standard, Interaction, and Trace levels to Message Server. Debug-level log events are neither sent to Message Server nor stored in the Log Database.
  • memory Log events are sent to the memory output on the local disk. This is the safest output in terms of the application performance.
  • [filename] Log events are stored in a file with the specified name. If a path is not specified, the file is created in the application's working directory.
  • Default value

    (blank)

    Takes effect immediately

    check-point

    Check point interval

    Specifies, in hours, how often the application generates a check point log event, to divide the log into sections of equal time. By default, the application generates this log event every hour. Setting the option to 0 prevents the generation of check-point events.

    Valid values

    0 - 24

    Default value

    1

    Takes effect immediately

    compatible-output-priority

    Enable 6.X compatible log output priority

    Specifies whether the application uses 6.x output logic.
  • true The log of the level specified by "Log Output Options" is sent to the specified output.
  • false The log of the level specified by "Log Output Options" and higher levels is sent to the specified output.
  • Valid values

    • true
    • false

    Default value

    false

    Takes effect immediately

    debug

    Output for level debug

    Specifies the outputs to which an application sends the log events of the Debug level and higher (that is, log events of the Standard, Interaction, Trace, and Debug levels). The log output types must be separated by a comma when more than one output is configured.

    Valid values

  • stdout Log events are sent to the Standard output (stdout).
  • stderr Log events are sent to the Standard error output (stderr).
  • network Log events are sent to Message Server, which can reside anywhere on the network. Message Server stores the log events in the Log Database. Setting the all log level option to the network output enables an application to send log events of the Standard, Interaction, and Trace levels to Message Server. Debug-level log events are neither sent to Message Server nor stored in the Log Database.
  • memory Log events are sent to the memory output on the local disk. This is the safest output in terms of the application performance.
  • [filename] Log events are stored in a file with the specified name. If a path is not specified, the file is created in the application's working directory.
  • Default value

    ..\logs\ResourceMgr

    Takes effect immediately

    expire

    Log Expiration

    Determines whether log files expire. If they do, sets the measurement for determining when they expire, along with the maximum number of files (segments) or days before the files are removed.

    Valid values

  • false No expiration; all generated segments are stored.
  • [number] file or [number] Sets the maximum number of log files to store. Specify a number from 1-100.
  • [number] day Sets the maximum number of days before log files are deleted. Specify a number from 1-100.
  • Default value

    20

    Takes effect immediately

    interaction

    Output for level interaction

    Specifies the outputs to which an application sends the log events of the Interaction level and higher (that is, log events of the Standard and Interaction levels). The log outputs must be separated by a comma when more than one output is configured.

    Valid values

  • stdout Log events are sent to the Standard output (stdout).
  • stderr Log events are sent to the Standard error output (stderr).
  • network Log events are sent to Message Server, which can reside anywhere on the network. Message Server stores the log events in the Log Database. Setting the all log level option to the network output enables an application to send log events of the Standard, Interaction, and Trace levels to Message Server. Debug-level log events are neither sent to Message Server nor stored in the Log Database.
  • memory Log events are sent to the memory output on the local disk. This is the safest output in terms of the application performance.
  • [filename] Log events are stored in a file with the specified name. If a path is not specified, the file is created in the application's working directory.
  • Default value

    ..\logs\ResourceMgr,network

    Takes effect immediately

    keep-startup-file

    Keep startup log file

    Specifies whether a startup segment of the log, containing the initial T-Server configuration, is to be kept. If it is, this option can be set to true or to a specific size. If set to true, the size of the initial segment will be equal to the size of the regular log segment defined by the segment option. The value of this option will be ignored if segmentation is turned off (that is, if the segment option set to false).

    Valid values

  • false No startup segment of the log is kept.
  • true A startup segment of the log is kept. The size of the segment equals the value of the segment option.
  • [number] KB Sets the maximum size, in kilobytes, for a startup segment of the log.
  • [number] MB Sets the maximum size, in megabytes, for a startup segment of the log.
  • Default value

    false

    Takes effect After restart

    memory

    Memory snapshot file name

    Specifies the name of the file to which the application regularly prints a snapshot of the memory output, if it is configured to do this. The new snapshot overwrites the previously written data. If the application terminates abnormally, this file will contain the latest log messages. Memory output is not recommended for processors with a CPU frequency lower than 600 MHz.

    Valid values

    [string] (memory file name)

    Default value

    (blank)

    Takes effect immediately

    memory-storage-size

    Memory output buffer size

    Specifies the buffer size for log output to the memory, if configured.

    Valid values

  • [number] KB or [number] The size of the memory output, in kilobytes. The minimum value is 128 KB.
  • [number] MB The size of the memory output, in megabytes. The maximum value is 64 MB
  • Default value

    (blank)

    Takes effect When memory output is created

    message_format

    Log messages format

    Specifies the format of log record headers that an application uses when writing logs in the log file. Using compressed log record headers improves application performance and reduces the log file's size. With the value set to short:
  • A header of the log file or the log file segment contains information about the application (such as the application name, application type, host type, and time zone), whereas single log records within the file or segment omit this information.
  • A log message priority is abbreviated to Std, Int, Trc, or Dbg, for Standard, Interaction, Trace, or Debug messages, respectively.
  • The message ID does not contain the prefix GCTI or the application type ID.
    A log record in the full format looks like this:
    2002-05-07T18:11:38.196 Standard localhost cfg_dbserver GCTI-00-05060 Application started
    A log record in the short format looks like this:
    2002-05-07T18:15:33.952 Std 05060 Application started
  • Valid values

    • short
    • full
  • short An application uses compressed headers when writing log records in its log file.
  • full An application uses complete headers when writing log records in its log file.
  • Default value

    short

    Takes effect immediately

    messagefile

    Message file

    Specifies the file name for application-specific log events. The name must be valid for the operating system on which the application is running. The option value can also contain the absolute path to the application-specific *.lms file. Otherwise, an application looks for the file in its working directory.

    Valid values

    [string].lms (message file name)

    Default value

    (blank)

    Takes effect Immediately, if an application cannot find its *.lms file at startup

    print-attributes

    Enable printing extended attributes

    Specifies whether the application attaches extended attributes, if any exist, to a log event that it sends to log output. Typically, log events of the Interaction log level and Audit-related log events contain extended attributes. Setting this option to true enables audit capabilities, but negatively affects performance. Genesys recommends enabling this option for Solution Control Server and Configuration Server when using audit tracking. For other applications, refer to Genesys 7.5 Combined Log Events Help to find out whether an application generates Interaction-level and Audit-related log events; if it does, enable the option only when testing new interaction scenarios.
  • true Attaches extended attributes, if any exist, to a log event sent to log output.
  • false Does not attach extended attributes to a log event sent to log output.
  • Valid values

    • true
    • false

    Default value

    false

    Takes effect immediately

    segment

    Log Segmentation

    Specifies whether there is a segmentation limit for a log file. If there is, sets the mode of measurement, along with the maximum size. If the current log segment exceeds the size set by this option, the file is closed and a new one is created.

    Valid values

  • false No segmentation is allowed.
  • [number] KB or [number] Sets the maximum segment size, in kilobytes. The minimum segment size is 100 KB.
  • [number] MB Sets the maximum segment size, in megabytes.
  • [number] hr Sets the number of hours for the segment to stay open. The minimum number is 1 hour.
  • Default value

    10000

    Takes effect immediately

    spool

    Folder for the temporary network log output files

    Specifies the folder, including full path to it, in which an application creates temporary files related to network log output. If you change the option value while the application is running, the change does not affect the currently open network output.

    Valid values

    [path] (the folder, with the full path to it)

    Default value

    (blank)

    Takes effect immediately

    standard

    Output for level standard

    Specifies the outputs to which an application sends the log events of the Standard level. The log output types must be separated by a comma when more than one output is configured.

    Valid values

  • stdout Log events are sent to the Standard output (stdout).
  • stderr Log events are sent to the Standard error output (stderr).
  • network Log events are sent to Message Server, which can reside anywhere on the network. Message Server stores the log events in the Log Database. Setting the all log level option to the network output enables an application to send log events of the Standard, Interaction, and Trace levels to Message Server. Debug-level log events are neither sent to Message Server nor stored in the Log Database.
  • memory Log events are sent to the memory output on the local disk. This is the safest output in terms of the application performance.
  • [filename] Log events are stored in a file with the specified name. If a path is not specified, the file is created in the application's working directory.
  • Default value

    ..\logs\ResourceMgr,network

    Takes effect immediately

    time_convert

    Time generation for log messages

    Specifies the system in which an application calculates the log record time when generating a log file. The time is converted from the time in seconds since the Epoch (00:00:00 UTC, January 1, 1970).
  • Local Time The time of log record generation is expressed as a local time, based on the time zone and any seasonal adjustments. Time zone information of the application's host computer is used.
  • Coordinated Universal Time The time of log record generation is expressed as Coordinated Universal Time (UTC).
  • Valid values

    • local
    • utc

    Default value

    local

    Takes effect immediately

    time_format

    Time format for log messages

    Specifies how to represent, in a log file, the time when an application generates log records.
    A log record's time field in the ISO 8601 format looks like this:
    2001-07-24T04:58:10.123
  • HH:MM:SS.sss (hours,minutes, seconds, and milliseconds) The time string is formatted according to the HH:MM:SS.sss (hours, minutes, seconds, and milliseconds) format.
  • According to the system's locale The time string is formatted according to the system's locale.
  • ISO 8601 format The date in the time string is formatted according to the ISO 8601 format. Fractional seconds are given in milliseconds.
  • Valid values

    • time
    • locale
    • ISO8601

    Default value

    time

    Takes effect immediately

    trace

    Output for level trace

    Specifies the outputs to which an application sends the log events of the Trace level and higher (that is, log events of the Standard, Interaction, and Trace levels). The log outputs must be separated by a comma when more than one output is configured.

    Valid values

  • stdout Log events are sent to the Standard output (stdout).
  • stderr Log events are sent to the Standard error output (stderr).
  • network Log events are sent to Message Server, which can reside anywhere on the network. Message Server stores the log events in the Log Database. Setting the all log level option to the network output enables an application to send log events of the Standard, Interaction, and Trace levels to Message Server. Debug-level log events are neither sent to Message Server nor stored in the Log Database.
  • memory Log events are sent to the memory output on the local disk. This is the safest output in terms of the application performance.
  • [filename] Log events are stored in a file with the specified name. If a path is not specified, the file is created in the application's working directory.
  • Default value

    ..\logs\ResourceMgr

    Takes effect immediately

    verbose

    Verbose Level

    Determines whether a log output is created. If it is, specifies the minimum level of log events generated. The log events levels, starting with the highest priority level, are standard, interaction, trace, debug and all.
  • all All log events (that is, log events of the Standard, Trace,Interaction, and Debug levels) are generated.
  • debug The same as all.
  • trace Log events of the Trace level and higher (that is, log events of the Standard, Interaction, and Trace levels) are generated, but log events of the Debug level are not generated.
  • interaction Log events of the Interaction level and higher (that is, log events of the Standard and Interaction levels) are generated, but log events of the Trace and Debug levels are not generated.
  • standard Log events of the Standard level are generated, but log events of the Interaction, Trace, and Debug levels are not generated.
  • none No log evenets are generated.
  • Valid values

    • all
    • debug
    • trace
    • interaction
    • standard
    • none

    Default value

    standard

    Takes effect immediately

    [monitor]

    sip.localhostname

    SIP Localhost Name

    Similar to monitor.sip.localuser, this parameter represents the hostname portion of SIP OPTIONS requests. Note that this value must not include a port number. If this parameter is not specified, then the IP address of the local system will be used

    Default value

    (blank)

    Takes effect After restart

    sip.localport

    sip.localport

    Similar to sip.localhostname, the parameter sip.localport provides configurability of the port part of Contact, Call-ID and From Headers.
    If this parameter is not specified, the default SIP port number of 5064 is used.
    Note that if sip.localhostname is not defined, sip.localport will be ignored.

    Valid values

    The port number must be an integer

    Default value

    5064

    Takes effect At start/restart

    sip.localsecureport

    sip.localsecureport

    Similar to sip.localhostname, the parameter sip.localsecureport provides configurability of the port part of Contact, Call-ID and From Headers when SIPS is used.
    If this parameter is not specified, the default SIPS port number of 5065 is used.
    Note that if sip.localhostname is not defined, sip.localsecureport will be ignored.

    Valid values

    The port number must be an integer

    Default value

    5065

    Takes effect At start/restart

    sip.localuser

    SIP Local User

    SIP user presented in OPTIONS requests. The specified text will be presented in the "From:" field of the form sip:user@host[:port]

    Default value

    GVP

    Takes effect After restart

    sip.proxy.optionsinterval

    SIP Resource OPTIONS Interval

    Specified in milliseconds, this is the interval by which RM sends OPTIONS message to a healthy resource to determine if the resource is alive

    Default value

    5000

    Takes effect After restart

    sip.proxy.unavailoptionsinterval

    SIP Unavailable Resource OPTIONS Interval

    Specified in milliseconds, this is the interval by which RM sends OPTIONS message to a dead resource to determine if the resource has become alive

    Default value

    5000

    Takes effect After restart

    sip.transport.0

    sip.transport.0

    These parameters define transport layer for SIP stack and the network interfaces that are used to process SIP requests. type:ip:port [parameters]

    where transport_name is any string; type is udp/tcp/tls; ip is the IP address of the network interface that accepts incoming SIP messages; port is the port number where SIP stack accepts incoming SIP messages;
    [parameters] defines any extra SIP transport parameters.

    Example:
    cert=[cert path and filename] Applicable to SIPS only and mandatory if using SIPS. The path and the filename of the TLS certificate to be used key=[key path and filename] Applicable to SIPS only and mandatory if using SIPS. The path and the filename of the TLS key to be used. type=[Type of secure transport] Applicable to SIPS only and is optional. The type of secure transport to be used and value can be TLSv1, SSLv2, SSLv3, SSLv23. Default to SSLv23. password=[password] Applicable to SIPS only and is optional. The password associated with the certificate and key pair. Required only if key file is password protected.

    Default value

    transport0 udp:any:5064

    Takes effect After restart

    sip.transport.1

    sip.transport.1

    These parameters define transport layer for SIP stack and the network interfaces that are used to process SIP requests. type:ip:port [parameters]

    where transport_name is any string; type is udp/tcp/tls; ip is the IP address of the network interface that accepts incoming SIP messages; port is the port number where SIP stack accepts incoming SIP messages;
    [parameters] defines any extra SIP transport parameters.

    Example:
    cert=[cert path and filename] Applicable to SIPS only and mandatory if using SIPS. The path and the filename of the TLS certificate to be used key=[key path and filename] Applicable to SIPS only and mandatory if using SIPS. The path and the filename of the TLS key to be used. type=[Type of secure transport] Applicable to SIPS only and is optional. The type of secure transport to be used and value can be TLSv1, SSLv2, SSLv3, SSLv23. Default to SSLv23. password=[password] Applicable to SIPS only and is optional. The password associated with the certificate and key pair. Required only if key file is password protected.

    Default value

    transport1 tcp:any:5064

    Takes effect After restart

    sip.transport.2

    sip.transport.2

    These parameters define transport layer for SIP stack and the network interfaces that are used to process SIP requests. type:ip:port [parameters]

    where transport_name is any string; type is udp/tcp/tls; ip is the IP address of the network interface that accepts incoming SIP messages; port is the port number where SIP stack accepts incoming SIP messages;
    [parameters] defines any extra SIP transport parameters.

    Example:
    cert=[cert path and filename] Applicable to SIPS only and mandatory if using SIPS. The path and the filename of the TLS certificate to be used key=[key path and filename] Applicable to SIPS only and mandatory if using SIPS. The path and the filename of the TLS key to be used. type=[Type of secure transport] Applicable to SIPS only and is optional. The type of secure transport to be used and value can be TLSv1, SSLv2, SSLv3, SSLv23. Default to SSLv23. password=[password] Applicable to SIPS only and is optional. The password associated with the certificate and key pair. Required only if key file is password protected.

    Default value

    transport2 tls:any:5065 cert=$InstallationRoot$\config\x509_certificate.pem key=$InstallationRoot$\config\x509_private_key.pem

    Takes effect After restart

    [proxy]

    sip.localport

    sip.localport

    Similar to sip.localhostname, the parameter sip.localport provides configurability of the port part of Contact, Call-ID and From Headers.
    If this parameter is not specified, the default SIP port number of 5060 is used.
    Note that if sip.localhostname is not defined, sip.localport will be ignored.

    Valid values

    The port number must be an integer

    Default value

    5060

    Takes effect At start/restart

    sip.localsecureport

    sip.localsecureport

    Similar to sip.localhostname, the parameter sip.localsecureport provides configurability of the port part of Contact, Call-ID and From Headers when SIPS is used.
    If this parameter is not specified, the default SIPS port number of 5061 is used.
    Note that if sip.localhostname is not defined, sip.localsecureport will be ignored.

    Valid values

    The port number must be an integer

    Default value

    5061

    Takes effect At start/restart

    sip.maxtcpconnections

    Maximum Number of TCP Connections

    Defines the maximum number of TCP connections established concurrently. If the maximum number of TCP connections has been reached, new SIP requests to establish TCP connections will be rejected.

    Valid values

    The number must be from 1 to 10000 inclusive

    Default value

    100

    Takes effect After restart

    sip.maxtlsconnections

    Maximum Number of TLS Connections

    Defines the maximum number of TLS connections established concurrently. If the maximum number of TLS connections has been reached, new SIP requests to establish TLS connections will be rejected.

    Valid values

    The number must be from 1 to 10000 inclusive

    Default value

    100

    Takes effect After restart

    sip.min_se

    Min SE

    Specified in seconds, this is used to calculate the minimum value of the Session-Expires header the RM is willing to accept.

    Default value

    90

    Takes effect After restart

    sip.mtusize

    Maximum Transmission Unit

    Defines the Maximum Transmission Unit (MTU) of the network interfaces. If a SIP request size is within 200 bytes of this value, the request will be sent on a congestion controlled transport protocol, such as TCP.

    Default value

    1500

    Takes effect After restart

    sip.proxy.dnsname

    Proxy DNS Name

    DNS name for the proxy in a clustered unicast configuration. A specific port can also be optionally specified as follows: "proxy.company.com:5060". If the DNS name is not configured, the local IP address will be used in the Record-Route.

    Default value

    (blank)

    Takes effect After restart

    sip.proxy.respaddr

    Responsible Address

    The set of addresses or domains that the Resource Manager is responsible for

    Default value

    (blank)

    Takes effect After restart

    sip.route.default.tcp

    Default route for TCP

    The number denotes the transport defined in sip.transport.x where x is the value of this parameter and will be used when no TCP routes are found.

    Valid values

    Must be a numeric, but can be empty

    Default value

    (blank)

    Takes effect At start/restart

    sip.route.default.tls

    Default route for TLS

    The number denotes the transport defined in sip.transport.x where x is the value of this parameter and will be used when no TLS routes are found.

    Valid values

    Must be a numeric, but can be empty

    Default value

    (blank)

    Takes effect At start/restart

    sip.route.default.udp

    Default route for UDP

    The number denotes the transport defined in sip.transport.x where x is the value of this parameter and will be used when no UDP routes are found. If this parameter is not set, the first UDP transport found in sip.transport.x becomes the default.

    Valid values

    Must be a numeric, but can be empty

    Default value

    (blank)

    Takes effect At start/restart

    sip.route.dest.0

    Route Destination 0

    For each <n> in the config parameter proxy.sip.route.dests, the parameter with name proxy.sip.route.dest.<n> must be present. Each of these represents an entry in the routing table. The format is: [Destination] [Netmask] [Transport] [Metric] The [Transport] entry corresponds to the index specified in 'sip.transport.x' configuration. The 'x' is the transport interface index. Each transport specified in 'sip.transport.x' must have at least one entry in the routing table, otherwise the interface will never be used. The order of destination does matter as the routing table is linearly searched until none of the rows matches, then the default entry for the specified protocol will be used. To select an interface, take the outgoing IP address. From the list of interfaces with the matching protocol, starting from the top row, mask the IP address with [Netmask] entry and compare with [Destination] entry. If [Destination] entry matches the masked value, then stop and use the interface defined in the [Transport] column. Note that the [Metric] entry must be configured but not used at this point.

    Default value

    (blank)

    Takes effect After restart

    sip.route.dests

    Route Destinations

    A list of space-delimited entries in a routing table. The entry ID starts from 0 and increments by 1 each time. For example, to specify 4 entries in the routing table, the value would be "0 1 2 3"

    Default value

    (blank)

    Takes effect After restart

    sip.sessionexpires

    Session Timeout

    Specified in seconds, this is used to define the duration of which a SIP session will expire if no re-INVITEs are sent/received within this period. This value would take affect only if the associate application or its parent tenant did not specify the sip.sessiontimer parameter value. When this parameter takes effect, its value will be used if (1) if the proxy.sip.min_se value is configured, if the proxy.sip.sessiontimer value is less than the proxy.sip.min_se value, it will use the proxy.sip.min_se value for session expiration, or (2) if the proxy.sip.min_se value is not configured, if the proxy.sip.sessiontimer value is less than 90, 90 will be used.

    Default value

    1800

    Takes effect After restart

    sip.threadpoolsize

    DNS query thread pool size

    The size of the thread pool for handling DNS queries

    Default value

    4

    Takes effect After restart

    sip.threads

    Number of Worker Threads

    Specifies the number of worker threads that handles the SIP requests arriving from the SIP transport layer. If the value is 0, all requests are handled within the arriving transport layer thread. Otherwise, all arriving requests are handled by hashing onto the N number of worker threads.

    Default value

    5

    Takes effect After restart

    sip.timer.ci_proceeding

    Timer for Client Transaction in Proceeding State

    Defines a timer for client transaction in the proceeding state. if a final response is not received within this value in milliseconds, the client transaction is considered terminated. Default value is 120000 (120 seconds)

    Default value

    120000

    Takes effect After restart

    sip.transport.0

    sip.transport.0

    These parameters define transport layer for SIP stack and the network interfaces that are used to process SIP requests. type:ip:port [parameters]

    where transport_name is any string; type is udp/tcp/tls; ip is the IP address of the network interface that accepts incoming SIP messages; port is the port number where SIP stack accepts incoming SIP messages;
    [parameters] defines any extra SIP transport parameters.

    Example:
    cert=[cert path and filename] Applicable to SIPS only and mandatory if using SIPS. The path and the filename of the TLS certificate to be used key=[key path and filename] Applicable to SIPS only and mandatory if using SIPS. The path and the filename of the TLS key to be used. type=[Type of secure transport] Applicable to SIPS only and is optional. The type of secure transport to be used and value can be TLSv1, SSLv2, SSLv3, SSLv23. Default to SSLv23. password=[password] Applicable to SIPS only and is optional. The password associated with the certificate and key pair. Required only if key file is password protected.

    Default value

    transport0 udp:any:5060

    Takes effect After restart

    sip.transport.1

    sip.transport.1

    These parameters define transport layer for SIP stack and the network interfaces that are used to process SIP requests. type:ip:port [parameters]

    where transport_name is any string; type is udp/tcp/tls; ip is the IP address of the network interface that accepts incoming SIP messages; port is the port number where SIP stack accepts incoming SIP messages;
    [parameters] defines any extra SIP transport parameters.

    Example:
    cert=[cert path and filename] Applicable to SIPS only and mandatory if using SIPS. The path and the filename of the TLS certificate to be used key=[key path and filename] Applicable to SIPS only and mandatory if using SIPS. The path and the filename of the TLS key to be used. type=[Type of secure transport] Applicable to SIPS only and is optional. The type of secure transport to be used and value can be TLSv1, SSLv2, SSLv3, SSLv23. Default to SSLv23. password=[password] Applicable to SIPS only and is optional. The password associated with the certificate and key pair. Required only if key file is password protected.

    Default value

    transport1 tcp:any:5060

    Takes effect After restart

    sip.transport.2

    sip.transport.2

    These parameters define transport layer for SIP stack and the network interfaces that are used to process SIP requests. type:ip:port [parameters]

    where transport_name is any string; type is udp/tcp/tls; ip is the IP address of the network interface that accepts incoming SIP messages; port is the port number where SIP stack accepts incoming SIP messages;
    [parameters] defines any extra SIP transport parameters.

    Example:
    cert=[cert path and filename] Applicable to SIPS only and mandatory if using SIPS. The path and the filename of the TLS certificate to be used key=[key path and filename] Applicable to SIPS only and mandatory if using SIPS. The path and the filename of the TLS key to be used. type=[Type of secure transport] Applicable to SIPS only and is optional. The type of secure transport to be used and value can be TLSv1, SSLv2, SSLv3, SSLv23. Default to SSLv23. password=[password] Applicable to SIPS only and is optional. The password associated with the certificate and key pair. Required only if key file is password protected.

    Default value

    transport2 tls:any:5061 cert=$InstallationRoot$\config\x509_certificate.pem key=$InstallationRoot$\config\x509_private_key.pem

    Takes effect After restart

    [registrar]

    sip.localhostname

    Localhost Name for Registrar

    Similar to registrar.sip.localuser, this parameter represents the hostname portion of the requests. Note that this value must not include a port number. If this parameter is not specified, then the IP address of the local system will be used.

    Default value

    (blank)

    Takes effect After restart

    sip.localport

    sip.localport

    Similar to sip.localhostname, the parameter sip.localport provides configurability of the port part of Contact, Call-ID and From Headers.
    If this parameter is not specified, the default SIP port number of 5062 is used.
    Note that if sip.localhostname is not defined, sip.localport will be ignored.

    Valid values

    The port number must be an integer

    Default value

    5062

    Takes effect At start/restart

    sip.localsecureport

    sip.localsecureport

    Similar to sip.localhostname, the parameter sip.localsecureport provides configurability of the port part of Contact, Call-ID and From Headers when SIPS is used.
    If this parameter is not specified, the default SIPS port number of 5063 is used.
    Note that if sip.localhostname is not defined, sip.localsecureport will be ignored.

    Valid values

    The port number must be an integer

    Default value

    5063

    Takes effect At start/restart

    sip.localuser

    SIP User for Registrar

    SIP user used by registrar in sending requests. The specified text will be presented in the "From:" field of the form sip:user@host[:port]</description>

    Default value

    GVP

    Takes effect After restart

    sip.registrar.domain

    Registrar Domain

    A comma-delimited list of domains accepted by this registrar. Only the host part of the strings defined by the domain entry of this configuration and request-uri of the REGISTER request will be compared. If this configuration value has empty value, comparison will be skipped. Otherwise, if a REGISTER request registers with a domain that is not in this list, the request will be rejected with a 404 Not Found.

    Default value

    (blank)

    Takes effect After restart

    sip.registrar.maxexpirytime

    Registrar Max Expiry Time

    Defines the maximum expiry time (in seconds) of this registrar. If the client requests an expiry time longer than this value, this value will be used instead.

    Default value

    60

    Takes effect After restart

    sip.registrar.minexpirytime

    Registrar Min Expiry Time

    Defines the minimum expiry time (in seconds) of this registrar. If the client requests an expiry time less than this value, the request will be rejected with this value in the Min-Expires header.

    Default value

    60

    Takes effect After restart

    sip.transport.0

    sip.transport.0

    These parameters define transport layer for SIP stack and the network interfaces that are used to process SIP requests. type:ip:port [parameters]

    where transport_name is any string; type is udp/tcp/tls; ip is the IP address of the network interface that accepts incoming SIP messages; port is the port number where SIP stack accepts incoming SIP messages;
    [parameters] defines any extra SIP transport parameters.

    Example:
    cert=[cert path and filename] Applicable to SIPS only and mandatory if using SIPS. The path and the filename of the TLS certificate to be used key=[key path and filename] Applicable to SIPS only and mandatory if using SIPS. The path and the filename of the TLS key to be used. type=[Type of secure transport] Applicable to SIPS only and is optional. The type of secure transport to be used and value can be TLSv1, SSLv2, SSLv3, SSLv23. Default to SSLv23. password=[password] Applicable to SIPS only and is optional. The password associated with the certificate and key pair. Required only if key file is password protected.

    Default value

    transport0 udp:any:5062

    Takes effect After restart

    sip.transport.1

    sip.transport.1

    These parameters define transport layer for SIP stack and the network interfaces that are used to process SIP requests. type:ip:port [parameters]

    where transport_name is any string; type is udp/tcp/tls; ip is the IP address of the network interface that accepts incoming SIP messages; port is the port number where SIP stack accepts incoming SIP messages;
    [parameters] defines any extra SIP transport parameters.

    Example:
    cert=[cert path and filename] Applicable to SIPS only and mandatory if using SIPS. The path and the filename of the TLS certificate to be used key=[key path and filename] Applicable to SIPS only and mandatory if using SIPS. The path and the filename of the TLS key to be used. type=[Type of secure transport] Applicable to SIPS only and is optional. The type of secure transport to be used and value can be TLSv1, SSLv2, SSLv3, SSLv23. Default to SSLv23. password=[password] Applicable to SIPS only and is optional. The password associated with the certificate and key pair. Required only if key file is password protected.

    Default value

    transport1 tcp:any:5062

    Takes effect After restart

    sip.transport.2

    sip.transport.2

    These parameters define transport layer for SIP stack and the network interfaces that are used to process SIP requests. type:ip:port [parameters]

    where transport_name is any string; type is udp/tcp/tls; ip is the IP address of the network interface that accepts incoming SIP messages; port is the port number where SIP stack accepts incoming SIP messages;
    [parameters] defines any extra SIP transport parameters.

    Example:
    cert=[cert path and filename] Applicable to SIPS only and mandatory if using SIPS. The path and the filename of the TLS certificate to be used key=[key path and filename] Applicable to SIPS only and mandatory if using SIPS. The path and the filename of the TLS key to be used. type=[Type of secure transport] Applicable to SIPS only and is optional. The type of secure transport to be used and value can be TLSv1, SSLv2, SSLv3, SSLv23. Default to SSLv23. password=[password] Applicable to SIPS only and is optional. The password associated with the certificate and key pair. Required only if key file is password protected.

    Default value

    transport2 tls:any:5063 cert=$InstallationRoot$\config\x509_certificate.pem key=$InstallationRoot$\config\x509_private_key.pem

    Takes effect After restart

    [rm]

    cluster_hotstandby

    Cluster Standby Mode

    This parameter has effect only if rm.cluster_ip parameter is non-empty. If "true", this parameter mandates that the RM cluster run in hot-standby redundancy mode where call data is replicated to other RM node for SIP dialog redundancy. Otherwise, this parameter mandates that the RM cluster be run in warm-standby redundancy mode where SIP dialog redundancy is not supported, but the new requests will be handled by the other healthy RM node.

    Valid values

    • true
    • false

    Default value

    false

    Takes effect After restart

    cluster_ip

    Cluster IP Address

    If non-empty, this parameter indicates that this RM node is part of a RM cluster and the value specifies the virtual IP address of the RM cluster this RM node is part of. In stand-alone mode, this parameter must be left empty.

    Default value

    (blank)

    Takes effect After restart

    conference-sip-error-respcode

    Conference Error Response Code

    When conference call fails due to lack of resource port capacity or reaching maximum conference size, this SIP response code will be returned to the caller. Expects parameter value of the form sipcode;desc or just sipcode. Example - 480 or 480;Conference Capacity reached

    Default value

    480

    Takes effect After restart

    options_response_contenttype

    OPTIONS Message Content-Type

    If rm.options_response_msg_body is defined, this string is returned by the RM as the "Content-type" header in the SIP response message.

    Default value

    application/text

    Takes effect After restart

    options_response_msg_body

    OPTIONS Message Body

    If defined, when the RM returns a response to a SIP OPTIONS message, this string is returned by the RM as the SIP response message body. Any hex-encoded characters in the string will first be decoded before being used. For example, string with multiple lines can be specified by: First Line%0D%0ASecond Line. This will result in %0D and %0A replaced by '\r' and '\n' respectively.

    Default value

    (blank)

    Takes effect After restart

    resource-no-match-respcode

    Resource Nomatch Error Response Code

    Expects parameter value of the form sipcode;desc or just sipcode.

    Default value

    480

    Takes effect After restart

    resource-unavailable-respcode

    Resource Unavailable Error Response Code

    Expects parameter value of the form sipcode;desc or just sipcode.

    Default value

    480

    Takes effect After restart

    sip-header-for-dnis

    SIP Header for DNIS

    This parameter indicates which header the RM should retrieve the DNIS from, for the purpose of identifying an IVRProfile

    Valid values

    • request-uri
    • to
    • history-info

    Default value

    history-info

    Takes effect immediately

    suspend-mode-respcode

    Suspend Mode Error Response Code

    When new session request comes and RM is in suspend mode, this SIP response code is returned. Expects parameter value of the form sipcode;desc or just sipcode.

    Default value

    503

    Takes effect After restart

    [snmp]

    SNMP settings.

    timeout

    SNMP Task Timeout

    The maximum amount of time that SNMP can wait for a new task. This value is specified in milliseconds.

    Valid values

    The parameter must be an integer value greater than zero.

    Default value

    100

    Takes effect At start/restart