Jump to: navigation, search

monitor Section



  


optionsofflineresp

Default Value: 503
Valid Values:
Changes Take Effect: At start/restart


List of semi-colon separated SIP-OPTIONS response codes >=300 which can be used to mark a resource offline. If the response code received is not present in the list, then the resource will be considered online. Default is 503 which is the shutdown response code for OPTIONS by MCP

sip.enable_dns_cache

Default Value: true
Valid Values: true, false
Changes Take Effect: At start/restart


Specifies if RM should enable or disable the use of DNS cache. Enabling DNS cache increases RM's resilience towards network issues between RM and the DNS Servers. If the option is enabled, the target address is retrieved from the DNS cache, if available. If unavailable, a fresh DNS query will be used to retrieve the target address and the result will be cached depending on the DNS query response. If the option is disabled, target address is resolved by a fresh DNS query.

sip.localuser

Default Value: GVP
Valid Values:
Changes Take Effect: After restart


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

sip.mtusize

Default Value: 1500
Valid Values:
Changes Take Effect: After restart


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.

sip.preferred_ipversion

Default Value: ipv4
Valid Values: ipv4, ipv6
Changes Take Effect: At start/restart


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

sip.proxy.optionsinterval

Default Value: 1000
Valid Values:
Changes Take Effect: After restart


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

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

Default Value: true
Valid Values:
Changes Take Effect: After restart


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.

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

Default Value: true
Valid Values:
Changes Take Effect: After restart


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.

sip.proxy.releaseconfonfailure

Default Value: true
Valid Values:
Changes Take Effect: After restart


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.

sip.proxy.unavailoptionsinterval

Default Value: 5000
Valid Values:
Changes Take Effect: After restart


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

sip.route.default.tcp

Default Value:
Valid Values:
Changes Take Effect: At start/restart


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.

sip.route.default.tcp.ipv6

Default Value:
Valid Values:
Changes Take Effect: At start/restart


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.

sip.route.default.tls

Default Value:
Valid Values:
Changes Take Effect: At start/restart


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.

sip.route.default.tls.ipv6

Default Value:
Valid Values:
Changes Take Effect: At start/restart


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.

sip.route.default.udp

Default Value:
Valid Values:
Changes Take Effect: At start/restart


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.

sip.route.default.udp.ipv6

Default Value:
Valid Values:
Changes Take Effect: At start/restart


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.

sip.tcp.portrange

Default Value:
Valid Values: Possible values are the empty string or low-high, where low and high are integers from 1030 to 65535 inclusive
Changes Take Effect: At start/restart


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.

sip.tls.portrange

Default Value:
Valid Values: Possible values are the empty string or low-high, where low and high are integers from 1030 to 65535 inclusive
Changes Take Effect: At start/restart


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.

sip.transport.0

Default Value: transport0 udp:any:5064
Valid Values:
Changes Take Effect: After restart


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, SSLv3, SSLv23, TLSv1_1, TLSv1_2. Default to TLSv1_2. Note that SSLv2 is no longer supported. 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. Note: The max path length supported for certificate and key file/path is 259 characters.

sip.transport.0.tos

Default Value: 0
Valid Values: Possible values are integers from 0 to 255 inclusive.
Changes Take Effect: At start/restart


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 and above. For Windows 2008 and above, the setting needs to be configured at the OS level through the policy settings. Please refer to the GVP User's Guide.

sip.transport.1

Default Value: transport1 tcp:any:5064
Valid Values:
Changes Take Effect: After restart


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, SSLv3, SSLv23, TLSv1_1, TLSv1_2. Default to TLSv1_2. Note that SSLv2 is no longer supported. 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. Note: The max path length supported for certificate and key file/path is 259 characters.

sip.transport.1.tos

Default Value: 0
Valid Values: Possible values are integers from 0 to 255 inclusive.
Changes Take Effect: At start/restart


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 and above. For Windows 2008 and above, the setting needs to be configured at the OS level through the policy settings. Please refer to the GVP User's Guide.

sip.transport.2

Default Value: transport2 tls:any:5065 cert=$InstallationRoot$/config/x509_certificate.pem key=$InstallationRoot$/config/x509_private_key.pem
Valid Values:
Changes Take Effect: After restart


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, SSLv3, SSLv23, TLSv1_1, TLSv1_2. Default to TLSv1_2. Note that SSLv2 is no longer supported. 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. Note: The max path length supported for certificate and key file/path is 259 characters.

sip.transport.2.tos

Default Value: 0
Valid Values: Possible values are integers from 0 to 255 inclusive.
Changes Take Effect: At start/restart


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 and above. For Windows 2008 and above, the setting needs to be configured at the OS level through the policy settings. Please refer to the GVP User's Guide.

sip.transport.dnsharouting

Default Value: false
Valid Values: true, false
Changes Take Effect: At start/restart


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.

sip.transport.localaddress

Default Value:
Valid Values:
Changes Take Effect: At start/restart


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.

sip.transport.localaddress_ipv6

Default Value:
Valid Values:
Changes Take Effect: At start/restart


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.

sip.transport.localaddress.srv

Default Value: false
Valid Values: true, false
Changes Take Effect: At start/restart


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.

sip.transport.routefailovertime

Default Value: 5
Valid Values:
Changes Take Effect: At start/restart


Specifies the failover time in seconds for SIP static routing and DNS HA routing. If a SIP request has not received a response within the failover time, and SIP static routing or DNS HA routing is enabled, the SIP request will be retransmitted to an alternate route.

sip.transport.routerecoverytime

Default Value: 30
Valid Values:
Changes Take Effect: At start/restart


Specifies the recovery time in seconds for SIP static routing and DNS HA routing. When SIP static routing or DNS HA routing is enabled and the route is marked as unavailable due to error or SIP response timeout, the route will be marked as available again after the recovery time.

sip.transport.setuptimer.tcp

Default Value: 30000
Valid Values: Possible values are integers from 1000 to 32000 inclusive.
Changes Take Effect: At start/restart


Specifies the maximum wait time in milliseconds for establishing a TCP or TLS connection before marking the resource unavailable.

sip.transport.unavailablewakeup

Default Value: true
Valid Values: true, false
Changes Take Effect: At start/restart


Specifies whether unavailable route destinations can be made active if needed before the route recover timer expires. The unavailable destinations would be made active only when all destinations corresponding to a static route group or DNS SRV domain are unavailable. This parameter is applicable when SIP stack is running under HA mode (Static route list or DNS SRV routing).

Feedback

Comment on this article:

blog comments powered by Disqus
This page was last modified on 24 July 2017, at 02:08.