[cluster]

electiontimer

ElectionTimer

Election timer in milli-seconds. If there is no response from remote member(s) for the election process after the specified milli-seconds, this node will become the master. Local resource manager will become the active node.

Valid values

Number must be from 1000 to 10000 inclusive

Default value

3000

Takes effect After restart

failoverscript

FailOver Batch Script Path

Absolute path to the executable fail over script. For NLB: NLB.bat

Default value

$InstallationRoot$/bin/NLB.bat

Takes effect After restart

ha-mode

Cluster HA Mode

By default, this will be set to none (stand-alone mode). For active-standby HA configuration this parameter should be set to active-standby, where only one RM is capable of taking calls at a time. For active-active configuration this parameter should be set to active-active, where both RM instances are capable of handling requests. The configuration cluster.virtual-ip is also mandatory if running in active-standby or active-active mode.

Valid values

  • none
  • active-standby
  • active-active

Default value

none

Takes effect After restart

heartbeattimer

Heartbeat Interval

Heart beat interval between cluster members for determining health of each other.

Default value

2000

Takes effect After restart

hotstandby

Cluster Standby Mode

This parameter has effect only if cluster.virtual-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

initial-electiontimer

InitialElectionTimer

Election timer in milli-seconds for initial election during RM startup. If there is no response from remote member(s) for the election process after the specified milli-seconds, this node will become the master. Local resource manager will become the active node.

Valid values

Number must be from 1000 to 60000 inclusive

Default value

10000

Takes effect After restart

member.1

Member 1

Describes the Host/IP and TCP port on which the member ID 1 can be reached. The format is IP:Port or Host:Port where Host/IP and Port specifies where this RM node can be reached for cluster communication.

Default value

(blank)

Takes effect After restart

member.2

Member 2

Describes the Host/IP and TCP port on which the member ID 2 can be reached. The format is IP:Port or Host:Port where Host/IP and Port specifies where this RM node can be reached for cluster communication.

Default value

(blank)

Takes effect After restart

members

Members

List of ID's of the members in the cluster (unsigned integers 1 to 32 delimited by space). For NLB, the ID's correspond to the unique host identifier (priority) number specified for each of the NLB cluster machines.

Default value

1 2

Takes effect After restart

mymemberid

My Member ID

Indicates this cluster manager instance's member ID (select one among the ID's listed in cluster.members).

Default value

(blank)

Takes effect After restart

virtual-ip

Cluster Virtual 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 or the hostname of the RM cluster this RM node is part of. In HA mode, this value gets written into the Record-Route and Via header (if cluster.virtual-ip-in-via is true). This parameter takes precedence over proxy.sip.transport.localaddress if both are specified. In stand-alone mode, this parameter must be left empty.

Default value

(blank)

Takes effect After restart

virtual-ip-in-via

Cluster Virtual IP Address in Via Header

This parameter takes effect only in HA mode. If set to true, virtual-ip will be written into the Via header when the SIP requests are forwarded. Otherwise, address specified by the proxy.sip.transport.localaddress parameter or the private IP address associated with the transport will be written into the Via header.

Valid values

  • true
  • false

Default value

true

Takes effect After restart

[ems]

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

*|*|*

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

*

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

Maximum Records in the Persisted Local DB File for CDR data

This option specifies the maximum number of data items to the local database for CDR reporting. Queuing to the local database will occur either when the Reporting Server is unavailable, or when data is being provided to the Client faster than the Server can consume it. A value of -1 indicates an "unlimited" number of records will be allowed. A value of 0 indicates that no records will be persisted locally and data will be discarded if the RS is unavailable.

Valid values

An integer greater or equal to -1.

Default value

1000000

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

cdrQueue_rm.db

Takes effect At start/restart

rc.cdr.max_throughput

Maximum Throughput of CDR data sent to the RS

This option specifies the maximum rate at which CDR data, in bytes per second, is sent to the Reporting Server. A value of 0 (default) indicates that CDR data will be sent as quickly as possible.

Valid values

An integer greater or equal to 0.

Default value

0

Takes effect At start/restart

rc.certificate

TLS Certificate for Reporting Client

The file name of the TLS certificate in "PEM" format. Required to connect to the Reporting Server (ActiveMQ) over TLS.

Valid values

File path

Default value

(blank)

Takes effect at start/restart

rc.ors.batch_size

OR Batch Size

The number of OR messages queued up by the reporting client before sending them up to the reporting server.

Valid values

An integer between 1-5000 inclusive.

Default value

500

Takes effect At start/restart

rc.ors.local_queue_max

Maximum Records in the Persisted Local DB File for OR data

This option specifies the maximum number of data items to the local database for Operational Reporting. Queuing to the local database will occur either when the Reporting Server is unavailable, or when data is being provided to the Client fdaster than the Server can consume it. A value of -1 indicates an "unlimited" number of records will be allowed. A value of 0 indicates that no records will be persisted locally and data will be discarded if the RS is unavailable.

Valid values

An integer greater or equal to -1.

Default value

1000000

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

orsQueue_rm.db

Takes effect At start/restart

[gvp]

nic.eth0

Health detection for NIC eth0

If nics parameter does not explicitly specify 0 as one of the values, this parameter will be ignored. For Windows, MAC address (in hexadecimal format) of the NIC to be monitored MUST be specified here. For Linux, full path to the bonding driver status file can be specified here(default value /proc/net/bonding/bond0 recommended). If the value is left empty or the bonding driver status file cannot be opened for reading, then eth0 will be directly monitored.

Default value

(blank)

Takes effect After restart

nic.eth1

Health detection for NIC eth1

If nics parameter does not explicitly specify 1 as one of the values, this parameter will be ignored. For Windows, MAC address (in hexadecimal format) of the NIC to be monitored MUST be specified here. For Linux, full path to the bonding driver status file can be specified here(default value /proc/net/bonding/bond0 recommended). If the value is left empty or the bonding driver status file cannot be opened for reading, then eth1 will be directly monitored.

Default value

(blank)

Takes effect After restart

nic.linkattribute

Bonding driver health attribute

This parameter only affects Linux. On Linux when bonding driver is configured, the string specified in this parameter together with nic.upvalue will be used in determining the health. If left empty, defaults to 'MII Status'.

Default value

MII Status:

Takes effect After restart

nic.upvalue

Bonding driver up status string

This parameter only affects Linux. On Linux when bonding driver is configured, the string specified in this parameter together with nic.linkattribute will be used in determining the health. If left empty, default to 'up'.

Default value

up

Takes effect After restart

nics

List of nic.eth<n> parameters

This parameter specifies the list of NICS specified by nic.eth parameters to be monitored. List of integer can be specified with the space as the delimiter. If this parameter is left empty, note: - on Windows, all NICs will be discovered and monitored. - on Linux, if bonding driver is installed for bond0, then /net/proc/bonding/bond0 will be monitored. Otherwise eth0 to eth will be auto detected and directly monitored. - on both Windows and Linux, all nic.eth parameters will be ignored.

Default value

(blank)

Takes effect After restart

[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

    ../logs/ResourceMgr

    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

    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

    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 (local) 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 (utc) 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 (time) The time string is formatted according to the HH:MM:SS.sss (hours, minutes, seconds, and milliseconds) format.
  • According to the system's locale (locale) The time string is formatted according to the system's locale.
  • ISO 8601 format (ISO8601) 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

    ISO8601

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

    Preferred IP version to be used in SIP Monitor

    Preferred IP version to be used in SIP. When multiple IP addresses with different IP versions are resolved from a destination address, the first address from the list with the preferred IP version will be used. However, if there is no sip.transport defined for the preferred version, other version will be used. Valid values are "ipv4" and "ipv6".

    Valid values

    • ipv4
    • ipv6

    Default value

    ipv4

    Takes effect At start/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

    1000

    Takes effect After restart

    sip.proxy.releaseconfonfailure

    SIP Release Conference Resource On Failure

    Can be true of false. If true is specified and the resource that handles the conference went offline, then all associated conference sessions are released and the new coming calls will be routed to the next available conference resource. If false is specified, new calls that are joining the conference will receive an error until the conference is released, when the session timer expires.

    Default value

    true

    Takes effect After restart

    sip.proxy.release-recordingclient-session-on-fail

    SIP Release Recording Client Session Resource On Failure

    Can be true of false. If true is specified and the resource that handles the Recording Client session went offline, then all associated Recording Client session calls are released and the new coming calls will be routed to the next available Recording Client resource. If false is specified, new calls that are joining the Recording Client session will receive an error until the Recording Client session is released, when the session timer expires.

    Default value

    true

    Takes effect After restart

    sip.proxy.release-recordingserver-session-on-fail

    SIP Release Recording Server Session Resource On Failure

    Can be true of false. If true is specified and the resource that handles the Recording Server session went offline, then all associated Recording Server session calls are released and the new coming calls will be routed to the next available Recording Server resource. If false is specified, new calls that are joining the Recording Server session will receive an error until the Recording Server session is released, when the session timer expires.

    Default value

    true

    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.route.default.tcp

    Default IPv4 route for TCP

    Default IPv4 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 IPv4 TCP routes are found.

    Default value

    (blank)

    Takes effect At start/restart

    sip.route.default.tcp.ipv6

    Default IPv6 route for TCP

    Default IPv6 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 IPv6 TCP routes are found. If this parameter is not set, the first IPv6 TCP transport found in sip.transport.x becomes the default.

    Default value

    (blank)

    Takes effect At start/restart

    sip.route.default.tls

    Default IPv4 route for TLS

    Default IPv4 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 IPv4 TLS routes are found.

    Default value

    (blank)

    Takes effect At start/restart

    sip.route.default.tls.ipv6

    Default IPv6 route for TLS

    Default IPv6 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 IPv6 TLS routes are found. If this parameter is not set, the first IPv6 TLS transport found in sip.transport.x becomes the default.

    Default value

    (blank)

    Takes effect At start/restart

    sip.route.default.udp

    Default IPv4 route for UDP

    Default IPv4 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 IPv4 UDP routes are found.

    Default value

    (blank)

    Takes effect At start/restart

    sip.route.default.udp.ipv6

    Default IPv6 route for UDP

    Default IPv6 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 IPv6 UDP routes are found. If this parameter is not set, the first IPv6 UDP transport found in sip.transport.x becomes the default.

    Default value

    (blank)

    Takes effect At start/restart

    sip.tcp.portrange

    Monitor Local TCP port range

    The local TCP port range to be used for SIP transport. If this parameter is not specified, RM will let the OS choose the local port.

    Valid values

    Possible values are the empty string or low-high, where low and high are integers from 1030 to 65535 inclusive

    Default value

    (blank)

    Takes effect At start/restart

    sip.tls.portrange

    Monitor Local TLS port range

    The local TLS port range to be used for SIP transport. If this parameter is not specified, RM will let the OS choose the local port.

    Valid values

    Possible values are the empty string or low-high, where low and high are integers from 1030 to 65535 inclusive

    Default value

    (blank)

    Takes effect At start/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; If ip is an IPv6 address, [] must be used. To define a transport to listen to all IPv4 interfaces, use "any" or "any4" for ip. To define a transport to listen to all IPv6 interfaces, use "any6" for ip; 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. cafile=[CA cert path and filename] Mandatory for TLS mutual authentication. The path and the filename of the certificate to be used for verifying the peer. The same certificate specified in cert=[cert path and filename] parameter can be used as the value here if using only 1 certificate is preferred. verifypeer=true Mandatory for TLS mutual authentication. This parameter turns on the TLS mutual authentication. verifydepth=[max depth for the certificate chain verification] Applicable only to TLS mutual authentication. This parameter sets the maximum depth for the certificate chain verification. For the default Genesys certificate provided, the recommended value is 1.

    Default value

    transport0 udp:any:5064

    Takes effect After restart

    sip.transport.0.tos

    IP Type of Service for SIP transport

    Specifies the IP Differentiaed Services Field (also known as ToS) to set in all outgoing SIP packets over the SIP transport. Note that this configuration does not work for Windows 2008. For Windows 2008, the setting needs to be configured at the OS level through the policy settings. Please refer to the GVP User's Guide.

    Valid values

    Possible values are integers from 0 to 255 inclusive.

    Default value

    0

    Takes effect At start/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; If ip is an IPv6 address, [] must be used. To define a transport to listen to all IPv4 interfaces, use "any" or "any4" for ip. To define a transport to listen to all IPv6 interfaces, use "any6" for ip; 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. cafile=[CA cert path and filename] Mandatory for TLS mutual authentication. The path and the filename of the certificate to be used for verifying the peer. The same certificate specified in cert=[cert path and filename] parameter can be used as the value here if using only 1 certificate is preferred. verifypeer=true Mandatory for TLS mutual authentication. This parameter turns on the TLS mutual authentication. verifydepth=[max depth for the certificate chain verification] Applicable only to TLS mutual authentication. This parameter sets the maximum depth for the certificate chain verification. For the default Genesys certificate provided, the recommended value is 1.

    Default value

    transport1 tcp:any:5064

    Takes effect After restart

    sip.transport.1.tos

    IP Type of Service for SIP transport

    Specifies the IP Differentiaed Services Field (also known as ToS) to set in all outgoing SIP packets over the SIP transport. Note that this configuration does not work for Windows 2008. For Windows 2008, the setting needs to be configured at the OS level through the policy settings. Please refer to the GVP User's Guide.

    Valid values

    Possible values are integers from 0 to 255 inclusive.

    Default value

    0

    Takes effect At start/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; If ip is an IPv6 address, [] must be used. To define a transport to listen to all IPv4 interfaces, use "any" or "any4" for ip. To define a transport to listen to all IPv6 interfaces, use "any6" for ip; 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. cafile=[CA cert path and filename] Mandatory for TLS mutual authentication. The path and the filename of the certificate to be used for verifying the peer. The same certificate specified in cert=[cert path and filename] parameter can be used as the value here if using only 1 certificate is preferred. verifypeer=true Mandatory for TLS mutual authentication. This parameter turns on the TLS mutual authentication. verifydepth=[max depth for the certificate chain verification] Applicable only to TLS mutual authentication. This parameter sets the maximum depth for the certificate chain verification. For the default Genesys certificate provided, the recommended value is 1.

    Default value

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

    Takes effect After restart

    sip.transport.2.tos

    IP Type of Service for SIP transport

    Specifies the IP Differentiaed Services Field (also known as ToS) to set in all outgoing SIP packets over the SIP transport. Note that this configuration does not work for Windows 2008. For Windows 2008, the setting needs to be configured at the OS level through the policy settings. Please refer to the GVP User's Guide.

    Valid values

    Possible values are integers from 0 to 255 inclusive.

    Default value

    0

    Takes effect At start/restart

    sip.transport.dnsharouting

    DNS HA Routing

    Specifies whether the DNS HA routing based on RFC3263 should be turned on. If turned off, alternate records returned from the DNS query will not be tried. Otherwise, alternate records returned from the DNS query will be tried based on RFC3263.

    Valid values

    • true
    • false

    Default value

    false

    Takes effect At start/restart

    sip.transport.localaddress

    Local Transport IPv4 Address

    If specified, the sent-by field of the Via header and the hostport part of the Contact header in the outgoing SIP message will be set to this value if a IPv4 transport is used. The value must be a hostname or domain name. If left empty the outgoing transport's actual IP and port will be used for the Via header, and the Contact header. Note that if the domain name used in the SRV record query is specified, sip.transport.localaddress.srv must be set to true to prevent the port part being automatically generated by the SIP stack.

    Default value

    (blank)

    Takes effect At start/restart

    sip.transport.localaddress.srv

    Local Transport Address contains SRV domain name

    Specifies whether the sip.transport.localaddress contains an SRV domain name. If set to true, port part will not be automatically generated by the SIP stack. Otherwise, the outgoing transport's port will used together with the hostname specified by the sip.transport.localaddress.

    Valid values

    • true
    • false

    Default value

    false

    Takes effect At start/restart

    sip.transport.localaddress_ipv6

    Local Transport IPv6 Address

    If specified, the sent-by field of the Via header and the hostport part of the Contact header in the outgoing SIP message will be set to this value if a IPv6 transport is used. The value must be a hostname or domain name. If left empty the outgoing transport's actual IP and port will be used for the Via header, and the Contact header. Note that if the domain name used in the SRV record query is specified, sip.transport.localaddress.srv must be set to true to prevent the port part being automatically generated by the SIP stack.

    Default value

    (blank)

    Takes effect At start/restart

    [proxy]

    sip.localuser

    Contact Header User Name

    Configures the user name portion of the Contact header generated from the RM

    Default value

    GVP

    Takes effect After 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.preferred_ipversion

    Preferred IP version to be used in SIP Proxy

    Preferred IP version to be used in SIP. When multiple IP addresses with different IP versions are resolved from a destination address, the first address from the list with the preferred IP version will be used. However, if there is no sip.transport defined for the preferred version, other version will be used. Valid values are "ipv4" and "ipv6".

    Valid values

    • ipv4
    • ipv6

    Default value

    ipv4

    Takes effect At start/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 IPv4 route for TCP

    Default IPv4 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 IPv4 TCP routes are found.

    Default value

    (blank)

    Takes effect At start/restart

    sip.route.default.tcp.ipv6

    Default IPv6 route for TCP

    Default IPv6 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 IPv6 TCP routes are found. If this parameter is not set, the first IPv6 TCP transport found in sip.transport.x becomes the default.

    Default value

    (blank)

    Takes effect At start/restart

    sip.route.default.tls

    Default IPv4 route for TLS

    Default IPv4 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 IPv4 TLS routes are found.

    Default value

    (blank)

    Takes effect At start/restart

    sip.route.default.tls.ipv6

    Default IPv6 route for TLS

    Default IPv6 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 IPv6 TLS routes are found. If this parameter is not set, the first IPv6 TLS transport found in sip.transport.x becomes the default.

    Default value

    (blank)

    Takes effect At start/restart

    sip.route.default.udp

    Default IPv4 route for UDP

    Default IPv4 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 IPv4 UDP routes are found.

    Default value

    (blank)

    Takes effect At start/restart

    sip.route.default.udp.ipv6

    Default IPv6 route for UDP

    Default IPv6 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 IPv6 UDP routes are found. If this parameter is not set, the first IPv6 UDP transport found in sip.transport.x becomes the default.

    Default value

    (blank)

    Takes effect At start/restart

    sip.route.dest.0

    Route Destination 0

    For each in the config parameter proxy.sip.route.dests, the parameter with name proxy.sip.route.dest. 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.tcp.portrange

    Proxy Local TCP port range

    The local TCP port range to be used for SIP transport. If this parameter is not specified, RM will let the OS choose the local port.

    Valid values

    Possible values are the empty string or low-high, where low and high are integers from 1030 to 65535 inclusive

    Default value

    (blank)

    Takes effect At start/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_C

    RFC 3261 Timer C value

    Defines a timer for client transaction to handle the case where an INVITE request never generates a final response. The timer is set when the timer sip.timer_C1 fires. If a final response is not received before this timer fires, the client transaction is considered terminated. Default value is 175000 (175 seconds).

    Valid values

    The timer length in millisecond must be between 100 and 1000000

    Default value

    175000

    Takes effect After restart

    sip.timer_C1

    Defines a timer for client transaction to handle the case where an INVITE request never generates a final response. The timer is set when an INVITE request is proxied, and reset when a provisional response with status codes 101 to 199 inclusive is received. Once it fires, the timer sip.timer_C will be set. Default value is 6000 (6 seconds).

    Valid values

    The timer length in millisecond must be between 100 and 1000000

    Default value

    6000

    Takes effect After restart

    sip.tls.portrange

    Proxy Local TLS port range

    The local TLS port range to be used for SIP transport. If this parameter is not specified, RM will let the OS choose the local port.

    Valid values

    Possible values are the empty string or low-high, where low and high are integers from 1030 to 65535 inclusive

    Default value

    (blank)

    Takes effect At start/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; If ip is an IPv6 address, [] must be used. To define a transport to listen to all IPv4 interfaces, use "any" or "any4" for ip. To define a transport to listen to all IPv6 interfaces, use "any6" for ip; 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. cafile=[CA cert path and filename] Mandatory for TLS mutual authentication. The path and the filename of the certificate to be used for verifying the peer. The same certificate specified in cert=[cert path and filename] parameter can be used as the value here if using only 1 certificate is preferred. verifypeer=true Mandatory for TLS mutual authentication. This parameter turns on the TLS mutual authentication. verifydepth=[max depth for the certificate chain verification] Applicable only to TLS mutual authentication. This parameter sets the maximum depth for the certificate chain verification. For the default Genesys certificate provided, the recommended value is 1.

    Default value

    transport0 udp:any:5060

    Takes effect After restart

    sip.transport.0.tos

    IP Type of Service for SIP transport

    Specifies the IP Differentiaed Services Field (also known as ToS) to set in all outgoing SIP packets over the SIP transport. Note that this configuration does not work for Windows 2008. For Windows 2008, the setting needs to be configured at the OS level through the policy settings. Please refer to the GVP User's Guide.

    Valid values

    Possible values are integers from 0 to 255 inclusive.

    Default value

    0

    Takes effect At start/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; If ip is an IPv6 address, [] must be used. To define a transport to listen to all IPv4 interfaces, use "any" or "any4" for ip. To define a transport to listen to all IPv6 interfaces, use "any6" for ip; 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. cafile=[CA cert path and filename] Mandatory for TLS mutual authentication. The path and the filename of the certificate to be used for verifying the peer. The same certificate specified in cert=[cert path and filename] parameter can be used as the value here if using only 1 certificate is preferred. verifypeer=true Mandatory for TLS mutual authentication. This parameter turns on the TLS mutual authentication. verifydepth=[max depth for the certificate chain verification] Applicable only to TLS mutual authentication. This parameter sets the maximum depth for the certificate chain verification. For the default Genesys certificate provided, the recommended value is 1.

    Default value

    transport1 tcp:any:5060

    Takes effect After restart

    sip.transport.1.tos

    IP Type of Service for SIP transport

    Specifies the IP Differentiaed Services Field (also known as ToS) to set in all outgoing SIP packets over the SIP transport. Note that this configuration does not work for Windows 2008. For Windows 2008, the setting needs to be configured at the OS level through the policy settings. Please refer to the GVP User's Guide.

    Valid values

    Possible values are integers from 0 to 255 inclusive.

    Default value

    0

    Takes effect At start/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; If ip is an IPv6 address, [] must be used. To define a transport to listen to all IPv4 interfaces, use "any" or "any4" for ip. To define a transport to listen to all IPv6 interfaces, use "any6" for ip; 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. cafile=[CA cert path and filename] Mandatory for TLS mutual authentication. The path and the filename of the certificate to be used for verifying the peer. The same certificate specified in cert=[cert path and filename] parameter can be used as the value here if using only 1 certificate is preferred. verifypeer=true Mandatory for TLS mutual authentication. This parameter turns on the TLS mutual authentication. verifydepth=[max depth for the certificate chain verification] Applicable only to TLS mutual authentication. This parameter sets the maximum depth for the certificate chain verification. For the default Genesys certificate provided, the recommended value is 1.

    Default value

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

    Takes effect After restart

    sip.transport.2.tos

    IP Type of Service for SIP transport

    Specifies the IP Differentiaed Services Field (also known as ToS) to set in all outgoing SIP packets over the SIP transport. Note that this configuration does not work for Windows 2008. For Windows 2008, the setting needs to be configured at the OS level through the policy settings. Please refer to the GVP User's Guide.

    Valid values

    Possible values are integers from 0 to 255 inclusive.

    Default value

    0

    Takes effect At start/restart

    sip.transport.dnsharouting

    DNS HA Routing

    Specifies whether the DNS HA routing based on RFC3263 should be turned on. If turned off, alternate records returned from the DNS query will not be tried. Otherwise, alternate records returned from the DNS query will be tried based on RFC3263.

    Valid values

    • true
    • false

    Default value

    false

    Takes effect At start/restart

    sip.transport.localaddress

    Local Transport IPv4 Address

    If specified, the sent-by field of the Via header and the hostport part of the Record-Route header in the outgoing SIP message will be set to this value if a IPv4 transport is used. The value must be a hostname or domain name. If left empty the outgoing transport's actual IP and port will be used for the Record-Route header. Note that if the domain name used in the SRV record query is specified, sip.transport.localaddress.srv must be set to true to prevent the port part being automatically generated by the SIP stack.

    Default value

    (blank)

    Takes effect At start/restart

    sip.transport.localaddress.srv

    Local Transport Address contains SRV domain name

    Specifies whether the sip.transport.localaddress contains an SRV domain name. If set to true, port part will not be automatically generated by the SIP stack. Otherwise, the outgoing transport's port will used together with the hostname specified by the sip.transport.localaddress.

    Valid values

    • true
    • false

    Default value

    false

    Takes effect At start/restart

    sip.transport.localaddress_ipv6

    Local Transport IPv6 Address

    If specified, the sent-by field of the Via header and the hostport part of the Record-Route header in the outgoing SIP message will be set to this value if a IPv6 transport is used. The value must be a hostname or domain name. If left empty the outgoing transport's actual IP and port will be used for the Record-Route header. Note that if the domain name used in the SRV record query is specified, sip.transport.localaddress.srv must be set to true to prevent the port part being automatically generated by the SIP stack.

    Default value

    (blank)

    Takes effect At start/restart

    sip.udprecvbuffersize

    UDP Receive Buffer Size

    This value configures the UDP socket buffer size used for receiving at the OS level. This value should be set with a multiple of page size (4096).

    Default value

    262144

    Takes effect After restart

    sip.udpsendbuffersize

    UDP Send Buffer Size

    This value configures the UDP socket buffer size used for sending at the OS level. This value should be set with a multiple of page size (4096). The recommended optimal value is that it should not be set to larger than 135168.

    Default value

    135168

    Takes effect After restart

    [registrar]

    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]

    Default value

    GVP

    Takes effect After restart

    sip.preferred_ipversion

    Preferred IP version to be used in SIP Registrar

    Preferred IP version to be used in SIP. When multiple IP addresses with different IP versions are resolved from a destination address, the first address from the list with the preferred IP version will be used. However, if there is no sip.transport defined for the preferred version, other version will be used. Valid values are "ipv4" and "ipv6".

    Valid values

    • ipv4
    • ipv6

    Default value

    ipv4

    Takes effect At start/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.route.default.tcp

    Default IPv4 route for TCP

    Default IPv4 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 IPv4 TCP routes are found.

    Default value

    (blank)

    Takes effect At start/restart

    sip.route.default.tcp.ipv6

    Default IPv6 route for TCP

    Default IPv6 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 IPv6 TCP routes are found. If this parameter is not set, the first IPv6 TCP transport found in sip.transport.x becomes the default.

    Default value

    (blank)

    Takes effect At start/restart

    sip.route.default.tls

    Default IPv4 route for TLS

    Default IPv4 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 IPv4 TLS routes are found.

    Default value

    (blank)

    Takes effect At start/restart

    sip.route.default.tls.ipv6

    Default IPv6 route for TLS

    Default IPv6 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 IPv6 TLS routes are found. If this parameter is not set, the first IPv6 TLS transport found in sip.transport.x becomes the default.

    Default value

    (blank)

    Takes effect At start/restart

    sip.route.default.udp

    Default IPv4 route for UDP

    Default IPv4 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 IPv4 UDP routes are found.

    Default value

    (blank)

    Takes effect At start/restart

    sip.route.default.udp.ipv6

    Default IPv6 route for UDP

    Default IPv6 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 IPv6 UDP routes are found. If this parameter is not set, the first IPv6 UDP transport found in sip.transport.x becomes the default.

    Default value

    (blank)

    Takes effect At start/restart

    sip.tcp.portrange

    Registrar Local TCP port range

    The local TCP port range to be used for SIP transport. If this parameter is not specified, RM will let the OS choose the local port.

    Valid values

    Possible values are the empty string or low-high, where low and high are integers from 1030 to 65535 inclusive

    Default value

    (blank)

    Takes effect At start/restart

    sip.tls.portrange

    Registrar Local TLS port range

    The local TLS port range to be used for SIP transport. If this parameter is not specified, RM will let the OS choose the local port.

    Valid values

    Possible values are the empty string or low-high, where low and high are integers from 1030 to 65535 inclusive

    Default value

    (blank)

    Takes effect At start/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; If ip is an IPv6 address, [] must be used. To define a transport to listen to all IPv4 interfaces, use "any" or "any4" for ip. To define a transport to listen to all IPv6 interfaces, use "any6" for ip; 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. cafile=[CA cert path and filename] Mandatory for TLS mutual authentication. The path and the filename of the certificate to be used for verifying the peer. The same certificate specified in cert=[cert path and filename] parameter can be used as the value here if using only 1 certificate is preferred. verifypeer=true Mandatory for TLS mutual authentication. This parameter turns on the TLS mutual authentication. verifydepth=[max depth for the certificate chain verification] Applicable only to TLS mutual authentication. This parameter sets the maximum depth for the certificate chain verification. For the default Genesys certificate provided, the recommended value is 1.

    Default value

    transport0 udp:any:5062

    Takes effect After restart

    sip.transport.0.tos

    IP Type of Service for SIP transport

    Specifies the IP Differentiaed Services Field (also known as ToS) to set in all outgoing SIP packets over the SIP transport. Note that this configuration does not work for Windows 2008. For Windows 2008, the setting needs to be configured at the OS level through the policy settings. Please refer to the GVP User's Guide.

    Valid values

    Possible values are integers from 0 to 255 inclusive.

    Default value

    0

    Takes effect At start/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; If ip is an IPv6 address, [] must be used. To define a transport to listen to all IPv4 interfaces, use "any" or "any4" for ip. To define a transport to listen to all IPv6 interfaces, use "any6" for ip; 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. cafile=[CA cert path and filename] Mandatory for TLS mutual authentication. The path and the filename of the certificate to be used for verifying the peer. The same certificate specified in cert=[cert path and filename] parameter can be used as the value here if using only 1 certificate is preferred. verifypeer=true Mandatory for TLS mutual authentication. This parameter turns on the TLS mutual authentication. verifydepth=[max depth for the certificate chain verification] Applicable only to TLS mutual authentication. This parameter sets the maximum depth for the certificate chain verification. For the default Genesys certificate provided, the recommended value is 1.

    Default value

    transport1 tcp:any:5062

    Takes effect After restart

    sip.transport.1.tos

    IP Type of Service for SIP transport

    Specifies the IP Differentiaed Services Field (also known as ToS) to set in all outgoing SIP packets over the SIP transport. Note that this configuration does not work for Windows 2008. For Windows 2008, the setting needs to be configured at the OS level through the policy settings. Please refer to the GVP User's Guide.

    Valid values

    Possible values are integers from 0 to 255 inclusive.

    Default value

    0

    Takes effect At start/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; If ip is an IPv6 address, [] must be used. To define a transport to listen to all IPv4 interfaces, use "any" or "any4" for ip. To define a transport to listen to all IPv6 interfaces, use "any6" for ip; 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. cafile=[CA cert path and filename] Mandatory for TLS mutual authentication. The path and the filename of the certificate to be used for verifying the peer. The same certificate specified in cert=[cert path and filename] parameter can be used as the value here if using only 1 certificate is preferred. verifypeer=true Mandatory for TLS mutual authentication. This parameter turns on the TLS mutual authentication. verifydepth=[max depth for the certificate chain verification] Applicable only to TLS mutual authentication. This parameter sets the maximum depth for the certificate chain verification. For the default Genesys certificate provided, the recommended value is 1.

    Default value

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

    Takes effect After restart

    sip.transport.2.tos

    IP Type of Service for SIP transport

    Specifies the IP Differentiaed Services Field (also known as ToS) to set in all outgoing SIP packets over the SIP transport. Note that this configuration does not work for Windows 2008. For Windows 2008, the setting needs to be configured at the OS level through the policy settings. Please refer to the GVP User's Guide.

    Valid values

    Possible values are integers from 0 to 255 inclusive.

    Default value

    0

    Takes effect At start/restart

    sip.transport.dnsharouting

    DNS HA Routing

    Specifies whether the DNS HA routing based on RFC3263 should be turned on. If turned off, alternate records returned from the DNS query will not be tried. Otherwise, alternate records returned from the DNS query will be tried based on RFC3263.

    Valid values

    • true
    • false

    Default value

    false

    Takes effect At start/restart

    sip.transport.localaddress

    Local Transport IPv4 Address

    If specified, the sent-by field of the Via header and the hostport part of the Contact header in the outgoing SIP message will be set to this value if a IPv4 transport is used. The value must be a hostname or domain name. If left empty the outgoing transport's actual IP and port will be used for the Via header, and the Contact header. Note that if the domain name used in the SRV record query is specified, sip.transport.localaddress.srv must be set to true to prevent the port part being automatically generated by the SIP stack.

    Default value

    (blank)

    Takes effect At start/restart

    sip.transport.localaddress.srv

    Local Transport Address contains SRV domain name

    Specifies whether the sip.transport.localaddress contains an SRV domain name. If set to true, port part will not be automatically generated by the SIP stack. Otherwise, the outgoing transport's port will used together with the hostname specified by the sip.transport.localaddress.

    Valid values

    • true
    • false

    Default value

    false

    Takes effect At start/restart

    sip.transport.localaddress_ipv6

    Local Transport IPv6 Address

    If specified, the sent-by field of the Via header and the hostport part of the Contact header in the outgoing SIP message will be set to this value if a IPv6 transport is used. The value must be a hostname or domain name. If left empty the outgoing transport's actual IP and port will be used for the Via header, and the Contact header. Note that if the domain name used in the SRV record query is specified, sip.transport.localaddress.srv must be set to true to prevent the port part being automatically generated by the SIP stack.

    Default value

    (blank)

    Takes effect At start/restart

    [rm]

    conference-sip-error-respcode

    Conference Error Response Code

    When conference call fails due to 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

    cti-unavailable-action

    CTI Unavailable action

    On the initial INVITE, if CTI-C sends a specific 4xx/5xx SIP response code matching any of the codes specified in "cti-unavailable-respcode", then RM will assume that the CTI Server connectivity is broken. In that case RM will check this parameter "cti-unavailable-action", and if it is set RM will perform the action specified in this parameter. The possible values are: "answer", "reject", or "script;;"

    Default value

    answer

    Takes effect After restart

    cti-unavailable-respcode

    CTI Unavailable Error Response Code

    On the initial INVITE, if CTI-C sends a specific 4xx/5xx SIP response code that matches any of the response codes specified in this parameter then RM will assume that the CTI Server connectivity is broken and it should not retry another CTI-C instance. Expects parameter value of the form sipcode1;sipcode2 etc.

    Default value

    404

    Takes effect After restart

    default-resource-port-capacity

    Default Resource Port Capacity

    This parameter specifies the port capacity assigned to each Physical Resources, if they are not defined. Default value is 500.

    Default value

    500

    Takes effect After restart

    fips_enabled

    FIPS Mode Enabled

    Specifies whether to enable FIPS mode in RM. When FIPS mode is enabled, only FIPS 140-2 approved ciphers and algorithms can be used in SSL connections.

    Valid values

    • true
    • false

    Default value

    false

    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

    options-errresp-on-noresources

    Error Response to SIP OPTIONS when All resources are offline

    This parameter when set to true,RM sends error response to SIP OPTIONS when it detects all GVP resources are offline.

    Valid values

    • true
    • false

    Default value

    true

    Takes effect After restart

    pass-capability-params-to-ctic

    Pass Capability Parameters in the Request to CTI Connector

    When this parameter set to true and the target is CTI Connector, RM passes the capability parameters (specified by "gvp.rm.resource-req" prefix) in the request to CTI connector. Note that for any other type of resource, those parameters are not passed.

    Valid values

    • true
    • false

    Default value

    true

    Takes effect After restart

    reject-recording-request-on-geo-location-nomatch

    Reject request for non-matching geo-location while selecting LRGs for recording client (MCP) and recoridng server resources

    When this parameter set to true, RM rejects recording request for non-matching geo-location while selecting LRGs for recording client (MCP) and recording server resources.

    Valid values

    • true
    • false

    Default value

    true

    Takes effect After restart

    resolve-addr-for-aor-match

    Resolve Address For AOR Matching

    When this parameter when set to true, RM resolves hostname/FQDN for matching incoming resource AOR with configured resource AORs. Otherwise a direct string matching is performed.

    Valid values

    • true
    • false

    Default value

    false

    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

    rewrite-referto-header

    Rewrite host port in Refer-To header with request-uri's

    When this parameter set to true, RM rewrite host port in Refer-To header with request-uri's in Mid-dialog SIP REFER.

    Valid values

    • true
    • false

    Default value

    true

    Takes effect After restart

    sip-header-for-cti-dnis

    SIP Header for DNIS from CTI Connector

    This parameter indicates which header the RM should retrieve the DNIS from(if P_Called_Party_ID header is not present), for the purpose of identifying an IVRProfile when the request is coming from CTI Connector

    Valid values

    • request-uri
    • to
    • history-info

    Default value

    request-uri

    Takes effect immediately

    sip-header-for-dnis

    SIP Header for DNIS

    This parameter indicates the header the RM should retrieve the DNIS from(if P_Called_Party_ID header is not present), 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

    treat-campaign-as-conference

    Treat campaign as conference in RM

    When this parameter set to true, RM routes MSML request with campaign id (like OCS campaign) as conference request.

    Valid values

    • true
    • false

    Default value

    true

    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

    [subscription]

    notify-interval

    Notify Interval

    The interval that RM sends out NOTIFY message for the subscriptions. Notification should be time based and can be configured through the parameter subscription.notify-interval. This parameter accepts unsigned integer value including zero and the default is 5(s).

    Default value

    5000

    Takes effect After restart

    sip.localuser

    SIP User for Subscription

    SIP user used by subscription in sending 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.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.preferred_ipversion

    Preferred IP version to be used in SIP Subscriptions

    Preferred IP version to be used in SIP. When multiple IP addresses with different IP versions are resolved from a destination address, the first address from the list with the preferred IP version will be used. However, if there is no sip.transport defined for the preferred version, other version will be used. Valid values are "ipv4" and "ipv6".

    Valid values

    • ipv4
    • ipv6

    Default value

    ipv4

    Takes effect At start/restart

    sip.route.default.tcp

    Default IPv4 route for TCP

    Default IPv4 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 IPv4 TCP routes are found.

    Default value

    (blank)

    Takes effect At start/restart

    sip.route.default.tcp.ipv6

    Default IPv6 route for TCP

    Default IPv6 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 IPv6 TCP routes are found. If this parameter is not set, the first IPv6 TCP transport found in sip.transport.x becomes the default.

    Default value

    (blank)

    Takes effect At start/restart

    sip.route.default.tls

    Default IPv4 route for TLS

    Default IPv4 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 IPv4 TLS routes are found.

    Default value

    (blank)

    Takes effect At start/restart

    sip.route.default.tls.ipv6

    Default IPv6 route for TLS

    Default IPv6 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 IPv6 TLS routes are found. If this parameter is not set, the first IPv6 TLS transport found in sip.transport.x becomes the default.

    Default value

    (blank)

    Takes effect At start/restart

    sip.route.default.udp

    Default IPv4 route for UDP

    Default IPv4 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 IPv4 UDP routes are found.

    Default value

    (blank)

    Takes effect At start/restart

    sip.route.default.udp.ipv6

    Default IPv6 route for UDP

    Default IPv6 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 IPv6 UDP routes are found. If this parameter is not set, the first IPv6 UDP transport found in sip.transport.x becomes the default.

    Default value

    (blank)

    Takes effect At start/restart

    sip.tcp.portrange

    Notifier Local TCP port range

    The local TCP port range to be used for SIP transport. If this parameter is not specified, RM will let the OS choose the local port.

    Valid values

    Possible values are the empty string or low-high, where low and high are integers from 1030 to 65535 inclusive

    Default value

    (blank)

    Takes effect At start/restart

    sip.tls.portrange

    Notifier Local TLS port range

    The local TLS port range to be used for SIP transport. If this parameter is not specified, RM will let the OS choose the local port.

    Valid values

    Possible values are the empty string or low-high, where low and high are integers from 1030 to 65535 inclusive

    Default value

    (blank)

    Takes effect At start/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; If ip is an IPv6 address, [] must be used. To define a transport to listen to all IPv4 interfaces, use "any" or "any4" for ip. To define a transport to listen to all IPv6 interfaces, use "any6" for ip; 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. cafile=[CA cert path and filename] Mandatory for TLS mutual authentication. The path and the filename of the certificate to be used for verifying the peer. The same certificate specified in cert=[cert path and filename] parameter can be used as the value here if using only 1 certificate is preferred. verifypeer=true Mandatory for TLS mutual authentication. This parameter turns on the TLS mutual authentication. verifydepth=[max depth for the certificate chain verification] Applicable only to TLS mutual authentication. This parameter sets the maximum depth for the certificate chain verification. For the default Genesys certificate provided, the recommended value is 1.

    Default value

    transport0 udp:any:5066

    Takes effect After restart

    sip.transport.0.tos

    IP Type of Service for SIP transport

    Specifies the IP Differentiaed Services Field (also known as ToS) to set in all outgoing SIP packets over the SIP transport. Note that this configuration does not work for Windows 2008. For Windows 2008, the setting needs to be configured at the OS level through the policy settings. Please refer to the GVP User's Guide.

    Valid values

    Possible values are integers from 0 to 255 inclusive.

    Default value

    0

    Takes effect At start/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; If ip is an IPv6 address, [] must be used. To define a transport to listen to all IPv4 interfaces, use "any" or "any4" for ip. To define a transport to listen to all IPv6 interfaces, use "any6" for ip; 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. cafile=[CA cert path and filename] Mandatory for TLS mutual authentication. The path and the filename of the certificate to be used for verifying the peer. The same certificate specified in cert=[cert path and filename] parameter can be used as the value here if using only 1 certificate is preferred. verifypeer=true Mandatory for TLS mutual authentication. This parameter turns on the TLS mutual authentication. verifydepth=[max depth for the certificate chain verification] Applicable only to TLS mutual authentication. This parameter sets the maximum depth for the certificate chain verification. For the default Genesys certificate provided, the recommended value is 1.

    Default value

    transport1 tcp:any:5066

    Takes effect After restart

    sip.transport.1.tos

    IP Type of Service for SIP transport

    Specifies the IP Differentiaed Services Field (also known as ToS) to set in all outgoing SIP packets over the SIP transport. Note that this configuration does not work for Windows 2008. For Windows 2008, the setting needs to be configured at the OS level through the policy settings. Please refer to the GVP User's Guide.

    Valid values

    Possible values are integers from 0 to 255 inclusive.

    Default value

    0

    Takes effect At start/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; If ip is an IPv6 address, [] must be used. To define a transport to listen to all IPv4 interfaces, use "any" or "any4" for ip. To define a transport to listen to all IPv6 interfaces, use "any6" for ip; 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. cafile=[CA cert path and filename] Mandatory for TLS mutual authentication. The path and the filename of the certificate to be used for verifying the peer. The same certificate specified in cert=[cert path and filename] parameter can be used as the value here if using only 1 certificate is preferred. verifypeer=true Mandatory for TLS mutual authentication. This parameter turns on the TLS mutual authentication. verifydepth=[max depth for the certificate chain verification] Applicable only to TLS mutual authentication. This parameter sets the maximum depth for the certificate chain verification. For the default Genesys certificate provided, the recommended value is 1.

    Default value

    transport2 tls:any:5067 cert=$InstallationRoot$/config/x509_certificate.pem key=$InstallationRoot$/config/x509_private_key.pem

    Takes effect After restart

    sip.transport.2.tos

    IP Type of Service for SIP transport

    Specifies the IP Differentiaed Services Field (also known as ToS) to set in all outgoing SIP packets over the SIP transport. Note that this configuration does not work for Windows 2008. For Windows 2008, the setting needs to be configured at the OS level through the policy settings. Please refer to the GVP User's Guide.

    Valid values

    Possible values are integers from 0 to 255 inclusive.

    Default value

    0

    Takes effect At start/restart

    sip.transport.dnsharouting

    DNS HA Routing

    Specifies whether the DNS HA routing based on RFC3263 should be turned on. If turned off, alternate records returned from the DNS query will not be tried. Otherwise, alternate records returned from the DNS query will be tried based on RFC3263.

    Valid values

    • true
    • false

    Default value

    false

    Takes effect At start/restart

    sip.transport.localaddress

    Local Transport IPv4 Address

    If specified, the sent-by field of the Via header and the hostport part of the Contact header in the outgoing SIP message will be set to this value if a IPv4 transport is used. The value must be a hostname or domain name. If left empty the outgoing transport's actual IP and port will be used for the Via header, and the Contact header. Note that if the domain name used in the SRV record query is specified, sip.transport.localaddress.srv must be set to true to prevent the port part being automatically generated by the SIP stack.

    Default value

    (blank)

    Takes effect At start/restart

    sip.transport.localaddress.srv

    Local Transport Address contains SRV domain name

    Specifies whether the sip.transport.localaddress contains an SRV domain name. If set to true, port part will not be automatically generated by the SIP stack. Otherwise, the outgoing transport's port will used together with the hostname specified by the sip.transport.localaddress.

    Valid values

    • true
    • false

    Default value

    false

    Takes effect At start/restart

    sip.transport.localaddress_ipv6

    Local Transport IPv6 Address

    If specified, the sent-by field of the Via header and the hostport part of the Contact header in the outgoing SIP message will be set to this value if a IPv6 transport is used. The value must be a hostname or domain name. If left empty the outgoing transport's actual IP and port will be used for the Via header, and the Contact header. Note that if the domain name used in the SRV record query is specified, sip.transport.localaddress.srv must be set to true to prevent the port part being automatically generated by the SIP stack.

    Default value

    (blank)

    Takes effect At start/restart

    subscription-duration

    Subscription Duration

    The subscription duration for the subscribe requests. If the Expires header is present then the minimum of subscription.subscription-duration and Expires value from the request is used as the subscription duration. However, if the Expires header specifies a value less than the allowed minimum (36) but greater than 0, then Resource Manager should use the allowed minimum (36) as the subscription duration.

    Default value

    600

    Takes effect After restart