Rhino SIP Servlet 1.1.0 :: Rhino SIP Servlet Installation and Administration Guide

You configure network interfaces in Rhino SIP Servlet by setting these properties, when creating or updating an interface.

Name Type Default Value Reconfigurable while active? Description

Name	Type	Default Value	Reconfigurable while active?	Description
IPAddress	String	None, a value must be specified.	❌	The IP address (or hostname) of the network interface. Must match a local network interface on the host. The special value `auto` means "listen on all interfaces". May also use CIDR address/mask notation (for example, "10.0.0.0/24"), which selects the matching local interface in the given range, intended for clusters. IPv4 and IPv6 addresses are supported.
Port	Integer	5060	❌	The port that will be used for unencrypted SIP transports (UDP, TCP).
SecurePort	Integer	5061	❌	The port that will be used for encrypted SIP transports (TLS).
Transports	String	TCP,UDP	❌	Comma-separated list of transports that the network interface supports.
VirtualAddresses	String	None	❌	Comma-separated list of virtual IPs or hostnames that are considered to be local, such as virtual addresses provided by an external load balancer. Incoming requests that are routed to a local address will be processed by the SIP Servlet RA before forwarding. Addresses may also include a port number, e.g. `host:5090`. This specifies the load balancer port, if an external load balancer provides the virtual address on a different port to the SIP Servlet RA. If no port is specified, the SIP Servlet RA will match the virtual address on any port.
ViaSentByAddress	String	None	❌	The hostname that will be used as the sent-by address in Via headers of requests sent on this interface.
UseVirtualAddressInURIs	Boolean	True	❌	If true and `VirtualAddresses` is set, the first virtual address in the list will be used as the hostname in Record-Route and Contact headers inserted by the RA. Otherwise, the network interface’s IP address will be used.

IPAddress

String

None, a value must be specified.

❌

The IP address (or hostname) of the network interface. Must match a local network interface on the host. The special value auto means "listen on all interfaces". May also use CIDR address/mask notation (for example, "10.0.0.0/24"), which selects the matching local interface in the given range, intended for clusters. IPv4 and IPv6 addresses are supported.

Port

Integer

❌

The port that will be used for unencrypted SIP transports (UDP, TCP).

SecurePort

Integer

❌

The port that will be used for encrypted SIP transports (TLS).

Transports

String

TCP,UDP

❌

Comma-separated list of transports that the network interface supports.

VirtualAddresses

String

None

❌

Comma-separated list of virtual IPs or hostnames that are considered to be local, such as virtual addresses provided by an external load balancer. Incoming requests that are routed to a local address will be processed by the SIP Servlet RA before forwarding.

Addresses may also include a port number, e.g. host:5090. This specifies the load balancer port, if an external load balancer provides the virtual address on a different port to the SIP Servlet RA. If no port is specified, the SIP Servlet RA will match the virtual address on any port.

ViaSentByAddress

String

None

❌

The hostname that will be used as the sent-by address in Via headers of requests sent on this interface.

UseVirtualAddressInURIs

Boolean

True

❌

If true and VirtualAddresses is set, the first virtual address in the list will be used as the hostname in Record-Route and Contact headers inserted by the RA. Otherwise, the network interface’s IP address will be used.

Changes to the network interface configuration of an active SIP Servlet RA entity will not be applied until the RA entity is restarted.

Previous page Next page

Configuring Network Interfaces