BroadSoft Partner Configuration Guide Aastra Clearspan TM April 2011 Document Version 1.4 2811 Internet Blvd. Frisco, TX 75034, U.S.A Tel: 469-365-3237 Fax: 469-365-3071 WWW.AASTRA.COM
BroadWorks Guide Copyright Notice 2008 Aastra Technologies Limited. All product information is subject to change without notice. All rights reserved. Trademarks BroadWorks and BroadWorks Assistant Enterprise, BroadWorks Assistant Mobile, BroadWorks Call Center, BroadWorks Communicator, BroadWorks Receptionist, and BroadWorks Deployment Studio are trademarks of BroadSoft, Inc. Microsoft, MSN, Windows, and the Windows logo are registered trademarks of Microsoft Corporation. Other product names mentioned in this document may be trademarks or registered trademarks of their respective companies and are hereby acknowledged. This document is printed in the United States of America. 2008 AASTRA. PAGE 2 OF 30
Document Revision History Version Reason for Change 1.1 Introduced document for Clearspan version Release 14.sp2 testing with BroadWorks Release 14.sp5. 1.2 Edited and published document. 1.3 Updated document format. 1.4 Edited and published document. 2008 AASTRA. PAGE 3 OF 30
Table of Contents 1 Overview... 5 2 Interoperability Status... 7 2.1 Verified Versions... 7 2.2 Interface Capabilities Supported... 7 2.3 Known Issues... 9 3 Solution Configuration... 11 4 BroadWorks Configuration... 12 4.1 BroadWorks Device Profile Configuration... 12 4.2 BroadWorks Configuration Steps... 13 5 Aastra Clearspan Configuration... 14 5.1 Subscriber Level Configuration Parameters... 14 5.2 System Level Configuration... 18 Appendix A: Sample Clearspan Configuration Files... 28 System Configuration... 28 Phone Configuration... 29 References... 30 2008 AASTRA. PAGE 4 OF 30
Table of Figures Figure 1 Clearspan Configuration Setup as an IP-PBX... 11 Figure 2 Add User... 15 Figure 3 Assign Phone Number, Extension, Identity/Device Profile, and Line/Port... 15 Figure 4 Assign Services... 16 Figure 5 Define SIP Authentication s User ID and Password... 17 Figure 6 Configuring the Device... 18 Figure 7 Set up Incoming Routes/Calls from the Clearspan SSM to the Clearspan s Subscribers... 21 Figure 8 Set up Incoming Routes/Calls from External to the Clearspan s Application Server... 22 Figure 9 Set up the Network Routes between the Clearspan s SSM and BroadWorks... 25 Figure 10 Configure a Dial Plan on the Clearspan SSM having an IP Address of 10.70.100.14... 26 Figure 11 Configure VSP/Dial-Plan/Source Route from the BroadWorks SBC... 27 Figure 12 System Configuration... 28 2008 AASTRA. PAGE 5 OF 30
1 Overview This document describes the configuration procedures required for Aastra Clearspan TM to make full use of the capabilities of BroadWorks. The Clearspan uses the Session Initiation Protocol (SIP) to communicate with BroadWorks for call control. This guide describes the specific configuration items that are important for use with BroadWorks. It does not describe the purpose and use of all configuration items on Clearspan. For those details, contact Aastra to obtain the following documents: Clearspan Application Server Enterprise Web Interface Admin Guide [1]. Clearspan Application Server Group Web Interface Admin Guide Part 1 [2]. Clearspan Application Server Group Web Interface Admin Guide Part 2 [3] In addition, BroadSoft Partner Configuration Guide Eclipse CXC Series [4] could be used as a reference for Clearspan s SIP Session Manager (SSM). 2008 AASTRA. PAGE 6 OF 30
2 Interoperability Status This section provides the known interoperability status of the Aastra Clearspan with BroadWorks. This includes the version(s) tested, capabilities supported and known issues. Interoperability testing validates that the device interfaces properly with BroadWorks via the SIP interface. Qualitative aspects of the device or device capabilities not affecting the SIP interface such as display features, performance, and audio qualities are not covered by interoperability testing. Requests for information and/or issues regarding these aspects should be directed to Aastra 2.1 Verified Versions The following table identifies the verified the Aastra Clearspan and BroadWorks versions and the month/year the testing occurred. If the device has undergone more than one test cycle, versions for each test cycle are listed, with the most recent listed first. Compatible Versions in the following table identify specific Clearspan versions which the partner has identified as compatible and should interface properly with BroadWorks. Generally, maintenance releases of the validated version are considered compatible and may not be specifically listed here. Contact Aastra for any questions concerning maintenance and compatible releases. NOTE: Interoperability testing is normally performed with the latest generally available (GA) device firmware/software and the latest GA BroadWorks release and service pack at the time the testing occurs. If there is a need to use a non-verified mix of BroadWorks and device software versions, customers can mitigate their risk by self-testing the combination using the BroadWorks IP-PBX/PBX Trunking Interoperability Test Plan [9]. Verified Versions Table Date (mm/yyyy) BroadWorks Release Aastra Clearspan Verified Version Aastra Clearspan Compatible Versions 07/2008 Release 14.sp5 Release 14.sp2 Any maintenance release of the verified revisions. 2.2 Interface Capabilities Supported The Aastra Clearspan has completed interoperability testing with BroadWorks using the BroadWorks IP-PBX/PBX Trunking Interoperability Test Plan [9]. The results are summarized in the following table. The BroadWorks test plan is composed of packages, each covering distinct interoperability areas, such as Basic call scenarios and Redundancy scenarios. Each package is composed of one or more test items which in turn are composed of one or more test cases. The test plan exercises the SIP interface between the device and BroadWorks with the intent to ensure interoperability sufficient to support the BroadWorks feature set. 2008 AASTRA. PAGE 7 OF 30
The Supported column in the following table identifies the Aastra Clearspan s support for each of the items covered in the test plan packages, with the following designations: Test item is supported. No Test item is not supported. NA Test item is not applicable to the device type. NT Test item was not tested. Caveats or clarifications are identified in the Comments column. Note that DUT in the following table refers to the Device Under Test which in this case is the Aastra Clearspan. BroadWorks IP-PBX/PBX Trunking Interoperability Test Plan Support Table Test Plan Package Test Plan Package Items Supported Comments Basic Call Origination Call Termination Session Audit Session Timer Ringback Forked Dialog Early UPDATE Early-Session No No 181 Call Being Forwarded NT Dial Plan DTMF Inband DTMF RFC 2833 DTMF DTMF Relay Codec Negotiation Codec Renegotiation NT SIP Connect Trunk Registration No PBX Redirect Calling Line ID and Privacy E.164 Numbering BroadWorks Services Voice Message Deposit/Retrieval NT Message Waiting Indicator Diversion Header History-Info Header Enterprise Trunking - OTG Enterprise Trunking - DTG Enterprise Trunking - TGRP NT NT NT NT NT NT 2008 AASTRA. PAGE 8 OF 30
BroadWorks IP-PBX/PBX Trunking Interoperability Test Plan Support Table Test Plan Package Test Plan Package Items Supported Comments DUT Services Call Control Services DUT Services Registration and Authentication Advice of Charge Meet-Me Conferencing Call Waiting Call Hold Call Transfer Three-Way Call Register Authentication Maximum Registration Minimum Registration Invite Authentication Re-Invite/Update Authentication Refer Authentication Device Authenticating BroadWorks NT NT No No No NT NT NT NT DUT Services Fax G711 Fax Passthrough G711 Fax Fallback T38 Fax Messaging SBC/ALG Register No Outgoing Invite Incoming Invite TCP Register No Outgoing Invite Incoming Invite 2.3 Known Issues This section lists the known interoperability issues between BroadWorks and specific partner release(s). Issues identified during interoperability testing and known issues identified in the field are listed. The following table provides a description of each issue and, where possible, identifies a workaround. The verified partner device versions are listed with an X indicating that the issue occurs in the specific release. The issues identified are device deficiencies or bugs, so typically not BroadWorks release dependent. The Issue Number is a BroadSoft ExtraView partner issue number if the testing was performed by BroadSoft. If the testing was performed by the partner or a third party, the partner may or may not supply a tracking number. For more information on any issues related to the particular partner device release, see the partner release notes. 2008 AASTRA. PAGE 9 OF 30
Issue Number Issue Description Partner Version R14.SP2 No issues identified. 2008 AASTRA. PAGE 10 OF 30
3 Solution Configuration The following diagram shows an example of a typical deployment configuration with Clearspan. Typically, Clearspan is placed on the customer premises and resides on a private network. SIP endpoints register to Clearspan, which includes an SBC for network routing, NAT traversal and security. Clearspan is identified as a BroadWorks PBX Classification Type D. Refer to the BroadWorks Business Trunking Configuration Guide [7] for PBX classification descriptions. Refer to the SIP Trunking configuration table in Partner Configuration Guide Acme Packet Session Director [8] to determine how to configure Acme Packet for this PBX classification type. Figure 1 Clearspan Configuration Setup as an IP-PBX The following subsections will describe how to configure Clearspan to support the configuration shown in the above diagram. The configuration examples will refer to data in the diagram. 2008 AASTRA. PAGE 11 OF 30
4 BroadWorks Configuration This section identifies the required BroadWorks device profile for the Aastra Clearspan as well as any other unique BroadWorks configuration required for interoperability with the Clearspan. 4.1 BroadWorks Device Profile Configuration This section identifies the device profile to use when deploying the Aastra Clearspan with BroadWorks. The following table identifies the required BroadWorks device identity/profile settings for interoperability between the Clearspan and BroadWorks. For an explanation of the profile parameters, refer to the BroadWorks Device Management Configuration Guide [5]. For most of the following parameters, an X indicates the parameter function is supported and/or required. If the item is blank, it is not supported. For items where text is supplied, the text content maps directly to the web page for adding or modifying a device profile. Aastra Clearspan Identity/Device Profile Signaling Address Type Number of Ports Ringback Tone/Early Media Support Authentication Intelligent Device Addressing Standard Options Unlimited RTP - Session Enabled Registration Capable Static Registration Capable X E.164 Capable Trusted Authenticate REFER RFC 3264 Hold X Video Capable Use History-Info Header Advanced Options Route Advance Wireless Integration PBX Integration X Add P-Called-Party-ID Auto Configuration Soft Client Requires BroadWorks Call Waiting Tone Advice of Charge Capable Forwarding Override 2008 AASTRA. PAGE 12 OF 30
Aastra Clearspan Identity/Device Profile Conference Device Music On Hold Device Requires BroadWorks Digit Collection Requires MWI Subscription Support Call Center MIME Type Reset Event Trunk Mode Not Supported User Auto Configuration Options Web Based Configuration URL Extension Auto Configuration Type Not Supported Enable Monitoring CPE System File Name Device File Format 4.2 BroadWorks Configuration Steps There are no additional BroadWorks configuration steps required. 2008 AASTRA. PAGE 13 OF 30
5 Aastra Clearspan Configuration The capabilities of Clearspan have been verified for use with BroadWorks based on the settings described in the following sections. For more information on the meaning, purpose, and applicability of the individual configuration items, sees references [1], [2], and [4]. 5.1 Subscriber Level Configuration Parameters This section describes subscriber configuration items that are generally required for each Clearspan to work with BroadWorks. System-specific settings are described in the following section. Step Descriptions Details Step 1 Add user. Use Clearspan s web interface to add a user. A user profile is created. Step 2 Assign phone number, extension, identity/device profile, and line/port. Open the Profile/Addresses menu of a user device to assign a phone number and extension. The phone and extension number must be unique and should be matched with one of the defined Trunk Group subscribers in the BroadWorks database. Define and assign the Identity/Device Profile to the user device, including its unique Line/Port assignment. Step 3 Assign services. Click on the Profile/Assign Services menu to open and assign the required services. Step 4 Step 5 Define SIP Authentication s user ID and password. Configure the device. Open the Utilities/Authentication menu to define the user ID and password. Configure an end-user device (for example, a SIP phone) using the parameters defined in Steps 1-4. The Aastra SIP phone can be configured manually or its configuration file can be downloaded to the device via a TFTP server. Aastra also supports bulk provisioning for multiple Aastra SIP phones using the TFTP method. 2008 AASTRA. PAGE 14 OF 30
Step 1: Add User Figure 2 Add User Step 2: Assign Phone Number, Extension, Identity/Device Profile, and Line/Port Figure 3 Assign Phone Number, Extension, Identity/Device Profile, and Line/Port 2008 AASTRA. PAGE 15 OF 30
Step 3: Assign Services Figure 4 Assign Services 2008 AASTRA. PAGE 16 OF 30
Step 4: Define SIP Authentication s User ID and Password Figure 5 Define SIP Authentication s User ID and Password 2008 AASTRA. PAGE 17 OF 30
Step 5: Configuring the Device Figure 6 Configuring the Device 5.2 System Level Configuration This section describes system-wide configuration items that are generally required for each Clearspan to work with BroadWorks. Subscriber-specific settings are described in the previous section. Step Descriptions Details Step 1 Step 2 Step 3 Set up the outgoing routes/calls from the Clearspan subscribers to the Clearspan s SSM. Set up the incoming routes/calls from the Clearspan SSM to the Clearspan s subscribers. Set up the network routes between the Clearspan s SSM and the BroadWorks. Access the Clearspan s Network Server CLI to set up outgoing routes/calls from Clearspan subscribers to external via the Clearspan s SIP Session Manager (SSM). Access to the Clearspan s SSM to set up incoming routes/calls from external to the Clearspan s Application Server via the Clearspan s SIP Session Manager (SSM). Access to the Clearspan s SSM to set up network routes between the Clearspan s SIP Session Manager (SSM) and BroadWorks. 2008 AASTRA. PAGE 18 OF 30
Step 1: Set up the Outgoing Routes/Calls from the Clearspan Subscribers to the Clearspan s SSM The following example shows all Clearspan outgoing calls to be redirected to the Clearspan-SSM. NS_CLI/SubscriberMgmt/Enterprise/Policy/FarEndHopOff/RoutingList> get AastraUSA Policy: FarEndHopOff Enterprise: AastraUSA Table: RoutingList AuthHost From To OutDM ============================================= Clearspan-SSM 1 1 DEL(1) 1 entry found. 2008 AASTRA. PAGE 19 OF 30
Step 2: Set up the Incoming Routes/Calls from the Clearspan SSM to the Clearspan s Subscribers Define Clearspan s Application Servers as follows: abbott.us.aastra.com costello.us.aastra.com 2008 AASTRA. PAGE 20 OF 30
Figure 7 Set up Incoming Routes/Calls from the Clearspan SSM to the Clearspan s Subscribers 2008 AASTRA. PAGE 21 OF 30
Set up incoming routes/calls from external to the Clearspan s Application Server as follows: Figure 8 Set up Incoming Routes/Calls from External to the Clearspan s Application Server 2008 AASTRA. PAGE 22 OF 30
Step 3: Set up the Network Routes between the Clearspan s SSM and BroadWorks Define BroadWorks SBC as follows: Name: BroadWorks SBC2 Domain: sbc2.iop1.broadworks.netip address: 66.239.146.149 2008 AASTRA. PAGE 23 OF 30
2008 AASTRA. PAGE 24 OF 30
Figure 9 Set up the Network Routes between the Clearspan s SSM and BroadWorks 2008 AASTRA. PAGE 25 OF 30
Configure a dial plan on the Clearspan SSM having an IP address of 10.70.100.14 to route Clearspan outgoing calls to BroadWorks via the BroadSoft SBC2 as follows: Figure 10 Configure a Dial Plan on the Clearspan SSM having an IP Address of 10.70.100.14 2008 AASTRA. PAGE 26 OF 30
7.2.3.2 Configure a dial plan on the Clearspan SSM to route Clearspan incoming calls from BroadWorks via the BroadSoft SBC2. Figure 11 Configure VSP/Dial-Plan/Source Route from the BroadWorks SBC 2008 AASTRA. PAGE 27 OF 30
Appendix A: Sample Clearspan Configuration Files System Configuration The following provisioning steps detail the addition of a SIP trunking provider to the Clearspan s based SSM configurations. A reference diagram is provided as well. This sequence creates a gateway called AAA Internet SBC and identifies it as an external service, implying that the destinations behind this gateway are not registered with or through this SSM. The outbound dial plan route created in the sequence above provisions the SSM to route SIP methods INVITE, REFER, MESSAGE, and so on, whose Request URI matches cs.somecorp.com to the sip gateway called AAA Internet SBC. The inbound source-route provisions the SSM to route SIP messages received from ip address 127.239.146.149 to the gateway called AS1/2 (Clearspan). Figure 12 System Configuration config vsp config enterprise config sip-gateway "AAA Internet SBC" set peer-identity "" set domain sbc1.aaainternet.net set domain-alias 127.239.146.148 set service-type external config server-pool config server AAASBC1 set host 127.239.146.148 return return config dial-plan config route outbound to AAA from Clearspan set peer server "vsp\enterprise\servers\sip-gateway ""AAA Internet SBC""" 2008 AASTRA. PAGE 28 OF 30
set apply-to-methods INVITE+REFER+MESSAGE+INFO+OPTIONS+SUBSCRIBE+NOTIFY+PRACK+UPDATE set request-uri-match domain-exact cs.somecorp.com return return config source-route "inbound from AAA to Clearspan" set peer server "vsp\enterprise\servers\sip-gateway ""AS1/2""" set source-match host 127.239.146.149 return top save Phone Configuration The following is an example of Aastra SIP phone s configuration file that could be downloaded from a TFTP server: upgrade file name: 55i.st upgrade ip address: 10.70.100.101 model: 55i firmware md5: 4af86417b4d0660e2dd68e8654890a6f handset volume: 6 speaker volume: 9 ringer volume: 7 time server1: 172.16.84.16 dhcp: 0 ip: 172.16.85.50 default gateway: 172.16.85.200 dns1: 172.16.84.16 tftp server: 10.70.100.20 sip dial plan terminator: 1 sip registration retry timer: 30 sip registration timeout retry timer: 30 sip registration renewal timer: 20 sip line1 auth name: 2413333861 sip line1 password: cs sip line1 user name: 2413333861 sip line1 display name: 2413333861 sip line1 screen name: "User A" sip line1 screen name 2: 2413333861 sip line1 proxy ip: us.aastra.com sip line1 registrar ip: us.aastra.com sip line1 registration period: 3600 sip line1 dtmf method: 0 sip line1 srtp mode: 0 sip line2 dtmf method: 0 sip line3 dtmf method: 0 sip silence suppression: 0 sip t1 timer: 500 sip t2 timer: 4000 sip use basic codecs: 1 sip out-of-band dtmf: 0 2008 AASTRA. PAGE 29 OF 30
References [1] Aastra Technologies Limited. 2008. Clearspan Application Server Enterprise Web Interface Admin Guide, 2777-001, Release 14.0. Contact Aastra at www.aastra.com. [2] Aastra Technologies Limited. 2008. Clearspan Application Server Group Web Interface Admin Guide Part 1. Contact Aastra at www.aastra.com. [3] Aastra Technologies Limited. 2008. Clearspan Application Server Group Web Interface Admin Guide Part 2. Contact Aastra at www.aastra.com. [4] BroadSoft, Inc. 2010. BroadSoft Partner Configuration Guide Eclipse CXC Series. Available from BroadSoft at xchange.broadsoft.com. [5] BroadSoft, Inc. 2010. BroadWorks Device Management Configuration Guide Release 17.0. Available from BroadSoft at xchange.broadsoft.com. [6] BroadSoft, Inc. 2010. BroadWorks Redundancy Guide, Release 17.0. Available from BroadSoft at xchange.broadsoft.com. [7] BroadSoft, Inc. 2010. BroadWorks Business Trunking Configuration Guide, Release 17.0. Available from BroadSoft at xchange.broadsoft.com. [8] BroadSoft, Inc. 2010. BroadSoft Partner Configuration Guide Acme Packet Session Director. Available from BroadSoft at xchange.broadsoft.com. [9] BroadSoft, Inc. 2010. BroadWorks IP-PBX/PBX Trunking Interoperability Test Plan, Release 17.0. Available from BroadSoft at xchange.broadsoft.com. 2008 AASTRA. PAGE 30 OF 30