integrating shoretel with microsoft lync via audiocodes ip

APPLICATION NOTE: AN10440

Integrating ShoreTel 14.2 with Microsoft Lync via AudioCodes IP to IP (SIP) Microsoft Lync 2013 and AudioCodes Mediant SBC and Gateway Family

Contents

Overview .................................................................................................................................................. 2 Required Components ....................................................................................................................... 2

Supported and Tested Versions ............................................................................................................. 3

Important Disclaimer ........................................................................................................................... 3

Intended Audience ............................................................................................................................ 3 AudioCodes Mediant Media Gateways ............................................................................................. 3

Initial Configuration ................................................................................................................................. 4

ShoreTel Configuration ................................................................................................................... 4

ShoreTel System Settings – General............................................................................................... 4

Call Control Settings ........................................................................................................................ 4 Sites Settings ...................................................................................................................................... 6

Switch Settings - Allocating Ports for SIP Trunks ............................................................................... 8

ShoreTel System Settings – Trunk Groups ........................................................................................ 11

AudioCodes Configuration ......................................................................................................... 22 Set up the AudioCodes Gateway ............................................................................................. 22

Microsoft Lync Configuration ...................................................................................................... 84

Add AudioCodes Gateway to the Topology .......................................................................... 84 Configure Lync Voice Routes and Normalization Rules ......................................................... 93

ST Doc Number

IN - 15010

Version 2.0

Date March, 2015

960 Stewart Drive, Sunnyvale, CA 94085 USA +1 (800) 425-9385 Toll Free +1 (408) 331-3300 Tel. ShoreTel.com

Overview

The purpose of this application note is to illustrate integrating the ShoreTel UC system with Microsoft (MS) Lync Server 2013 for delivering voice calls between the two systems. This integration allows Lync audio conferencing calls to and from external callers via trunks on the ShoreTel system. The same steps are required to enable users on either system to place voice calls to one another (extension to extension dialing).

This application note does not provide details on the following integration features:

MS Outlook Voicemail integration for client-side unified messaging

MS Outlook Calendar integration for automated call handling mode changes

MS Outlook Calendar integration for automated conference bridge details within appointments

MS Outlook Contact importing for easy dial-by-name and dial-by-company

TAPI integration for dialing directly from within Outlook contacts

MS Exchange integration for server-side unified messaging

MS Lync integration for IM, presence, or remote call control

This document focuses exclusively on the integration of MS Lync “Enterprise Voice” capabilities with the ShoreTel UC system via the AudioCodes Mediant mediant SBC and gateway products. Refer to other application notes and product documentation for details on all of the other integration methods. Please see the ‘References and Resources” section at the end of this document for a complete listing of related documentation and other configuration resources.

MS Lync enterprise voice access to the public switched telephony network (PSTN) can be delivered via ShoreTel voice switches and the AudioCodes Mediant family of session border controllers and media gateways. Microsoft Lync audio conferencing users and ShoreTel IP phone users can place, transfer, and conference calls between the two systems.

Required Components

1) Any of the following AudioCodes Mediant SBC and media gateway products - Mediant 500 E-SBC - Mediant 800 Gateway & E-SBC - Mediant 1000B Gateway & E-SBC - Mediant 2600 E-SBC - Mediant 3000 Gateway & E-SBC - Mediant 4000 E-SBC - Mediant 9000 SBC* - Mediant Software SBC (Server Edition and Virtual Edition)*

2) Microsoft Lync Server 2013 with Mediation Server configured

3) One or more ShoreTel Voice physical or Virtual Switches with available SIP trunk capacity

*If the requirement for transcoding is not required to be performed at the AudioCodes device, then the

AudioCodes Mediant 9000 and the Software SBC devices can be utilized. Test were performed to ensure direct call, transfer, forward, hold/resume, Music on Hold, long call, long hold, pre-answer abandon, pre-transfer abandon, and other similar features and functionality were integrated properly and fully functional between the Microsoft Lync 2013 environment and the ShoreTel environment.

Supported and Tested Versions This document is written based on testing with the following versions of software:

ShoreTel 14.2_Build_19.43.1700.0

MS Lync Server 2013

AudioCodes Mediant 1000B version 6.80A.244.006 Functionality differences based on future software updates from ShoreTel, AudioCodes, and Microsoft will be reflected as needed via updates to this document and other supporting resources. See the ‘References and Resources” section at the end of this document.

Important Disclaimer This document is for informational purposes only and is provided “AS IS”. Microsoft and its partners cannot verify the accuracy of this information and take no responsibility for the content of this document. To the extent permitted by law, Microsoft makes no warranties of any kind, disclaims all express, implied and statutory warranties, and assumes no liability to you for any damages of any type in connection with the content of this document.

Intended Audience The information provided in this document has been provided by Microsoft Partners or equipment manufactures and is provided “AS IS”. This document contains information about how to modify the configuration of your PBX or VoIP gateway. Improper configuration may result in the loss of service of the PBX or gateway. Microsoft is unable to provide support or assistance with the configuration or troubleshooting of components described within. Microsoft recommends readers to engage the service of a Microsoft Lync specialist or the manufacturers of the equipment described within to assist with the planning and deployment of Lync 2013.

AudioCodes Mediant Media Gateways

AudioCodes offers the enterprise customer a key component in the unified telephony network: the Mediant device that connects the ShoreTel system with MS Lync 2013. AudioCodes Mediant media gateways and SBCs are cost-effective VoIP gateways and SBCs packaged in a stackable 1U or 2U chassis; they are designed to interface between the traditional PSTN and IP networks, or between two IP-based systems such as ShoreTel and MS Lync.

Figure 1 – MS Lync and ShoreTel Interconnected via AudioCodes

Initial Configuration

The configuration information below shows examples for configuring ShoreTel and the AudioCodes gateway. Even though configuration requirements can vary from setup to setup, the information provided in these steps, along with that found in the ShoreTel Planning and Installation Guide and the documentation provided by AudioCodes and Microsoft, should prove to be sufficient. However every design can vary and some may require more planning than others.

ShoreTel Configuration

This section describes the ShoreTel system configuration to support SIP Trunking. The section is divided into general system settings and trunk configurations (both group and individual) needed to support SIP Trunking.

ShoreTel System Settings – General The first settings to address within the ShoreTel system are the general system settings. These configurations include the Call Control, the Site and the Switch settings. If these items have already been configured on your system, skip this section and go on to the “ShoreTel System Settings – Trunk Groups” section below.

Call Control Settings The first settings to configure within ShoreTel Director are the Call Control Options. To configure these settings for the ShoreTel system, log into ShoreTel Director and select “Administration” then “Call Control” followed by “Options” – the “Call Control Options” screen will then appear (Figure 2).

Figure 2 – Call Control Options Screen

Within the “Call Control Options” SIP parameters; confirm that the appropriate settings are made for the “Realm”, “Enable SIP Session Timer” and “Always Use Port 5004 for RTP” parameters. Note: New installations of ST 14.2 will not have this parameter. It will only appear for upgraded systems. The “Realm” parameter is used in authenticating all SIP devices. It is typically a description of the computer or system being accessed. Changing this value will require a reboot of all ShoreTel switches serving SIP extensions. It is not necessary to modify this parameter to get the ShoreTel IP PBX system functional with AudioCodes gateway. Step 1 Verify that the “Enable SIP Session Timer” box is checked (enabled). Step 2 Set the Session Interval Time to the recommended setting of 3600 seconds. Step 3 Select the appropriate refresher (from the pull down menu) for the SIP Session Timer. The “Refresher” field will be set either to “Caller (UAC)” [User Agent Client] or to “Callee (UAS)” [User Agent Server]. If the “Refresher” field is set to “Caller (UAC)”, the Caller’s device will be in control of the

session timer refresh. If “Refresher” is set to “Callee (UAS)”, the device of the person called will control the session timer refresh.

Step 4 Verify the “Voice Encoding and Quality of Service”, specifically the “Media Encryption” parameter. Make sure this parameter is set to “None”, otherwise you may experience one-way audio issues. Please refer to ShoreTel Administration Guide for additional details on media encryption and the other parameters in the “Voice Encoding and Quality of Service” area. Step 5 Disable (uncheck) the “Always Use Port 5004 for RTP” parameter if checked; it is required for implementing SIP trunks between ShoreTel systems only. For SIP configurations, Dynamic User Datagram Protocol (UDP) must be used for RTP Traffic. If the parameter is disabled, Media Gateway Control Protocol (MGCP) will no longer use UDP port 5004; MGCP and SIP traffic will use dynamic UDP ports (Figure 3).

Figure 3 – Call Control Options Settings Once this parameter is unchecked, make sure that “everything” (IP Phones, ShoreTel Voice Switches, ShoreTel Server, Distributed Voice Mail Servers / Remote Servers, Conference Bridges and Contact Centers) is “fully” rebooted – this is a “one time only” item. By not performing a full system reboot after changing this setting, one-way audio may occur during initial testing. Step 6 Be sure to save your changes before leaving this screen by clicking Save at the top of the page.

Sites Settings The next settings to address are the administration of sites. These settings are modified under the ShoreTel Director by selecting “Administration” then “Sites”. This selection brings up the “Sites” screen.

Step 1 Within the “Sites” screen select the name of the site to configure. The “Edit Site” screen will then appear. The only changes required to the “Edit Site” screen are to the “Admission Control Bandwidth” and “Intra-Site / Inter-Site Calls” parameters (Figure 4).

Figure 4 – Site Bandwidth settings

Step 2 Set the appropriate Admission Control Bandwidth for your network. Please refer to the ShoreTel Planning and Installation Guide for additional information on setting Admission Control Bandwidth for your network. Admission Control Bandwidth defines the bandwidth available to and from the site. This is important as SIP trunk calls will be counted against the site bandwidth.

Note: Bandwidth of 2046 kbps is just an example.

Step 3 Configure the "Inter-Site Calls" option for "Very Low Bandwidth Codecs." By default "Very

Low Bandwidth Codecs" contains two codecs, G.729 and G.711u, with G.729 being the primary codec of choice. The “Inter-Site Calls” parameter defines which codecs will be used when establishing a call with AudioCodes – the preferred codec choice is G.729.

Note: Please do not modify the "Very Low Bandwidth Codecs" codec list.

Step 4 Save changes before leaving this screen by clicking Save at the top of the page.

Switch Settings - Allocating Ports for SIP Trunks The final general settings to configure are the ShoreTel switch settings. These changes are modified by selecting “Administration” then “Platform Hardware” followed by “Virtual Switches /Service Appliances” - “Primary” in ShoreTel Director (Figure 5).

Figure 5 – Administration Switches This action brings up the “Switches” screen. From the “Switches” screen choose the name of the switch to configure for SIP trunks. The “Edit ShoreTel Switch” screen will appear. Step 1 Within the “Edit ShoreTel Switch” screen, select the desired number of SIP Trunks from the ports available as shown in Figure 6(a). Each port designated as a Port Type of “SIP Trunk” enables the support for five individual SIP trunks. The AudioCodes Mediant 1000 can be configured for up to 120 SIP trunks. Each trunk can support one concurrent call between the ShoreTel system and the MS Lync 2013 system. Determine the desired capacity of the interconnection between the two systems and configure the necessary resources as required, then proceed to the next section. Step 2 Be sure to save your changes before leaving this screen by clicking Save at the top of the page. Note: Virtual Trunks switch comes preconfigured with SIP Trunk capacity as shown is Figure 6(b). Hence, no configuration required for Virtual Trunk Switches.

Figure 6 – ShoreTel Switch Settings

Figure 6 – ShoreTel Switch Settings

ShoreTel System Settings – Trunk Groups ShoreTel Trunk Groups only support Static IP Addresses for Individual Trunks. The AudioCodes gateway interfaces should also be configured to use a “static” IP Address. The MS Lync’s solution with Audio Codes requires setup of two different trunk groups on the ShoreTel system:

PSTN SIP Trunk Group

Lync SIP Trunk Group PSTN SIP Trunk Group

Step 1 From the pull down menus on the “Trunk Groups” screen, select the site desired and select the “SIP” trunk type to configure. Step 2 Click on the “Go” link from “Add new trunk group at site”. The “Edit SIP Trunk Group” screen will appear as shown in Figure 7.

Figure 7 – Administration Trunk Groups

Step 3 Enter your preferred name for the new trunk group. In the example in Figure 8, the name “SIP PSTN” has been created. Step 4 The “Enable SIP Info for G.711 DTMF Signaling” parameter should not be enabled (checked). Enabling SIP info is currently only used with SIP tie trunks between ShoreTel systems. Step 5 The “Profile:” parameter is should be left at a default setting of “Default ITSP”; It is not necessary to modify this parameter when connecting to the AudioCodes device. Step 6 The “Enable Digest Authentication” parameter defaults to “<None>” and modification is not required when connecting to the AudioCodes device. The next item to change in the “Edit SIP Trunks Group” screen is to make the appropriate settings for the “Inbound:” parameters as shown in Figure 8. Step 7 Within the “Inbound:” settings, ensure the “Number of Digits from CO” is set to match what the ShoreTel SIP trunk switch will be receiving from AudioCodes PSTN gateway and ensure the

“DNIS” or “DID” box is enabled (checked), along with the “Extension” parameter. Step 9 We recommend that the “Tandem Trunking” parameter be enabled (checked) otherwise transfers to external telephone numbers will fail via SIP trunks. For additional information on this parameter please refer to the ShoreTel Planning and Installation Guide.

Figure 8 – SIP Trunk Group (SIP PSTN)

The next item to change in the “Edit SIP Trunks Group” screen is to make the appropriate settings for the “Onbound:” parameters (Figure 8). Step 10 Enable (check) the “Outbound” parameter and define a Trunk “Access Code” and “Local Area Code” as appropriate. In the “Trunk Services:” area, make sure the appropriate services are enabled or disabled based on your needs. The “Enable Caller ID” parameter determines if the call is sent out as <unknown> or with caller information (Caller ID). User DID will impact how information is passed out to the SIP Trunk group. The final parameters for configuration in the Trunk Group are “Trunk Digit Manipulation” (Figure 9).

Figure 9 – SIP Trunk Group (SIP PSTN) with off system extensions

Step 11 Disable (uncheck) the “Dial in E.164 Format” parameter to match the format PSTN Trunk and define a Trunk “Access Code” and “Local Area Code” as appropriate. Next you must create the Off System Extension (OSE) range that will be used to represent the Lync audio conferencing bridge or Lync softphone users. An OSE is required for every Lync enterprise voice endpoint that will be using the ShoreTel system. Step 12 Click the Edit button next to Off System Extensions:. The Off Systems Extension Range dialog is displayed (Figure 9)

Step 13 Click OK to save the first range and repeat if necessary to create sufficient extensions for all your Lync endpoints. Step 14 After all your setting changes are made to the “Edit SIP Trunk Group” screen, click the “Save” button at the top of the page. SIP PSTN Individual Trunks ShoreTel System Settings – Individual Trunks: This section covers the configuration of the individual trunks. Select “Administration”, then “Trunks” followed by “Individual Trunks” to configure the individual trunks. The “Trunks by Group” screen is used to change the individual trunks settings that appear

Figure 10 – Trunks by Group

Step 1 Select the site for the new individual trunk(s) to be added and select the appropriate trunk group from the pull down menu in the “Add new trunk at site” area as shown in Figure 10. In this example, the site is “Headquarters” and the trunk group is “SIP PSTN”, as created above. Step 2 Click on the “Go” button to bring up the “Edit Trunk” screen. Step 3 From the individual trunks “Edit Trunk” screen, input a name for the individual trunks. When selecting a name, the recommendation is to name the individual trunks the same as the name of the trunk group so that the trunk type can easily be tracked. Step 4 For the “Switch:” , select the switch upon which the individual trunk will be created. For the “IP Address”, enter the IP address of the AudioCodes gateway. Step 5 Select the number of individual trunks desired (each one supports “one” audio path – example if 10 is configured, then 10 audio paths can be active at one time). Note: Individual SIP Trunks cannot span networks. SIP trunks can only terminate on the switch

selected. There is no failover to another switch. If you want to build a redundant configuration, two trunk groups will be needed with each pointing to another AudioCodes gateway – just the same as if

PRI were being used. Step 6 Once all changes are complete, select the “Save” button to commit changes.

Figure 11 – Individual trunk setting for PSTN trunk group

Depending on your environment you may have to create a DNIS map on the primary PSTN trunk coming into the ShoreTel system for the enterprise voice user since they are not defined in ShoreTel Director. See example below (Figure 12).

Figure 12 – DNIS Digit Map

SIP Lync trunk group Step 1 From the pull down menus on the “Trunk Groups” screen, select the site desired and select the “SIP” trunk type to configure. Step 2 Click on the “Go” link from “Add new trunk group at site”. The “Edit SIP Trunk Group” screen will appear as shown in Figure 14.

Figure 13 – Administration Trunk Groups

Step 3 Enter your preferred name for the new trunk group. In the example in Figure 14, the name “SIP Lync” has been created. Step 4 The “Enable SIP Info for G.711 DTMF Signaling” parameter should not be enabled (checked). Enabling SIP info is currently only used with SIP tie trunks between ShoreTel systems. Step 5 The “Profile:” parameter is should be left at a default setting of “Default ITSP”; It is not necessary to modify this parameter when connecting to the AudioCodes device. Step 6 The “Enable Digest Authentication” parameter defaults to “<None>” and modification is not required when connecting to the AudioCodes device. The next item to change in the “Edit SIP Trunks Group” screen is to make the appropriate settings for the “Inbound:” parameters as shown in Figure 14. Step 7 Within the “Inbound:” settings, ensure the “Number of Digits from CO” is set to match what the ShoreTel SIP trunk switch will be receiving from AudioCodes Lync gateway and ensure the “DNIS” or “DID” box is enabled (checked), along with the “Extension” parameter. Step 9 We recommend that the Tandem Trunking parameter be enabled (checked) otherwise transfers to external telephone numbers will fail via SIP trunks. For additional information on this parameter please refer to the ShoreTel Planning and Installation Guide.

Figure 14 – SIP Trunk Group (SIP Lync)

The next item to change in the “Edit SIP Trunks Group” screen is to make the appropriate settings for the “Onbound:” parameters (Figure 14). Step 10 Enable (check) the “Outbound” parameter and define a Trunk “Access Code” and “Local Area Code” as appropriate. In the “Trunk Services:” area, make sure the appropriate services are enabled or disabled based on

your needs. The “Enable Caller ID” parameter determines if the call is sent out as <unknown> or with caller information (Caller ID). User DID will impact how information is passed out to the SIP Trunk group. The final parameters for configuration in the Trunk Group are “Trunk Digit Manipulation” (Figure 15).

Figure 15 – SIP Trunk Group (SIP PSTN) with off system extensions

Step 11 Disable (uncheck) the “Dial in E.164 Format” parameter to match the format “SIP Lync” Trunk and define a Trunk “Access Code” and “Local Area Code” as appropriate. Next you must create the Off System Extension (OSE) range that will be used to represent the Lync audio conferencing bridge or Lync softphone users. An OSE is required for every Lync enterprise voice endpoint that will be using the ShoreTel system. Step 12 Click the Edit button next to Off System Extensions: The off Systems Extension Range dialog is displayed (Figure 15)

Step 13 Click OK to save the first range and repeat if necessary to create sufficient extensions for all your Lync endpoints. Step 14 After all your setting changes are made to the “Edit SIP Trunk Group” screen, click the “Save” button at the top of the page.

SIP Lync Individual Trunks ShoreTel System Settings – Individual Trunks: This section covers the configuration of the individual trunks. Select “Administration”, then “Trunks” followed by “Individual Trunks” to configure the individual trunks. The “Trunks by Group” screen is used to change the individual trunks settings that appear

Figure 16 – Trunks by Group

Step 1 Select the site for the new individual trunk(s) to be added and select the appropriate trunk group from the pull down menu in the “Add new trunk at site” area as shown in Figure 16. In this example, the site is “Headquarters” and the trunk group is “SIP Lync”, as created above. Step 2 Click on the “Go” button to bring up the “Edit Trunk” screen. Step 3 From the individual trunks “Edit Trunk” screen, input a name for the individual trunks. When selecting a name, the recommendation is to name the individual trunks the same as the name of the trunk group so that the trunk type can easily be tracked. Step 4 For the “Switch:”, select the switch upon which the individual trunk will be created. For the “IP Address”, enter the IP address of the AudioCodes gateway for Lync Trunks. Step 5 Select the number of individual trunks desired (each one supports “one” audio path – example if 10 is configured, then 10 audio paths can be active at one time). Note: Individual SIP Trunks cannot span networks. SIP trunks can only terminate on the switch

selected. There is no failover to another switch. If you want to build a redundant configuration, two trunk groups will be needed with each pointing to another AudioCodes gateway – just the same as if PRI were being used. Step 6 Once all changes are complete, select the “Save” button to commit changes.

Figure 17 – Individual Trunk setting for Lync trunk group

After setting up the trunk groups and individual trunks, refer to the ShoreTel Planning and Installation Guide to make the appropriate changes for the User Group settings. This completes the settings for the ShoreTel system side. ShoreTel Technical Support In the event that you have problems with the ShoreTel system you may contact ShoreTel Technical Assistance Center at +1 (800) 742-2348 (Toll Free) or +1 (408) 331-3313 (International). A support contract must be in place before any assistance will be provided.

1 Configuring AudioCodes E-SBC

This section shows how to configure AudioCodes E-SBC for interworking between Microsoft Lync Server 2013 and the ShoreTel SIP Tie Trunk. These configuration procedures are based on the interoperability test topology described in Section Error! Reference source not found. on page Error! Bookmark not defined., and includes the following main areas:

E-SBC WAN interface - ShoreTel SIP Tie Trunking environment

E-SBC LAN interface - Lync Server 2013 environment

Configuration is performed using the E-SBC's embedded Web server (referred to in this document as Web interface).

Notes:

To implement Microsoft Lync and ShoreTel SIP Tie Trunk based on the configuration described in this section, AudioCodes E-SBC must be installed with a Software License Key that includes the following software features:

√ Microsoft

√ SBC

√ Security

√ DSP

√ RTP

√ SIP

For more information about the Software License Key, contact your AudioCodes sales representative.

The scope of this document does not cover security aspects for connecting the SIP Trunk to the Microsoft Lync environment. Security measures should be implemented in accordance with your organization's security policies. For basic security guidelines, refer to the Recommended Security Guidelines document.

Before you begin configuring the E-SBC, ensure that the E-SBC's Web interface navigation tree is in Advanced display mode. To do this, select the Advanced option, as shown below:

Note that when the E-SBC is reset, the navigation tree reverts to Basic menu display.

1.1 Step 1: Configure IP Network Interfaces

This step shows how to configure the E-SBC's IP network interfaces. There are several methods of deploying the E-SBC; this interoperability test topology employs the following deployment method:

E-SBC interfaces with the following IP entities:

Lync servers, located on the LAN

ShoreTel SIP Tie Trunk, located on the WAN

E-SBC connects to the WAN through a DMZ network

Physical connection: The type of physical connection to the LAN depends on the method used to connect to the enterprise's network. In the interoperability test topology, E-SBC connects to the LAN and WAN using dedicated LAN ports (i.e., two ports and two network cables are used).

E-SBC also uses two logical network interfaces:

LAN (VLAN ID 1)

WAN (VLAN ID 2)

Figure 1-1: Network Interfaces in Interoperability Test Topology

1.1.1 Step 1a: Configure VLANs

This step shows how to define VLANs for each of the following interfaces:

LAN VoIP (assigned the name "Voice")

WAN VoIP (assigned the name "Public")

To configure the VLANs:

1. Open the Ethernet Device Table page (Configuration tab > VoIP menu > Network > Ethernet Device Table).

There will be one existing row for VLAN ID 1 and underlying interface GROUP_1.

1. Add another VLAN ID 2 for the WAN side as follows:

Parameter Value

Index 1

VLAN ID 2

Underlying Interface GROUP_2 (Ethernet port group)

Name vlan 2

Figure 1-2: Configured VLAN IDs in Ethernet Device Table

1.1.2 Step 1b: Configure Network Interfaces

This step shows how to configure the IP network interfaces for each of the following interfaces:

LAN VoIP (assigned the name "Voice")

WAN VoIP (assigned the name "Public")

To configure the IP network interfaces:

1. Open the IP Interfaces Table page (Configuration tab > VoIP menu > Network > IP Interfaces Table).

2. Modify the existing LAN network interface:

a. Select the 'Index' radio button of the OAMP + Media + Control table row, and then click Edit.

b. Configure the interface as follows:

Parameter Value

IP Address 10.133.4.43 (IP address of E-SBC)

Prefix Length 16 (subnet mask in bits for 255.255.0.0)

Gateway 10.133.4.1

Interface Name Voice (arbitrary descriptive name)

Primary DNS Server IP Address 10.133.4.40

Underlying Device vlan 1

3. Add a network interface for the WAN side:

a. Enter 1, and then click Add Index.

a. Configure the interface as follows:

Parameter Value

Application Type Media + Control

IP Address 172.26.249.30 (WAN IP address)

Prefix Length 24 (for 255.255.255.0)

Gateway 172.26.249.1 (router's IP address)

Interface Name Public

Underlying Device vlan 2

4. Click Apply, and then Done.

The configured IP network interfaces are shown in the figure below:

Figure 1-3: Configured Network Interfaces in IP Interfaces Table

1.1.3 Step 1c: Configure the Native VLAN ID

This step shows how to configure the Native VLAN ID for the LAN and WAN interfaces.

To configure the Native VLAN ID for the IP network interfaces:

1. Open the Physical Ports Settings page (Configuration tab> VoIP menu > Network > Physical Ports Table).

2. For the GROUP_1 member ports, set the 'Native Vlan' field to 1. This VLAN was assigned to network interface "Voice".

3. For the GROUP_2 member ports, set the 'Native Vlan' field to 2. This VLAN was assigned to network interface "Public".

Figure 1-4: Configured Port Native VLAN

1.2 Step 2: Enable the SBC Application

This step describes how to enable the SBC application.

To enable the SBC application:

1. Open the Applications Enabling page (Configuration tab > VoIP menu > Applications Enabling > Applications Enabling).

Figure 1-5: Enabling SBC Application

2. From the 'SBC Application' drop-down list, select Enable.

3. Click Submit.

4. Reset the E-SBC with a burn to flash for this setting to take effect (see Section 1.15 on page 83).

1.3 Step 3: Configure SRDs

This step describes how to configure Signaling Routing Domains (SRDs). The SRD represents a logical VoIP network. Each logical or physical connection requires an SRD, for example, if the E-SBC interfaces with both the LAN and WAN, a different SRD is required for each.

The SRD comprises:

Media Realm: defines a UDP port range for RTP/SRTP (media) traffic on a specific logical IP network interface of the E-SBC.

SIP Interface: defines a listening port and type (UDP, TCP, or TLS) for SIP signaling traffic on a specific logical IP network interface of the E-SBC.

1.3.1 Step 3a: Configure Media Realms

This step shows how to configure Media Realms. The simplest configuration is to create two Media Realms - one for internal (LAN) traffic and one for external (WAN) traffic.

To configure Media Realms:

1. Open the Media Realm Table page (Configuration tab > VoIP menu > VoIP Network > Media Realm Table).

2. Modify the existing Media Realm for LAN traffic:

Parameter Value

Index 1

Media Realm Name MRLan (descriptive name)

IPv4 Interface Name Voice

Port Range Start 6000 (represents lowest UDP port number used for

media on LAN.)

Number of Media Session Legs 10 (media sessions assigned with port range)

Figure 1-6: Configuring Media Realm for LAN

3. Configure a Media Realm for WAN traffic:

Parameter Value

Index 2

Media Realm Name MRWan (arbitrary name)

IPv4 Interface Name Public

Port Range Start 7000 (represents the lowest UDP port number used for media on WAN. This was a requirement of certification testing)

Number of Media Session Legs 10 (media sessions assigned with port range)

Figure 1-7: Configuring Media Realm for WAN

The configured Media Realms are shown in the figure below:

Figure 1-8: Configured Media Realms in Media Realm Table

1.3.2 Step 3b: Configure SRDs

This step shows how to configure the SRDs.

To configure SRDs:

1. Open the SRD Settings page (Configuration tab > VoIP menu > VoIP Network > SRD Table).

2. Configure an SRD for the E-SBC's internal interface (toward Lync Server 2013):

Parameter Value

SRD Index 1

SRD Name LanSRD (descriptive name for SRD)

Media Realm MRLan (associates SRD with Media Realm)

Figure 1-9: Configuring LAN SRD

3. Configure an SRD for the E-SBC's external interface (toward the ShoreTel SIP Tie Trunk):

Parameter Value

SRD Index 2

SRD Name WanSRD

Media Realm MRWan

Figure 1-10: Configuring WAN SRD

1.3.3 Step 3c: Configure SIP Signaling Interfaces

This step shows how to configure SIP Interfaces. For the interoperability test topology, an internal and external SIP Interface must be configured for the E-SBC.

To configure SIP Interfaces:

1. Open the SIP Interface Table page (Configuration tab > VoIP menu > VoIP Network > SIP Interface Table).

2. Configure a SIP interface for the LAN:

Parameter Value

Index 1

Interface Name Arbitrary descriptive name

Network Interface Voice

Application Type SBC

TLS Port 5067 (recommended)

TCP Port 5068 (if TCP is used)

UDP Port 0

SRD 1

3. Configure a SIP interface for the WAN:

Parameter Value

Index 2

Interface Name Arbitrary descriptive name

Network Interface Public

Application Type SBC

UDP Port 5060

TCP and TLS 0

SRD 2

The configured SIP Interfaces are shown in the figure below:

Figure 1-11: Configured SIP Interfaces in SIP Interface Table

1.4 Step 4: Configure Proxy Sets

This step shows how to configure Proxy Sets. The Proxy Set defines the destination address (IP address or FQDN) of the IP entity server. Proxy Sets can also be used to configure load balancing between multiple servers.

For the interoperability test topology, two Proxy Sets must be configured for the following IP entities:

Microsoft Lync Server 2013

ShoreTel SIP Tie Trunk

These Proxy Sets will later be associated with IP Groups.

To configure Proxy Sets:

1. Open the Proxy Sets Table page (Configuration tab > VoIP menu > VoIP Network > Proxy Sets Table).

2. Configure a Proxy Set for Lync Server 2013:

Parameter Value

Proxy Set ID 1

Proxy Address FE15.ilync15.local:5067

(Lync Server 2013 IP address / FQDN and destination port)

Transport Type TLS

Proxy Name Arbitrary descriptive name

Enable Proxy Keep Alive Using Options

Is Proxy Hot Swap Yes

SRD Index 1

Figure 1-12: Configuring Proxy Set for Microsoft Lync Server 2013

3. Configure a Proxy Set for the ShoreTel SIP Tie Trunk:

Parameter Value

Proxy Set ID 2

Proxy Address 172.26.249.129:5060

(ShoreTel IP address / FQDN and destination port)

Transport Type UDP

Proxy Name Arbitrary descriptive name

Enable Proxy Keep Alive Using Options

SRD Index 2 (enables classification by Proxy Set for SRD of IP Group belonging to ShoreTel SIP Tie Trunk)

Figure 1-13: Configuring Proxy Set for ShoreTel SIP Tie Trunk

4. Reset the E-SBC with a burn to flash for these settings to take effect (see Section 1.15 on page 83).

1.5 Step 5: Configure IP Groups

This step shows how to configure IP Groups. The IP Group represents an IP entity on the network with which the E-SBC communicates. This can be a server (e.g., IP PBX or ITSP) or it can be a group of users (e.g., LAN IP phones). For servers, the IP Group is typically used to define the server's IP address by associating it with a Proxy Set. A typical deployment consists of multiple IP Groups associated with the same SRD. For example, you can have two LAN IP PBXs sharing the same SRD, and two ITSPs / SIP Trunks sharing the same SRD. After IP Groups are configured, they're used to configure IP-to-IP routing rules for denoting source and destination of the call.

In this interoperability test topology, IP Groups must be configured for the following IP entities:

Lync Server 2013 (Mediation Server) located on the LAN

ShoreTel SIP Tie Trunk located on the WAN

To configure IP Groups:

1. Open the IP Group Table page (Configuration tab > VoIP menu > VoIP Network > IP Group Table).

2. Configure an IP Group for the Lync Server 2013 Mediation Server:

Parameter Value

Index 1

Type Server

Description Microsoft Lync (arbitrary descriptive name)

Proxy Set ID 1

SIP Group Name 172.26.249.30 (according to ITSP requirement)

SRD 1

Media Realm Name MRLan

IP Profile ID 1

3. Configure an IP Group for the ShoreTel SIP Tie Trunk:

Parameter Value

Index 2

Type Server

Description ShoreTel Tie Trunk (arbitrary descriptive name)

Proxy Set ID 2

SIP Group Name 172.26.249.129 (according to ITSP requirement)

SRD 2

Media Realm Name MRWan

IP Profile ID 2

The configured IP Groups are shown in the figure below:

Figure 1-14: Configured IP Groups in IP Group Table

1.6 Step 6: Configure IP Profiles

This step shows how to configure IP Profiles. The IP Profile defines a set of call capabilities relating to signaling (e.g., SIP message terminations such as REFER) and media (e.g., coder and transcoding method).

In this interoperability test topology, IP Profiles must be configured for the following IP entities:

Microsoft Lync Server 2013 - to operate in secure mode using SRTP and TLS

ShoreTel SIP Tie trunk - to operate in non-secure mode using RTP and UDP

Fax supporting ATA

Note that the IP Profiles were assigned to these entities (i.e., IP Groups) in the previous step (see Section 1.5 on page 36).

To configure IP Profiles:

1. Open the IP Profile Settings page (Configuration tab > VoIP > Coders and Profiles > IP Profile Settings).

2. Click Add.

3. Click the Common tab, and then configure the parameters as follows:

Parameter Value

Index 1

Profile Name Microsoft Lync (arbitrary descriptive name)

Symmetric MKI Enable

MKI Size 1

Reset SRTP State Upon Re-key Enable

Generate SRTP keys mode: Always

Figure 1-15: Configuring IP Profile for Lync Server 2013 – Common Tab

4. Click the SBC tab, and then configure the parameters as follows:

Parameter Value

Extension Coders Group ID Coders Group 1

Transcoding Mode Force

Allowed Coders Group ID Coders Group 1

Allowed Coders Mode Restriction and Preference

Media Security Behavior SRTP

Remote Update Support Supported Only After Connect

Remote Re-Invite Support Supported Only With SDP

Remote Delayed Offer Support Not Supported

Remote Refer Behavior Handle Locally (required because Lync Server 2013 does not support receipt of SIP REFER)

Remote 3xx Behavior Handle Locally (required because Lync Server 2013 does not support receipt of SIP 3xx responses)

Enforce MKI Size Enforce

Remote Early Media RTP Behavior Delayed (required because Lync Server 2013 does not send RTP immediately to the remote side when it sends a SIP 18x response)

Figure 1-16: Configuring IP Profile for Lync Server 2013 – SBC Tab

5. Configure an IP Profile for the ShoreTel SIP Tie Trunk:

a. Click Add.

b. Click the Common tab, and then configure the parameters as follows:

Parameter Value

Index 2

Profile Name Vzn Trunk (arbitrary descriptive name)

Figure 1-17: Configuring IP Profile for ShoreTel SIP Tie Trunk – Common Tab

6. ShoreTel requires the SIP Signaling and RTP packets to be treated independently and marked with the proper settings to be delivered to the ShoreTel SIP Tie Trunking network.

7. Click the SBC tab, and then configure the parameters as follows:

Parameter Value

Profile ID 2

Extension Coders Group ID Coders Group 2

Allowed Coders Group ID Coders Group 2

Parameter Value

Allowed Coders Mode Restriction and Preference (lists Allowed Coders first and then original coders in received SDP offer)

Media Security Behavior RTP

P-Asserted-Identity Add (required for anonymous calls)

Diversion Mode Add

History-Info Mode Remove

Fax Behavior Handle on re-INVITE

Remote REFER Behavior Handle Locally (E-SBC handles / terminates incoming REFER requests instead of forwarding them to SIP Trunk)

Remote Multiple 18x Not Supported

Remote Can Play Ringback No (required because Lync Server 2013 does not provide a ring back tone for incoming calls)

Remote Hold Format Send Only

Figure 1-18: Configuring IP Profile for ShoreTel SIP Tie Trunk – SBC Tab

1.7 Step 7: Configure Coders

This step shows how to configure coders (termed Coder Group). As Lync Server 2013 supports the G.711 coder while the network connection to ShoreTel SIP Tie Trunk may restrict operation with a lower bandwidth coder such as G.729, you need to add a Coder Group with the G.729 coder for the ShoreTel SIP Tie Trunk.

Note that the Coder Group ID for this entity was assigned to its corresponding IP Profile in the previous step (see Section 1.6 on page 38).

To configure coders:

1. Open the Coder Group Settings (Configuration tab > VoIP menu > Coders and Profiles > Coders Group Settings).

2. Configure a Coder Group for Lync Server 2013:

Parameter Value

Coder Group ID 1

Coder Name G.711 U-law

G.711 A-law

Silence Suppression Enable

Figure 1-19: Configuring Coder Group for Lync Server 2013

3. Configure a Coder Group for ShoreTel SIP Tie Trunk:

Parameter Value

Coder Group ID 2

Coder Name G.729

G.711 U-law

G.711 A-law

Figure 1-20: Configuring Coder Group for ShoreTel SIP Tie Trunk

The procedure below describes how to configure an Allowed Coders Group to ensure that voice sent to the ShoreTel SIP Tie Trunk uses the G.729 coder whenever possible. Note that this Allowed Coders Group ID was assigned to the IP Profile belonging to the ShoreTel SIP Tie Trunk in the previous step (see Section 1.6 on page 38).

To set a preferred coder for Microsoft Lync:

1. Open the Allowed Coders Group page (Configuration tab > VoIP menu > SBC > Allowed Coders Group).

2. Configure an Allowed Coder as follows:

Parameter Value

Allowed Coders Group ID 1

Coder Name G.711 U-law

G.711 A-law

Figure 1-21: Configuring Allowed Coders Group for Microsoft Lync

3. Configure an Allowed Coder as follows:

Parameter Value

Allowed Coders Group ID 2

Coder Name G.729

G.711 U-law

G.711 A-law

Figure 1-22: Configuring Allowed Coders Group for ShoreTel SIP Tie Trunk

4. Open the General Settings page (Configuration tab > VoIP menu > SBC > General Settings).

Figure 1-23: SBC Preferences Mode

5. From the 'Preferences Mode' drop-down list, select Include Extensions.

6. Click Submit.

1.8 Step 8: Configure a SIP TLS Connection

This section shows how to configure the E-SBC for using a TLS connection with the Lync Server 2013 Mediation Server. This is essential for a secure SIP TLS connection.

1.8.1 Step 8a: Configure the NTP Server Address

This step shows how to configure the NTP server's IP address. It is recommended to implement an NTP server (Microsoft NTP server or a third-party server) to ensure that the E-SBC receives the accurate and current date and time. This is necessary for validating certificates of remote parties.

To configure the NTP server address:

1. Open the Application Settings page (Configuration tab > System > Application Settings).

2. In the 'NTP Server IP Address' field, enter the IP address of the NTP server (e.g., 10.1.1.11).

Figure 1-24: Configuring NTP Server Address

3. Click Submit.

1.8.2 Step 8b: Configure a Certificate

This step shows how to exchange a certificate with Microsoft Certificate Authority (CA). The certificate is used by the E-SBC to authenticate the connection with Lync Server 2013.

Follow these main steps:

a. Generate a Certificate Signing Request (CSR).

b. Request a Device Certificate from CA.

c. Obtain a Trusted Root Certificate from CA.

d. Deploy Device and Trusted Root Certificates on the E-SBC.

To configure a certificate:

1. Open the Certificates page (Configuration tab > System > Certificates).

Figure 1-25: Certificates Page - Creating CSR

2. In the 'Subject Name' field, enter the media gateway name (e.g., ITSP-GW.ilync15.local).

Note: The value entered in this field must be identical to the gateway name configured in the Topology Builder for Lync Server 2013 (see Section 0 on page 84.

3. Click Create CSR; a certificate request is generated.

4. Copy the CSR from the line "----BEGIN CERTIFICATE" to "END CERTIFICATE REQUEST----" to a text file (such as Notepad), and then save it to a folder on your computer with the file name certreq.txt.

5. Open a Web browser and navigate to the Microsoft Certificates Services Web site at http://<certificate server>/CertSrv.

Figure 1-26: Microsoft Certificate Services Web Page

6. Click Request a certificate.

Figure 1-27: Request a Certificate Page

7. Click advanced certificate request, and then click Next.

Figure 1-28: Advanced Certificate Request Page

8. Click Submit a certificate request ..., and then click Next.

Figure 1-29: Submit a Certificate Request or Renewal Request Page

9. Open the certreq.txt file that you created and saved in Step 4, and then copy its contents to the 'Saved Request' field.

10. From the 'Certificate Template' drop-down list, select Web Server.

11. Click Submit.

Figure 1-30: Certificate Issued Page

12. Select the Base 64 encoded option for encoding, and then click Download certificate.

13. Save the file as gateway.cer to a folder on your computer.

14. Click the Home button or navigate to the certificate server at http://<Certificate Server>/CertSrv.

15. Click Download a CA certificate, certificate chain, or CRL.

Figure 1-31: Download a CA Certificate, Certificate Chain, or CRL Page

16. Under the 'Encoding method' group, select the Base 64 option for encoding.

17. Click Download CA certificate.

18. Save the file as certroot.cer to a folder on your computer.

19. In the E-SBC's Web interface, return to the Certificates page and do the following:

a. In the 'Device Certificate' field, click Browse and select the gateway.cer certificate file that you saved on your computer in Step 13, and then click Send File to upload the certificate to the E-SBC.

b. In the 'Trusted Root Certificate Store' field, click Browse and select the certroot.cer certificate file that you saved on your computer in Step 18, and then click Send File to upload the certificate to the E-SBC.

Figure 1-32: Certificates Page (Uploading Certificate)

20. Reset the E-SBC with a burn to flash for your settings to take effect (see Section 1.15 on page 83).

1.9 Step 9: Configure SRTP

This step shows how to configure media security. If you configure the Microsoft Mediation Server to use SRTP, you must configure the E-SBC to operate in the same manner. Note that SRTP was enabled for Lync Server 2013 when you configured an IP Profile for Lync Server 2013 (see Section 1.6 on page 38).

To configure media security:

1. Open the Media Security page (Configuration tab > Media menu > Media Security).

2. Configure the parameters as follows:

Parameter Value

Media Security Enable

Figure 1-33: Configuring SRTP

3. Click Submit.


1.10 Step 10: Configure Maximum IP Media Channels

This step shows how to configure the maximum number of required IP media channels. The number of media channels represents the number of DSP channels that the E-SBC allocates to call sessions.

Note: This step is required only if transcoding is required.

To configure the maximum number of IP media channels:

1. Open the IP Media Settings page (Configuration tab > VoIP menu > IP Media > IP Media Settings).

Figure 1-34: Configuring Number of IP Media Channels

2. In the 'Number of Media Channels' field, enter the number of media channels according to your environments transcoding calls (e.g., 30).

3. Click Submit.


1.11 Step 11: Configure IP-to-IP Call Routing Rules

This step shows how to configure IP-to-IP call routing rules. These rules define the routes for forwarding SIP messages (e.g., INVITE) received from one IP entity to another. The E-SBC selects the rule whose configured input characteristics (e.g., IP Group) match those of the incoming SIP message. If the input characteristics do not match the first rule in the table, they are compared to the second rule, and so on, until a matching rule is located. If no rule is matched, the message is rejected. The routing rules use the configured IP Groups to denote the source and destination of the call. As configured in Section 1.5 on page 36, IP Group 1 represents Lync Server 2013, and IP Group 2 represents ShoreTel SIP Tie Trunk.

For the interoperability test topology, the following IP-to-IP routing rules must be configured to route calls between Lync Server 2013 (LAN) and ShoreTel SIP Tie Trunk (WAN):

Terminate SIP OPTIONS messages on the E-SBC that are received from the LAN

Calls from Lync Server 2013 to ShoreTel SIP Tie Trunk

Calls from ShoreTel SIP Tie Trunk to Lync Server 2013

To configure IP-to-IP routing rules:

1. Open the IP-to-IP Routing Table page (Configuration tab > VoIP menu > SBC > Routing SBC > IP-to-IP Routing Table).

2. Configure a rule to terminate SIP OPTIONS messages received from the LAN:

a. Click Add.

b. Click the Rule tab, and then configure the parameters as follows:

Parameter Value

Index 0

Request Type OPTIONS

Destination Type Dest Address

Destination Address internal

Figure 1-35: Configuring IP-to-IP Routing Rule for Terminating SIP OPTIONS from LAN – Rule Tab

3. Click the Action tab, and then configure the parameters as follows:

Parameter Value

Destination Type Dest Address

Destination Address internal

Figure 1-36: Configuring IP-to-IP Routing Rule for Terminating SIP OPTIONS – Action Tab

4. Click the Submit button.

5. Configure a rule to route calls from Lync Server 2013 to ShoreTel SIP Tie Trunk:

a. Click Add.


Parameter Value

Index 1

Route Name Arbitrary descriptive name

Source IP Group ID 1

Figure 1-37: Configuring IP-to-IP Routing Rule for Lync to ITSP – Rule tab


Parameter Value

Destination Type IP Group

Destination IP Group ID 2

Destination SRD ID 2

Figure 1-38: Configuring IP-to-IP Routing Rule for Lync to ITSP – Action tab


8. Configure a rule to route calls from ShoreTel SIP Tie Trunk to Lync Server 2013:

a. Click Add.


Parameter Value

Index 3

Route Name Arbitrary descriptive name

Source IP Group ID 2

Figure 1-39: Configuring IP-to-IP Routing Rule for ITSP to Lync – Rule tab


Parameter Value

Destination Type IP Group

Destination IP Group ID 1

Destination SRD ID 1

Figure 1-40: Configuring IP-to-IP Routing Rule for ITSP to Lync – Action tab


The configured routing rules are shown in the figure below:

Figure 1-41: Configured IP-to-IP Routing Rules in IP-to-IP Routing Table

Note: The routing configuration may change according to your specific deployment topology.

1.12 Step 12: Configure IP-to-IP Manipulation Rules

This step shows how to configure IP-to-IP manipulation rules. These rules manipulate the source and / or destination number. The manipulation rules use the configured IP Groups to denote the source and destination of the call. As configured in Section 1.5 on page 36, IP Group 1 represents Lync Server 2013, and IP Group 2 represents ShoreTel SIP Tie Trunk. These manipulations can be utilized on the incoming message and/or the outgoing message.

Note: Adapt the manipulation table according to your environment's dial plan.

For this interoperability test topology, a set of normalization manipulation rules are configured to remove the ‘+1’ from the Source and Destination numbers presented by Microsoft Lync. These were performed in the IP-to-IP Inbound manipulation rules. While using a set of IP-to-IP Outbound manipulation rules, add the "+" (plus sign) to the destination number for calls from IP Group 2 (ShoreTel SIP Tie Trunk) to IP Group 1 (i.e., Lync Server 2013) for any destination username prefix.

To configure a number manipulation rule:

1. Open the IP-to-IP Outbound Manipulation page (Configuration tab > VoIP menu > SBC > Manipulations SBC > IP-to-IP Inbound).

2. Click Add.

3. Click the Rule tab, and then configure the parameters as follows:

Parameter Value

Index 1

Source IP Group 1

Source Username Prefix +1

Destination Username Prefix * (asterisk sign)

Manipulated URI Source

Figure 1-42: Configuring IP-to-IP Outbound Manipulation Rule – Rule Tab


Parameter Value

Remove From Left 2 (this removes the ‘+1’)

Figure 1-43: Configuring IP-to-IP Outbound Manipulation Rule - Action Tab

5. Click Submit.

6. Click Add.


Parameter Value

Index 2

Source IP Group 1

Source Username Prefix * (asterisk sign)

Destination Username Prefix +1

Manipulation URI Destination



Parameter Value

Remove From Left 2 (this removes the ‘+1’)


9. Click Submit.

The figure below shows an example of configured IP-to-IP inbound manipulation rules for calls from IP Group 1 (i.e., Lync Server 2013):

Figure 1-46: Example of Configured IP-to-IP Inbound Manipulation Rules

Rule Index Description

1 Calls from IP Group 1 with a source number that contains a prefix of ‘+1’ and with any destination number (*), remove the "+1" from the prefix of the source number.

2 Calls from IP Group 1 with a destination number that contains a prefix of ‘+1’, remove "+1" from the destination number.

To configure an IP-to-IP Outbound number manipulation rule:

1. Open the IP-to-IP Outbound Manipulation page (Configuration tab > VoIP menu > SBC > Manipulations SBC > IP-to-IP Outbound).

2. Click Add.


Parameter Value

Index 0

Source IP Group 2

Destination IP Group 1




Parameter Value

Manipulated Item Destination URI

Prefix to Add +1 (plus sign)


5. Click Submit.

6. Click Add.


Parameter Value

Index 1

Source IP Group 1

Destination IP Group 2




Parameter Value

Manipulated Item Source URI

Privacy Restriction Mode Remove Restriction


9. Click Submit.

The figure below shows an example of configured IP-to-IP outbound manipulation rules for calls between IP Group 1 (i.e., Lync Server 2013) and IP Group 2 (i.e., ShoreTel SIP Tie Trunk):

Figure 1-51: Example of Configured IP-to-IP Outbound Manipulation Rules

Rule Index Description

0 Calls from IP Group 2 to IP Group 1 with any destination number (*), add "+1" to the prefix of the destination number.

1 Calls from IP Group 1 to IP Group 2 change the Privacy Restriction to allow presentation.

1.13 Step 13: Configure Message Manipulation Rules

This step shows how to configure SIP message manipulation rules. SIP message manipulation rules can include insertion, removal, and/or modification of SIP headers. Manipulation rules are grouped into Manipulation Sets, enabling you to apply multiple rules to the same SIP message (IP entity).

After configuring SIP message manipulation rules, you must assign them to the relevant IP Group (in the IP Group table) and determine whether they must be applied to inbound or outbound messages.

To configure a SIP message manipulation rule:

1. Open the Message Manipulations page (Configuration tab > VoIP menu > SIP Definitions > Msg Policy & Manipulation > Message Manipulations).

2. Select Add +

3. Configure a new manipulation rule (Manipulation Set 3) for ShoreTel SIP Tie Trunk. This rule applies to messages being sent to the ShoreTel SIP Tie trunk (IP Group 2), calls initiated by the Lync Server 2013 (IP Group 1) which contain a long PAI. The SBC separates the P-Asserted Identity header into 2 separate PAI headers. This removes the second P-Asserted Identity header on the outgoing message towards the ShoreTel SIP Tie Trunk.

Parameter Value

Index 0

Manipulation Name Arbitrary descriptive name

Manipulation Set ID 1

Action Subject header.P-Asserted-Identity.1

Action Type Remove

Figure 1-52: Configuring SIP Message Manipulation Rule 0 (for ShoreTel SIP Tie Trunk)

4. Select Add +

5. Configure a new manipulation rule (Manipulation Set 3) for ShoreTel SIP Tie Trunk. This rule applies to messages being sent to the ShoreTel SIP Tie trunk (IP Group 2), for calls initiated by the Lync Server 2013 (IP Group 1) with the url type of ‘Tel” rather than ‘Sip’. This converts the header type for proper interworking towards the ShoreTel SIP Tie Trunk.

Parameter Value

Index 1



Message Type invite

Action Subject header.P-Asserted-Identity.url.type

Action Type Modify

Action Value ‘1’



7. Select Add +

8. Configure a new manipulation rule (Manipulation Set 3) for ShoreTel SIP Tie Trunk. This rule applies to messages being sent to the ShoreTel SIP Tie trunk (IP Group 2), for PSTN originated call being forwarded back to the PSTN initiated by the Lync Server 2013 (IP Group 1). This removes a prefix Action Value containing ‘+1’ from the Diversion header, causing the E-SBC to manipulate the Diversion Header towards the SIP Trunk.

Parameter Value

Index 2



Message Type Invite

Condition header.diversion exists

Action Subject header.diversion.url.user

Action Type Remove Prefix

Action Value ‘+1’



10. Select Add +

11. Configure a new manipulation rule as a continuation rule to the previous rule (Manipulation Set 3) for ShoreTel SIP Tie Trunk. This rule applies only if the previous rule was applied. This modifies an Action Value to change the URL host of the outgoing Diversion header to reflect that of the E-SBC host towards the SIP Trunk.

Parameter Value

Index 3



Action Subject header.diversion.url.host

Action Type Modify

Action Value 172.26.249.30'

Row Rule User Previous Condition



Figure 1-56 shows an example of configured SIP Message Manipulation rules.

Figure 1-56: Example of Configured SIP Message Manipulation Rules

The table below includes SIP message manipulation rules which are bound together by commonality via the Manipulation Set IDs which are executed for messages sent to the ShoreTel SIP Tie Trunk (IP Group 2). These rules are specifically required to enable correct interworking between ShoreTel SIP Tie Trunk and Lync Server 2013. The specific items are needed to support the interoperability. Refer to the User’s Manual for further details concerning the full capabilities of header manipulation.

Rule Index

Reason Description

0 Removal of second PAI Microsoft Lync 2013 sends a long P-Asserted-Identity which the E-SBC changes into two separate PAI headers. This rule is utilized to remove the second PAI.

1 PAI header URL type to SIP This rule is utilized to change the URL type from ‘TEL’ to ‘SIP’ for the P-Asserted-Identity Header.

2 Remove ‘+1’ prefix from Diversion header

If a Diversion Header exists within an Invite message, the following rule removes prefix ‘+1’ from the User part in Diversion Header if it is found to have this.

3 Set the URL host of the Diversion header to that of the E-SBC WAN

Rule replaces Host part in Diversion Header with value of the WAN address of the E-SBC that is recognized by the ShoreTel SIP Tie Trunk. To perform this rule; manipulation rule 2 must first be utilized for the ShoreTel SIP Tie Trunk.

13. Assign Manipulation Set IDs 3 to IP Group 2:

a. Open the IP Group Table page (Configuration tab > VoIP menu > VoIP Network > IP Group Table).

b. Select the row of IP Group 2, and then click Edit.

c. Click the SBC tab.

d. Set the 'Outbound Message Manipulation Set' field to 1.

Figure 1-57: Assigning Manipulation Set to IP Group 2

e. Click the Submit button.

1.14 Step 14: Configure Miscellaneous E-SBC Settings

This section shows how to configure miscellaneous E-SBC settings.

1.14.1 Step 14a: Configure Call Forking Mode

This step shows how to configure the E-SBC's handling of SIP 18x responses received for call forking of INVITE messages. For the interoperability test topology, if 18x with SDP is received, the E-SBC opens a voice stream according to the received SDP. The E-SBC reopens the stream according to subsequently received 18x responses with SDP, or plays a ringback tone if a 180 response without SDP is received. It's mandatory to set this field for the Lync Server 2013 environment.

To configure call forking:

1. Open the General Settings page (Configuration tab > VoIP menu > SBC > General Settings).

2. From the 'SBC Forking Handling Mode' drop-down list, select Sequential.

Figure 1-58: Configuring Forking Mode

3. Click Submit.

1.15 Step 15: Reset the E-SBC

After completing configuration of the E-SBC, save ("burn") the configuration to the E-SBC's flash memory with a reset for the settings to take effect.

To save the configuration to flash memory:

1. Open the Maintenance Actions page (Maintenance tab > Maintenance menu > Maintenance Actions).

Figure 1-59: Resetting the E-SBC

2. Ensure that the 'Burn to FLASH' field is set to Yes (default).

3. Click the Reset button.

Configuring Lync Server 2013

This section describes how to configure Microsoft Lync Server 2013 to operate with AudioCodes E-SBC.

Note: Dial plans, voice policies, and PSTN uses are also necessary for enterprise voice deployment but are beyond the scope of this document.

Configuring the E-SBC as an IP / PSTN Gateway

The procedure below describes how to configure the E-SBC as an IP / PSTN Gateway.

To configure E-SBC as IP/PSTN Gateway and associate it with Mediation Server:

4. On the server where the Topology Builder is installed, start the Lync Server 2013 Topology Builder (Windows Start menu > All Programs > Lync Server Topology Builder), as shown below:

Figure 0-1: Starting the Lync Server Topology Builder

The following is displayed:

Figure 0-2: Topology Builder Dialog Box

5. Select the Download Topology from existing deployment option, and then click OK; you are prompted to save the downloaded Topology:

Figure 0-3: Save Topology Dialog Box

6. Enter a name for the Topology file, and then click Save. This step enables you to roll back from any changes you make during the installation.

The Topology Builder screen with the downloaded Topology is displayed:

Figure 0-4: Downloaded Topology

7. Under the Shared Components node, right-click the PSTN gateways node, and then from the shortcut menu, choose New IP/PSTN Gateway, as shown below:

Figure 0-5: Choosing New IP/PSTN Gateway


Figure 0-6: Define the PSTN Gateway FQDN

8. Enter the Fully Qualified Domain Name (FQDN) of the E-SBC (e.g., ITSP-GW.ilync15.local). Update this FQDN in the relevant DNS record, and then click Next; the following is displayed:

Figure 0-7: Define the IP Address

9. Define the listening mode (IPv4 or IPv6) of the IP address of your new PSTN gateway, and

then click Next.

10. Define a root trunk for the PSTN gateway. A trunk is a logical connection between the Mediation Server and a gateway uniquely identified by the following combination: Mediation Server FQDN, Mediation Server listening port (TLS or TCP), gateway IP and FQDN, and gateway listening port.

Note:

When defining a PSTN gateway in Topology Builder, you must define a root trunk to successfully add the PSTN gateway to your topology.

The root trunk cannot be removed until the associated PSTN gateway is removed.

Figure 0-8: Define the Root Trunk

f. In the 'Listening Port for IP/PSTN Gateway' field, enter the listening port that the E-SBC will use for SIP messages from the Mediation Server that will be associated with the root trunk of the PSTN gateway (e.g., 5067).

g. In the 'SIP Transport Protocol' field, select the transport type (e.g., TLS) that the trunk uses.

h. In the 'Associated Mediation Server' field, select the Mediation Server pool to associate with the root trunk of this PSTN gateway.

i. In the 'Associated Mediation Server Port' field, enter the listening port that the Mediation Server will use for SIP messages from the SBC (e.g., 5067).

j. Click Finish.

The E-SBC is added as a PSTN gateway, and a trunk is created as shown below:

Figure 0-9: E-SBC added as IP/PSTN Gateway and Trunk Created

11. Publish the Topology: In the main tree, select the root node Lync Server, and then from the Action menu, choose Publish Topology, as shown below:

Figure 0-10: Choosing Publish Topology


Figure 0-11: Publish the Topology

12. Click Next; the Topology Builder starts to publish your topology, as shown below:

Figure 0-12: Publishing in Progress

13. Wait until the publishing topology process completes successfully, as shown below:

Figure 0-13: Publishing Wizard Complete

14. Click Finish.

Configuring the "Route" on Lync Server 2013

This section shows how to configure a "Route" on the Lync Server 2013, and to associate it with the E-SBC PSTN gateway.

To configure the "route" on Lync Server 2013:

16. Start the Microsoft Lync Server 2013 Control Panel (Start > All Programs > Microsoft Lync Server 2013 > Lync Server Control Panel), as shown below:

Figure 0-14: Opening the Lync Server Control Panel

You're prompted to enter your login credentials:

Figure 0-15: Lync Server Credentials

17. Enter your domain username and password, and then click OK; the Microsoft Lync Server 2013 Control Panel is displayed:

Figure 0-16: Microsoft Lync Server 2013 Control Panel

18. In the left navigation pane, select Voice Routing.

Figure 0-17: Voice Routing Page

19. In the Voice Routing page, select the Route tab.

Figure 0-18: Route Tab

20. Click New; the New Voice Route page appears:

Figure 0-19: Adding New Voice Route

21. In the 'Name' field, enter a name for this route (e.g., SIP Trunk Route).

22. In the 'Starting digits for numbers that you want to allow' field, enter the starting digits you want this route to handle (e.g., * to match all numbers), and then click Add.

Figure 0-20: Adding New Trunk

23. Associate the route with the E-SBC Trunk that you created:

k. Under the 'Associated Trunks' group, click Add; a list of all the deployed gateways is displayed:

Figure 0-21: List of Deployed Trunks

l. Select the E-SBC Trunk you created, and then click OK; the trunk is added to the 'Associated Trunks' group list:

Figure 0-22: Selected E-SBC Trunk

24. Associate a PSTN Usage with this route:

m. Under the 'Associated PSTN Usages' group, click Select and then add the associated PSTN Usage.

Figure 0-23: Associating PSTN Usage with the Route

25. Click OK (located on the top of the New Voice Route page); the New Voice Route (Uncommitted) is displayed:

Figure 0-24: Confirmation of New Voice Route

26. From the Commit drop-down list, choose Commit all, as shown below:

Figure 0-25: Committing Voice Routes

The Uncommitted Voice Configuration Settings page appears:

Figure 0-26: Uncommitted Voice Configuration Settings

27. Click Commit; a message is displayed confirming a successful voice routing configuration, as shown below:

Figure 0-27: Confirmation of Successful Voice Routing Configuration

Click Close; the new committed Route is displayed in the Voice Routing page, as shown below:

Figure 0-28: Voice Routing Screen Displaying Committed Routes

28. For ITSPs that implement a call identifier, continue with the steps below.

Note: The SIP History-Info header provides a method to verify the identity (ID) of the call forwarder (i.e., the Lync user number). This ID is required by ShoreTel SIP Tie Trunk in the Diversion header. Using the IP Profile settings assigned to the ShoreTel SIP Tie Trunk (see Section 1.13 on page 75), the device adds this ID to an added Diversion header in the sent INVITE message while removing the History-Info header on the ShoreTel side of the call session.

n. In the Voice Routing page, select the Trunk Configuration tab. Note that you can add and modify trunk configuration by site or by pool.

Figure 0-29: Voice Routing Screen – Trunk Configuration Tab

o. Click Edit; the Edit Trunk Configuration page appears:

Figure 0-30: Edit Trunk Configuration

p. Select the Enable forward call history option, and then click OK.

q. Repeat Steps 11 through 13 to commit your settings.

integrating shoretel with microsoft lync via audiocodes ip

Documents