Deploying Ms Teams Direct Routing With Ip Office
Deploying Ms Teams Direct Routing With Ip Office
Support covers:
· MS Teams
MS Teams licensed through Microsoft with licenses assigned to users for features required. The free version of
MS Teams is not supported.
· Direct Routing
MS Teams Direct routing using an ASBC E R8.1.3.
o Scenarios covered include calls by MS Teams only users, IP Office only users, and users who are
simultaneous MS Teams+IP Office users.
o These notes should be used in conjunction with the Microsoft documentation. Refer to
https://docs.microsoft.com/en-us/microsoftteams/direct-routing-landing-page
o Automatically create, update and delete IP Office users matching users in the Azure Active Directory.
· Avaya Calling
Avaya calling is an alternation method of integrating MS Teams and IP Office. For details, refer to the separate
"Deploying Avaya Calling for MS Teams with IP Office" manual.
Overview
7
o MS Teams C all Routing Options
8
o User Types
9
o Scenarios
11
o Telephone and Extension Numbers
13
o Requirements
13
o Known C all Limitations
· Avaya Call
This method uses a MS Teams plug-in called Avaya C all. It links the user's MS Teams client with their Avaya
Workplace client. For details, refer to the separate "Deploying Avaya Calling for MS Teams with IP Office"
manual.
· Direct Routing
PSTN calls are routed via a third-parties SBC , in this case an ASBC E connected to the IP Office. This allows
calls to use PSTN trunks connected to the IP Office.
· Operator Connect
This option is similar to Direct Routing. However, all administration and services are run through the
infrastructure of a PSTN provide who is part of the Microsoft Operator C onnect program, using their SBC s and
SIP trunks.
· Does not require any specific IP Office user profile to interact with MS Teams
users.
· C an see and call MS Teams users from the IP Office system directory.
· C annot be part of IP Office features such as hunt groups, since they do not exist
as a user/extension record in the IP Office configuration
· Requires a MS Teams license (Microsoft 365 Business Voice without C alling Plan).
· The user can be included in the configuration of other IP Office features such as
hunt groups, park/page, etc.
1.3 Scenarios
The integration with MS Teams covered in this documentation make use of the following new components:
·
9
· Direct Routing support
MS Teams users can be licensed to make and receive PSTN calls by a number of routes. Direct routing allows
that operation to be via any of a number of Microsoft accredited SBC s. For IP Office support, ASBC E R8.1.3
can be used.
10
· Direct Routing support and Azure Active Directory synchronization
IP Office R11.1 FP2 and higher can connect to Azure Active Directory in order to obtain MS Teams user
information. This can be used to update directory information and/or create IP Office users.
· C reate and maintain IP Office users from user records in Azure Active Directory. Those users can be ordinary
IP Office users and/or MS Teams+IP Office users.
· Select and assign the voice routing policy to use to MS Teams users.
Number Formats
Before looking at how the numbers are used, it is important to look at the formats used to enter and display the
numbers. MS Teams-IP Office integration involves a number of different interfaces, each with slight variances on
how it displays the same number.
MS Teams Client (1632) 768 8402 extn 402 (1632) 768 8402 +402
1. The IP Office also adds the required protocol prefix and domain/port suffix elements (for example sip:
+441632768402;ext=402@sip.pstnhub.microsoft.com:5061).
Telephone Numbers
This documentation assumes that incoming calls for all telephone numbers are routed from the PSTN to the IP
Office. It does not cover scenarios where the customer also has telephone numbers routed directly to MS Teams
through Microsoft calling plans.
· Note that the expected telephone number is a full number including international country code but no country
specific international dialing prefix (except+ where indicated).
· If the customer has telephone numbers registered to Microsoft calling plans, those numbers need to migrated
to one of the IP Office system's line providers.
· Microsoft recommend that phone numbers are configured as full E.164 phone numbers with country code. MS
Teams also support phone numbers with extensions, which are used to lookup users when the lookup against
the telephone number returns more than one result.
Extension Numbers
For scenarios that include MS Teams only users:
· The MS Teams only users' extension numbers must be unique from the IP Office extension numbers used by IP
Office only and MS Teams+IP Office users.
· For ease of configuration and maintenance, use extension ranges for each that do not overlap.
· Due to the operation of MS Teams, the + indicator used for E.164 international numbers also appears on
extension numbers in some interfaces.
· User A: x401
· User B: x402
1.5 Requirements
The following is a summary of the requirements for installation:
Area Requirements
IP Office · IP Office R11.1 FP2 running either subscription mode or IP Office Preferred edition.
Certificates · Administrator rights to obtain the IP Office root certificate and to generate identity
certificates for the same certificate authority (C A).
MS Teams only users · MS Teams: MS Teams license including direct routing (Microsoft 365 Business
Voice without C alling Plan).
MS Teams+IP Office · MS Teams: MS Teams license including direct routing (Microsoft 365 Business
users Voice without C alling Plan).
· IP Office: IP Office User Profile/License:
Domain · Administrator rights to configure the customer's domain DNS or add files to the
domains default website root.
Other requirements · Administrator rights to the customer's tenancy through the Azure Active Directory
and MS Teams admin portals.
Summary
17
o Direct Routing C omponents
17
§ Dial Plans
18
§ Regular Expressions
18
§ Voice Routing Policies
18
§ Voice Routes
19
§ Emergency Routing Policies
19
§ PSTN Usages
19
§ SBC
19
§ MS Teams Line
20
o Direct Routing C all Flow
21
o Direct Routing Flowchart
22
o SBC Verification
· In Voice routes, they are used to match the number on outgoing calls to the routes for the call.
108
For more details, see Using Regular Expressions (regex) .
· The different usages are checked for a matching voice route in the order that the usages are listed in the voice
routing policy. That is, all the voice routes with the same usage are checked for a match as a set, using their
dial pattern and priority settings.
o If no dial pattern match is found, then the next set of usage voice routes are checked, based on the order of
usages in the voice routing policy.
o If a dial pattern match is found, a connection to the SBC (or SBC s) listed in the matched usage route with
the highest priority is attempted.
§ The SBC s which have recently had a successful handshake are checked first, in random order. In MS
Teams, these are referred to as the 'healthy' SBC s.
§ If not successful, any other SBC s specified are checked, again in random order. In MS Teams, these are
referred to as the 'demoted' SBC s.
§ If successful SBC connection occurs, the call now follows the SBC s routing settings.
· If no successfully routed match occurs, the call is re-routed to Microsoft calling plans if enabled for the user,
otherwise the call is dropped.
· Each voice routing policy is configured with a list of PSTN usage records. C alls routed by the policy can only
use voice routes which are set with one of those PSTN usages.
· Each emergency routing policy is configured with a single PSTN usage from the set available. C alls routed by
the policy can only use voice routes which also have the same PSTN usage.
2.1.7 SBC
When using direct routing, the final stage of outgoing call routing in MS Teams is to route the call to a Microsoft
accredited SBC .
For IP Office support, ASBC E R8.1.3 should be used. Direct routing is supported from R8.1.2, however R8.1.3
contains updates required for IP Office.
Normal Calls
[Teams User] > [Dial plan] > [Voice routing policy] > [PSTN usage] > [Voice routes] > [SBCs]
The MS Teams user dials a number:
1. Dial plan
The number is checked for a match against either the user's associated dial plan. The dial plan applies the
number translation if a match occurs, otherwise the call is dropped. A translation can include allowing the
number dialed to remain as is.
2. Voice routing policy
The user's associated voice routing policy indicates the PSTN usage records they can use.
3. PSTN usage
PSTN usage records have no configuration settings other than their name. However, they are used used to
create links between a user's voice routing policy and the voice routes their calls can use. The same PSTN
usage must appear in each.
4. Voice routes
The translated number is checked for matches against the available voice routes. Only voice routes that
match usages in the user's voice routing policy are checked for a dial pattern match.
5. SBC
The matched voice route specifies the SBC or SBC s to use for the call. If the SBC is available, the call is
connected. If not available, further attempts at matching to another route in the same usage is attempted.
Emergency Calls
[Teams User] > [Emergency routing policy] > [PSTN usage] > [Voice routes] > [SBCs]
The routing of emergency calls via direct routing should be done through emergency routing policies rather than the
voice routing policies used for normal calls.
The MS Teams user dials a number:
1. Emergency routing policy
If the number matches one in the user's associated emergency routing policy, that policy is used to route the
call. If the number matches one of those in the policy's Emergency dial mask, it is translated to the
Emergency dial string number. For example, if a user dials 911 or 999, the number is translated to 112 for
onward routing.
2. PSTN usage
PSTN usage records have no configuration settings other than their name. However, they are used used to
create links between a user's emergency routing policy and the voice routes it can use. The same PSTN usage
must appear in each.
3. Voice routes
The emergency number is checked for a match against the available voice routes. The matching looks for a
voice route with a dial pattern that matches the emergency number and the PSTN usage set in the emergency
routing policy.
4. SBC
The matched voice route specifies the SBC or SBC s to use for the call.
Routing Failure
In all the above, if direct routing fails at any point, the call is redirected to using Microsoft C alling Plans if the MS
Teams user is configured for calling plans. If otherwise, the call is dropped.
· Add a text file to the root of the domain's default web site.
· IP Office extension numbers in the range 2XX. MS Teams only user extension numbers in the range 4XX.
· For ease of implementation and maintenance, the extension number range used for MS Teams only users
should not overlap with the range used for other users.
· Local area code 01632.
· The customer wants to be able to restrict which MS Teams users can make outgoing national and international
PSTN through the IP Office.
Numbers to Consider
Begin planning by considering the different numbers used on or routed through the IP Office:
Extension IP Office These are 3 digit numbers in the range 200 to 299. These can be used for our IP
Numbers Office only and MS Teams+IP Office users.
MS Teams Only These are 3 digit numbers in the range 400 to 499. These can be used for any
MS Teams only users.
IP Office Shortcodes These are numbers of variable length but always beginning with *.
Incoming PSTN Calls The customer's main number for calls to the IP Office is 01632 768000.
Emergency Calls 999 and 112.
PSTN Local Potentially any 6 digit number.
National 7 to 10 digit numbers with a leading 0.
International Numbers beginning 00.
There are also some special scenarios we want to consider for calls made by MS Teams users:
· Any calls from MS Teams with a + prefix need to be converted:
o + changed to the international dialing prefix for the customer's locale, if the country code is not 44.
o + or 00 and the country code removed for international calls that should be handled as national calls.
o + removed from any other numbers. MS Teams sometimes prefixes + to non-international numbers.
· We want calls prefixed with the country code 44 changed back to being national numbers with just the national
dialing prefix.
· The matching of calls already dialed in the format expected by the IP Office may appear superfluous. However,
doing this in the customer's dial plan prevent those numbers being altered by the fixed country dial plan, which
typically will add + or + and the country code for the users's location to any number.
· The dial patterns do not need the ( ) brackets as in the dial plan since we are do not need to refer to them in
any translation.
3.2 Callflow
The following is a view of the call routing within MS Teams for our example:
· In theory, the emergency calls could have used the same voice route and PSTN usage. However, using separate entries just for emergency calls means future changes
to normal call routing can be made and testing without affecting emergency call routing.
In this case:
· The dial plan is still needed to perform any necessary number translation between numbers used in MS Teams and numbers formats supported by the IP Office. In this
case, the + is stripped from any numbers.
· Only a single voice route and single PSTN usage are now required for normal calls.
o In theory, the emergency calls could have used the same voice route and PSTN usage. However, using separate entries just for emergency calls means future
changes to normal call routing can be made and tested without affecting emergency call routing.
· We could in theory, have configured this using the global dial plan, global voice routing policy and global emergency routing policy.
· The voice routes allow calls to internal extension numbers to be routed to either the primary or secondary IP Office servers. C alls are then routed across the IP Office
network as necessary.
· During IP Office resilience, IP Office IP telephony users will failover and internal calls from MS Teams can continue.
· Other calls will use the voice route matching the MS Teams user's location. However, if connection is not possible, the alternate SBC and IP Office can be used.
However, this will require each IP Office to have routing to handle how the customer wants outgoing PSTN calls from the other location handled. For example, allowed
after suitable number changes using ARS shortcodes, or dropped after hearing a suitable prompt such as "Service currently not available".
Summary
32
1. User C onfiguration in MS Teams
33
2. C hecking MS Teams User Numbers
Procedure
1. Using a user account with full administrator rights, login to Azure Active Directory at https://portal.azure.com.
2. Select Azure AD and then Users.
3. Select the required user.
4. Select Contact Info.
5. Set the user's Office phone number as required. This is stored as the businessPhone value with Azure Active
Directory.The format varies depending on the type of number being set (see Telephone and Extension
11
Numbers ).
Procedure
1. Login to the MS Teams admin portal at https://admin.teams.microsoft.com/user
4. Verify that the Phone number for the user is shown as expected. For more information, see Telephone and
11
Extension Numbers .
Summary
36
1. Manually Adding MS Teams+IP Office Users
37
2. Manually Adding Directory Entries for MS Teams Only Users
38
3. Adding an MS Teams Line
38
4. C heck C ollaboration Service
Procedure
1. Using IP Office Manager or IP Office Web Manager, access the IP Office system configuration.
2. C onfigure the user as required for their IP Office operation. This process only covers the changes required for
MS Teams.
3. Select User or Call Management | Users.
4. Add a new user as normal or select the existing user you want to edit.
5. Select the User tab:
a. Select a Profile that supports MS Teams user integration:
· On subscription mode systems: MS Teams+IP Office users are supported by the UC User profile.
· On PLDS licensed systems: MS Teams+IP Office users are supported by the Office Worker,
Teleworker and Power User profiles.
b. Select Enable MS Teams Client.
6. Select the Mobility tab:
a. The Coverage Delay sets a pause, if required, between calls alerting on the user's IP Office extension
devices and then also altering on their MS Teams client.
b. The user's MS Teams URI should match their Office phone setting as specified in Azure Active Directory
11
(for more information, see MS Teams Telephone Numbers ):
· If the MS Teams URI field is grayed out, the system has been configured to only allow automatic
57
updates through Azure Active Directory synchronization. See Preventing Manual URI Editing .
7. C lick OK or Save.
8. If prompted to allow the system to automatically create an matching extension entry, allow the system to
create one matching the type of IP Office extension the user will be using.
9. If using IP Office Manager, save the configuration back to the IP Office system.
Procedure
1. Using IP Office Web Manager, access the IP Office system configuration.
2. Select System Settings | Directory.
3. Select Add Directory Entry.
4. For the Name, enter the user name followed by a space and MST. For example; Diego Siciliani MST
5. For the Number, use one of the following formats (for more information, see Telephone and Extension
Numbers 11 ):
· Note 1: A dash is a delimiter signifying that the following number is an extension number.
6. C lick Save.
Procedure
1. Using IP Office Manager or IP Office Web Manager, access the IP Office system configuration.
a. Set the Proxy Address to the IP Address of the ASBC E interface being used (A1 or A2).
b. Ensure that the Max Calls value matches the Concurrent call capacity of the ASBC E entry in MS
Teams.
5. On the VoIP tab, ensure that only a single codec is selected
Procedure
1. Using a web browser, access the IP Office server on port 7071.
2. Select the System tab.
· Note that the processes shown in this document are just examples. Processes such as assigning policies to
users can be performed for a whole tenancy, for a group of users or for individual users. PowerShell scripts
can also be used for most processes rather than using the MS Teams UI menus.
· Note also that a policy assigned to an individual user overrides any assigned to a group, which itself overrides
any assigned globally. Bear this is mind for ease of maintenance when planning the customer's policies and
how to assign those policies. For more information, see https://docs.microsoft.com/en-
us/microsoftteams/assign-policies-users-and-groups
· In mixed scenarios, the setting applied directly to a user typically overrides any applied to their group, which
themselves override any applied to the whole tenancy. This should be kept in mind when planning the
implementation as it will also affect maintenance.
Summary
43
1. Adding an MS Teams Line
44
2. Verify the SBC Domain
45
3. Adding the ASBC E to MS Teams
46
4. C reating Dial Plans
48
5. C reating Voice Routing Policies
50
6. C reating Voice Routes
52
7. C onfigure Emergency C alling
Procedure
1. Using IP Office Manager or IP Office Web Manager, access the IP Office system configuration.
a. Set the Proxy Address to the IP Address of the ASBC E interface being used (A1 or A2).
b. Ensure that the Max Calls value matches the Concurrent call capacity of the ASBC E entry in MS
Teams.
5. On the VoIP tab, ensure that only a single codec is selected
· Add a text file to the root of the domain's default web site.
Procedure
1. Login to the admin portal at https://admin.microsoft.com/Adminportal.
2. Select Settings | Domain.
3. Select Add Domain.
4. Enter the domain name and click Use this domain.
5. Select the method you want to use to verify the domain and click Continue.
6. Follow the instructions provided for the values that need to be added to the domain's DNS server or root
website.
7. When you have prepared the DNS server records or web site files as requested, click Verify.
8. Skip any other actions and click Continue.
9. C lick Done.
Procedure
1. Login to the MS Teams admin portal at https://admin.teams.microsoft.com/direct-routing/v2
2. Select Voice and then Direct Routing.
4. Enter the FQDN of the ASBC E. If the domain used in the FQDN is not already one verified by Microsoft (see
44
Verify the SBC Domain ), follow the instructions displayed by MS Teams after adding the SBC entry.
5. Enable the SBC and set the SIP signaling port to 5061.
6. Ensure that the Concurrent call capacity matches the Max Calls setting of the IP Office MS Teams line.
43
See Adding an MS Teams Line .
7. C lick Save.
· User dial plans - For each tenancy you can create up to a 1000 additional dial plans. Some or all MS Teams
users can be associated with one of those user plans. The dialing rules in that user plan are then checked for a
dialing match before then being checked against the country dialing plan.
Procedure
1. Login to the MS Teams admin portal at https://admin.teams.microsoft.com/policies/teamsdialplan
2. If necessary, select Voice and then select Dial plans.
3. Either select the Global dial plan or click Add to add a new plan.
· The global plan is applied to the dialing of all users who are not associated with any specific user plan.
· Adding a new plan creates a copy of the existing global plan including its existing translations.
8. C lick Save.
Procedure
1. Login to the MS Teams admin portal at https://admin.teams.microsoft.com
2. Select Users.
3. Select the required user or users.
4. C lick Edit settings.
5. Select the dial plan you want to assigned to the user or users and click Apply.
· The different usages are checked for a matching voice route in the order that the usages are listed in the voice
routing policy. That is, all the voice routes with the same usage are checked for a match as a set, using their
dial pattern and priority settings.
Procedure
1. Log in to the MS Teams admin portal at https://admin.teams.microsoft.com/policies/teamsonlinevoicerouting
2. If necessary, select Voice and then Voice routing policies.
4. For a new policy, add a unique descriptive name and, if necessary, a description.
5. To add PSTN usage records:
a. C lick Add or remove PSTN usage records.
b. Select an existing PSTN usage from the list of those available and click Save and apply. Alternatively, to
create a new PSTN usage, click Add and when completed, select it and click Save and apply.
6. C heck that the usages are listed in the required order for matching to potential voice routes. If necessary,
select a record and click Move up or Move down. The order of the usages sets the order in which matching
voice routes are checked for dial pattern matches.
7. C lick Save.
8. C reate any other voice policies required.
Procedure
1. Login to the MS Teams admin portal at https://admin.teams.microsoft.com
2. Select Users.
3. Select the required user or users.
4. C lick Edit settings.
5. Select the Policies tab and click Edit.
6. In Voice routing policy drop-down, select the policy you want to assigned to the user or users and click
Apply.
· The routes are grouped by usage and then checked in the order of the usages as listed in the user's assigned
voice routing policy.
o The first set of usage voice routes are checked for a dial pattern match.
o If no dial pattern match is found, then the next set of usage voice routes are checked, based on the order of
usages in the voice routing policy.
o If a dial pattern match is found, a connection to the SBC (or SBC s) listed in the matched usage route with
the highest priority is attempted.
§ The SBC s which have recently had a successful handshake are checked first, in random order. In MS
Teams, these are referred to as the 'healthy' SBC s.
§ If not successful, any other SBC s specified are checked, again in random order. In MS Teams, these are
referred to as the 'demoted' SBC s.
§ If successful SBC connection occurs, the call now follows the SBC s routing settings.
· If no successfully routed match occurs, the call is re-routed to Microsoft calling plans if enabled for the user,
otherwise the call is dropped.
Procedure
1. Log in to the MS Teams admin portal at https://admin.teams.microsoft.com/direct-routing/v2/voice-routes
2. Select Voice and then Direct Routing.
3. Select the Voice Routes tab. The existing voice routes are displayed.
24
· In this example from our simple single server scenario (see Example Scenario ), the Dial number
pattern matches any dialed number following their processing through the user voice routing policies. The
single ASBC E is set as the destination for calls.
4. To add an new route, click Add. To edit an existing route, select it and then click Edit.
a. Enter a unique descriptive name for the voice route and, if necessary, a description.
b. Set the Priority. When multiple voice route matches occur, the highest priority one is tested first.
c. Enter the Dialed number match. This dial pattern is used to match for numbers that should then be
routed using the voice route. The dial pattern uses regex format syntax. For example, ^2\d{2})$
108
matches 3-digit extension numbers being with a 2. See Using Regular Expressions (regex) .
d. To add an SBC to the list of SBC s used by this voice route:
i. C lick Add SBCs.
ii. Select the ASBC E from the list of enrolled SBC s and click Apply.
e. Add a PSTN usage for the voice route. Only calls by users who have the same usage in their associated
voice routing policy can use the voice route.
i. C lick Add PSTN usage or from the list of those already shown, click Add.
ii. Select an existing PSTN usage from the list of those available and click Save and apply.
Alternatively, to create a new PSTN usage, click Add and when completed, select it and click Save
and apply.
f. C lick Save.
5. Repeat the process to define any additional voice routes required.
6. Once you've added the voice routes required, check they are in the required order. If necessary, select a
record and click Move up or Move down.
Summary
52
1. C onfiguring an Emergency Policy
53
2. Assigning an Emergency Policy to Users
Procedure
1. Login to the MS Teams admin portal at https://admin.teams.microsoft.com/direct-routing/v2
2. Select Voice and then Emergency policies.
3. Either click Add to add a new policy or select an existing policy and click Edit.
· The Global policy is used for all users to who you do not specifically assign an emergency policy.
4. If adding a new policy, enter a unique descriptive name for the policy and, if necessary, add a description.
5. If Dynamic emergency calling is enabled, Teams retrieves policy and location information from the
service and includes that information as part of the emergency call.
6. Define the emergency numbers required:
a. C lick Add.
b. In the Emergency dial string, enter the main emergency number that users will dial. For example 112.
c. You can also define an optional Emergency dial mask. This can contain any other numbers that should
be automatically translated to the Emergency dial string when dialed. For example, 999. To add
multiple additional numbers to the mask, separate each number with a semi-colon. For example, 999;911.
· For locales where all emergency calls go to the same emergency service operator, using an
Emergency dial mask simplifies configuration.
· Use of a mask also allows you to include numbers that might be dialed by visitors from locales where
other numbers are used for emergency calls.
· For locales where emergency calls go to different operators based on the number dialed, repeat this
step to add a separate Emergency dial string for each different operator service rather than using
masks.
d. Select a PSTN usage record. The record is used to determine which voice route is used to route
emergency calls.
7. C lick Save.
8. If using an emergency policy other than the global one, assign the policy to the required users. See Assigning
53
an Emergency Policy to Users .
Procedure
1. Login to the MS Teams admin portal at https://admin.teams.microsoft.com
2. Select Users.
3. Select the required user or users.
4. C lick Edit settings.
5. Select the Policies tab and click Edit.
6. In Emergency call routing policy drop-down, select the policy you want to assigned to the user or users
and click Apply.
· Directory Synchronization
Add the name and telephone number details of MS Teams only users to the IP Office system directory. Also
add the contact details of other contacts that the customer stores in Azure Active Directory.
· MS Teams Voice Routing Policy Synchronization
For MS Teams users, assign which voice routing policy they should use.
· IP Office User Creation and Maintenance
User details from Azure Active Directory can be used to create and update users and extensions on the IP
Office system. This can be used to create IP Office only and MS Teams+IP Office users.
· One to run synchronization to create IP Office only users, with appropriate IP Office user and extension
templates for those users. Groups can also be used to allow separate synchronization processes using
different templates. For example, to create SIP extension users and DEC T extension users.
· One to run synchronization to create MS Teams+IP Office users with appropriate templates for that role.
· IP500 V2 Systems
Azure Active Directory connection uses the C ollaboration Service on Linux-based IP Office servers. For
standalone IP500 V2 systems, the service requires an IP Office Application Server or UC M Module. However,
only directory synchronization is supported.
Summary
57
1. Preventing Manual URI Editing
57
2. Enabling Directory Synchronization
58
3. C onfiguring Azure Active Directory App Registration
59
4. C onfiguring a Teams Administrator
60
5. C reating User and Extension Templates
61
6. C reating User Provisioning Rules
62
7. Setting Up a Direct Routing Synchronization Process
Procedure
1. Using IP Office Manager or IP Office Web Manager, load the IP Office system configuration.
Procedure
1. Using IP Office Manager or IP Office Web Manager, load the IP Office configuration.
2. Select System or System Settings | System. If necessary, select the required server in the network.
3. Select Directory Services.
4. Select HTTP.
5. Set the Directory Type to Collaboration Services.
6. The default Resync Interval is set to 3600 seconds (1 hour). Adjust the value if required.
7. C lick OK or Update to save the changes.
8. If using IP Office Manager, save the configuration back to the IP Office system.
Procedure
1. Using a user account with full administrator rights, login to Azure Active Directory at https://portal.azure.com.
2. Search for and select Azure Active Directory.
3. Select Overview.
4. The Basic Information section includes the Tenant ID that is required for IP Office connections. C opy the
value to a text file.
5. If planning to create a connection for a particular group of users:
a. Select Groups and locate the required group.
Procedure
1. C reate a new user whose name and password will be used for the IP Office connection:
a. Using a user account with administrator rights, login to Azure Active Directory at https://portal.azure.com.
b. Search for and select Azure Active Directory.
c. Select Users and add a new user and set a unique descriptive name for their function. For example,
IPOLink. No user licenses are required for this user.
d. Select Assigned Roles.
e. Select Add Assignment.
f. Select Teams Administrator and click Add.
2. After creating the user:
a. Login at https://admin.teams.microsoft.com using the user details and set a password when prompted. Do
not enable multi-factor authentication.
b. If a password expiry policy is in place for users, that feature should be disabled for this user. Note the
user's UserID. Then, using PowerShell, connect to Azure Active Directory and use the following
command:
· The process below uses the template management menus to create or upload new templates. Templates can
also be created from existing users or extensions by selecting to edit their details and then clicking Save As
Template. The new template will then appear in template management menu described below.
· For MS Teams+IP Office users, the user template used must configure the user's Profile settings to one of the
following and enabled the Enable MS Teams Client setting.
· On subscription mode systems: MS Teams+IP Office users are supported by the UC User profile.
· On PLDS licensed systems: MS Teams+IP Office users are supported by the Office Worker, Teleworker
and Power User profiles.
Procedure
1. Using IP Office Web Manager, access the IP Office system configuration.
· Sets the extension type for the new users using either a specified extension template or specified extension
type (in which case default extension settings are applied).
· Sets user settings, other than those taken from Azure Active Directory, for the new users using a user
template. If no user template is specified, default user settings are applied.
· Optionally configures on which system the new users should be created.
Procedure
1. Using IP Office Web Manager, access the IP Office system configuration.
2. Select Solution.
3. Select Solution Settings and then User Synchronization.
· Use a field in the each users Azure Active Directory directory settings to set the system name, FQDN or
LAN1/LAN2 IP address of the required system.
· If neither of the above methods is used, the new users are all created on the primary server.
9. If not setting the extension numbers using a value received from Azure Active Directory, set the Starting
Extension number. Otherwise, leave this field blank.
10. Select the required extension template or select an extension type. If you select an extension type, then the
default IP Office settings are applied to the new users associated extensions.
11. Select the required user template. If you do not select a user template, then the default IP Office settings are
applied to the new users.
12. C lick Save.
Procedure
1. C heck you have the require configuration IDs from Azure Active Directory. See C onfiguring Azure Active
Directory App Registration 58 .
2. Using IP Office Web Manager, access the IP Office system configuration.
3. Select Solution.
4. Select Solution Settings and then User Synchronization.
5. C lick +ADD and select User Synchronization using Microsoft Teams.
6. Select the Connect to Directory Service tab.
a. Enter a Configuration Name to identify the purpose for this connection. For example, DirectRoutingSync.
b. For Collaboration Client, select Direct Call Routing.
c. Use User Synchronization type to select the roles that the synchronization should perform. The
selection affects the additional fields and tabs available:
Setting Description
IP Office Users Only Support the creation, updating and deletion of IP Office users to match the
users in Azure Active Directory.
Microsoft Teams Add details of the MS Teams only users to the IP Office user directory.
Users Only
· Also update their settings in MS Teams with any Office telephone number
configured for them in Azure Active Directory.
· Optionally, also assign a specific voice routing policy to the MS Teams
user settings.
· Use Group Directory to manage IP Office entries for just those users who are members of a specific
Azure Active Directory group.
e. Enter the details obtained from Azure Active Directory into the matching fields.
f. C lick Test Connection and wait a couple of minutes.
g. If successful, continue with the configuration. Otherwise, check and adjust the settings.
7. If using MS Teams Users Only:
The Azure Active Directory fields from which the user name and number information is taken need to be set.
For other modes, the values are set through the Synchronize User Fields settings below.
a. In the Name Attribute field, enter the name of the Azure Active Directory user field that should be used
to populate the user name in the IP Office system directory entries. The name is displayed with a suffix of
MST. The default is to use the displayName from Azure Active Directory.
b. The Azure Active Directory field from which the user's telephone number information is taken is fixed as
businessPhones.
8. If using MS Teams Users Only or Both:
The details of the MS Teams admin user to use for the connection are needed. In addition, direct routing
settings to be applied to the users can be specified.
a. In the Microsoft Teams PowerShell Username and Microsoft Teams PowerShell Password fields,
enter the user name and password of the Azure Active Directory user configured as a MS Teams
59
administrator .
b. The Voice Routing Policy Name and Voice Routing Policy Usage fields can be used to specify the
voice routing policy assigned to the users.
· If the policy does not already exist, it is created and the usage is added to it. The policy is then
assigned to the users.
· If the policy already exists, it is assigned to the users with no changes the usages it contains (the
Voice Routing Policy Usage value, if set in the IP Office sync settings, is ignored).
· The final pair of drop-downs can be used to set on which IP Office system in a network new users
should be created. If not set, the required system can be specified in the user provisioning rule
selected. If otherwise, new users are created on the primary system.
ii. Select which functions should be performed by this user synchronization entry. You can select any or
all of the roles:
· New - C reate new IP Office user and extension records for any user whose user identification is not
already present.
· Update - Update the settings, if required, of the user with the same user identification.
· Delete - Delete the user and extension records for any users whose user identification is not
present in the latest synchronization.
iii. If the synchronization actions should be performed regularly, click Use Schedule and define the
required schedule.
iv. C lick Preview Results. A summary of the changes that would be made is shown. If necessary, make
changes to the settings.
v. When complete, click Synchronize.
9. C lick Save.
Summary
67
1. Example Schematic
67
2. Information Required
68
3. Get the ASBC E Version
69
4. Obtain the ASBC E C ertificates
74
5. Adding a Root C ertificate to the ASBC E
75
6. Adding an Identity C ertificate to the ASBC E
76
7. Define the IP Office Server Interworking Profile
78
8. Define the MS Teams Server Interworking Profile
80
9. C reate a TLS C lient Profile for the IP Office
81
10. C reate a TLS C lient Profile for MS Teams
82
11. C reate the TLS Server Profiles
83
12. C reate the SIGMA Script Files
85
13. Upload the SIGMA Scripts
86
14. C reate a SIP Server for the IP Office
88
15. C reate a SIP Server for MS Teams
90
16. Define a SIP C all Routing Profile for the IP Office
91
17. C reate a URI Group for IP Office Extensions
92
18. Define a SIP C all Routing Profile for MS Teams
94
19. C onfigure Topology Hiding for the IP Office
95
20. C onfigure Topology Hiding for MS Teams
96
21. Define the Media Rules for the IP Office
97
22. Define the Media Rules for MS Teams
99
23. C reate the Endpoint Policy Groups
100
24. C reate the SIP Signaling Interfaces
101
25. C reate the SIP Media Interfaces
102
26. C onfigure the Server Flow for IP Office
104
27. C onfigure the Server Flow for MS Teams
105
28. ASBC E Flowchart
· The configuration of the private and public DNS to ensure correct resolution of any FQDNs used is not
covered in this document.
68
Proceed to getting the ASBC E version .
Procedure
1. After logging in to the ASBC E, note its version number in full. This must be 8.1.3 or higher.
69
2. Proceed to adding the certificates .
MS Teams Certificates
To support MS Teams, the ASBC E requires the following certificates:
IP Office Certificates
To support IP Office, the ASBC E requires the following certificates. If IP Office certificates are already present, for
example if the ASBC E is supported remote IP Office extensions, those existing certificates can also without any
further changes.
· IP Office Root Certificate
This is the root certificate used by IP Office for SIP TLS. If the IP Office root certificate is self signed,
Verification depth has to be set to 1. If the certificate is coming from external verification authority, verification
depth should be set to 2 (length of certificate chain).
o For the examples in this document, the certificate is named IPO_RootCA.pem
Summary
70
o Downloading the IP Office Root C ertificate
71
o Generating an Identity C ertificate in IP Office Web C ontrol
72
o Generating an Identity C ertificate in IP Office Web Manager
73
o Extracting the ASBC E Private Key and Identity C ertificate
Procedure
1. Login to the IP Office Web C ontrol by either:
· From within IP Office Web Manager, select the primary server. C lick on and select Platform View.
· or browse to https://<IP Office IP address>:7071 and login as the Administrator.
3. Under CA Certificate, click on Download (PEM-encoded) and save the root_ca.pem file to your PC .
4. Proceed to generating an ID certificate for the ASBC E:
72
· For IP Office subscription mode systems with Automatic C ertificate Management enabled.
71
· For other IP Office systems.
Procedure
1. Login to the IP Office Web C ontrol by either:
· From within IP Office Web Manager, select the primary server. C lick on and select Platform View.
· or browse to https://<IP Office IP address>:7071 and login as the Administrator.
71
7. Proceed to extracting the private key and identity certificate .
Procedure
1. Login to IP Office Web Manager for the subscription mode IP Office system.
2. Select Security | Security Settings.
3. If the system is in a Server Edition network, click on the next to the primary server.
4. Select Certificates.
5. C lick Regenerate.
6. Enable For Different Machine.
10. When prompted, set an encryption password for the identity certificate and click Yes.
11. The browser will prompt you to download and save the certificate file.
71
12. Proceed to extracting the private key and identity certificate .
Procedure
1. Using SFTP, connect to the ASBC E management IP address using port 222 and the ipcs login.
71
2. C opy the IP Office identity certificate created for the ASBC E (SBCE_ID.p12) to the /home/ipcs
directory.
3. Using SSH, login to the ASBC E management IP using port 222 and ipcs login.
4. Enter the command sudo su and type the root password.
5. Enter the following commands. When prompted for a password or PEM pass phrase, enter the password
specified when generating an identity certificate for the ASBC E 71 .
· Note that if any special characters are used in the password, to enter that password at the
command line requires the character to be prefixed with a \. For example, a @ in the password
would be typed as \@ at the command line.
74
8. Proceed to adding the root certificates to the ASBC E .
Procedure
69
First obtain certificates for the ASBC E , then:
Procedure
74
First add the root certificates to the ASBC E , then:
Procedure
75
First add the identity certificates to the ASBC E , then:
1. Select Configuration Profiles and then Server Interworking.
2. C lick Add.
3. For the Profile Name, enter a unique descriptive name.
4. On the General settings tab:
a. Set the Refer Handling to Yes.
b. Set the URI Scheme to SIP.
5. On the Advanced settings tab:
a. Set Record Routes to Both Sides and Extensions to Avaya.
6. All other tabs should be left as their default values. C lick Finish.
78
8. Proceed to creating a server interworking profile for MS Teams .
Procedure
76
First define the IP Office server interworking profile , then:
1. Select Configuration Profiles and then Server Interworking.
2. C lick Add.
3. For the Profile Name, enter a unique descriptive name.
4. On the General settings tab:
a. Set the Hold Support to Microsoft Teams
b. Set the Refer Handling to Yes.
c. Set the Delayed Offer to Yes.
d. Set the URI Scheme to SIP.
5. On the Advanced settings tab, set Record Routes to Both Sides and Extensions to Lync.
6. All other tabs should be left as their default values. C lick Finish. The MS Teams interworking profile should
look similar to the following:
80
7. Proceed to creating a TLS client profile for the IP Office .
Procedure
78
First define the MS Teams server interworking profile , then:
· If the IP Office root certificate is self-signed, set this to 1. That includes subscription systems using
Automatic Certificate Management.
· If the certificate is coming from external verification authority, set this to 2 (length of certificate chain).
81
9. Proceed to creating TLS client profile for MS Teams .
Procedure
80
First create a TLS client profile for the IP Office , then:
8. The TLS client profile for MS Teams should look similar to the following.
80
9. Proceed to creating TLS Server profiles .
Procedure
81
First create a TLS client profile for MS Teams , then:
1. Select TLS Management | Client Profiles.
2. C lick Add and create a TLS server profile for the IP Office.
a. Profile Name - Enter a unique descriptive name to help select this profile later in other menus.
b. Certificate - Select the IP Office identity certificate created for the ASBC E.
c. Peer Verification - Select None.
d. C lick Next and then Finish.
e. The TLS server profile setting for the IP Office system should look similar to the following.
e. The TLS server profile setting for MS Teams should look similar to the following.
83
4. Proceed to create the SIGMA scripts .
Procedure
82
First create the TLS server profiles , then:
1. On your PC , create 2 text files. One containing the script for the IP Office, the other the script for MS Teams.
The details for the script files are listed below.
85
2. Proceed to uploading the SIGMA scripts .
1. Replace each instance of <ASBCE_FQDN> with the public FQDN of the ASBC E.
2. Replace each instance of <ASBCE_IP_ADDRESS> with the public IP address of the ASBC E to which that
FQDN resolves.
3. Replace <ASBCE_VERSION> with AVAYA SBCE-<version> where <version> is the Version value
shown on the ASBC E's initial menu after logging in. See Get the ASBC E Version 68 .
Procedure
83
First create the SIGMA script files , then:
1. Select C onfiguration Profiles and then Signaling Manipulation.
2. C lick Upload and select the SIGMA file created for the IP Office.
3. C lick Upload again and select the SIGMA file created for MS Teams.
86
4. Proceed to creating SIP server entries for the IP Office .
Procedure
85
First upload the SIGMA scripts , then:
1. Select Services and then SIP Server.
2. C lick Add and add a SIP server profile for the IP Office.
3. Enter a Profile Name. C lick Next.
4. In the General Settings menu:
Procedure
86
First create a SIP server for the IP Office , then:
1. Select Services and then SIP Servers.
· sip2.pstnhub.microsoft.com/5061/TLS
· sip3.pstnhub.microsoft.com/5061/TLS
d. C lick Next.
5. There are no changes to the default Authentication settings. C lick Next.
Procedure
88
First create a SIP server for MS Teams , then:
1. Select Global Profiles and then Routing.
2. C lick Add.
3. Enter a Profile Name and click Next.
4. In the routing profile settings, click Add to specify the IP route details:
Procedure
90
First define a SIP call routing profile for the IP Office , then:
· In our example scenario, IP Office extensions use the range 200 to 299. MS Teams only users with
extension numbers use the range 400 to 499. In our URI Group, only an entry of the IP Office range is
required.
92
7. Proceed to creating a SIP call route profile for MS Teams .
Procedure
91
First create a URI group for IP Office extensions , then:
1. Select Global Profiles and then Routing.
2. Enter a Profile Name and click Next.
3. Create a route for IP Office extension numbers:
In some scenarios, such as some call transfers, MS Teams may send a REFER addressed with an IP Office
extension number and the MS Teams domain. Using the URI match previously configured, this entry routes
such calls back to the IP Office system.
a. C lick Add.
b. For the URI Group, select the group previously created to match IP Office extension numbers. C alls
addressed to these should be rerouted back to the IP Office.
c. In the routing profile settings, click Add and add a call route with the following setting:
i. Set the Priority/Weight to 1.
ii. For the Server Configuration, select the SIP server profile entry created for the IP Office.
iii. For the Next Hop Address, enter the address for the IP Office and the port to use. For example:
10.1.1.17:5061.
d. The settings should now look similar to the following:
f. C lick Finish.
5. The final routing profile should look similar to the following:
94
6. Proceed to configuring topology hiding .
Procedure
92
First define a SIP call routing profile for MS Teams , then:
1. Select Global Profiles and then Topology Hiding.
2. Select the default profile and click Clone.
3. Enter a unique descriptive name for the profile for connections to the IP Office and click Finish.
4. Select the new profile and click Edit.
5. Set the To, Request-Line, Refer-To, Referred-By and From headers to Overwrite. For each, set the
Overwrite Value to the IP Office system's SIP domain .
95
6. Proceed to creating topology hiding for MS Teams .
Procedure
94
First configure topology hiding for the IP Office , then:
1. Select Global Profiles and then Topology Hiding.
2. Select the default profile and click Clone.
3. Enter a unique descriptive name for the profile for connections to the MS Teams and click Finish.
4. Select the new profile and click Edit.
a. Set the From header to Overwrite, with the Overwrite Value set to the FQDN of the ASBC E.
b. C heck that all the other values at their defaults of Auto.
96
5. Proceed to creating the media rules for IP Office .
Procedure
95
First configure topology hiding for MS Teams , then:
6. C lick Finish.
97
7. Proceed to creating the media rules for MS Teams .
Procedure
96
First define the media rules for the IP Office , then:
7. C lick Finish.
99
8. Proceed to creating the endpoint policies .
Procedure
97
First define the media rules for MS Teams , then:
e. C lick Finish.
3. Create an endpoint policy for MS Teams:
a. Select the existing default-low policy and click Clone.
b. Enter a unique descriptive name for the new policy and click Finish.
c. Select the new policy and click Edit.
d. Set the Media Rule to the media rule previously created for the MS Teams connection.
e. C lick Finish.
100
4. Proceed to creating the SIP signaling interfaces .
Procedure
99
First create the endpoint policy groups , then:
1. Select Network & Flows and then Signaling Interface.
a. C lick Add.
b. In the Name field, enter a description name for the interface.
c. In the IP Address field, select the ASBC E's external network interface.
d. Set the ports to match those configured for SIP with MS Teams.
e. In the TLS Profile, select the TLS server profile previously created for MS Teams.
f. C lick Finish.
4. The final settings should appear similar to the following:
101
5. Proceed to creating SIP media interfaces .
Procedure
100
First create the SIP signaling interfaces , then:
1. Select Network & Flows and then Media Interface.
a. C lick Add.
b. In the Name field, enter a description name for the interface.
c. In the IP Address field, select the ASBC E's external network interface.
d. Set the ports to match those used for SIP media with MS Teams.
e. C lick Finish.
4. The final settings should appear similar to the following:
102
5. Proceed to configuring the server flow .
Procedure
101
First create the SIP media interfaces , then:
c. In the SIP Server Profile, Signaling Interface, Media Interface, End Point Policy Group and
Topology Hiding fields, select entries created for the IP Office.
d. For the Received Interface, and Routing Profiles, select the signaling interface and routing profiles
created for the MS Teams.
e. C lick Finish.
4. Create a server flow for calls being returned back to the IP Office:
a. C lick Add.
c. In the SIP Server Profile, Signaling Interface, Media Interface and End Point Policy Group
fields, select entries created for the IP Office.
d. For the Received Interface, and Routing Profiles, also select the profiles created for IP Office rather
than MS Teams.
e. C lick Finish.
5. The server flow details should look similar to the following:
104
6. Proceed to creating a server flow for MS Teams .
Procedure
102
First configure the server flow for IP Office , then:
· In Voice routes, they are used to match the number on outgoing calls to the routes for the call.
· https://support.microsoft.com/en-us/topic/6ea76427-0892-4237-b024-10b418dcb05e
· https://regex101.com/
This site provides a useful tool for testing the operation of your own regex strings.
Summary
109
· Interpreting Regex Strings
110
· Regex Syntax
111
· Telephone Number Examples
111
· Digit Translations
^\+?(2\d{2})$
The string works as follows:
^\+?(2\d{2})$ · The \+ matches a literal + character (the E.164 international prefix indicator). The \ is
needed as a + on its own is a specific regex command.
^\+?(2\d{2})$ · The ( ) brackets group elements. This can be important when translating numbers, as
translations can include references the digits that matched the different pairs of
brackets.
^\+?(2\d{2})$ · The \d matches any digit. The \ is needed to indicate that it is not a match for an
alphabetic d character.
^\+?(2\d{2})$ · The {2} modifies the preceding element to match 2 instance of that element.
^\+?(2\d{2})$ · The $ matches the end of the string. Including this means the pattern will not match
longer numbers that begin with a 2.
^(\+|00)(.+)$
The string works as follows:
^(\+|00)(.+)$ · The ( ) brackets group elements for processing and, potentially, for future translation.
^(\+|00)(.+)$ · So the 1st pair of brackets indicates a match to any number beginning with + or 00.
^(\+|00)(.+)$ · So the .+ operate together to match any number of digits and characters.
^(\+|00)(.+)$ · The 2nd pair of brackets enclose the match for any number of characters. In this
example, a translation can use the value $2 to refer to the matched characters, without
their + or 00 prefix, since that was matched by the first pair of brackets.
String Position
Enclose a pattern with these ensures matching to the full number only.
Syntax Description
Character Types
Syntax Description
Group
Syntax Description
| Or: Separate alternate possible matches. For example:569|669 matches either 569 or 669. Multiple
alternates can be specified, for example: 569|669|779.
() Group: Use ( ) brackets to group syntax. When performing digit translations, the element $1 in a
translation represents the digits matched by the syntax in the first pair of ( ) brackets in the original
pattern, $2 the second pair of brackets and so on.
[] Range of Characters: Use [ ] square brackets to group specific characters or a character range to
match. For example: [569] matches a 5, 6 or 9; [5-7] matches a 5, 6 or 7; [0-9*#+] matches
any telephone number character.
· When used in [ ] brackets, characters such as + and * are literal matches.
· Use a ^ character inside the [] brackets to perform a non-match. For example: [^569] matches
an digit other than 5, 6 or 9.
Number of Matches
Syntax Description
? Match zero or one: Use a ? question mark to match zero or one occurrences of the preceding
element. For example: ^\+? matches numbers beginning with or without a + prefix.
* Match zero or more: Use an * to match zero or more occurrences of the preceding element. For
example: ^1.*$ matches 1 and numbers beginning with a 1. To match an actual *, use \*
+ Match one or more: Use a + plus sign to match one or more occurrences of the preceding element.
For example: ^1.+$ matches number beginning with a 1 but not just 1. To match an actual +, use \+
{n} Match N times: Match the preceding item exactly n times. For example: ^.{3} matches 3-digit
numbers.
{n,} Match N or more times: Match the preceding item n or more times. For example: ^. {3,}$
matches 3-digit or longer numbers.
{,m} Match up to M times: Match the preceding item up to m times. For example: ^.{,4}$ matches
numbers up to 4-digits long.
{n,m} Match between N to M times: Match the preceding item at least m times, but no more than n times.
For example: ^.{3,4}$ matches 3 and 4-digit numbers.
Match any dialing ^.+$ This differs from the above match for any numbers as it also
includes +, * and # elements that may occur in telephone
number.
^[0-9*#]$ This differs from the above match in that is only matches
telephone numbers using the numeric digits, * and #.
Match any seven digit ^(\d{7})$ This would for example, match the dialing of a local number in
number the US. In order to be properly handled, the number would
require a transform to add the digits for national dialing with the
local area code.
Match any eleven digit ^\+1(\d{10})$ This would for example, match the dialing of a national number
number beginning with a within the US.
+1
Match any eleven digit ^\+1(555|666) This would for example, match the dialing of national numbers
number beginning with (\d{7})$ in the US with the particular area codes 555 or 565.
1555 or 1666
Add US 416 area code 555 0134 ^(\d{7})$ 416$1 416 555 0134
to 7 digit numbers
Change 00 prefix 0044 1632 309348 ^00(.+)$ +1$1 +44 1632 309348
numbers to E.164
format 001 416 555 0134 +1 416 555 0134
Change E.164 format +44 1632 309348 ^\+(.*)$ 00$1 0044 1632 309348
numbers to non-E.164
format +1 416 555 0134 001 416 555 0134
User
MS teams IP Office users are presented similarly to simultaneous users.
Connection Status
Supporting MS Teams uses 2 TLS sockets between ASBC E and IP Office. These can be verified in the SIP TC P
Users status menu (Status | SIP TCP User Data...).
If there are not 2 TC P sockets to the ASBC E IP address, the most likely cause is a certificate issue between ASBC E
and IP Office.
User Status
C onfiguration of individual users for MS Teams can be verified using SIP Phone Status menu (Status | SIP
Phone Status).
Tracing Calls
In order to escalating issues, IP Office System Monitor traces are required. These should be generated using the
default filters plus, on the Filters | Trace Options | SIP tab, enable SIP and Verbose. For call related issues,
116
ASBC E traces for the same event/time period are also required, see ASBC E SIP Tracing .
Summary
116
1. Tracing Address
117
2. Tracing SIP C alls on the ASBC E
117
3. Downloading Traces from the ASBC E
Procedure
1. Open an SSH command line session to the SBC E_HA(Primary) IP address.
2. Enter the command login as: ipcs and enter the ipcs user password when requested.
3. Enter the command [ipcs@SBCE ~]$ su - and enter the root password when requested.
4. The cursor should now be prefixed [root@SBCE ~].
10th November 2021 01a First release. Support with IP Office R11.1 FP2.
23rd November 2021 01b Removal of media bypass notes from direct routing.
Notice
While reasonable efforts have been made to ensure that the information in this document is complete and accurate at the time of printing, Avaya assumes no liability for any errors. Avaya reserves the right to
make changes and corrections to the information in this document without the obligation to notify any person or organization of such changes.
Documentation disclaimer
“ Documentation” means information published by Avaya in varying mediums which may include product information, operating instructions and performance specifications that Avaya may generally make
available to users of its products and Hosted Services. Documentation does not include marketing materials. Avaya shall not be responsible for any modifications, additions, or deletions to the original
published version of documentation unless such modifications, additions, or deletions were performed by Avaya. End User agrees to indemnify and hold harmless Avaya, Avaya's agents, servants and
employees against all claims, lawsuits, demands and judgments arising out of, or in connection with, subsequent modifications, additions or deletions to this documentation, to the ex tent made by End User.
Link disclaimer
Avaya is not responsible for the contents or reliability of any linked websites referenced within this site or documentation provided by Avaya. Avaya is not responsible for the accuracy of any information,
statement or content provided on these sites and does not necessarily endorse the products, services, or information described or offered within them. Avaya does not guarantee that these links will work all
the time and has no control over the availability of the linked pages.
Warranty
Avaya provides a limited warranty on Avaya hardware and software. Refer to your sales agreement to establish the terms of the limited warranty. In addition, Avaya’s standard warranty language, as well as
information regarding support for this product while under warranty is available to Avaya customers and other parties through the Avaya Support website:
https://support.avaya.com/helpcenter/getGenericDetails?detailId=C20091120112456651010 under the link “ Warranty & Product Lifecycle” or such successor site as designated by Avaya. Please note that if
You acquired the product(s) from an authorized Avaya Channel Partner outside of the United States and Canada, the warranty is provided to You by said Avaya Channel Partner and not by Avaya.
“ Hosted Service” means a hosted service subscription that You acquire from either Avaya or an authorized Avaya Channel Partner (as applicable) and which is described further in Hosted SAS or other service
description documentation regarding the applicable hosted service. If You purchase a Hosted Service subscription, the foregoing limited warranty may not apply but You may be entitled to support services in
connection with the Hosted Service as described further in your service description documents for the applicable Hosted Service. Contact Avaya or Avaya Channel Partner (as applicable) for more information.
Hosted Service
THE FOLLOWING APPLIES IF YOU PURCHASE A HOSTED SERVICE SUBSCRIPTION FROM AVAYA OR AN AVAYA CHANNEL PARTNER (AS APPLICABLE), THE TERMS OF USE FOR HOSTED
SERVICES ARE AVAILABLE ON THE AVAYA WEBSITE, HTTPS://SUPPORT.AVAYA.COM/LICENSEINFO UNDER THE LINK “ Avaya Terms of Use for Hosted Services” OR SUCH SUCCESSOR SITE AS
DESIGNATED BY AVAYA, AND ARE APPLICABLE TO ANYONE WHO ACCESSES OR USES THE HOSTED SERVICE. BY ACCESSING OR USING THE HOSTED SERVICE, OR AUTHORIZING
OTHERS TO DO SO, YOU, ON BEHALF OF YOURSELF AND THE ENTITY FOR WHOM YOU ARE DOING SO (HEREINAFTER REFERRED TO INTERCHANGEABLY AS “ YOU” AND “ END USER” ),
AGREE TO THE TERMS OF USE. IF YOU ARE ACCEPTING THE TERMS OF USE ON BEHALF A COMPANY OR OTHER LEGAL ENTITY, YOU REPRESENT THAT YOU HAVE THE AUTHORITY TO
BIND SUCH ENTITY TO THESE TERMS OF USE. IF YOU DO NOT HAVE SUCH AUTHORITY, OR IF YOU DO NOT WISH TO ACCEPT THESE TERMS OF USE, YOU MUST NOT ACCESS OR USE
THE HOSTED SERVICE OR AUTHORIZE ANYONE TO ACCESS OR USE THE HOSTED SERVICE. YOUR USE OF THE HOSTED SERVICE SHALL BE LIMITED BY THE NUMBER AND TYPE OF
LICENSES PURCHASED UNDER YOUR CONTRACT FOR THE HOSTED SERVICE, PROVIDED, HOWEVER, THAT FOR CERTAIN HOSTED SERVICES IF APPLICABLE, YOU MAY HAVE THE
OPPORTUNITY TO USE FLEX LICENSES, WHICH WILL BE INVOICED ACCORDING TO ACTUAL USAGE ABOVE THE CONTRACT LICENSE LEVEL. CONTACT AVAYA OR AVAYA’S CHANNEL
PARTNER FOR MORE INFORMATION ABOUT THE LICENSES FOR THE APPLICABLE HOSTED SERVICE, THE AVAILABILITY OF ANY FLEX LICENSES (IF APPLICABLE), PRICING AND BILLING
INFORMATION, AND OTHER IMPORTANT INFORMATION REGARDING THE HOSTED SERVICE.
Licenses
THE SOFTWARE LICENSE TERMS AVAILABLE ON THE AVAYA WEBSITE, HTTPS://SUPPORT.AVAYA.COM/LICENSEINFO, UNDER THE LINK “ AVAYA SOFTWARE LICENSE TERMS (Avaya
Products)” OR SUCH SUCCESSOR SITE AS DESIGNATED BY AVAYA, ARE APPLICABLE TO ANYONE WHO DOWNLOADS, USES AND/OR INSTALLS AVAYA SOFTWARE, PURCHASED FROM
AVAYA INC., ANY AVAYA AFFILIATE, OR AN AVAYA CHANNEL PARTNER (AS APPLICABLE) UNDER A COMMERCIAL AGREEMENT WITH AVAYA OR AN AVAYA CHANNEL PARTNER. UNLESS
OTHERWISE AGREED TO BY AVAYA IN WRITING, AVAYA DOES NOT EXTEND THIS LICENSE IF THE SOFTWARE WAS OBTAINED FROM ANYONE OTHER THAN AVAYA, AN AVAYA AFFILIATE
OR AN AVAYA CHANNEL PARTNER; AVAYA RESERVES THE RIGHT TO TAKE LEGAL ACTION AGAINST YOU AND ANYONE ELSE USING OR SELLING THE SOFTWARE WITHOUT A LICENSE. BY
INSTALLING, DOWNLOADING OR USING THE SOFTWARE, OR AUTHORIZING OTHERS TO DO SO, YOU, ON BEHALF OF YOURSELF AND THE ENTITY FOR WHOM YOU ARE INSTALLING,
DOWNLOADING OR USING THE SOFTWARE (HEREINAFTER REFERRED TO INTERCHANGEABLY AS “ YOU” AND “ END USER” ), AGREE TO THESE TERMS AND CONDITIONS AND CREATE A
BINDING CONTRACT BETWEEN YOU AND AVAYA INC. OR THE APPLICABLE AVAYA AFFILIATE (“ AVAYA” ).
Avaya grants You a license within the scope of the license types described below, with the ex ception of Heritage Nortel Software, for which the scope of the license is detailed below. Where the order
documentation does not ex pressly identify a license type, the applicable license will be a Designated System License. The applicable number of licenses and units of capacity for which the license is granted
will be one (1), unless a different number of licenses or units of capacity is specified in the documentation or other materials available to You. “ Software” means computer programs in object code, provided by
Avaya or an Avaya Channel Partner, whether as stand-alone products, pre-installed on hardware products, and any upgrades, updates, patches, bug fix es, or modified versions thereto. “ Designated Processor”
means a single stand-alone computing device. “ Server” means a Designated Processor that hosts a software application to be accessed by multiple users. “ Instance” means a single copy of the Software
ex ecuting at a particular time: (i) on one physical machine; or (ii) on one deployed software virtual machine (“ VM” ) or similar deployment.
License type(s)
Designated System(s) License (DS). End User may install and use each copy or an Instance of the Software only on a number of Designated Processors up to the number indicated in the order. Avaya may
require the Designated Processor(s) to be identified in the order by type, serial number, feature key, Instance, location or other specific designation, or to be provided by End User to Avaya through electronic
means established by Avaya specifically for this purpose.
Concurrent User License (CU). End User may install and use the Software on multiple Designated Processors or one or more Servers, so long as only the licensed number of Units are accessing and using the
Software at any given time. A “ Unit” means the unit on which Avaya, at its sole discretion, bases the pricing of its licenses and can be, without limitation, an agent, port or user, an e-mail or voice mail account
in the name of a person or corporate function (e.g., webmaster or helpdesk), or a directory entry in the administrative database utilized by the Software that permits one user to interface with the Software. Units
may be linked to a specific, identified Server or an Instance of the Software.
CPU License (CP). End User may install and use each copy or Instance of the Sof tware on a number of Serv ers up to the number indicated in the order
prov ided that the perf ormance capacity of the Serv er(s) does not exceed the perf ormance capacity specif ied f or the Sof tware. End User may not re-install or
operate the Sof tware on Serv er(s) with a larger perf ormance capacity without Av ay a’s prior consent and pay ment of an upgrade f ee.
Named User License (NU). Y ou may : (i) install and use each copy or Instance of the Sof tware on a single Designated Processor or Serv er per authorized Named
User (def ined below); or (ii) install and use each copy or Instance of the Sof tware on a Serv er so long as only authorized Named Users access and use the
Sof tware. “Named User”, means a user or dev ice that has been expressly authorized by Av ay a to access and use the Sof tware. At Av ay a’s sole discretion, a
“Named User” may be, without limitation, designated by name, corporate f unction (e.g., webmaster or helpdesk), an e-mail or v oice mail account in the name of
a person or corporate f unction, or a directory entry in the administrativ e database utilized by the Sof tware that permits one user to interf ace with the Sof tware.
Shrinkwrap License (SR). Y ou may install and use the Sof tware in accordance with the terms and conditions of the applicable license agreements, such as
“shrinkwrap” or “clickthrough” license accompany ing or applicable to the Sof tware (“Shrinkwrap License”).
Copy right
Except where expressly stated otherwise, no use should be made of materials on this site, the Documentation, Sof tware, Hosted Serv ice, or hardware prov ided
by Av ay a. All content on this site, the documentation, Hosted Serv ice, and the product prov ided by Av ay a including the selection, arrangement and design of
the content is owned either by Av ay a or its licensors and is protected by copy right and other intellectual property laws including the sui generis rights relating to
the protection of databases. Y ou may not modif y , copy , reproduce, republish, upload, post, transmit or distribute in any way any content, in whole or in part,
including any code and sof tware unless expressly authorized by Av ay a. Unauthorized reproduction, transmission, dissemination, storage, and or use without the
express written consent of Av ay a can be a criminal, as well as a civ il of f ense under the applicable law.
Virtualization
The f ollowing applies if the product is deploy ed on a v irtual machine. Each product has its own ordering code and license ty pes. Note that each Instance of a
product must be separately licensed and ordered. For example, if the end user customer or Av ay a Channel Partner would like to install two Instances of the
same ty pe of products, then two products of that ty pe must be ordered.
The f ollowing applies if the H.264 (AVC) codec is distributed with the product. THIS PRODUCT IS LICENSED UNDER THE AVC PATENT PORTFOLIO LICENSE
FOR THE PERSONAL USE OF A CONSUMER OR OTHER USES IN WHICH IT DOES NOT RECEIVE REMUNERATION TO (i) ENCODE VIDEO IN
COMPLIANCE WITH THE AVC STANDARD (“AVC VIDEO”) AND/OR (ii) DECODE AVC VIDEO THAT WAS ENCODED BY A CONSUMER ENGAGED IN A
PERSONAL ACTIVITY AND/OR WAS OBTAINED FROM A VIDEO PROVIDER LICENSED TO PROVIDE AVC VIDEO. NO LICENSE IS GRANTED OR SHALL
BE IMPLIED FOR ANY OTHER USE. ADDITIONAL INFORMATION MAY BE OBTAINED FROM MPEG LA, L.L.C. SEE HTTP://WWW.MPEGLA.COM.
WITH RESPECT TO CODECS, IF THE AVAY A CHANNEL PARTNER IS HOSTING ANY PRODUCTS THAT USE OR EMBED THE G.729 CODEC, H.264
CODEC, OR H.265 CODEC, THE AVAY A CHANNEL PARTNER ACKNOWLEDGES AND AGREES THE AVAY A CHANNEL PARTNER IS RESPONSIBLE FOR
ANY AND ALL RELATED FEES AND/OR ROY ALTIES. THE G.729 CODEC IS LICENSED BY SIPRO LAB TELECOM INC. SEE
WWW.SIPRO.COM/CONTACT.HTML. THE H.264 (AVC) CODEC IS LICENSED UNDER THE AVC PATENT PORTFOLIO LICENSE FOR THE PERSONAL USE
OF A CONSUMER OR OTHER USES IN WHICH IT DOES NOT RECEIVE REMUNERATION TO: (I) ENCODE VIDEO IN COMPLIANCE WITH THE AVC
STANDARD (“AVC VIDEO”) AND/OR (II) DECODE AVC VIDEO THAT WAS ENCODED BY A CONSUMER ENGAGED IN A PERSONAL ACTIVITY AND/OR
WAS OBTAINED FROM A VIDEO PROVIDER LICENSED TO PROVIDE AVC VIDEO. NO LICENSE IS GRANTED OR SHALL BE IMPLIED FOR ANY OTHER
USE. ADDITIONAL INFORMATION FOR H.264 (AVC) AND H.265 (HEVC) CODECS MAY BE OBTAINED FROM MPEG LA, L.L.C. SEE
HTTP://WWW.MPEGLA.COM.
Security Vulnerabilities
Inf ormation about Av ay a’s security support policies can be f ound in the Security Policies and Support section of https://support.av ay a.com/security . Suspected
Av ay a product security v ulnerabilities are handled per the Av ay a Product Security Support Flow (https://support.av ay a.com/css/P8/documents/100161515).
Downloading Documentation
For the most current v ersions of Documentation, see the Av ay a Support website: https://support.av ay a.com, or such successor site as designated by Av ay a.
Contact Av ay a Support
See the Av ay a Support website: https://support.av ay a.com f or product or Hosted Serv ice notices and articles, or to report a problem with y our Av ay a product or
Hosted Serv ice. For a list of support telephone numbers and contact addresses, go to the Av ay a Support website: https://support.av ay a.com (or such
successor site as designated by Av ay a), scroll to the bottom of the page, and select Contact Av ay a Support.