Configuring SIP Server
Complete these steps to configure the SIP Server instances for Cluster-mode operation.
Task Summary
Configuring SIP Server for the Cluster
Create the switch.
Create a single SIP Server switch for the entire cluster. When configuring this switch, keep the following rules in mind:
[+] Key Rules for switch configuration
- Do not configure Extension or ACD Position DNs in the switch. These objects are configured in the SIP Voicemail server.
- Do not configure Agent Logins in the switch. Agent configuration is also handled in SIP Voicemail server.
- ACD Queue DNs are not supported in the cluster.
- Other DNs are still configured in the switch. For example, Trunk, Trunk Group, Voice over IP Service, Virtual Queue, Routing Point, and External Routing Point DNs.
- All SIP Server applications running in the cluster must use the same switch.
For details about configuring a SIP Server Switch object, see the Framework 8.1 SIP Server Deployment Guide.
Create the Cluster Configuration DN.
The cluster switch must contain one Cluster Configuration DN. All SIP Server and SIP Proxy applications in the cluster use the parameters configured under this DN. Create the DN with the following settings:
[+] See settings
| Name
|
Value
|
Key Info
|
| sipproxy-applications
|
Enter a comma-separated list of names for all active SIP Proxy Applications in the cluster.
|
Include all SIP Proxy instances that serve different data centers.
|
| applications
|
Enter a comma-separated list of primary SIP Server Applications presented in the cluster.
|
Include all SIP Server instances for all data centers.
|
| active-applications
|
Enter a comma-separated list of active primary SIP Server Applications presented in the cluster.
|
|
| service-type
|
Enter the value sip-cluster-nodes.
|
|
Configure Outbound Proxy DN.
The cluster switch must contain one Outbound Proxy DN. All SIP Server and SIP Proxy applications in the cluster use the parameters configured under this DN.
In the Annex tab, TServer section, configure the following (mandatory options):
[+] See settings
| Name
|
Value
|
Key Info
|
| oos-check
|
3
|
|
| oos-force
|
5
|
These two options (oos-check and oos-force) enable active out-of-service detection. In this specific example, SIP Server is checking for proxies (by using value of the contact option) every 3 seconds and sets them in the out-of-service state 5 seconds after the last check that was not responded.
|
| service-type
|
sip-outbound-proxy
|
|
| contact
|
FQDN of SIP Proxy resolved to SRV list
|
Set this option to the Fully Qualified Domain Name (FQDN), which resolves to the SRV list of the SIP Proxy addresses. SIP Server uses this list to load balance the traffic across all SIP Proxy instances. To localize SIP traffic inside one data center, this FQDN must be resolved to different sets of SIP Proxies based on geo-location: in other words, SIP Server should be aware only about those SIP Proxy instances installed in the same data center where SIP Server resides.
|
| external-contact
|
FQDN of SIP Proxy resolved to A-record (host:port)
|
Set this option to the FQDN used by the SIP phones to access the SIP Proxy instances in the cluster. Use the following format:
host:port
Where host is an FQDN that can be resolved using DNS to a list of SIP Proxy IP Addresses (DNS A records), port is the TCP/IP port that SIP Proxy uses to listen for SIP messages from SIP phones (all SIP Proxy instances listen on the same port). For example:
anyproxy.DnsServer.com:7018.
|
Configure Dial Plan DN.
The cluster switch may contain one or more Dial Plan DNs (Voice over IP Service DNs of the type dial-plan). There should be the same number of Dial Plan and SIP Voicemail DNs created on the cluster switch, since each Dial Plan DN refers to a corresponding SIP Voicemail DN. Create the Dial Plan DN with the following settings:
[+] See settings
- service-type — Enter the value dial-plan.
- dial-plan-rule — Set the value for this rule to the following:
.=>MY_EXTENDED_DN;type=extended
In this case, Dial Plan DN is referring to the SIP Voicemail DN with the name "MY_EXTENDED_DN".
Configure SIP Voicemail Server DN.
The cluster switch may contain one or more SIP Voicemail Server DNs (Voice over IP Service DNs of the type extended). A typical cluster deployment will have one SIP Voicemail Server DN configured for each data center. Create this DN with the following settings:
[+] See settings
- service-type — Enter the value extended.
- url — Set this option to the URL for the local SIP Voicemail server in this data center. For example,
http://myhost:myport
Configure Device Profile DN.
The cluster switch can support multiple Device Profile DNs (Voice over IP Service DNs of type device-profile). These DNs are used to configure the DN-level parameters that SIP Server dynamically assigns to the device participating in a call.
Configure the Voice over IP Service DN for device-profile
[+] See settings
- service-type — Enter device-profile
- profile-id — Enter a value to identify this profile. SIP Server assigns the profile to a device by matching this value to the content of the User-Agent header in the SIP message. If no device profile is found, then a default device is created (in other words, all device parameters will have default values). The value of the profile-id parameter must either match the value of the User-Agent header or it can be defined as a substring which can be found in the User-Agent header.
Notes:
- The string is case-sensitive.
- There is no default value.
- Changes take effect for the next call.
- You can set the profile-id to the special value of default-profile. SIP Server uses this profile to handle any device that does include the User-Agent header in its SIP messages (and so cannot be used to match a specific device profile).
Device-profile selection process for 3pcc calls
[+] See selection process
Device profile is selected based on the 'User-Agent' header value received in one of the the SIP messages from the device. If this information is not available, then in all the following scenarios, the default device profile is used. If the default-profile is not created, then all device parameters take their default values.
Destination device in any call scenario
Original outgoing INVITE sent to a call destination is always created using default-profile. If the device supplies the 'User-Agent' header in the response to the outgoing INVITE sent by the SIP Server, then this information is used to select the device profile for the device and to replace the existing one.
Origination device in 1pcc inbound call
Device profile is assigned based on the 'User-Agent' header received in the INVITE message from the originating the call.
Origination device of TMakeCall
If 'User-Agent' header was submitted in the SIP REGISTER request received from this device, then the matching device profile is used.
Origination device of TInitiateCall/TInitiateConference
The consultation call origination device uses the same device profile as the one used for this device in the main call.
Configure Trunk, Trunk Group, and Media Service (Voice over IP Service) DNs.
Set the contact option to a valid URI.
Configure the SIP Server Applications.
[+] On the Server Info Tab
For each SIP Server instance in the cluster node, you must configure listening ports for the T-Controller and Interaction Proxy modules:
- Create a new port for T-Controller. Click Add Port and assign the following information:
- ID — TCPort
- Listening Port — Enter an available port number.
- Connection Protocol — Enter TController as the protocol.
- Create a new port for Interaction Proxy.
- ID — IPport
- Listening Port — Enter an available port number.
- Connection Protocol — Enter IProxy as the protocol.
Note: All names are case-sensitive.
[+] On the Options Tab
For each SIP Server instance in the cluster node, configure the following options:
- geo-location — Enter a string identifying the Data Center to which this SIP Server instance belongs.
Important: This parameter must be defined for SIP Server to work properly in cluster mode. All applications deployed in the same data center use the same value for this geo-location parameter.
- sip-address — This existing SIP Server option is mandatory in cluster mode. SIP Server uses this parameter to build the Via and Contact headers in SIP messages.
- sip-outbound-proxy — Set this option to true.
- sip-enable-gdns — Set this option to true.
- sip-enable-rfc3263 — Set this option to true.
- gdns-verbose-level — In the Log section, set this option to 4 to enable GDNS logs. This is an optional parameter, used to troubleshoot DNS-related scenarios.
- sip-link-type — Set this option to 3.
- server-role — Set this option to 5.
- msml-support — Set this option to true. This enables msml for integration with GVP media services.
- dial-plan — Set this option to the name of the Dial Plan DN (Voice over IP Server DN with service-type set to dial-plan to be used by this SIP Server application.
