Revision as of 17:02, June 9, 2020 by Valentip (talk | contribs) (Update with the copy of version: DRAFT)
Jump to: navigation, search

SIP Proxy Application Configuration Options

applications

Default Value: NULL
Valid Values: String value
Change Take Effect: After restart

Specifies a comma-separated list of all SIP Server applications names in the environment. Only primary servers need to be specified.

oos-check

Default Value: 5
Valid Values: 0–300
Changes Take Effect: Immediately

Specifies how often, in seconds, SIP Proxy checks SIP Servers for out-of-service status.

oos-force

Default Value: 5
Valid Values: 1–32
Changes Take Effect: Immediately

Specifies how often, in seconds, SIP Proxy checks whether the out-of-service SIP Server starts to respond.

overload-ctrl-dialog-rate

Default Value: 0
Valid Values: Any positive integer
Changes Take Effect: Immediately

Specifies a dialog rate (incoming INVITE requests per second) threshold. All over-threshold INVITE requests will be rejected. When set to a value of 0 (the default), this functionality is disabled.

resolve-host

Default Value: false
Valid Values: true, false
Changes Take Effect: After SIP Proxy restart

If this option is set to false, the name of the host where SIP Proxy runs is specified in the Via header. If this option is set to true, the resolved IP address is specified in the Via header.

serving-sipserver

Default Value: NULL
Valid Values: Any string
Change Take Effect: After restart

Specifies the SIP Server application name to which all requests from endpoints and media gateways will be forwarded.

sip-address

Default Value: NULL
Valid Values: String value
Changes Take Effect: After SIP Proxy restart

Specifies the IP address of the SIP Proxy interface. This option must be set when deploying SIP Proxy on a host with multiple network interfaces. If this option is specified, SIP Proxy inserts the option value into the Via header of outgoing SIP messages.

sip-ip-tos

Default Value: 256
Valid Values: 0–255
Changes Take Effect: After SIP Proxy restart

Specifies the value of the Type of Service (TOS) byte in the IP header of SIP messages that are sent by SIP Proxy. If this option is not specified, the operating system TOS byte is used. The default value (256) disables this functionality. Only decimal values are accepted.

Depending on the network configuration, the TOS byte is treated as one of the following:

  • 3-bit IP precedence field, followed by a 4-bit type-of-service. The least significant bit (LSB) is unused and set to 0. (RFC 1349)
  • 6-bit DiffServ, with the two least significant bits unused. (RFC 2474)

Note: On most operating systems, applications that are running on behalf of non-privileged user accounts are not permitted to set a non-zero TOS value, so you might have to perform additional actions to enable this functionality. In particular:

  • On Linux, the application must have CAP_NET_ADMIN capability (that is, be capable of running from the root account).
  • On Windows, the following registry setting must be set (see also http://support.microsoft.com\kb/248611): HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Services\Tcpip\Parameters\DisableUserTOSSetting = (DWORD) 0

Refer to operating system documentation for additional information.

sipproxy-role

Default Value: 0
Valid Values: 0,10
Changes Take Effect: After restart

Specifies the mode of the SIP Proxy:

  • 0—Reserved for engineering purposes
  • 10—Standalone mode (the only mode currently supported)
Comments or questions about this documentation? Contact us for support!