OpenScape Branch V10 Configuration Guide Administrator Documentation Issue 4
OpenScape Branch V10 Configuration Guide Administrator Documentation Issue 4
OpenScape Branch V10 Configuration Guide Administrator Documentation Issue 4
P31003-H81A0-M101-04-76A9
Provide feedback to further optimize this document to [email protected].
atos.net
Table of Contents
History of Changes ...................................................................................................................................................... 8
1 Disclaimer ........................................................................................................................................................ 8
2 Software Installation ......................................................................................................................................... 8
2.1 Boot sequence setup ........................................................................................................................................... 8
2.1.1 Configure BIOS for IBM/Lenovo 3250M3/M5/M6 and 3550M4/M5 .......................................................... 9
2.1.2 Boot device for one time use: for IBM 3250M3/M5/M6 ............................................................................... 9
3 USB Stick Setup tool ...................................................................................................................................... 10
4 Full Installation............................................................................................................................................... 14
5 Branding ......................................................................................................................................................... 15
6 OpenScape Voice (OSV) Configuration ........................................................................................................ 16
7 OpenScape Branch Configuration ................................................................................................................ 18
8 Network Services .......................................................................................................................................... 19
8.1 Ethernet Interface Bonding ...................................................................................................................... 22
9 OSB IPV6 for Administration ......................................................................................................................... 32
10 IPV6 Support for SIP Devices ......................................................................................................................... 32
11 OSB IPv6 support for SIP trunks ..................................................................................................................... 34
12 Users/Password Recovery/Change ............................................................................................................... 37
12.1 Users/Passwords .............................................................................................................................................. 37
13 Administration Accounts ................................................................................................................................ 38
14 Radius ............................................................................................................................................................ 38
15 SSH with PKI and Certificate files for WEB Server ........................................................................................... 39
16 Utilities (Reboot + VersionInformation) ............................................................................................................ 40
17 Time Settings/NTP ......................................................................................................................................... 41
18 VOIP Configuration ........................................................................................................................................ 42
18.1. PROXY Mode ........................................................................................................................................... 42
18.2. SIP Server Configuration ......................................................................................................................... 42
18.3. Codecs Configuration ............................................................................................................................... 45
18.4. RTP Configuration .................................................................................................................................... 47
18.5. Timers and Thresholds .............................................................................................................................. 48
18.6. SIP Manipulation, Office Code Mapping and Gateways ............................................................................ 49
18.7. SIP Manipulation Provisioning ................................................................................................................... 49
18.8. Office Code Mapping ................................................................................................................................. 51
18.9. Extension Dialing Across Office Codes ..................................................................................................... 51
18.10. Source-Based Routing ............................................................................................................................... 51
18.11. SIP Routing Provisioning ........................................................................................................................... 53
18.12. Gateway Provisioning ................................................................................................................................ 54
18.13 SIP Manipulation Provisioning ................................................................................................................... 57
19 Call Forward (Voice Mail) ............................................................................................................................... 58
20 Local Voice Mail Service ................................................................................................................................ 59
21 MOH ............................................................................................................................................................... 64
22 QOS ............................................................................................................................................................... 66
23 DHCP ............................................................................................................................................................. 67
24 PhoneSoftwareManagement ......................................................................................................................... 68
24.1. Feature Description- Prerequisites ............................................................................................................ 68
24.2. Central HTTPS server ................................................................................................................................ 68
24.3. Phones ....................................................................................................................................................... 69
24.4. Branch Office ............................................................................................................................................. 69
24.5. OSB Configuration ..................................................................................................................................... 70
24.6. DLS Configuration ...................................................................................................................................... 72
24.7. Configure Central HTTPS Server .............................................................................................................. 72
1
P31003-H81A0-M101-04-76A9, 15/11/21
OpenScape Branch V10, Configuration Guide
24.8. Obtain Branch Office Data ......................................................................................................................... 73
24.9. Synchronize with OpenScape Server ........................................................................................................ 75
24.10. Location...................................................................................................................................................... 75
24.11. Phone Deployment .................................................................................................................................... 77
24.12. Deploy Workpoints ..................................................................................................................................... 78
24.13. Manage Rules ............................................................................................................................................ 78
25 Auto Attendant (AA) ....................................................................................................................................... 80
26 Message rate control ..................................................................................................................................... 80
27 Digest Authentication Credentials synchronization between OSB and OSV ................................................ 81
28 Emergency Calling ......................................................................................................................................... 81
29 NG911 support for Emergency Calling ......................................................................................................... 83
30 CDR ............................................................................................................................................................... 87
30.1 CDR Record Details ................................................................................................................................. 88
32. DNS ................................................................................................................................................................ 89
32.1 Slave DNS ................................................................................................................................................. 89
32.2 Forward DNS ............................................................................................................................................ 91
32.3 Master DNS............................................................................................................................................... 92
33. DNS SRV ....................................................................................................................................................... 93
34. Multi Line Hunting Groups (MLHG) ............................................................................................................... 95
34.1 Synchronization for OSB MLHG and Emergency Calling Subnets ...................................................... 96
35. OSB Redundancy .......................................................................................................................................... 97
35.1 Upgrading Redundant System................................................................................................................. 97
35.2 Disabling Redundant System .................................................................................................................. 98
35.3 Master Status Check ................................................................................................................................ 98
35.4 Backup Status Check ............................................................................................................................... 99
36. Phone Configuration for Proxy..................................................................................................................... 100
36.1 Load Config (DB XML File) .......................................................................................................................... 110
36.2 Import Config (DB XML File) .................................................................................................................. 110
36.3 Export Config (DB XML File) .................................................................................................................. 111
36.4 Backup/Restore of custom configuration files ...................................................................................... 111
36.4.1 Export ............................................................................................................................................... 111
36.4.2 Import ............................................................................................................................................... 112
36.5. How to install / upgrade a file ................................................................................................................... 113
36.5.1 Install ................................................................................................................................................ 113
36.5.2 Upgrade ................................................................................................................................................ 115
36.5.3 How to configure Bulk Configuration (Delta XML) ................................................................................ 120
36.5.4 How to Restart ...................................................................................................................................... 125
36.5.5 How to configure Scheduled Maintenance ........................................................................................... 127
37. Creating Delta XML .................................................................................................................................... 129
38. Upgrade ....................................................................................................................................................... 120
39. Debug/Tracing ............................................................................................................................................. 122
39.1 Log settings (Log Size, Log Level and Syslog) .......................................................................................... 122
39.2 Log data .................................................................................................................................................. 124
39.3 Rapidstat ................................................................................................................................................. 127
39.4 Debugging Tools (ICMP, Trace Route, Network Tracer) .................................................................... 127
39.5 Continuous Tracing ................................................................................................................................ 126
39.6 On Demand Trace .................................................................................................................................. 126
39.7 Advanced (Enabling the System Collector Logs) ................................................................................ 127
40 Signaling and Transport Settings .................................................................................................................. 129
41 Branch SBC Mode ....................................................................................................................................... 130
42 Media Server (MS) ....................................................................................................................................... 138
42.1 Configuring OSB as main Media Server in OSV ....................................................................................... 140
42.2 Configuring OSB in the OSV as Branch Media Server .................................................................. 146
2
P31003-H81A0-M101-04-76A9, 15/11/21
OpenScape Branch V10, Configuration Guide
42.2.1 Enable Media Server Audit in the OSV ................................................................................................. 150
42.2.2 Upload of Customized Media Server Announcements ........................................................................ 152
43. TLS Configuration ....................................................................................................................................... 154
43.1 Create TLS Certificate ............................................................................................................................ 154
43.2 Submit the Certificate Sign Request file to the Certificate Authority ..................................................... 154
43.3 Download the Certificate from the Certificate Authority ...................................................................... 155
43.4 Upload TLS Certificates for OpenScapeBranch .................................................................................. 155
44. Minimum TLS Version .................................................................................................................................. 158
44.1 Configuration of TLS in OpenScapeBranch/OSV ................................................................................. 160
44.2 Configuration of MTLS in OpenScapeBranch/OSV .............................................................................. 162
44.3 Configuration of TLS in Phones ............................................................................................................... 164
44.4 Tracing with TLS ...................................................................................................................................... 166
45 Certificate verification process compliant with Baseline Security Policy ...................................................... 167
46 Special characters in P-Preferred Identity of SIP INVITE ................................................................................ 168
47 OpenScape Branch SRTP Interworking and Codec Transcoding Configuration .......................................... 168
47.1 SRTP Termination ................................................................................................................................. 168
48 Media Transcoding ...................................................................................................................................... 174
49 Security enhancements ............................................................................................................................... 176
50 Support of near end NAT Firewall ............................................................................................................... 178
51 VOIP - Signaling and Transport Settings .................................................................................................... 181
52 Open External Firewall - Pinhole ................................................................................................................. 182
53 Table A: Fixed/Configurable Port Information .............................................................................................. 184
54 Table B: OSB Configuration Limits ............................................................................................................. 185
55 Table C: Hardware Types Table ................................................................................................................. 186
56 Table D: Operating Modes Diagram ................................................................................................................... 189
57 Table E: Routing Table ........................................................................................................................................ 190
58 OpenScape Branch 50i ....................................................................................................................................... 192
58.1 Integrated GW Configuration (Advantech 50i)............................................................................................ 192
58.1.1 Configuration Options ...................................................................................................................... 192
58.2 Enable Integrated GW and Discover card configuration ..................................................................... 194
58.3 FXS Configuration .................................................................................................................................. 195
58.3.1 Endpoint Service Profile For FXS Subscribers ................................................................................. 199
58.3.2 Location Information......................................................................................................................... 200
58.3.3 Features (FXS subscribers) ............................................................................................................. 201
58.4 FXO Configuration .................................................................................................................................. 202
58.4.1 FXO - Trunk Group Configuration .................................................................................................... 205
58.5 BRI Configuration ................................................................................................................................... 207
58.5.1 Configure OSB 50i D44 to be used as BRI NT (Network) ............................................................... 210
58.5.2 BRI - Trunk Group Configuration ..................................................................................................... 212
58.6.1 PRI - Trunk Group Configuration ..................................................................................................... 227
58.7 Integrated Gateway – General Settings ................................................................................................ 233
58.7.1 Gateway/Trunk Configuration .......................................................................................................... 233
58.7.2 SIPQ V2 ........................................................................................................................................... 233
58.7.3 Blacklist ............................................................................................................................................ 233
58.7.6 Codec Configuration ........................................................................................................................ 238
58.7.7 CID Suppression .............................................................................................................................. 239
58.7.8 Number Modification ........................................................................................................................ 240
58.7.9 Local Toll Table ................................................................................................................................ 250
59 OpenScape Branch 500i.............................................................................................................................. 251
59.1 Configuration Options ................................................................................................................................... 251
59.2 Enable Integrated GW and Discover card configuration ..................................................................... 252
59.3 PRI Configuration ................................................................................................................................... 255
59.3.1 PRI - Trunk Group Configuration ..................................................................................................... 265
3
P31003-H81A0-M101-04-76A9, 15/11/21
OpenScape Branch V10, Configuration Guide
59.4 500i - General Settings ........................................................................................................................... 270
59.4.1 Redundancy ..................................................................................................................................... 270
59.4.2 Gateway/Trunk Configuration .......................................................................................................... 273
59.4.3 SIPQ V2 ........................................................................................................................................... 273
59.4.4 Blacklist ............................................................................................................................................ 273
59.5 Number Modification .............................................................................................................................. 278
59.5.1 Incoming Calls .................................................................................................................................. 281
59.5.2 Outgoing Calls.................................................................................................................................. 283
59.5.3 OSB 50i/500i Gateway Number Modification Implementation ......................................................... 285
59.6 Local Toll Table ...................................................................................................................................... 289
59.6.1 Creation of LTT ................................................................................................................................ 289
60 OpenScape Branch 50i/500i as GW Only ................................................................................................... 290
60.1 OpenScape Voice ................................................................................................................................... 290
60.1.1 One endpoint for the OSB Main as the main destination of all calls to the gateway. ....................... 290
60.1.2 Two additional endpoints shall be configured for each gateway in order to provide an alternative if
the OSB Main is not accessible: ....................................................................................................... 292
60.2 OpenScape Branch Main ....................................................................................................................... 296
60.2.1 VoIP ................................................................................................................................................. 296
60.2.2 Gateway ........................................................................................................................................... 298
60.2.3 Media Server .................................................................................................................................... 298
60.2.4 Auto Attendant ................................................................................................................................. 298
60.2.5 Survivable Mode features ................................................................................................................ 299
60.2.6 Redundancy ..................................................................................................................................... 299
60.2.7 Backup Link ...................................................................................................................................... 299
60.2.8 DNS .................................................................................................................................................. 299
60.2.9 NTP .................................................................................................................................................. 299
60.2.10 Digest Authentication ....................................................................................................................... 299
60.2.11 Licensing .......................................................................................................................................... 299
60.2.12 Caller Number Suppression ............................................................................................................. 299
60.3 OpenScape 50i/500i Gateway ..................................................................................................................... 300
60.3.1. Licensing .......................................................................................................................................... 303
61 OSB 50i DP24 and OSB 500i DP4/8 as standalone PRI Adapters to SIP Trunking ................................................... 306
62 Proxy ATA .................................................................................................................................................... 307
62.1 Configuration Options ............................................................................................................................. 307
62.1.1 Proxy ATA behind OSB Proxy (ex. OSB500i) connected to OSV .................................................... 307
62.2 Proxy ATA connected directly to OSV .................................................................................................. 310
62.2.1 OSV/CMP ......................................................................................................................................... 310
62.2.2 Proxy ATA ........................................................................................................................................ 310
62.2.3 General Proxy ATA Configuration .................................................................................................... 312
62.4 System Status ......................................................................................................................................... 320
62.5 Analog FXS Features Support Table .................................................................................................... 321
63 Multiple OSBs in a Branch .......................................................................................................................... 323
63.1 Configuration in the OSV: ...................................................................................................................... 323
63.2 Configuration in the OSB: ...................................................................................................................... 323
64 Simplified Installation ................................................................................................................................... 327
64.1 Common Management Portal and OSB Assistant configuration: ....................................................... 327
64.1.1 Load the OpenScape Branch Software into CMP ............................................................................ 327
64.1.2 Configure the OpenScape Branch Office for Installation ................................................................. 327
64.1.3 Load the OpenScape Branch Files into CMP .................................................................................. 328
64.1.4 Required files ................................................................................................................................... 328
64.1.5 Optional files..................................................................................................................................... 328
64.2 Option 1 - Zero Touch Installation ......................................................................................................... 330
64.2.1 Zero Touch Installation Steps .......................................................................................................... 331
4
P31003-H81A0-M101-04-76A9, 15/11/21
OpenScape Branch V10, Configuration Guide
64.3 Option 2 – Simplified Installation Using Logical ID and DHCP Option 43 .......................................... 332
64.3.1 USB Stick preparation ...................................................................................................................... 332
64.3.2 DHCP Configuration......................................................................................................................... 332
64.3.3 Option 2 Installation Steps ............................................................................................................... 333
64.4 Option 3 – Simplified Installation Using Logical ID with DHCP not providing Option 43 ................... 334
64.4.1 USB Stick preparation ...................................................................................................................... 334
64.4.2 DHCP Configuration......................................................................................................................... 334
64.4.3 Option 3 Installation Steps ............................................................................................................... 334
64.5 Option 4 – Simplified Installation Using Existing Configuration File ................................................... 336
64.5.1 USB Stick preparation ...................................................................................................................... 336
64.5.2 DHCP Configuration......................................................................................................................... 336
64.5.3 Option 4 Installation Steps ............................................................................................................... 337
64.6 Option 5 – Secured Simplified Installation Using VPN ........................................................................ 337
64.6.1 USB Stick preparation ...................................................................................................................... 337
64.6.2 DHCP Configuration......................................................................................................................... 339
64.6.3 Option 5 Installation Steps ............................................................................................................... 340
64.6.4 Error Conditions ............................................................................................................................... 341
65 Back Up Data Link ....................................................................................................................................... 342
65.1 Network and Connectivity Requirements .............................................................................................. 342
65.1.1 Media Server .................................................................................................................................... 342
65.1.2 Network Services ............................................................................................................................. 342
65.1.3 Gateways ......................................................................................................................................... 342
65.1.4 Data Center Router .......................................................................................................................... 342
65.1.5 IPSec VPN ....................................................................................................................................... 342
65.1.6 PPP Network .................................................................................................................................... 342
65.2 Known Restrictions ................................................................................................................................. 343
65.2.1 General ............................................................................................................................................ 343
65.2.2 OSB V1R4 ........................................................................................................................................ 343
65.2.3 OSB V1R3 ........................................................................................................................................ 343
65.3 Configuration for OpenScape Branch with OpenScape Voice Integrated Simplex or Collocated .... 343
65.3.1 Configuring the OpenScape Voice for Backup Data Link Support .................................................. 343
65.3.2 Subscriber Rerouting Configuration ................................................................................................. 346
65.3.3 Configuration of Voice Mail Rerouting (optional).............................................................................. 357
65.4 Configuring the OpenScape Branch for Backup Data Link Support .................................................. 358
65.4.1 Backup Link Server (BLS) Configuration ......................................................................................... 358
65.4.2 Backup Link Client (BLC) Configuration .......................................................................................... 361
65.4.3 Survivability Mode Avoidance .......................................................................................................... 364
65.5 Configuration for OpenScape Branch with OpenScape Voice Geo Separated ................................. 365
65.5.1 Configuring the OpenScape Voice for Backup Data Link Support .................................................. 365
65.5.2 Configuration of Voice Mail Rerouting (optional).............................................................................. 378
65.5.3 Configuring the OpenScape Branch for Backup Data Link Support ................................................ 379
65.5.4 Survivability Mode Avoidance .......................................................................................................... 386
66 Data Center Router Settings for Geo Separated Configuration................................................................... 387
66.1 SNMP Configuration ............................................................................................................................... 387
66.2 WAN Monitoring ...................................................................................................................................... 387
66.2.1 Configuration on Data Center Router 1............................................................................................ 387
66.2.2 Configuration on Data Center Router 2............................................................................................ 388
66.3 Configuration on Branch Router .................................................................................................................. 389
66.4 Alternate routing to Backup Link Server ...................................................................................................... 389
66.4.1 Configuration on Data Center Router 1............................................................................................ 390
66.5 Configuration on Data Center Router 2 ....................................................................................................... 390
67 SIP Service Provider Provisioning ............................................................................................................... 391
67.1 Enable the WAN interface ...................................................................................................................... 391
5
P31003-H81A0-M101-04-76A9, 15/11/21
OpenScape Branch V10, Configuration Guide
67.2 Create SIP Service Provider Profile ............................................................................................................. 392
67.3 Create SIP Trunk .................................................................................................................................... 397
67.4 Create Routing Map ............................................................................................................................... 400
67.5 Do not send invite without SDP and MOH in Survivability Mode ........................................................ 400
67.5.1 No MOH to SSP in Survivability Mode ............................................................................................. 400
67.5.2 Providing MOH to the SSP in Survivability Mode ............................................................................ 401
67.6 Point to Service Provider or Publix DNS (If Applicable) ...................................................................... 401
67.7 Cseq updates for Digest Authentication ............................................................................................... 401
68 Licensing ...................................................................................................................................................... 402
68.1 Supported License Types ...................................................................................................................... 403
68.2 Central License Server (CLS)................................................................................................................ 405
68.3 Common Management Portal License Configuration .......................................................................... 405
68.4 Stand Alone License Configuration ....................................................................................................... 407
68.5 Subscription License .............................................................................................................................. 410
69 Automatic Call Distribution (ACD) ................................................................................................................ 411
69.1 General Configuration ............................................................................................................................ 411
69.2 ACD Queues ........................................................................................................................................... 411
69.3 ACD Profiles............................................................................................................................................ 414
69.4 ACD Agents ............................................................................................................................................ 415
69.5 ACD Audio Files ..................................................................................................................................... 417
69.6 Configuration for Toggle Key ................................................................................................................. 418
70 Virtualized OpenScape Branch Solution ..................................................................................................... 419
70.1 OSB iso image ........................................................................................................................................ 419
70.2 ISO Image for fresh installation ............................................................................................................. 419
70.3 ISO Image for migration of native hardware ......................................................................................... 421
70.4 Virtual Machine (VM) .............................................................................................................................. 422
70.5 Creating the VM ...................................................................................................................................... 422
70.6 Deploying OSB vApp .............................................................................................................................. 422
70.7 Creating VM manually ............................................................................................................................ 431
70.8 Setting up the VM ................................................................................................................................... 445
70.9 VM version .............................................................................................................................................. 449
70.10 Virtual OSB Installation .......................................................................................................................... 450
70.11 VMware tools installation ....................................................................................................................... 453
70.12 OpenScape Branch and SBC distribution via OVA ............................................................................. 460
70.13 VLAN configuration for OSB VM ........................................................................................................... 460
70.13.1 Port on L2 switch configured as untagged ....................................................................................... 460
70.13.2 Port on L2 switch configured as tagged ........................................................................................... 460
70.13.3 ESXi Host Interface VLAN configuration.......................................................................................... 460
71 Hosted OpenScape Branch with Secured Management Network .............................................................. 461
71.1 Network Requirements ........................................................................................................................... 461
71.1.1 VPN Concentrator Options .............................................................................................................. 461
71.1.2 Firewall ............................................................................................................................................. 462
71.1.3 Network Configuration ...................................................................................................................... 462
71.2 Configuration for OpenScape Branch .......................................................................................................... 462
71.2.1 Configuring the VPN using IPSec .................................................................................................... 462
71.3 Certificate Profile .................................................................................................................................... 464
71.4 Configuration for OpenScape Voice ...................................................................................................... 466
71.5.1 Configuring Management IP for the Endpoint .................................................................................. 466
72 Replacing OSB Voice Prompts (Features) .................................................................................................. 467
72.1 Language File ......................................................................................................................................... 467
72.2 Directory Structure .................................................................................................................................. 467
72.3 General Purpose Voice Prompts ........................................................................................................... 468
72.4 ACD Announcements ............................................................................................................................. 468
6
P31003-H81A0-M101-04-76A9, 15/11/21
OpenScape Branch V10, Configuration Guide
72.5 Auto Attendant Announcements ............................................................................................................ 469
72.6 Voice Mail Announcements ................................................................................................................... 470
72.7 Replacing files ........................................................................................................................................ 471
72.8 Steps to Install ........................................................................................................................................ 472
72.9 V9 Backup/Restore Custom Files ......................................................................................................... 474
7
P31003-H81A0-M101-04-76A9, 15/11/21
OpenScape Branch V10, Configuration Guide
History of Changes
8
P31003-H81A0-M101-04-76A9, 15/11/21
OpenScape Branch V10, Configuration Guide
1 Disclaimer
This document has been elaborated along the OpenScapeBranch development as a guide and manual of
configuration best practices.
However the descriptions and configurations in this document are based, and limited, to a very specific
deployment scenario: the Development Laboratory. Most cases, setups and networks found on the real
deployment are unique and may require a proper adequacy or necessary configuration changes to work
correctly.
2 Software Installation
2.1 Boot sequence setup
Some BIOS configuration changes may be required if you are using an OpenScape Branch 50/250,
OpenScape Branch 50i, OpenScape Branch 500i, Lenovo/IBM or Fujitsu server. (Not required for
OpenScape Branch 50i A024/48).
Before installation, if you are using IBM/Lenovo or Fujitsu hardware then some BIOS configuration changes
may be required:
Set the boot sequence for some servers adding the USB storage as first option and
the Hard Disk as second.
Verify Automatic Power Restore Policy to “Always ON” for IBM 3250 servers.
BIOS change steps for making the USB device the primary boot device will be added and a change
request has been submitted to Fujitsu.
OpenScape Branch 50/250/50i: Verify Auto Power on is Enabled. (Advanced > APM
Configuration > Restore On ACPower Loss > Power On.)
Note: if problems detecting USB stick on OpenScape Branch 50/250, OpenScape Branch 50i shows
then BIOS update is required. Contact service if this is needed (Work around is to unplug/plug USB
stick while OSB is turned on).
Note: After software installation, for security issue, it is recommended to start the boot from Hard Disk option.
8
P31003-H81A0-M101-04-76A9, 15/11/21
OpenScape Branch V10, Configuration Guide
Software image: image provided for customer on SWS.
List - Text file for external server along with software image in case of SFTP/HTTPS installation/ upgrade. File must be created
manually.
Example: To install image_osb-10.2.*.*-*.tar, place "list" file in the same directory (of the HTTPS/SFTP server) where tar file is
located.
Note: If your server is Linux, store the image file in an empty directory.
9
P31003-H81A0-M101-04-76A9, 15/11/21
OpenScape Branch V10, Configuration Guide
2.1.1 Configure BIOS for IBM/Lenovo 3250M3/M5/M6 and 3550M4/M5
2.1.2 Boot device for one time use: for IBM 3250M3/M5/M6
and 3550M3/M4/M5, Lenovo SR250 and SR530
9
P31003-H81A0-M101-04-76A9, 15/11/21
OpenScape Branch V10, Configuration Guide
6. Exit setup.
7. Continue with the system boot.
You can not select USB as a boot option since there are multiple USBs on the system, and
picking a specific port would be problematic. The best solution is to plug a USB in (as shown
below: a Kingston Data Traveler USBstick) and you can then select.
The System Boot Mode must be configured correctly, otherwise the Server will not boot
from the Hard Drive.
10
P31003-H81A0-M101-04-76A9, 15/11/21
OpenScape Branch V10, Configuration Guide
must be changed to UEFI mode. In System Settings, the Legacy Support must be disabled.
IMPORTANT:
The following servers do not support UEFI Boot Mode, only Legacy Mode:
Fujitsu Rx 200 S6
Fujitsu Rx 200 S7
50i
500i
11
P31003-H81A0-M101-04-76A9, 15/11/21
OpenScape Branch V10, Configuration Guide
3 USB Stick Setup tool
This application is distributed with the following files from SWS
misc_osb-10.02.*.*-*.tar.gz - has the default XML configuration files and the MIBS
vApps_osb-10.02.*.*-*.zip - Contains the OVF templates to create and deploy a virtual machine
for the various models of Virtual OSB.
sw-metadata-osb-10.02.*.*-*.json – this file is used with OS Composer application.
The USB Stick Wizard (usbsticksetup.exe) is a Windows application used to generate a USB Stick (pen
drive) for OpenScape Branch Installation.
1) Unzip the file “usbsticksetup_oss-*.*.*.*.zip. The files will unzip into a folder called “usbsticksetup”. The contents of the
“usbsticksetup” folder will look like:
10
P31003-H81A0-M101-04-76A9, 15/11/21
OpenScape Branch V10, Configuration Guide
2) Copy the software image *.tar file into the ob folder. The ob folder will then look like:
11
P31003-H81A0-M101-04-76A9, 15/11/21
OpenScape Branch V10, Configuration Guide
Up to V10R1:
System Name
12
P31003-H81A0-M101-04-76A9, 15/11/21
OpenScape Branch V10, Configuration Guide
Option to create new Config
USB Stick will be Note: DHCP, Logical ID, CMP
Starting from V10R2: File. Network interfaces
created with existing URL, Automated, PreInstall, and
configuration is required with Net Boot Options are covered on
this option. DB file (*.xml). If option
is selected then Server Simplified installation Appendix
Min 2GB USB Stick section.
Required Name and Interfaces
are grayed out. Fields can only be edited/clear
Note: DB (xml) when Automated or Net boot are
can not be used selected.
for different
hardware types.
5. After filling in the required information press OK to create the USB Stick .
6. After the process is concluded the USB Stick can be removed and it will be ready for
installation.
Note: log from USB Stick setup tool is available on PC by selecting “Start”, “Run”, and “%TEMP%”. Log name shows as
“usbsticksetup_(date).log”.
13
P31003-H81A0-M101-04-76A9, 15/11/21
OpenScape Branch V10, Configuration Guide
4 Full Installation
Installation erases both backup and active partitions and overwrites them with existent SW in USB. The
database can be preserved if previously stored in USB stick. This option is only available if the USB stick is
plugged and the system is booting from the USB stick.
Note: option can be done from Local GUI only. (Not supported from CMP).
Default login
User Name: administrator
Password: Asd123!.
14
P31003-H81A0-M101-04-76A9, 15/11/21
OpenScape Branch V10, Configuration Guide
Go to Maintenance > Install/Upgrade tab > Full “Install” option appears
(Note that option only shows when booting from USB stick).
For redundant system, when the flag Reboot only when all calls are disconnected is selected
and upgrade is activated, the calls will be blocked until the end of upgrade process in both nodes (master and backup).
When activating the upgrade, a warning message is displayed.
15
P31003-H81A0-M101-04-76A9, 15/11/21
OpenScape Branch V10, Configuration Guide
During this period it is not possible to receive or generate calls and register subscribers.
However, it is possible to unlock the calls when the master node has already performed the upgrade and the backup node has not
finished yet. For this, it is necessary to use the Cancel wait for backup upgrade button.
The Cancel wait for backup upgrade button is only available when calls are being blocked on the system by "pmc block" command.
14
P31003-H81A0-M101-04-76A9, 15/11/21
OpenScape Branch V10, Configuration Guide
5 Branding
Feature allows updating the Company Name, Product Name, TLA, and Logo.
Note: Feature applies to local GUI only.
Logo picture: changes the Logo Picture that is presented on Local GUI for the login screen and title bar. The file must
be a valid image (png, jpg, gif) and should use the recommended dimension (160x40) for proper display and can not be
larger than 50KB. After importing logo, it is required to “Apply Changes” so that new logo shows.
Note regarding browser cache: Any changing user interface element may not be immediately visible on all versions of
all supported browsers. Browser reload discarding cache (usually Ctrl-F5) may be needed for updating the pages
accordingly. Even clearing the browsing history may be needed.
USB can be created using the updated Company Name, Product Name, TLA, and Logo so that Customized
Branding parameters can be used during FullInstallation.
15
P31003-H81A0-M101-04-76A9, 15/11/21
OpenScape Branch V10, Configuration Guide
6 OpenScape Voice (OSV) Configuration
Following configuration required in the OSV. All signaling will go through proxy.
Note: If there is a GW behind the OSB Endpoint, then the OSB Endpoint must be set as an Associated
Endpoint in the GW.
Required flags for Proxy Functionality. OSB IP address must be configured for alias
Note: “Do not Send Invite without SDP” (Port is optional. Ex 10.234.1.70:5060).
attribute must NOT be selected on Note: if using OSB with Redundancy then
OSB50i/OSB500i Integrated Gateway Alias should include Redundant IP and
End Point. Physical IP addresses for both OSB nodes.
Configure Endpoint as trusted if Digest Authentication is used in the OSV and OSV version is older than (OSV6 PS23) or (OSV7 PS08).
1) "Scenario where Digest Authentication is enabled in the OSV but challenges are NOT desired for SIP requests on this OSB endpoint to the OSV". Configure
the Endpoint as "Trusted" for all ports. OSV parameter Srx/Sip/AuthTraverseViaHdrs can be set to "RtpFalse" since the Endpoint is configured as "Trusted" for all
ports and no challenges for requests on this Endpoint will be issued from the OSV with Digest Authentication enabled.
16
2) "Scenario where Digest Authentication is enabled in the OSV and challenges are desired for SIP requests on this OSB endpoint to the OSV". On the
Endpoint, configure as "Trusted" only the specific SIP OPTIONS port which will be used to communicate with the OSV. OSV parameter
P31003-H81A0-M101-04-76A9, 15/11/21
Srx/Sip/AuthTraverseViaHdrs is set to "RtpTrue" to traverse the header for the trusted port being used by OPTIONS. OSV will issue challenges for all SIP
OpenScape Branch V10, Configuration
requests on this Endpoint for ports which are notGuide
trusted (all except for the port using OPTIONS). Also make sure in the OSB configuration the SIP OPTIONS are
set to use this specific port as well (refer to Page 16).
2. Discover/Add Branch Office
Configuration > OpenScape Voice > Business Group > Branch Office List > Add
Select OSB
Endpoint
17
P31003-H81A0-M101-04-76A9, 15/11/21
OpenScape Branch V10, Configuration Guide
7 OpenScape Branch Configuration
OpenScape Branch tab is used to configure Branches running on OpenScape Branch Hardware. OSB 6000
(Lenovo/IBM) Supports 6000 registered subscribers; OSB 1000 (Lenovo/IBM) supports 1000 registered
subscribers; OSB500i (Advantech 500i) supports 500 registered subscribers; OSB 50/250 supports 250
registered subscribers; OSB50i supports 80 subscribers; while OSB 50i A024/48 supports 24/48 FXS
ports.
Select Branch Office from Branch Office list.
Help Link for sub section.
After selecting the Branch Office user has access to Statistics, Registered Subscribers, Backup link Status
(if enabled), and Link Status (OSB 50i/500i only). License Information is covered on Licensesection.
18
P31003-H81A0-M101-04-76A9, 15/11/21
OpenScape Branch V10, Configuration Guide
8 Network Services
User can configure network services using this menu. A pre-defined configuration of interfaces and default
gateway can be done using USB Stick Wizard.
Configuration > OpenScape Branch > Branch Office > Configuration > Network/Net Services > Settings
1) Select
Network/Net
Services from
Configuration Menu
19
P31003-H81A0-M101-04-76A9, 15/11/21
OpenScape Branch V10, Configuration Guide
2) Window shows Interface IP.
Note: Each subsection provides Help Links.
Note: changes to Interface Network Services
will require a system restart.Eth0 cannot be
disabled.
20
P31003-H81A0-M101-04-76A9, 15/11/21
OpenScape Branch V10, Configuration Guide
Window shows Interface IP.
Note: Each subsection provides Help
Links.
Note: changes to Interface Network
Services will require a system
restart.Eth0 cannot be disabled.
Interface Bonding –
checkbox for enabling the
creation of bonding groups
composed of multiple (at least
two) Ethernet interfaces.
21
P31003-H81A0-M101-04-76A9, 15/11/21
OpenScape Branch V10, Configuration Guide
8.1 Ethernet Interface Bonding
Ethernet Bonding provides the OSB user with the ability to create bonding groups composed of multiple (at least two)
Ethernet interfaces. Bonding groups are useful for providing added reliability or added bandwidth. A system that uses bonding
groups for reliability will typically use pairs of Ethernet ports, with each port being connected to different switch/router. A
system that uses bonding groups for added bandwidth will typically use pairs of Ethernet ports, with both ports being
connected to the same switch/router.
A bonding group shall consist of exactly two selected Ethernet interfacesports. If Interface bonding is enabled, then each row
of the lower table must have exactly two checkboxes checked before the screen can be saved by clicking OK.
If Interface bonding is checked, and any bonding group does not have two Ethernet interfaces ports assigned, then clicking
the OK button must result in an error message and the screen must remain open until the error is corrected.
22
P31003-H81A0-M101-04-76A9, 15/11/21
OpenScape Branch V10, Configuration Guide
Example 1 - OSB with 2 ethernet ports (eth0, eth1))
Note:Bonding is allowed only when WAN is not configured or required (SBC modes).
Note:Bonding is restricted to the LAN (bond0). eth1 must be enabled before selecting it to be part of a bonding group
(bond0).
23
P31003-H81A0-M101-04-76A9, 15/11/21
OpenScape Branch V10, Configuration Guide
Example 2 - OSB with 4 ethernet ports (eth0, eth1,eth3,eth4))
Note:If OSB is configured in one of the SBC modes, a second bond group (bond1) will be available.
Note: If bond1 is available, eth1 will not be allowed on LAN bond group (bond0). eth0 is not allowed on bond1 (if
present).
Note: eth2 and eth3 interfaces are enabled automatically when selected on bond group.
24
P31003-H81A0-M101-04-76A9, 15/11/21
OpenScape Branch V10, Configuration Guide
25
P31003-H81A0-M101-04-76A9, 15/11/21
OpenScape Branch V10, Configuration Guide
26
P31003-H81A0-M101-04-76A9, 15/11/21
OpenScape Branch V10, Configuration Guide
27
P31003-H81A0-M101-04-76A9, 15/11/21
OpenScape Branch V10, Configuration Guide
28
P31003-H81A0-M101-04-76A9, 15/11/21
OpenScape Branch V10, Configuration Guide
Terminal (OSB with 4 ethernet ports (eth0, eth1, eth2, eth3) in SBC mode
lenovo:/home/administrator # cat /etc/sysconfig/network/ifcfg-eth0
BONDING_MASTER=yes
BONDING_MODULE_OPTS="mode=active-backup miimon=100"
BONDING_SLAVE0=seth0
BONDING_SLAVE1=seth2
BOOTPROTO=static
MTU=1500
IPADDR=21.21.0.150
NETMASK=255.255.0.0
STARTMODE=auto
USERCONTROL=no
lenovo:/home/administrator # cat /etc/sysconfig/network/ifcfg-eth1
BONDING_MASTER=yes
BONDING_MODULE_OPTS="mode=balance-rr miimon=100"
BONDING_SLAVE0=seth1
BONDING_SLAVE1=seth3
BOOTPROTO=static
MTU=1500
IPADDR=21.22.0.151
NETMASK=255.255.0.0
STARTMODE=auto
USERCONTROL=no
lenovo:/home/administrator #
29
P31003-H81A0-M101-04-76A9, 15/11/21
OpenScape Branch V10, Configuration Guide
lenovo:/home/administrator # ifconfig
eth0 Link encap:Ethernet HWaddr 40:F2:E9:BB:E5:D0
inet addr:21.21.0.150 Bcast:21.21.255.255 Mask:255.255.0.0
inet6 addr: fe80::42f2:e9ff:febb:e5d0/64 Scope:Link
UP BROADCAST RUNNING MASTER MULTICAST MTU:1500 Metric:1
RX packets:3006 errors:0 dropped:0 overruns:0 frame:0
TX packets:559 errors:0 dropped:0 overruns:0 carrier:0
collisions:0 txqueuelen:0
RX bytes:266010 (259.7 Kb) TX bytes:56598 (55.2 Kb)
31
P31003-H81A0-M101-04-76A9, 15/11/21
OpenScape Branch V10, Configuration Guide
32
P31003-H81A0-M101-04-76A9, 15/11/21
OpenScape Branch V10, Configuration Guide
9 OSB IPV6 for Administration
OpenScape Branch can also support the OSB Administration Interface to be IPv6.
Configuration > OpenScape Branch > Branch Office > Configuration > Network/Net Services > Settings
32
P31003-H81A0-M101-04-76A9, 15/11/21
OpenScape Branch V10, Configuration Guide
Second step is to determine the kind of connection with OSV, either IPv4 or IPv6 on Sip Server Settings (under
VOIP tab).
Configuration > OpenScape Branch > Branch Office > Configuration > VoIP > Sip Server Settings
Please note the following table that indicates the phone configuration whether it is operating with IPv4 or IPv6.
33
P31003-H81A0-M101-04-76A9, 15/11/21
OpenScape Branch V10, Configuration Guide
OSB Proxy IP version to Data Center
IP version from IPv4 IPv6
GW Only/ATA to IPv4 Outbound Proxy Outbound Proxy = OSB Proxy
OSB = OSB Proxy Node 1 Primary Node 1 Primary = OSB Proxy
= OSV Node 1 Node 1 Backup Node 1 Backup = <empty>
= OSV Node 2 Node 2 Node 2 Primary = <empty>
Primary = OSV Node 2 Node 2 Node 2 Backup = <empty>
Backup = OSV Node 1 Proxy Proxy failure – no fallback
The only way to get fallback in case of OSB Proxy failure is by means of an alternative route through an OS SBC.
In this case, the Node 1 Backup shall be configured with the OS SBC WAN IP address which shall also be using
IPv4.
This feature introduces the communication with SIP Service Providers via IPv6. So additionally to Proxy Mode,
SBC Proxy supports IPv6 on its WAN side.
First step is the configuration of WAN interface with IPv6 (already mentioned above).
The flag “IP Version towards SIP server” will be grayed out with content value IPv4 (under VOIPSIP Server
Settings).
Configuration OpenScape Branch Branch Office Configuration VoIP Sip Server Settings
According to the requirements, three topologies are supported for connection to IPv6 SSP.
For this reason it is allowed from now on to configure an SBC Proxy with IPv6 support as Gateway only.
Topology 1: OSB in SBC Proxy Mode (LAN IPv4, WAN IPv6) , SSP IPv6 , OSV IPv4
Topology 2: OSB_1 in SBC Proxy Mode (LAN IPv4, WAN IPv6) and Gateway Only, SSP IPv6 connected to
OSB_1, OSB_2 Proxy Mode (LAN IPv4, WAN IPv6) connected to OSB_1, OSV IPv6 connected to OSB_2,
external IPv4 phones
Topology 3: OSB_1 in SBC Proxy Mode (LAN IPv4, WAN IPv6) and Gateway Only, SSP IPv6 connected to
OSB_1, OSB_2 Proxy Mode (LAN IPv4, WAN IPv6) connected to OSB_1, OSV IPv4 connected to OSB_2,
external IPv6 phones
34
P31003-H81A0-M101-04-76A9, 15/11/21
OpenScape Branch V10, Configuration Guide
by SSP” (SSP configuration) flag will be grayed out and the available Gateway/Trunk rules will be the following:
LAN – Integrated Gateway (only if 50i/500i HW).
WAN – SIP Service Provider
Furthermore the second OSB (OSB_2) mentioned on topologies 1 and 2 above will have a new option on
Gateway/Trunk Type “OSB with SSP”.
35
P31003-H81A0-M101-04-76A9, 15/11/21
OpenScape Branch V10, Configuration Guide
36
P31003-H81A0-M101-04-76A9, 15/11/21
OpenScape Branch V10, Configuration Guide
12 Users/Password Recovery/Change
Configuration > OpenScape Branch > Branch Office > Configuration > Security > General > Passwords
12.1 Users/Passwords
Default users/passwords for OSB:
37
P31003-H81A0-M101-04-76A9, 15/11/21
OpenScape Branch V10, Configuration Guide
13 Administration Accounts
Administration accounts configuration for the firewall/routing settings of OSB.
Administrator Accounts can be created by pressing the Add button and the existing ones can be edited or
deleted using the Edit and Delete buttons.
Adding or editing launches the Administrator Account configuration window.
38
P31003-H81A0-M101-04-76A9, 15/11/21
OpenScape Branch V10, Configuration Guide
Administrator Profile
User Name - User name of the Administrator account. Password - The password for
the Administrator account user Confirm Password - Confirm & verify the Administrator
ac password.
Privilege - Administrative privileges. Possible values: Network Administrator, Security
Administrator, Networ Administrator, Read Only.
Expires (days) - The password expiration timeslot. Possible v SSH login - Login to the
Linux open source application that exchanged using a secure channel between two
networked d by default.
Change password in first login - When adding a new u Password in first login is
enabled by default, & the Expires p 99999, meaning the password will not expire.
NOTE:
Only user root has the privilege to change the password of other users without knowing
the current password.
Users with privileges “Administrator”, “Security Administrator” and “Network and
Security Administrator” are able to define the password of other users only when adding
the user.
After that, only the user itself can change the password providing the current and new
password.
14 Radius
OpenScape Branch supports Radius Authentication and Accounting which provides a way of identifying a user
before allowing access to aclient.
Note: RADIUS is supported with redundant OSBs. Users on each physical OSB are authenticated via RADIUS so
the physical IP addresses of each of the OSBs (not the Virtual IP) must be configured in the RADIUS servers.
Configuration > OpenScape Branch > Branch Office > Configuration > Security > Radius
Note: different applications allow different numbers of characters in a username. CLI allows 44, while SSH and
HTTPS allow 254. It is recommended that the customer limits his/her usernames to 44 characters on all three
applications.
39
P31003-H81A0-M101-04-76A9, 15/11/21
OpenScape Branch V10, Configuration Guide
16 Utilities (Reboot + Version Information)
User can restart system to current or backup partition. It is also possible to show software information. (Health
Check and Configuration Export/Import is covered later on)
Configuration > OpenScape Branch > Branch Office > Configuration > Maintenance > Restart
40
P31003-H81A0-M101-04-76A9, 15/11/21
OpenScape Branch V10, Configuration Guide
17 Time Settings/NTP
User can configure NTP server and time settings under Network Services. Configuration > OpenScape Branch
> Branch Office > Configuration > Network/Net Services > NTP.
NOTE: If Redundancy is active, system will use physical IP for NTP queries. So, for slave synchronization the
physical IP of both Master and Slave OpenScape SBC must be added to NTP Server firewall list.
41
P31003-H81A0-M101-04-76A9, 15/11/21
OpenScape Branch V10, Configuration Guide
18 VOIP Configuration
User can configure VOIP parameters. Some configuration changes will cause the SIP server to restart, active and
ongoing calls may fail.
Configuration > OpenScape Branch > Branch Office > Configuration > VoIP
User has to configure OpenScape Branch mode under System configuration: Note: changes to OpenScape
Branch mode require a system restart.
Configuration > OpenScape Branch > Branch Office > Configuration > System > Settings
Gateway Only feature can only be enabled for 500i and 50i
Systems, including Proxy ATA, on SBC-Proxy and SSPs with
IPV6 too.
StandAlone mode Activation - is under the System Tab, "Enable StandAlone Mode" flag will reboot the system and
check for the proper license
42
P31003-H81A0-M101-04-76A9, 15/11/21
OpenScape Branch V10, Configuration Guide
42
P31003-H81A0-M101-04-76A9, 15/11/21
OpenScape Branch V10, Configuration Guide
And OSV nodes will be configured under VOIP/general.
Configuration OpenScape Branch Branch Office Configuration VoIP Sip Server Settings
4) Node1/Node2: Node1:
3) Target Type:
Depending on OSV mode
Binding: Node1/Node2 (depending on OSV mode)
configure the appropriate
have to be configured with IP or
Primary/Backup SIP Server
FQDN/Transport/Port. SRV record is grayed-out.
IP/FQDN, Transport, and Port.
SRV Record: DNS SRV Record query searches
Node2: Depending on OSV addresses automatically using respective Transport.
mode configure the Priority will apply according to network configuration.
appropriate Primary/Backup
SIP Server IP/FQDN,
Transport, and Port.
43
P31003-H81A0-M101-04-76A9, 15/11/21
OpenScape Branch V10, Configuration Guide
TCP/UDP/TLS OSV Mode MTLS
Simplex
sipsm1_vip Node 1 sipsm3_vip
Collocated
sipsm1_vip Node 1 sipsm3_vip
sipsm2_vip Node 2 sipsm4_vip
Geo-Separated
sipsm1_vip Node 1 Primary Server sipsm3_vip
sipsm2_vip Node 1 Secondary Server sipsm4_vip
sipsm2_vip Node 2 Primary Server sipsm4_vip
sipsm1_vip Node 2 Secondary Server sipsm3_vip
Note: In case the OSV is configured with the same IP address for TLS and MTLS (sipsm1_vip = sipsm3_vip, sipsm2_vip =
sipsm4_vip) then use the MTLS port 5161 instead of 5061
44
P31003-H81A0-M101-04-76A9, 15/11/21
OpenScape Branch V10, Configuration Guide
18.3. Codecs Configuration
Configuration > OpenScape Branch > Branch Office > Configuration > Features > Codecs
The support of different codecs for Integrated gateway and Media server calls require the following
configurations:
In this first section user has to select which codecs will be available under “Enable Codec Support for
Transcoding”
Second step is to add these codecs on Media profiles. Please note that only codecs that are enabled appear as
an option on Media Profile configuration.
45
P31003-H81A0-M101-04-76A9, 15/11/21
OpenScape Branch V10, Configuration Guide
Configuration > OpenScape Branch > Branch Office > Configuration > VoIP > Media
In this section user will enable the profiles and select the codecs and order of codecs that will be used
46
P31003-H81A0-M101-04-76A9, 15/11/21
OpenScape Branch V10, Configuration Guide
Flags:
Allow Unconfigured Codecs: If enabled, even when a codec is not in the list of supported codecs on the igw_profile,
the OSB will accept it and use it for transcoding.
NOTE: The "Enable Codec Support for Transcoding" flag was originally used for codec transcoding between the
LAN/WAN from a Branch-SBC or SBC Proxy, but it is also needed to support the transcoding for Integrated Gateway
and Media Server.
46
P31003-H81A0-M101-04-76A9, 15/11/21
OpenScape Branch V10, Configuration Guide
18.4. RTP Configuration
Packetization time (ms): The interval between the RTP packets. Allowed values are
10, 20 and 30 ms
Dtmf Forward Twist (dB): Sets the maximum threshold in the forward twist for the
DTMF to be detected by OSB. Dtmf Forward Twist is the difference in dB between
row (lower frequency) and column (higher frequency) energies for dtmf frequencies,
when column energy is greater than the row energy. This value should be adjusted
only if DTMF are not being correctly detected or voice is being wrongly detected as
DTMF.
Available options:4,5,6,7,8,9,10
Default value:8 dB
Dtmf reverse Twist (dB): Sets the maximum threshold in reverse twist for the DTMF
to be detected by OSB. Dtmf Reverse Twist is the difference in dB between row
(lower frequency) and column (higher frequency) energies for dtmf frequencies, when
row energy is greater than the column energy. This value should be adjusted only if
DTMF are not being correcly detected or voice is being wrongly detected as DTMF.
Available options:4,5,6,7,8,9,10
Default value:4 dB
Enable RFC 2833 support: Enables RFC2833 support for sending DTMF digits. If
the flag is enabled, the user of RFC will be negotiated between parties. If the flag is
disabled, DTMF digits are transmitted inband. This flag can only be set if “Enable
RFC2833 Support” is set. Default is disabled.
Send DTMF end using ptime: When enabled, this flag will send the three DTMF
END (final) packets using the ptime interval between them, otherwise the three
DTMF end (final) packets will be sent in a burst at same time. Set this flag if any
DTMF end packets are being lost.
Use Restrict V29 FAX Frequency: Changes V29 Fax carrier frequency tolerance
from 2Hz to 1Hz.
This flag must be set only if after a V29-9600 training or page transmission a V21
47
P31003-H81A0-M101-04-76A9, 15/11/21
OpenScape Branch V10, Configuration Guide
18.5. Timers and Thresholds
Failure Threshold (pings): number of failure attempts counted Options Interval (sec): keep alive interval to
before considering a node failure (Range 1-10) send options to SIP Server. (Range 10 - 300).
Success Threshold (pings): number of positive responses before Options Timeout (sec): timeout when waiting
considering node is active (Range 1-10). for 200OK from SIP Server (Range 1 - 32).
Transition Mode Threshold: number of failure attempts counted Notification Rate: Number of notifications per
before switching to Survivability Mode (Set transition mode sec after state transition. Disabled in Proxy
threshold to 0 if this mode is not required). ACD Mode.
Scenario1 (Going to Survivability Mode): normal Scenario2 (Going to Survivability Mode): normal
OPTIONS 4s (first timeout/fail) OPTIONS fast ping 4s OPTIONS 4s (first timeout/fail) OPTIONS fast ping 4s
OPTIONS fast ping 4s (failure threshold - 2 fast OPTIONS fast ping 4s (failure threshold - 2 fastpings)
pings) TRANSITION 60s (ping interval) TRANSITION 60s (ping interval)
OPTIONS transition 4s (transition threshold) OPTIONS transition 4s (transition threshold) TRANSITION
Total: 76seconds 60s (ping interval)
OPTIONS transition 4s (transition threshold)
Total: 140seconds
Going to Normal Mode: Any time between 0 to 64 Going to Normal Mode: Any time between 0 to 64 (Options
(Options + timeout) seconds OSB will go back toNM + timeout) seconds OSB will go back to NM
Note for going to Survivability Mode scenarios: Timer Total example shows from the time Option is sentand
not responded. Transition time could be longer depending when last Option was responded by OSV.
48
P31003-H81A0-M101-04-76A9, 15/11/21
OpenScape Branch V10, Configuration Guide
18.6. SIP Manipulation, Office Code Mapping and Gateways
Configuration for SIP Manipulation (Survivability Mode), Office Code Mapping (Survivability Mode and Normal
Mode) and Routing (Survivability Mode) are located under VOIP Menu and Manipulation and Routing Tab.
Configuration > OpenScape Branch > Branch Office > Configuration > VoIP > Manipulation and Routing
Allows user to change SIP headers during Survivability Mode (except from an Emergency Number). Rules priority
applies for best match from left to right.
Note: after save in Sip Manipulation Window user has to Apply Changes for them to commit. Apply Changes for Sip
Manipulation requires SipServer to be restarted. Call processing will be affected temporarily.
Match Digits: digits Header: SIP Header used for digit manipulation Add Prefix: place digits in
dialed (called number) will (R-URI /From/PAI/PPI/Diversion). front on Header.
be compared against. Delete/Insert Position: position where to make Replace All With: All digits will
Match Position: start change be replaced on Header.
compare of Match Digits
at this position.
Delete Digits: Number of Note: Call type different than “All” can
digits to be removed. only be configured for FROM Header.
Insert Digits: place digits
at position.
a) Row1: match 53 to the called number starting on digits position 4 (Count 0 through 4 from the left of the called number). If match replace all digits
with 5558880000
Dial 7777535000 match (Position 4), after Translation 5558880000.
b) Row2: match 561719 to the called number starting on digit position 0. If match delete 6 digits and prefix 555888.
Dial 5617195200 match (Position 0), after Translation 5558885200
c) Row3: match 305 to the called number starting on digit position 0. If match delete 2 digits from position 1 and then append 44. User Dials
3053333240 match (Position 0), after Translation 3443333240.
d) Row4: match 555888 to the calling number starting on digit position 0. If match, delete 555888 for SIP to SIP only. User Calling Number
5558885246 match (Position 0), after Translation 5246 if a SIP-SIP call was made.
49
P31003-H81A0-M101-04-76A9, 15/11/21
OpenScape Branch V10, Configuration Guide
Note: is possible to add a + in the From Header (if needed for certain GWs, ex. HiPath 3000). Example: Match digits: 4, Match position: 0,
Header: From, Add prefix: +. This configuration is needed for HiPath 3000/4000 so that the Gateway is able to interpret the called party number as
international number. + on R-URI should be removed as well.
50
P31003-H81A0-M101-04-76A9, 15/11/21
OpenScape Branch V10, Configuration Guide
18.8. Office Code Mapping
Configuration allows a customer to set up extension dialing across office codes defined on the same branch
(Survivability Mode), and to establish source-based routing whereby a calling party number is used as the key
for determining which outgoing gateway is used (Survivability Mode or Survivability/Normal Modes).
Configuration > OpenScape Branch > Branch Office > Configuration > VoIP > Manipulation and Routing
SN Range: subscriber numbers can be added as a range using a dash (ex. 3100 – 3350) or as a single number (ex. 3388).
Note1: duplicate subscriber numbers within the same or different ranges are not allowed.
Office Code: maximum of 14 digits [0-9] can be entered (Country Code, Area Code, and Exchange Code grouped together). This
field is only usedin Survivability Mode.
Destination Prefix: stores a single destination prefix that identifies which outgoing GW/TKG/SSP should be used to route external
calls from an extension (Routing Prefix on GW Provisioning Table).
Insert Office Code: when set, will cause the new “Office Code” function to insert the office code of the called party into the R-URI.
This field gives the user the ability to choose between using the Office Code function or SIP Manipulation to adjust the R-URI. This
field is only used in Survivability mode.
Note: Office Code and/or Destination Prefix are required.
In Normal Mode, the OSV is responsible for SIP Manipulation, while the OSB handles gateway selectionand
Type of Number (TON) handling. The OSV will also be responsible for prefixing a dialed subscriber number with
an office code.
In Survivable Mode, the OSB is responsible for SIP Manipulation, gateway selection, and Type of Number
(TON) handling.
Feature supports routing of outgoing calls to the PSTN over facilities that are associated with the calling party,
rather than the called party (Regular OSB mechanism). This is useful in cases where a customer has multiple
51
P31003-H81A0-M101-04-76A9, 15/11/21
OpenScape Branch V10, Configuration Guide
physical branches that only have a few subscribers. The physical branches may be in geographically dispersed
locations, hence requiring different trunk facilities to carry the PSTN traffic.
Normal Mode
52
P31003-H81A0-M101-04-76A9, 15/11/21
OpenScape Branch V10, Configuration Guide
While the OSV has its own concept of source-based routing based on Rate Areas (the description of this
capability is outside the scope of this document), the OSB version of this capability is also supported on the
OSB in Normal mode, in case the customer prefers to configure it in one placeonly. Setting the checkbox
labeled “Enable source-based routing in Normal Mode” will result in the Office Code table contents (SN Range
and Destination Prefix fields) being used to determine which outgoing gateway to use for calls to external
destinations. Note that the calling party number is used for the lookup in the SN Range field.
Survivable Mode
OSB performs a lookup in the SN Range field using the calling party number to get the Destination Prefix. The
prefix is then used by the function that looks at the Gateway table to determine which outgoing facility to utilize
for the call. source-based routing.
If no match is found the traditional OSB outgoing call routing, which is based on the called party number, is
used.
Source IP: source IP of the message to be routed (Subnet address in CIDR notation is also supported)
Error codes: reply code list used to reroute the messages. If Destination Type is set to Voice Mail, codes from 640 to 690 may be
used to set ringing timeout for calls whose original destination is a registered subscriber. (ex. timeout of 6s can be set by adding the
code 640 (640 - 634 = 6) to the list. Note that it is required to set at least an error code at the list. If more than one code from 640 to
690 is added, only the last one will take effect. If the destination of a call is a gateway or if the Destination Type is not Voice Mail,
ringing timeout is always 180s.
Destination IP/FQDN: This is the configuration of the destination of the message to be routed.
Destination tag: defines a tag to be added to re-routed SIP headers. SIP manipulation rules do not apply to destination tag.
Destination type: determines the type of route used for the rule
53
P31003-H81A0-M101-04-76A9, 15/11/21
OpenScape Branch V10, Configuration Guide
18.12. Gateway Provisioning
Configuration > OpenScape Branch > Branch Office > Configuration > Features > Enable gateways/trunks Feature
allows user to configure Gateways for Normal Mode and Survivability Mode.
Note: user has to Apply Changes after saving GW provisioning changes. Apply Changes requires SipServer and
SSM processes to be restarted. Call processing will be affected temporarily.
54
P31003-H81A0-M101-04-76A9, 15/11/21
OpenScape Branch V10, Configuration Guide
IP Address/FQDN/DNS Srv: configuration for GW IP,
FQDN, or DNS Srv. Only one can be configured.
FQDN is resolved via DNS or /etc/host.
55
P31003-H81A0-M101-04-76A9, 15/11/21
OpenScape Branch V10, Configuration Guide
Note: Routing Prefix expressions may be used for matching. Expressions available do not necessarily
comply with POSIX Regular Expression rules. Nevertheless, POSIX Regular Expressions are a good
reference to build matching rules. Expressions:
Denotes repetition of the previous item zero 93*1% --> Match on 91, 931, 9331,
*
or more times 93331, etc. followed by any digits.
Note: GW provisioning routing prefix matches on "[" first instead of Digits for best match. Ex. Rules
"9011%" and “[2-9]%” are created. If user dials 9011XXXX Best match is “[2-9]%”.
a) Create an SSP profile. Do not configure anything in the profile, just give a name to it. Save & apply.
b) Change the gateway type to SIP Trunk & associate the profile created to it. Save & apply.
Note: The B2BUA is used by default in SM in SSP calls. The REFER will be handled locally by the B2BUA.
It will make the calls in SM be routed through B2BUA then the REFER will be handled locally.
54
P31003-H81A0-M101-04-76A9, 15/11/21
OpenScape Branch V10, Configuration Guide
OSB: Allow SIP trunks from LAN side activation Instructions
Proxy and Proxy-ACD Modes
Features: click on Sip Service Provider profiles and create an SSP profile (default settings)
56
P31003-H81A0-M101-04-76A9, 15/11/21
OpenScape Branch V10, Configuration Guide
18.13 SIP Manipulation Provisioning
1) DNS Server List: DNS server can be configured in the OSB in order to resolve FQDNs configured.
OSB will act as DNS client. Up to three DNS Servers can be configured. IF IPV6 is enabled, the NTP
address can bea IPV6 address.
Configuration > OpenScape Branch > Branch Office > Configuration > Network/Net Services >
DNS
57
P31003-H81A0-M101-04-76A9, 15/11/21
OpenScape Branch V10, Configuration Guide
Entries should not be
added between #OB#
or they will be over
written with GUI
changes.
Host file: if no DNS server is available, FQDNs can be resolved using OSB host file /etc/hosts Note: Limit of 5
SSH sessions (Idle expiration timer is 60 minutes)
58
P31003-H81A0-M101-04-76A9, 15/11/21
OpenScape Branch V10, Configuration Guide
19 Call Forward (Voice Mail)
Allows re routing of messages to Voice Mail during SM. Feature was introduced in V1R4 and can be used
instead of SIP Routing to route calls to Voice Mail in SM. Configuration
OpenScape Branch Branch Office Configuration Features Call Forwarding
58
P31003-H81A0-M101-04-76A9, 15/11/21
OpenScape Branch V10, Configuration Guide
20 Local Voice Mail Service
Provides for OSB’s a simple Voice Mail capability in normal and survivable mode.
NOTE: MWI notification capability is NOT supported for analog subscribers (FXS ports).
59
P31003-H81A0-M101-04-76A9, 15/11/21
OpenScape Branch V10, Configuration Guide
General
VoiceMail Retrieve Destination (From Own Ext.): number that user dials to access his
own mailbox (up to 24 characters).
VoiceMail Retrieve Prompt (From Own Ext.): Select the greeting message that is
played when user access his own mailbox.
VoiceMail Retrieve Destination (From Other Ext.): number that user dials to access
his mailbox from other destination (up to 24 characters). This number must be
different from VoiceMail Destination and VoiceMail Retrieve Destination.
VoiceMail Retrieve Prompt (From Other Ext.): Select the greeting message that is
played when user access his mailbox from other destination.
60
P31003-H81A0-M101-04-76A9, 15/11/21
OpenScape Branch V10, Configuration Guide
VoiceMail Boxes
61
P31003-H81A0-M101-04-76A9, 15/11/21
OpenScape Branch V10, Configuration Guide
Maintenance
Clear VoiceMail Folder: Clear All VoiceMail Messages and Recorded Greetings.
62
P31003-H81A0-M101-04-76A9, 15/11/21
OpenScape Branch V10, Configuration Guide
Announcements
A fresh delivered OSB will contain default prompts for the VoiceMail service.
The VoiceMail box user will be able to record his own VoiceMail prompt.
63
P31003-H81A0-M101-04-76A9, 15/11/21
OpenScape Branch V10, Configuration Guide
21 MOH
OpenScape Branch supports Music On Hold while running in Survivability Mode using local Media Server.
Note: OSB Media Server must be enabled for this feature.
Configuration OpenScape Branch Branch Office Configuration Features Enable Music On Hold
64
P31003-H81A0-M101-04-76A9, 15/11/21
OpenScape Branch V10, Configuration Guide
22 QOS
QOS (Quality of Service) is the ability to guarantee a certain level of performance to the Voice over IP data
flow in converged voice/data IP networks. OSB allows QoS configuration if required by network switches
and routers (this configuration is only valid for: the RTP traffic with RTP bridging/anchoring).
RTP via RTPproxy.
Name Decimal
CS0 0
CS1 8
CS2 16
CS3 24
CS4 32
CS5 40
CS6 48
CS7 56
AF11 10
AF12 12
AF13 14
AF21 18
AF22 20
AF23 22
AF31 26
AF32 28
AF33 30
AF41 34
AF42 36
AF43 38
EF PHB 46
66
P31003-H81A0-M101-04-76A9, 15/11/21
OpenScape Branch V10, Configuration Guide
23 DHCP
OSB can be configured to act as a DHCP server for devices within the Branch.
Note: DLS and NTP (Network Services Menu, NTP Tab) information will be provided to DHCPclients.
Configuration > OpenScape Branch > Branch Office > Configuration > Network/Net Services > DHCP
67
P31003-H81A0-M101-04-76A9, 15/11/21
OpenScape Branch V10, Configuration Guide
24 Phone Software Management
24.1. Feature Description- Prerequisites
Area in OSB disk is reserved for phone SW so that phones can upgrade application from OSB within the Branch
instead of connecting to main HTTPS server in Data Center. With this capability a software load isonly
downloaded once to the branch instead of having multiple downloads for each of the phones at the branch. It is
very useful when limited bandwidth is available to the branch. DLS informs devices accordingly to use OSB
appliance for phone software upgrade. OSB pulls phone software from the configured HTTPS server. For this
implementation, all phones belonging to a branch, must be assign to a DLS location. DLS location must be set to
use OSB for software deployment and may include more than one branch.
Branch Office has been created on the OSV with OSB (only OSB is supported)
HTTP server configured (IIS or Apache) with port 444 and administrator must check not to exceed 250 MB
of software
OSB mirrors with the Central HTTP phone SW Server (port 444).Both must be configured withport 444
Central HTTPS server URL: server where the phone software is uploaded (https://server/path)
68
P31003-H81A0-M101-04-76A9, 15/11/21
OpenScape Branch V10, Configuration Guide
For this guide, Central HTTPS URL:
24.3. Phones
Only OpenStage phones are supported. Only Openstage phones are supported. Optipoints do not support
functionality to retrieve phone software from HTTPserver.
Phone sip gateway must always be set and point to OSB. In case of FQDN or DNS SRV usage, DLSserver
must be able to resolve these entries.
69
P31003-H81A0-M101-04-76A9, 15/11/21
OpenScape Branch V10, Configuration Guide
24.5. OSB Configuration
Enable Phone Software Management on OSB.
Configuration > OpenScape Branch > Branch Office > Configuration > Features > Enable Phone Software
Management.
70
P31003-H81A0-M101-04-76A9, 15/11/21
OpenScape Branch V10, Configuration Guide
After Phone Software Management setup has been completed and OSB has completed the download
(scheduled or immediate) of phone images, administrator can check that OSB provides http server functionality
by opening any browser and selecting one of the following URLs:
https://<osb_ip>:4560/opt/siemens/openbranch/var/PhoneSwRepository or https://<osb_ip>:4560/
At this point, OSB has mirrored successfully the phone software from the Central HTTP server and OSBis able
to provide this software to the branchphones
71
P31003-H81A0-M101-04-76A9, 15/11/21
OpenScape Branch V10, Configuration Guide
24.6. DLS Configuration
All branch phones must be assigned to one location. One location can be set to include more thanone branch
office.
It is assumed that phones are already registered with DLS, either DLS IP has been provided to phones via
DHCP option or DLS scan feature has been used.
Please note that once configuration is completed, for each branch subscriber, the corresponding location will
be set only if phone is registered with DLS
Start scan to check sw available on the server. After scanning is completed, DLS entry “Central HTTPS server”
will display phone images.
72
P31003-H81A0-M101-04-76A9, 15/11/21
OpenScape Branch V10, Configuration Guide
Based on the setup so far, DLS is aware of the phone software that the Openscape Branch contains since it
scanned the Central HTTPS server which the Openscape Branch used to download images from
73
P31003-H81A0-M101-04-76A9, 15/11/21
OpenScape Branch V10, Configuration Guide
After selecting Save, admin must scroll down, select OpenScape Voice tab and then click the “Get Branches”
button. As stated in the bottom message area, admin must see protocol tabsheet to check status
Selecting refresh at this point in OpenScape Voice tab, will display the Branch Officesconfigured on the
Openscape Voice server (only the ones that are type OpenScapeBranch)
74
P31003-H81A0-M101-04-76A9, 15/11/21
OpenScape Branch V10, Configuration Guide
24.9. Synchronize with OpenScape Server
Synchronization will get subscriber data (E164DN, Switch, BG, Branch Office).
Deployment Service > Element Manager > Element Manager Configuration. Select the element manager
already created in step 3.2 and select toSynchronize
As stated in the bottom message area, admin must see protocol tab to check status.
24.10. Location
Location is the parameter that binds the phones with the OSB and the phone software on the OSB with the
phone software on the Central HTTPSserver.
Deployment Service > Administration > Server Configuration > Location Name: Enter the Name for the
Location.
HTTPS Server: Select the previously configured HTTPS server that the OSB is mirroring from.
75
P31003-H81A0-M101-04-76A9, 15/11/21
OpenScape Branch V10, Configuration Guide
Use OSBranch for Software Deployment: select the checkbox to use OSB to provide software to the phones.
“OSBranch path” and “OSBranch port” values will be set and active (not grayed out anymore) Business groups
(tab): add the Branch Office (one or more).
Note: Restrictions can be configured on “SW Deployment Restrictions” tab.
Verification: OSB subscribers must be configured with location “OSB Location” at the DLS server (phones
already registered with DLS server as mentioned previously)
-Switch: grp1016c (OSV)
-BG Name: BG Manual testing (BG)
-Branch Name: RX200_Goliath (Branch Office)
-Branch subs: 2105007001, 2105007002, 2105007003, 2105007004
-DLS location: OSB Location
Search by location (pop up list should include configured location)
76
P31003-H81A0-M101-04-76A9, 15/11/21
OpenScape Branch V10, Configuration Guide
Results: Please note that if phones are registered with DLS, then a valid IP address will be displayed in the
corresponding column field.
77
P31003-H81A0-M101-04-76A9, 15/11/21
OpenScape Branch V10, Configuration Guide
24.12. Deploy Workpoints
Deployment Service > Software Deployment > Deploy Workpoints
Admin can search by location (click on the drop down button in the location field to select location from a list).
Select table view to view all phones
78
P31003-H81A0-M101-04-76A9, 15/11/21
OpenScape Branch V10, Configuration Guide
After the last step is completed, info will appear on the bottom message area regarding the lastactions that took
place.
Verification: Navigate to Job Control for verification. This applies for both ways of software deployment (Deploy
Workpoints and Manage Rules)
Deployment Service Job Coordination Job Control. Select table view
As stated above there are 4 jobs active, including the two devices that DLS could not create SD Job for in the
previous step. Admin can select any job to check execution time and deploymentdata.
Note: DLS instructed the phone to download the phone image from the OSB and SW deployment is scheduled
at a later time.
79
P31003-H81A0-M101-04-76A9, 15/11/21
OpenScape Branch V10, Configuration Guide
25 Auto Attendant (AA)
OpenScape Branch supports Automated Attendant functionality. The system can be configured to automatically
playback announcements to a line, enable the caller to navigate through the application via the usage of DTMF
tones in order to be forwarded to other announcements, subscriber lines or voicemail boxes.
Note: If Auto Attendant is used with IGW then Phones/GWs must not be configured with G.729A only, G.711
codec is also required.
The Auto Attendant functionality presents the same behavior during normal operating mode as well as during
survivable mode. OpenScape Branch supports up to 6 different Auto-Attendant routing instances. Each instance
must be associated to a destination number.
Configuration > OpenScape Branch > Branch Office > Configuration > Features > Enable Auto Attendant
Inter digit timer: time the system will wait for more digits when digits were
already dialed (3-15).
Record Access Code: code used to record user’s announcements
Wait to go to menu: delay to get connectedto Menu Announcements.
can be uploaded/deleted.
Note: Only WAV audio files (.wav) with: Bit Rate:
128kbps, Audio Sample size: 16 bit, Channels: Note: Endpoint profile Xfer
Mono, Sampling Rate: 8 kHz, Audio Format: service must be enabled in OSV
PCM are allowed for announcements. for AA feature
80
P31003-H81A0-M101-04-76A9, 15/11/21
OpenScape Branch V10, Configuration Guide
Digit: selection number.
Name: name for the dial rule.
File: Announcement played if digit is dialed.
Destination: Destination number to which the
call will be routed. Allow Recording: enable /
disable announcement recording for that
destination (E164 number required).
Repeat this menu: Repeats the Destination
selection greeting file when this digit is dialed. If
the checkbox is set, then the "File",
"Destination", and "Allow recording" fields are
Name: name for Menu.
ignored.
Time Out: timer before call is routed to default destination.
Activation Mode:
1) Automatic: enabled/disabled automatically by configured time.
2) Manual: enabled/disabled via access code.
3) Both: Automatic and Manual enabled/disabled is allowed.
WeekDay/Time configuration: configuration when menu will be enabled/disabled automatically. Only applies if Activation mode
is Automatic or Both.
Activation Code: Code used to enable menu (Manual and Both modes only)
Deactivation Code: Code used to disable menu (Manual and Both modes only)
Destination selection greeting: announcement guides caller to select a destination.
Failure prompt: announcement presented to caller when chosen destination is invalid.
Default destination prompt: announcement presented before xfer to default destination.
Final prompt file: announcement presented to caller when chosen destination is invalid and the default destination could not
answer the call for some reason or it is not configured.
Transfer prompt file: announcement presented to caller when call is transferred to the chosen destination.
Extension dialing….caller will be able to dial the desired extension number.
Default Destination: escape destination for Menu if a valid option is not selected.
Number of Extension Dialing Digits: maximum number of digits that can be dialed for an extension Extension Dialing is activated
Digit Selection: This shall allow a customer to route all calls to a particular DN to an announcement and then forward on to a
destination.
Note: To record an announcement (only one Welcome message/subscriber) dial the RA-Code (ex. *98) directly from one of the
subscribers that has Recording Enabled (ex.5558885200). The FROM header should correspond to the Subscriber number format.
A called party then routed to the Record Enabled Auto Attendant Destination will first get that Welcome message before being
transferred to that subscriber.
79
P31003-H81A0-M101-04-76A9, 15/11/21
OpenScape Branch V10, Configuration Guide
26 Message rate control
In previous version this was named SNORT ( Network Intrusion Prevention System (NIPS)) and Network
Intrusion Detection System(NIDS), which performs packet logging and real-time traffic analysis on IP
networks. It checks for networks packets and tries to find a “signature” in suspect packets. When the feature is
enabled and Message Rate Threshold is reached, the Snort (now the IP Tables) will configure a Firewall rule
to block the IP that generated such traffic. This IP will be monitored, if no more traffic comes from this IP the
Firewall rule will be removed when block period expires. Otherwise, the block period will be renewed.
Note: OSB IP as well as PC for OAM should be configured in IP addresses to avoid packet lost.
Configuration > OpenScape Branch > Branch Office > Configuration > Security > Message rate control
80
P31003-H81A0-M101-04-76A9, 15/11/21
OpenScape Branch V10, Configuration Guide
27 Digest Authentication Credentials synchronization between OSB and
OSV
During the SIP registration process, OSB requests for the Subscriber Data and for the Digest Authentication
Credentials if these feature is enabled in the OSB.
Note: The OSB's FQDN (<hostname>.<domain name>) must be configured as an alias for the branch
endpoint in the OSV.
Configuration > OpenScape Branch > Branch Office > Configuration > Security > General > Digest Authentication Tab
81
P31003-H81A0-M101-04-76A9, 15/11/21
OpenScape Branch V10, Configuration Guide
28 Emergency Calling
Provides the access to Emergency Services.
As a general rule the emergency calls should be forwarded to PSTN gateway which supports CAMA
functionality in US or for other PSTN gateway in cases where CAMA is not used. A call to the Emergency
Number triggers the server to try to establish an outgoing call to an Emergency gateway (highest priority).
When an Emergency call fails to reach the PSAP, call is re-routed to the configured local Destination (ex.
Local Attendant) which has land line to call PSAP directly.
The Emergency calling menu is located under Features (Features Available in Normal Mode and
Survivability Mode) and there are two sections available for configuration: Emergency Call Routing and
Emergency Calling Numbers.
81
P31003-H81A0-M101-04-76A9, 15/11/21
OpenScape Branch V10, Configuration Guide
Emergency Calling Subnet - LIN
LIN : Local Identification Number used to associate Notes :
a subscriber to its physical location "IP Address or Subnet" "255.255.255.255" and
CallBack Number: phone number registered at the "Subnet Mask" "255.255.255.254" parameters are
PSAP. If an outgoing emergency call is used when the IP address of calling SIP phone
unintentionally interrupted, then the remote cannot be matched
operator may callback at this number Routing prefix values will show only after GW entry
is configured on GW provisioning table and flagged
as emergency route
For OSB Proxy ATA and OSB Gateway Only, the Location Information and Emergency Calling Numbers are
available under the FXS configuration menu ( Features > Configure integrated gateway > Configure FXS
> FXS Configuration) since the Emergency Calling feature is not available under Features.
For any FXS subscriber, specific location information values can be set to override general
values.
82
P31003-H81A0-M101-04-76A9, 15/11/21
OpenScape Branch V10, Configuration Guide
29 NG911 support for Emergency Calling
Pass transparently the PIDF-LO and Geo-location header fields (NG911) - OSB shall support the transparent
conveyance of location information (GeoLocation header fields and the PIDF-LO in the SIP message body)
OSB: NG911 support for emergency calling - OSB shall be able to include a GeoLocation header field and a
pre-defined PIDF-LO into an outgoing emergency call for location unaware phones.
LLDP-MED
OSB in Normal Mode
All operation modes are supported
(Proxy, SBC-Proxy, Branch SBC)
Mandatory parameters
83
P31003-H81A0-M101-04-76A9, 15/11/21
OpenScape Branch V10, Configuration Guide
OSB in Normal Mode
INVITE request received from a SIP subscriber
DN part of the R-URI corresponds to the routing prefix
Geo-Location must be enabled
84
P31003-H81A0-M101-04-76A9, 15/11/21
OpenScape Branch V10, Configuration Guide
OSB Gateway Only
OSB Proxy ATA
(phone’s AOR)
Geo-location support for FXS (OSB 50i & OSB Proxy ATA)
Features > Integrated Gateway > FXS Configuration
Each FXS port can be set with different value for Building, Floor &Room
Emergency number must be configured to identify that the dialed number corresponds to an emergency
85
P31003-H81A0-M101-04-76A9, 15/11/21
OpenScape Branch V10, Configuration Guide
If an emergency number is configured for a subnet which includes the OSB LAN IP address on the
Emergency Calling screen, the configured emergency number is automatically filled in the FXS
emergency number
Notes:
OSB continues to support Regular Emergency calls and Emergency Gateways (PSTN) in all supported
modes
NG911 Emergency calls to SIP Service Providers through the OpenScape Branch SBC-`Proxy / Branch
SBC will not be supported on this 1st step.
If an NG911 emergency call is done in survivable mode the call will be handled as a regular Emergency
call and route the call to the configured Emergency Gateway (PSTN)
OSB shall provide NG911 support in SM with FRN5498
86
P31003-H81A0-M101-04-76A9, 15/11/21
OpenScape Branch V10, Configuration Guide
30 CDR
OpenScape Branch supports Call Detail Records while running in Survivability mode. While running in
Normal mode this is done by the OSV.
Note: CDR Allocated space
-400 MB small systems (<3550/Fujitsu).
-512MB for 3550/Fujitsu.
Configuration > OpenScape Branch > Branch Office > Configuration > Features > Enable Call Detail Records
Note: CDR uses the Contact information included in 200OK for storing FQDN or IP information for called party
on Outgoing GW/SSP calls.
87
P31003-H81A0-M101-04-76A9, 15/11/21
OpenScape Branch V10, Configuration Guide
30.1 CDR Record Details
FILENAME: /OSBIP169-20111108T090005+0500000004.bf Name of CDR record
DEVICE: OpenScape Branch Device Type HOSTNAME: OSBIP169 Configured OSB Hostname
FILETYPE: BILLING CDR file
VERSION: V7R0.02.00 SW version running on Active Partition CREATE: 2011-11-08T09:00:05+0500 File
Creation Date
0,Std,OSBIP169,607b4e345ae75cd,10,5558885226,5558885256,orig,term,,,,,10.234.1.70,10.234.1.101,20
11-8-11 T08:58:01.0+0500,2011-08-11T08:58:04.0+0500,5256,200,OK,,0, 0x010104 CLOSE: 2011-11-
88
P31003-H81A0-M101-04-76A9, 15/11/21
OpenScape Branch V10, Configuration Guide
32.DNS
Handling of domain names using OpenScape Branch DNS Server can be done in three different ways: Slave,
Forward and Master (Service only).
Configuration > OpenScape Branch > Branch Office > Configuration > Network/Net Services > DNS
89
P31003-H81A0-M101-04-76A9, 15/11/21
OpenScape Branch V10, Configuration Guide
Enable OSEE v9 DNS zone splitting-
Support of DNS zone splitting by configuring
and using a key for retrieving the assigned
DNS zone file. Disabled by default.
If reverse lookup is desired, then
the reverse zone must be added
as shown in the example.
The master DNS for each zone allows slaves to refresh their zone record when the 'expire’ parameter of the SOA Record
is reached. The "expire" value should be longer than the longest time that you require the slave DNS server to function
without contacting the master DNS server. Often the "refresh" value will be30 minutes or so and the "expire" value will be
1 week.
Note: If Redundancy is active, system will use physical IP for DNS queries. So, for slave synchronization the physical IP
of both Master and Slave OpenScape Branches must be added to DNS Server firewall list.
90
P31003-H81A0-M101-04-76A9, 15/11/21
OpenScape Branch V10, Configuration Guide
32.2 Forward DNS
OSB as a Forward DNS will forward requests to an external DNS server and caches the results.
Note: Forward DNS should only be used if Master DNS is trustable and reachable. Otherwise, slave configuration is
recommended.
IP masters/forwards: IP address
of the Master DNS.
91
P31003-H81A0-M101-04-76A9, 15/11/21
OpenScape Branch V10, Configuration Guide
32.3Master DNS
OSB acts as Master DNS server. For this case, no DNS Master Server is configured. The flag DNS Server is activated
and Custom DNS files can be uploaded. All zones have to be manually configured.
NOTE: Other DNS configuration is grayed out when customization is enabled.
92
P31003-H81A0-M101-04-76A9, 15/11/21
OpenScape Branch V10, Configuration Guide
33. DNS SRV
DNSSRV will be used when you need OpenScape Branch and phones to receive several addresses in order to
have forwarding options in case of a failure of OpenScape Voice node or Network outages.
Note: For more information on configuring the DNS Server and the OSV Solution with DNS-SRV, please refer to
the OSV Test Configuration and Connectivity Solutions Manual available inG-DMS.
For DNS-SRV it is necessary to create different SRV zones (domains) for OSV node 1, OSV node 2 (only for
geographical separation between nodes) and one zone for each Branch (if you use only TCP, UDP and TLS) or
two zones for each Branch if you use MTLS (one for TCP, UDP and TLS and one for MTLS).
Note: The priority of the proxy in the DNS server configuration has to be a lower number (higher priority) than
the OSV. Configuration > OpenScape Branch > Configuration > System > Settings
93
P31003-H81A0-M101-04-76A9, 15/11/21
OpenScape Branch V10, Configuration Guide
Enter the SRV record for the OSV. It must be
entered for both nodes in Geo-Separated Mode.
Zone name cannot be the same for the 2 nodes.
Note: port numbers are automatically taken from
SRV response.
94
P31003-H81A0-M101-04-76A9, 15/11/21
OpenScape Branch V10, Configuration Guide
OpenStage/Optipoint :
4) Ports configured with 0 since port is taken from SRV response.
5) DNS SRV records are configured for Server, Registrar, and
Gateway addresses.
6) Update Domain Name under phone Network Settings.
95
P31003-H81A0-M101-04-76A9, 15/11/21
OpenScape Branch V10, Configuration Guide
34. Multi Line Hunting Groups (MLHG)
Stand alone feature which operates in survivability mode with no relation with OpenScape Voice MLHG groups. In
order to have a similar functionality while in Survivability Mode the user has to set MLHG parameters accordingly.
Note: feature is not available in Proxy ACDmode.
Configuration > OpenScape Branch > Branch Office > Configuration > Features > Multi-line Hunt Groups
Hunt Type: Linear: hunting will always be done in the same sequence
according to the group members order. Cyclic: hunting will be done
based on the last subscriber that answered the call and then the next
one will be called. Parallel: all members will ring simultaneously.
UCD: hunting similar to cyclic type but the call will be presented to the
members until a disconnection or answer. It will not be disconnected
after the first cycle for the group members.
No Answer Advance Timer: Period that each member will ring before
the next member is called.
Overflow Destination: in case of none of members answer the call then
the overflow is called. The overflow can be a subscriber, another MLHG,
or a PSTN number.
95
P31003-H81A0-M101-04-76A9, 15/11/21
OpenScape Branch V10, Configuration Guide
34.1 Synchronization for OSB MLHG and Emergency Calling Subnets
It is possible to enable periodic synchronization of data between the OpenScape Branch Assistant and the
OpenScape Branch servers for Multiline Hunt Group and Emergency Calling subnets.
Note: feature is not supported for peer OSBcluster.
Configuration > OpenScape Voice > Administration > General Settings > OSB Synchronization
Configuration > OpenScape Branch > Administration > General Settings > OSB Synchronization
96
P31003-H81A0-M101-04-76A9, 15/11/21
OpenScape Branch V10, Configuration Guide
35. OSB Redundancy
Redundancy uses a non-proprietary protocol which is used to increase the availability of the Branch. This is
based on a virtual IP address in the same subnet of the OpenScape Branch used for redundancy. During
switchovers, calls remain active if connected between Endpoints.
Note: Files changed manually (ex. /etc/hosts), customized DHCP/DNS files and CDRs are not synchronized
between nodes. TLS related files (certificates, key files, CRL lists) and Passwords are synchronized. Other DB
parameters (including Hostname) are synchronized and identical between nodes.
For OSB V2/V1R4: Passwords, files changed manually (ex. /etc/hosts), TLS Certificates, and CDRs are not
synchronized between. Passwords must match between both nodes. Other DB parameters (including
Hostname) are synchronized and identical between nodes.
Configuration > OpenScape Branch > Branch Office > Configuration > Network/Net Services > Settings
Virtual IP: virtual IP address for redundant System. Redundant OSB can be managed via the
IP Address/Backup IP address: physical IP for each node. Virtual IP address; active node synchronizes
Note: it is required to configure 3 OSV End Points for the DB/XML to the standby node.
redundant system (1 for Redundant and 1 for each physical IP
address of each node). 3 Branch offices must be added for
configuration and maintenance.
Note: IPs for Master, Backup, Virtual must be on the same network.
Please note that when enabling the Redundancy and configuring IPs in OSB1, the database is copied in the
second node if available so it would not be required to enable it onOSB2.
1.Go to Software Repository on Maintenance tab and upload image. tar and spa file
2.Go to OpenBranch Assistant tab and select Job Management
3. In the List of Jobs, select Add Job. Select as Action Transfer, the Target version (version previously
uploaded in the Software Repository).
4. In the Start Time and Date field either select immediate or schedule the action for a specific time and date
5.From the List of nodes select the virtual node and press OK
6. Once Transfer action is Complete proceed with the Activation of the software. The user caneither Add a new
Job in the List of Jobs or clone the Transfer action and change the Action to Activation…Activation of the
Software is started
7. Activation of software is Complete and Master node restarts.
8.Standby Node becomes Active temporarily.
9. Once running again, after about 5 minutes, previous Active Node becomes Master Node again and uploads
SW image to Original Standby Node.
10. Upload/Upgrade completes, Standby Node restarts. Both Nodes are now upgraded.
97
P31003-H81A0-M101-04-76A9, 15/11/21
OpenScape Branch V10, Configuration Guide
Note: a few alarms will show during upgrade procedure since nodes will restart. Alarms shouldclear
automatically when upgrade completes.
1.Select the Master Node from Menu in the OpenBranch Assistant tab->Networkservices->Edit Interface.
2.Delete the entries for node 2, virtual node and change the IPAddress Node 1 to a temporaryIP.
3. Go to the Redundancy Tab and Disable Redundancy. Press OK and Apply changes
At this point system gets restarted. When the box comes up with the new temporary IP address, in order for the
user to be able to administer the box, he will have to edit the corresponding Endpoint in the OSV (either change
the IP of the Endpoint or create a new dummy one). The box now is a standalone box and Previously Backup
node has now become Master.
4. Repeat the above steps for the Backup Node (which is now Master)
Note: If Redundant System is not available OSB Master will show an alarm. Alarms are reported using physical
IP address of each node.
IMPORTANT Note: In an OSB redundant environment were OSB is in survivability mode, If OSBMaster is
doped causing switching of master/slave-node, then:
RTP flow between the PSTN and the MLHG agent will stay up, but the SIP call will be lost.
All calls that where in queue (e.g. in ringing state) will be lost. Note that the backup OSB1000 does not know anything about
these calls.
98
P31003-H81A0-M101-04-76A9, 15/11/21
OpenScape Branch V10, Configuration Guide
35.4Backup Status Check
Physical IP address of second node can be used to check node status (Backup Node in this case).
Note: backup node only allows read access.
Configuration > OpenScape Branch > Branch Office > Configuration > Local Dashboard > Services Status (Show)
Verify Redundancy
service shows running
99
P31003-H81A0-M101-04-76A9, 15/11/21
OpenScape Branch V10, Configuration Guide
36. Phone Configuration for Proxy Check outbound proxy flag
100
P31003-H81A0-M101-04-76A9, 15/11/21
OpenScape Branch V10, Configuration Guide
37. OSB Status information
It is possible to get OSB System Status, System Information, Registered Subscribers, Logs (See Logging
Section), Service Status and Subscriber Data.
Only
Applicable to
Redundancy
101
P31003-H81A0-M101-04-76A9, 15/11/21
OpenScape Branch V10, Configuration Guide
102
P31003-H81A0-M101-04-76A9, 15/11/21
OpenScape Branch V10, Configuration Guide
37.2 Services Status
103
P31003-H81A0-M101-04-76A9, 15/11/21
OpenScape Branch V10, Configuration Guide
104
P31003-H81A0-M101-04-76A9, 15/11/21
OpenScape Branch V10, Configuration Guide
38. Alarms
38.1Alarm Configuration
OSB allows user to activate/deactivate/configure alarm thresholds as well as check alarm status/History.
Configuration > OpenScape Branch > Branch Office > Configuration > Alarms > Alarm Settings
1- GroupID and EventId correspond to the SNMP trap OID (last 2 numbers of the OID).
2- GroupName name of the GroupID. It groups together system status information of similar
kind.
3- EventName character string that describers the alarm. Closely related to the trap name as
defined in the OSB SNMP MIB.
4- Active determines if the alarm will be generated or not.
5- Threshold value that needs to be checked by monitor for an alarm to be generated.
6- Trigger shows the condition where the alarm will be generated. Trigger is a comparison
with alarm value.
7- Severity alarm severity assigned to that particular alarm (warning, minor, major, critical).
The Severity is fixed per Fault-Id.
8- Flow Timer indicates the minimal time to wait before generating a next occurrence of the
same alarm.
9- ReportingClass number between 0 and 7 that groups events to classes that are reported
to the same trap destination. 0 means that the event is not reported via SNMP trap.
10- Faulty Object character string that defines the object that is at fault.
11- Event Type classifies alarms into: communications, environmental, equipment,
processingError, andqualityOfService.
105
P31003-H81A0-M101-04-76A9, 15/11/21
OpenScape Branch V10, Configuration Guide
38.2 SNMP V3 GET Configuration
The Management portal of OSB allows the configuration of snmp v3 gets of linux default MIB.
106
P31003-H81A0-M101-04-76A9, 15/11/21
OpenScape Branch V10, Configuration Guide
38.3 Trap Destinations
Configuration > OpenScape Branch > Branch Office > Configuration > Alarms > SNMP Configuration
Alarms can be routed to a remote device using SNMP v2c or SNMP v3.
To allow SNMP manager discovery, SNMP v2c read-only community name and SNMP v2c read-only IP have to be configured. Note:
if read-only community name is configured in the SNMP v2c trap destinations table for an IP, general configuration will not be used
for that IP.
107
P31003-H81A0-M101-04-76A9, 15/11/21
OpenScape Branch V10, Configuration Guide
For SNMP v3 trap destination table:
IP address: Defines the IP used where trap is sent.
Port: Internal port used to send the trap.
Security name: SNMP v3 security name.
Security level: authPriv (traps sent with authentication and privacy), auth (traps sent with
authentication only), none.
Auth protocol: Authentication protocol (md5 or sha1).
Auth password: Authentication password.
Priv protocol: Privacy/Encryption protocol (des or aes).
Priv password: Privacy/Encryption password.
Blocked: Trap will not be sent (if checked).
Reporting class set: list of Alarm Reporting Classes that will be reported via SNMP TRAP.
108
P31003-H81A0-M101-04-76A9, 15/11/21
OpenScape Branch V10, Configuration Guide
38.4Alarm Status/History
It is possible to check the status of alarms to see if any are active. User can also go back and check on
alarm History to see alarms that occurred and cleared automatically.
Maintenance > Inventory > Nodes > Branch Office
108
P31003-H81A0-M101-04-76A9, 15/11/21
OpenScape Branch V10, Configuration Guide
36. Backup/Restore and XML Configurations
User can change system configuration by loading, importing or exporting xml configuration files.
Note: configuration done from CLI (ex. /etc/hosts, Manual DNS config, etc) will have to be backed up
manually as it is not part of the XML.
Configuration > OpenScape Branch > Branch Office > Maintenance > Import/Export
109
P31003-H81A0-M101-04-76A9, 15/11/21
OpenScape Branch V10, Configuration Guide
Note: The maximum number of .xml configuration files a system can store at the same time is reduced.
When the user tries to save 25 files or more, all except the newest 10 will be compressed on a .tar.gz.
1) In the Load field, select a configuration file from the drop down menu and press Load.
A new configuration file is loaded. Changes are applied permanently by selecting Apply Changes on the General page.
Note: after appl yi ng changes the loaded config file will be incremented by 1 (e.g. Config_1_.xml is configured as
Config_2_.xml).
1) In the Import field, select Choose file and browse for the file you want to upload on a new window.
A new configuration file is loaded. Changes are applied permanently by selecting Apply Changes on the General page.
Note: after applying changes the loaded config file will be incremented by 1. (e.g. Config_1_.xml is configured as
110
P31003-H81A0-M101-04-76A9, 15/11/21
OpenScape Branch V10, Configuration Guide
Config_2_.xml).
3) Select a configuration file to export and Save or Open file. By default the latest config file is selected.
Note: The maximum number of .xml configuration files a system can store at the same time is reduced.
When the user tries to save 25 files or more, all except the newest 10 will be compressed on a .tar.gz.
111
P31003-H81A0-M101-04-76A9, 15/11/21
OpenScape Branch V10, Configuration Guide
36.4 Backup/Restore of custom configuration files
36.4.1 Export
The available file groups are listed in the scroll box. Select groups to export by selecting the checkboxes aside
the group name. Any number of groups can be selected and exported.
Shortcut checkboxes can be accessed just above the scroll box. There it is possible to select All groups,
Config Files (XML group) or Security Files (Security certificates and keys group).
A password will be required when selecting All, Security Files or Security certificates and keys. This
password is used to encrypt the sensitive data and will be required only when importing those files.
Press Export just below the scroll area to save a tar file with all the files related to the selected groups. The
tar file is named <hostname>-customBackup-<date>.tar.
111
P31003-H81A0-M101-04-76A9, 15/11/21
OpenScape Branch V10, Configuration Guide
36.4.2 Import
Select the tar file by pressing the Upload button. If the file is valid, the left scroll area is populated with the non empty
group directories. The right scroll area shows the contents of the currently selected group.
Select groups to import by selecting the checkboxes aside the group name. Any number of groups can be
selected and imported.
112
P31003-H81A0-M101-04-76A9, 15/11/21
OpenScape Branch V10, Configuration Guide
As in the export section, a password will be required when selecting All, Security Files or
Security certificates and keys. This password is used to decrypt the sensitive data and is
required to import those files.
Depending on which groups are selected, pressing Apply Changes may be required to
complete the import process.
Error messages may appear at the end of import operation. Details about the error may be
found on "Web Server" log.
Install / Upgrade Tab under Maintenance allows you to start the OSB software installation or upgrade.
36.5.1 Install
The Install option is available only the first time you perform the full installation.
Installation erases both backup and active partitions and overwrites the existent software version in USB.
The database can be preserved if previously stored in USB stick.
Starting from V10R2, the UEFI bootloader flag is available in the installation option. “UEFI Bios
detected” or “UEFI Bios NOT detected” message is also shown, depending on the boot mode
configured in the server.
For Legacy Mode, this flag should be deactivated and for UEFI Mode this flag should be activated.
113
P31003-H81A0-M101-04-76A9, 15/11/21
OpenScape Branch V10, Configuration Guide
The UEFI bootloader flag could be also activated in the USBsticksetup.
Please, attention to choose this option. The System Boot Mode must be configured correctly,
otherwise the Server will not boot from the Hard Drive.
INFO: For virtual machines, it is recommended to use Legacy Mode, then this flag should be not used.
INFO:
Using physical hardware, this option is available only if the USB stick is plugged and the system is booting
from the USB stick. For virtual machines, this option is also available in full installation.
114
P31003-H81A0-M101-04-76A9, 15/11/21
OpenScape Branch V10, Configuration Guide
Partitioning
1. Partition “A” is used to hold one copy of the uncompressed OpenScape Branch software.
2. Partition “B” is used to hold a second copy of the uncompressed OpenScape Branch software.
The “A” and “B” partitions provide the possibility of falling back to a previous software release in the event of a
problem when upgrading to a new software release.
Upon initial installation, the “A” partition holds the “active” file system which is loaded into RAM whenever the
OpenScape SBC is restarted. When performing the first upgrade after the initial installation, the new software is
stored on the “B” partition and the boot loader is modified, so that the “B” partition is designated as holding the
“active” file system which is loaded into RAM whenever the OpenScape SBC is restarted.
At this point, the software on the “A” partition becomes the backup software. If there is a problem with the new
software, fallback to the software which still resides on the “A” partition is possible.
In case the previous upgrade is successful, a subsequent upgrade replaces the software on the “A” partition and the
bootloader is modified once again, so that the software on the “A” partition becomes the partition designated as
holding the “active” file system and the software on the “B” partition becomes the backup software.
The “Data” partition contains directories for XML (Extensible Markup Language) system configuration data files,
syslog, alarms, manifest (list of all files and versions delivered with the images), and temporary space.
More partitions
During the full installation it is possible to request the creation of more code partitions. You can create
until 5 partitions, and this number is only limited by the size of the used disk. For instance, it is
possible to select 5, but the system permits only 4 partitions. The explanation about the partitions “A” and
“B” are still valid, but now they will rotate over an extra number of partitions:
113
P31003-H81A0-M101-04-76A9, 15/11/21
OpenScape Branch V10, Configuration Guide
After a full installation
An upgrade will use the next “empty” or “avail” partition in numeric order. In this case the “Partition 2” is
selected and the result is:
As shown, the partition 2 becomes the new “Active” partition and the Partition 0 is the new “Backup” of
“Active” partition. If a new upgrade is done, then the result is:
As shown, the partition 3 becomes the new “Active” partition and the Partition 2 is the new “Backup” of
“Active” partition. In case a new upgrade takes place, then the result is:
The process continues as described. An administrator can change the “Active” partition to any valid
software partition and its backup partition is automatically selected if it is still available. This is done at
code partitions under the restart tab.
Note: Database files are related to a version. In case of a fallback to an older version it is possible that the
last configurations will be not used. These configurations can be redone if the old version allows them.
114
P31003-H81A0-M101-04-76A9, 15/11/21
OpenScape Branch V10, Configuration Guide
36.5.2 Upgrade
Upgrade option includes the fields shown in the image below:
Upgrade field
The Upgrade means that a full version is installed in an available partition and the active partition is
preserved in case of failure or to return to an older version.
The upgrade and activation of the new software are separated actions. The activation can be performed
at a specific date or right after the upgrade. Until a reboot operation takes place, the system informs that
a new software is available at each login.
When performing an upgrade, by any means other than USB stick, make sure the IP address of the
sending device is in the “white list” of the Message Rate control function. Navigate to Local GUI >
Security > Message Rate Control.
It is recommended to use the Local File option when possible by getting the image onto a local computer
or network. This could prevent problems related with the timeout of the file transfer caused by long
propagation delays.
Upgrade full version is installed on the backup partition and the active partition is preserved in case of
failure.
115
P31003-H81A0-M101-04-76A9, 15/11/21
OpenScape Branch V10, Configuration Guide
Prerequisites
Software image *.tar file is required for all upgrade’s types. Tar files contains 3 files:
image*.ob
image*.key
image*.sig.
Note: Upgrade process is interrupted if Web Page is Closed during the copy / sftp of the software. DB is
not modified during Upgrades.
1.USB stick
Note: in case of a redundant system both nodes are upgraded. Master first then backup.
2. Local file
The user chooses which local file to upload, depending on the version desired.
Note: In case of a redundant system both nodes are upgraded. Master node first and after that the
backup node.
116
P31003-H81A0-M101-04-76A9, 15/11/21
OpenScape Branch V10, Configuration Guide
3. HTTPS
a) Provide the hostname (IP address) and remote directory of a https server which contains the
software image.
b) Add the *.tar and *.spa files in this directory.The file named "list" must be added in the same
directory. This file should contain the name related to the software image, e.g. image_SBC-
10.09.00.00-1.tar.
c) Click List Versions and select the available software version to upgrade.
4. SFTP
117
P31003-H81A0-M101-04-76A9, 15/11/21
OpenScape Branch V10, Configuration Guide
a) Provide the hostname (IP address), port and remote directory of SFTP server which contains the
software image.
b) Supply a username and password to login to the server.
c) Add the *.tar file in this remote directory. The file named “list” must be added in the same
directory. This file should contain the name related to the software image, e.g. image_SBC-
10.09.00.00-1.tar.
d) Click List Versions and select the available software version to upgrade.
118
P31003-H81A0-M101-04-76A9, 15/11/21
OpenScape Branch V10, Configuration Guide
After the upgrade process, the new code must be activated. The activation can be requested using
Activate now option or Activate at date. In case you select Activate at date, it is necessary to schedule
a specific day and time.
It is also possible to request the system to wait for running calls before reboot to activate the new code. In
that case, it is necessary to enable the flag Reboot only when all calls are disconnected and configure
the time to wait for all calls be disconnected. The option for Time to wait for all calls to be
disconnected is from 1 to 72 hours and the default value is 24 hours.
Important: The use of the option to wait calls will also reject new calls. It is important to know that the
system will keep blocking new calls until all the upgrade/activation is completed. In case of redundant
systems this also includes the upgrade of the backup node. If the calls rejected by this process cannot be
diverted to other servers, they will be lost. In this case, the administrator is responsible to redirect the
traffic to another SBC.
This area shows if a reboot process is running. If the process is not in final steps, it is possible to cancel it
using the buttons Activation / Restart cancel and Schedule cancel.
It is also possible to request the system to wait for running calls before reboot to a partition. The use of
the option to wait calls will also reject new calls. If the calls rejected by this process cannot be diverted to
other servers, they will be lost.
119
P31003-H81A0-M101-04-76A9, 15/11/21
OpenScape Branch V10, Configuration Guide
36.5.3 How to configure Bulk Configuration (Delta XML)
Prior to the creation of a Delta XML file, it is necessary to change all the data to be included. In the
following example the NTP client (NTP tab) is disabled and new entries have been added to "DNS
server IP address" and "Alias" (DNS tab).
Note: Do not Apply Changes. Changes are detected by differing the not applied changes with the last
saved config xml file.
After the changes, navigate to Configuration > OpenScape Branch > Branch Office > Maintenance >
Bulk Configuration.
Validate the changes that have not been applied by clicking Please Validate Configuration Before
Edition. Once the validation takes place, the edition area is presented.
Note: Changes done on configuration after this step are detected only when reloading the "Bulk
Configuration (Delta XML)" tab.
Now it is possible to navigate through the individual changes. Use the buttons Prev diff and Next diff to
jump from one diff to the previous or next ones. Current diff focuses the diff area on the current
selected change.
XML Path indicates, on the xml structure, the position of the currently selected change.
All operations are done over the currently selected change (visually observed as surrounded by a
120
P31003-H81A0-M101-04-76A9, 15/11/21
OpenScape Branch V10, Configuration Guide
dotted frame).
Note: In normal configuration task this feature can be used to have a preview of modifications on xml before
the Apply Changes.
Only "accepted" changes are included on Delta XML files. It is possible to include/exclude changes on
Delta XML file individually or in groups ("item" elements (lists or tables).
Accept and Drop acts over currently selected change (checkbox All unchecked).
Accepted changes are marked with a green background. Dropping an accepted change returns its
background to the original color. Original background colors are the same ones used on the Compare on
Import / Export tab.
121
P31003-H81A0-M101-04-76A9, 15/11/21
OpenScape Branch V10, Configuration Guide
For lists and tables ("item" elements) there are additional operations shown at the left area below the
"XML Path".
This Notice is presented the first time Replace Whole Table is checked:
122
P31003-H81A0-M101-04-76A9, 15/11/21
OpenScape Branch V10, Configuration Guide
If the Replace Whole Table is checked, all "item" elements in the same level are colored in green. The
exported Delta XML, when applied, replaces the whole previous configured table content by the one in
green. Table Index informs the position of the "item" element (starts with 0).
Prev and Next navigates inside the table selecting "item" elements individually. Accept/Drop applies to
them.
The following is presented when All is checked for the first time. When checked the Accept / Drop acts
over all the changes. Be aware that unpredictable results may occur when exporting the Delta XML file.
123
P31003-H81A0-M101-04-76A9, 15/11/21
OpenScape Branch V10, Configuration Guide
After all desired changes are accepted, press Validate Accepted Changes. Export area is presented.
If local GUI is accessed through CMP, changing "Delta XML Name" is not possible. CMP demands
deltaXml.xml as the name of the Delta XML file. Any other name is ignored.
All xml tags inside the following xml tags are ignored for the purpose of generating Delta XML file:
alarmList
saveUser
saveRUser
saveTime
clientIpAddr
swVersion
hwType
product
124
P31003-H81A0-M101-04-76A9, 15/11/21
OpenScape Branch V10, Configuration Guide
hostname
logicalBranchOfficeId
hwId
saveCounter
openBranchNetwork
mode
voipData.
Restart button
This button is used to reboot the system and use the active partition.
On redundant systems this only restarts the selected node. To restart the other node of the redundant
pair, select the other node and repeat the procedure.
Note: When the node that is restarted is acting as Master the other node might take over the Master
function.
125
P31003-H81A0-M101-04-76A9, 15/11/21
OpenScape Branch V10, Configuration Guide
Restart from backup button
This button is used to reboot the system and use the software stored in backup partition of the current
partition. If the backup partition is not available (code was removed or overwritten), this button is disabled.
On redundant systems this only restarts the selected node to backup version. It is mandatory to repeat
the procedure on the other node of the redundant pair.
Note: When the node that is restarted to backup is acting as Master the other node might take over the
Master function.
Note: When one of the nodes has been restarted to backup and the other hasn’t, an alarm stating
Redundant system has an invalid version (sync. is disabled) is triggered until both are running the
same version.
This button calls the check and repair tool for all Branch disks. All problems found are automatically fixed.
Note: This option is only available if the USB stick is plugged and the system is booting from the USB
stick.
The available code partitions are listed in a table with buttons to control them.
The buttons Block / Unblock and Unblock all are used to block the partitions against upgrades. It does
not block the partition that is selected to run. Using the buttons Restart from X, all valid partitions can be
selected to run.
Read more about the behavior of partitions in Partitioning under How to Install / Upgrade a file.
126
P31003-H81A0-M101-04-76A9, 15/11/21
OpenScape Branch V10, Configuration Guide
Activation / Restart information field
This area shows if a reboot process is running. If the process has not been completed yet, it is possible to
cancel it using the buttons Activation / Restart cancel and Schedule Cancel.
It is also possible to request the system to wait for running calls before reboot to a partition. The use of
the option to wait calls also rejects new calls. If the calls rejected by this process cannot be diverted to
other servers, they get lost.
This section shows the server Scheduled Maintenance state. The server can enter in a maintenance state
either by a user or by internal conditions. The user can decide to put a server in maintenance at a specific
time or immediately.
Note: The server can enter in maintenance state even before the date and time defined if the server
thinks that is the right decision.
Maintenance mode in SBC is a way to set the SBC call processing in an out of service state, so the traffic
can be handled by another server, without shutting down the server. In that way, the upgrade and
configuration functionalities can still be done.
When in a maintenance state, a server does not accept any calls and must be ready for administration
procedures like updates and configurations. In case of a scheduled Maintenance administrators are
responsible to redirect traffic to another SBC (in case the topology of the network does not support
rerouting automatically) during maintenance window. After this new implementation there is the possibility
of scheduling automatically the maintenance mode only when there are no active calls in the system.
Additionally, in case of scheduled Maintenance mode if flag In Maintenance only after all calls are
disconnected is set, active calls are not affected at any way before Time to wait for all calls be
disconnected (between 1 to 72 hours) is reached. Ongoing calls can be monitored in the Management
Portal in Diagnostics & Logs Menu and in Statistics Tab.
All new calls are rejected until Maintenance mode is activated. Statistics work in maintenance mode and
ongoing calls can be monitored in the Management Portal in Diagnostics & Logs Menu and in Statistics
Tab.
127
P31003-H81A0-M101-04-76A9, 15/11/21
OpenScape Branch V10, Configuration Guide
The following fields are available:
Maintenance State: It is the current state of the server and the text inside the () describes how the
server enters in this state.
Select what type of maintenance state will be applied when the button Apply button is pressed.
Available options:
- Auto: When the server enters in maintenance by itself (normally associated with software or
hardware problems).
The Auto mode only uses the server software decisions to control if the server is in maintenance.
- Schedule: When requested by an administrator using a define date and time period.
The Schedule option uses the time in the boxes below to select when the server will enter in
maintenance.
These fields are used to define the period when the server enters in maintenance if the
Schedule option is used. The timers here are always related to the server date and time
not the user date and time (be careful when working in different time zones).
o In maintenance only after all calls are disconnected:
It is also possible to request the system to wait for running calls before starting the maintenance.
128
P31003-H81A0-M101-04-76A9, 15/11/21
OpenScape Branch V10, Configuration Guide
The use of the option to wait calls will also reject new calls. It is important to know that the system will
keep blocking new calls until all the maintenance is completed. In case of redundant systems this also
includes the maintenance of the backup node. If the calls rejected by this process cannot be diverted
to other servers, they will be lost.
These are the selected codes and messages sent to the rejected new calls when In maintenance only
after all calls are disconnected or Reboot only when all calls are disconnected (in install/upgrade or
restart tabs), is selected.
Prior to the creation of Delta XML file it is necessary to change all data to be
included.
Please refer to the OpenScape Branch V9 Admin Guide, section 3.2.3.2
‘’How to Create a New Batch Job’’
In the following example the NTP client (NTP tab) is disabled and new entries
have been added to "DNS server IP address" and "Alias" (DNS tab).
Note: Do not Apply Changes. Changes are detected by differing the not
applied changes with the last saved config xml file.
129
P31003-H81A0-M101-04-76A9, 15/11/21
OpenScape Branch V10, Configuration Guide
Validate the changes that have not been applied by clicking the "Please Validate Configuration Before
Edition". Once the validation takes place, the edition area will be presented.
Note: Changes done on configuration after this step will only be detected when reloading the "Bulk
Configuration (Delta XML)" tab.
Now it is possible to navigate through the individual changes. Use the buttons Prev diff and Next diff to jump
from one diff to the previous or next ones. Current diff focus the diff area on the current selected change.
XML Path indicates, on the xml structure, the position of the currently selected change.
114
P31003-H81A0-M101-04-76A9, 15/11/21
OpenScape Branch V10, Configuration Guide
All operations are done over the currently selected change (visually observed as surrounded by a dotted
frame).
Hint: In normal configuration task this feature can be used to have a preview of modifications on xml before the
115
P31003-H81A0-M101-04-76A9, 15/11/21
OpenScape Branch V10, Configuration Guide
Apply Changes.
Only "accepted" changes are included on Delta XML files. It is possible to include/exclude changes on Delta
XML file individually or in groups ("item" elements (lists or tables)).
Accept and Drop acts over currently selected change (checkbox All unchecked).
Accepted changes are marked with a green background. Dropping an accepted change returns its background
to the original color. Original background colors are the same ones used on the Compare on Import/Export
tab.
115
P31003-H81A0-M101-04-76A9, 15/11/21
OpenScape Branch V10, Configuration Guide
For lists and tables ("item" elements) we have additionally operations at left below the "XML Path".
116
P31003-H81A0-M101-04-76A9, 15/11/21
OpenScape Branch V10, Configuration Guide
This Notice is presented the first time Replace Whole Table is checked.
If the Replace Whole Table is checked, will turn green all "item" elements in the same level. The exported
Delta XML, when applied, will replace the whole previous configured table content by the one in green. Table
Index informs the position of the "item" element (starts with 0). Prev and Next navigates inside the table
selecting "item" elements individually. Accept/Drop applies to them.
117
P31003-H81A0-M101-04-76A9, 15/11/21
OpenScape Branch V10, Configuration Guide
The following is presented when All is checked for the first time. When checked the Accept/Drop acts over all
the changes. Be aware that unpredictable results may occur when exporting the Delta XML file.
After all desired changes are accepted, press Validate Accepted Changes. Export area is presented.
118
P31003-H81A0-M101-04-76A9, 15/11/21
OpenScape Branch V10, Configuration Guide
Delta XML file can be exported through the browser or SFTP.
If local GUI is accessed through CMP, changing "Delta XML Name" will not be possible. CMP demands
deltaXml.xml as the name of the Delta XML file, other name will be ignored.
All xml tags inside the following xml tags are ignored for the purpose of generating Delta XML file:
119
P31003-H81A0-M101-04-76A9, 15/11/21
OpenScape Branch V10, Configuration Guide
38. Upgrade
Full version will be installed on the backup partition and the active partition will be preserved in case of failure.
Upgrade is possible using USB stick, local files stored in PC/network, HTTPS and SFTP. In USB stick the
version stored in stick will be used, while in other methods the user has to choose which version will be used. In
HTTPS or SFTP, the list is retrieved from the server of SW supplier. Software image *.tar file is required for all
upgrades types. Tar files contains 3 files: image*.ob, image*.key, and image*.sig.
Note: Upgrade process will be interrupted if Web Page is Closed during the copy/sftp of the software(Local
GUI). DB is not modified during Upgrades.
Under Maintenance
Inventory, Image can be
added to the Software
Repository.
Browse/Add Image
Upgrade and SPA file
1. USB Stick Copy image*.tar into USB stick and select Upgrade in GUI. USB stick needs to be selected for
Location source in drop down menu. Note: only one image must be copied to USB stick.
120
P31003-H81A0-M101-04-76A9, 15/11/21
OpenScape Branch V10, Configuration Guide
Note: “Assuming drive cache:
write through” message shows
on system/syslog when USB is Verify following OSV default firewall rule exists if
connected to OSB. 1) Select USB Stick from Menu. experiencing problems upgrading/updating where
2) Select Full Image Type error is related to CMP not being able to SFTP to
3) Click on Activate SB.
4) When Upgrade Completes Packet Filter Rule Name:
Remove USB and confirm oLcal_Init_TCP_Node_IP
restart. Description:
Remote FQDN:
Remote IP Address:
Remote NetMask:
Remote Port Begin: 0
Remote Port End: 0
Direction: InComing
Local Host : bond_node_alias
Local Port Begin: 0
Local Port End: 0
Transport Protocol: TCP
Action : Allow
2. Local File Copy image*.tar into local PC/Network. Common Repository needs to be selected for location
source in drop down menu. Follow same steps as USB upgrade.
3. SFTP/HTTPS: only available from Local GUI. Contact Service if this is required.
121
P31003-H81A0-M101-04-76A9, 15/11/21
OpenScape Branch V10, Configuration Guide
39. Debug/Tracing
122
P31003-H81A0-M101-04-76A9, 15/11/21
OpenScape Branch V10, Configuration Guide
123
P31003-H81A0-M101-04-76A9, 15/11/21
OpenScape Branch V10, Configuration Guide
39.2 Log data
Log data is available under the main OpenScape Branch Dashboard under Configuration >
OpenScape Branch > Branch Office > Configuration >Diagnostics & Logs > Debugging
Application Description
Alarm History Alarm History shows details about alarms triggered in the system. These details
include information of date, time and, threshold when the alarm was activated or
cleared.
Alarm Manager Log of Alarm Manager Application. Useful when an alarm is not being triggered, a
false alarm is being activated or not cleared accordingly.
B2BUA B2BUA is an Asterisk running in the system. It has three main functions: work as
a B2BUA for gateways and SSPs in Survivability Mode; provide some
functionalities like ACD, Auto Attendant and Voicemail; provide the Integrated
Gateway functionality for PRI, BRI, FXS and FXO boards. This log is useful for
debugging all these functions, regarding the Integrated Gateway it is necessary
to investigate call processing, DTMF detection, FAX T.38, voice quality issues,
etc.
Backup Link Client Logs for the Backup Link Client application, which are needed when the
Backup Link features is enabled and failures in the link status between the
branch offices and the datacenter are observed.
Backup Link Server Logs for the Backup Link Server application, which are needed when the
Backup Link features is enabled and failures in the link status between the
branch offices and the datacenter are observed.
Boot Log of the last system boot. It is useful to debug problems of processes or
driver modules not being correctly installed and, to identify hardware failure
indications. Additionally, it provides system capabilities are correctly detected
and configured.
CAS Log of the CAS MFC R2 signaling. This signaling is applicable only for E1
MFC R2 interface. This log is useful to debug all CAS MFC R2 call establishment and
features issues.
124
P31003-H81A0-M101-04-76A9, 15/11/21
OpenScape Branch V10, Configuration Guide
CAS Log of the CAS E&M/Ring Down signaling. This signaling is applicable for
E&M/Ring Down both T1 and E1 interfaces. This log is useful to debug all CAS E&M/Ring
Down call establishment issues.
CDR Logs from Call Detail Recording that is the application that records in a ticket
the information regarding caller, callee parties call duration and etc, for a call
that was done during the survivable mode. The tickets are internally stored
until the external server retrieved them.
Continuous Tracing Continuous trace is the application that collects the logs from the applications
does the log rotation, compression and aging.
DAHDI Log of the DAHDI driver. Applies to the OSB 50i and OSB 500i only. This log
is useful to debug problem in the PRI, BRI, FXS and FXO ports alarms. It is
also useful to debug FXO and FXS signaling, along with B2BUA logs.
Firewall & This log contains the details of packets that are blocked by the Firewall and
Msg Rate Control Msg Rate control.
ISDN Log of the ISDN Layer 2 and Layer 3 ISDN messages (BRI and PRI ports).
This log is also included in the B2BUA logs when set to level INFO or
DEBUG. Level INFO includes Layer 3 messages and it is useful to debug call
processing issues, along with B2BUA logs. Level DEBUG includes Layer 3
and Layer 2 messages. This level is very verbose and must only be activated
to debug Layer 2 issues, like link establishment and BRI PTMP issues.
Logs provided by the software installation tools that are responsible for
Install/Update/Upgrade system upgrades or updates via local file, ssh or sftp.
Same tool also provide logs for the initial installation via usbstick or software
image.
Phone Software These are the logs from Phone Software Management application that is
Management used to store, control and allow the upload and download of Phone software
images.
Process Manager Log of the Process Manager application responsible for the system sanity
monitoring and also for license management. It includes processes status
checking and starting or stopping them if applicable. It is also responsible for
the configuration deployment, it includes the fallback to previous system
partition when there is an upgrade issue, the configuration is not valid or the
current system partition is corrupted.
Redundancy This log show details about the redundancy manager application. It is useful
to debug issues related to redundancy process functionalities, like switchover
failures.
Registration Blacklist This table stores the subscribers that try to register but fails due not
configured or wrong credentials.
RTP Proxy The RTPProxy is the component responsible to relay RTP packets between
different interfaces and some VoIP features interworking like transcoding,
transrating, SRTP, ICE, STUN, etc. RTP Proxy logs are useful debugging
issues involving these features, specially voice quality issues, DTMF, FAX
T.38, rtcp-mux, etc.
Simplified Installation The log of simplified installation is similar to the installation tool logs but in
this case the installation procedure uses the easy install concept where the
software and the system configuration is done almost with no intervention
from the user.
125
P31003-H81A0-M101-04-76A9, 15/11/21
OpenScape Branch V10, Configuration Guide
SIP SIP Server is a Kamalio application running in the system. It provides the SIP
Server signaling, being always the system external SIP interface. This log is useful
to debug call processing issues, SIP connection issues and many other
problems in registration, port mapping, number modification, DNS, NAT,
Options Heartbeat, etc.
SIP Service Provider This log shows details about the SSPs Registration process.
SSM SSM works together with SIPserver, it's used to provide some SIP
functionalities and interworking with SIP Service providers. Usually their logs
are needed for call failures related to SSPs, MoH for subscribers on SM,
SipRec, call using anchored SBC sessions i.e codec transcoding
Survivability Provider Log of the Survivability provider application. This application is responsible
for the OPTIONs heartbeat functionality, that indicates the system
operational mode (SM, NM, etc). This application is also responsible for SSP
registration and BCF Notifications functionalities.
System This log contains the Kernel logs. Useful to debug operational system and
device drivers (sensors, ethernet, etc) related issues.
Web Server Log of the local web server application. Useful to debug the local
management, GUI interface and XML issues.
126
P31003-H81A0-M101-04-76A9, 15/11/21
OpenScape Branch V10, Configuration Guide
39.3 Rapidstat
Tool that collects system information for systemdebugging.
Up to five levels of information can be retrieved. Result will be a compressed file containing the information. By
default the info level is set to 2.
Note: Recommendation is to collect Level5 which includes information of all 5 categories.
Level 1 – System configuration, template files, boot and system log, process manager log, installed packages,
cpu load, security, snmp, memory usage and disk usage.
Level 2 – Sip server logs, b2bua logs, sp logs and cdr logs + Level1
Level 3 – SNORT and audit logs + Level1/2
Level 4 – Management logs + Level 1/2/3
Level 5 – Media server logs, B2BUA channels and PRI/BRI information (50i/500i) + Rapidstat Level 1/2/3/4
Note: Level5 could take a few minutes to collect depending on traffic/usage (50i/500i)
Configuration OpenScape Branch Branch Office Configuration Diagnostics & Logs Debugging
127
P31003-H81A0-M101-04-76A9, 15/11/21
OpenScape Branch V10, Configuration Guide
ICMP
1) Select ICMP.
2) Enter Parameters (ex. IP).
3) Select Start.
4) Select Stop and view results in “Results Display”
128
P31003-H81A0-M101-04-76A9, 15/11/21
OpenScape Branch V10, Configuration Guide
TraceRoute
1.Select TraceRoute.
2.Enter Parameters (ex. IP).
3.Select Start.
Note: command stops automatically whencomplete
(not necessary to select Stop)
4.Select View or Export
125
P31003-H81A0-M101-04-76A9, 15/11/21
OpenScape Branch V10, Configuration Guide
126
P31003-H81A0-M101-04-76A9, 15/11/21
OpenScape Branch V10, Configuration Guide
39.5 Continuous Tracing
User can configure a trace manager server (OSVTM) so that traces/logs are captured 24x7. Log level categories are set
under Settings tab (Default is Error).
Note: setting the log levels to Warning, Notice, Info, or Debug may affect system performance and/or call
processing and should only be done during maintenance windows.
Please note than even in a maintenance window Basic functionality can be affected if high level of tracing is done.
Tracing should only be enabled if requested by service.
Configuration > OpenScape Branch > Branch Office > Configuration > Diagnostics & Logs > Continuous Tracing
Note: SIP
Server Info
and Debug
level will
produce the
same output
Log Type/Level for On demand
trace. Trace can be
started/stopped manually or can
be configured to run for certain
time limit (ex. 5 minutes).
Note: Default setting Log level is
Error for most services (PM level
is default “Notice).
Note: setting the log levels to Warning, Notice, Info, or Debug may affect system performance and/orcall
processing and should only be done during maintenance windows.
Please note than even in a maintenance window Basic functionality can be affected if high level of tracing is done.
Tracing should only be enabled if requested by service.
126
P31003-H81A0-M101-04-76A9, 15/11/21
OpenScape Branch V10, Configuration Guide
39.7 Advanced (Enabling the System Collector Logs)
39.7.1 Export the current XML
39.7.2 Edit the XML
39.7.3 Search for <showAdvancedTab/>
39.7.4 Replace to <showAdvancedTab>1</ showAdvancedTab >
Eg.
<continuousTracingSystemName>systemName</continuousTracingSystemName>
<continuousTracingSFTPUsername>username</continuousTracingSFTPUsername>
<continuousTracingSFTPPassword>WGiNBgV/QfjgjZ6K/7qMUg==</continuousTracingSFTPPassword
>
<ssmLogLevel>error</ssmLogLevel>
<redundancyLogLevel>notice</redundancyLogLevel>
<showAdvancedTab />
<cscEnable />
<cscResources />
<cscProcesses />
<cscIgw />
7 – The Advanced Tab is now available (Go to Diagnostics & logs > Advanced)
127
P31003-H81A0-M101-04-76A9, 15/11/21
OpenScape Branch V10, Configuration Guide
8 – Update the "Journal Configuration" help
Text:
Note: If you are using the HW 50i refresh you have to set the "Console Device"
to "/dev/ttS4". To the others hardware please use "/dev/ttS0"
128
P31003-H81A0-M101-04-76A9, 15/11/21
OpenScape Branch V10, Configuration Guide
40 Signaling and Transport Settings
Configuration > OpenScape Branch > Branch Office > Configuration > VoIP > Port and Signaling Settings
INVITE timeout - normal mode: Timer which applies if no final reply for an INVITE arrives after the 100 Trying was received in
Normal mode operation.
INVITE timeout - survivable mode: Timer which applies if no final reply for an INVITE arrives after the 100 Trying was received
in Survivable mode operation.
TCP keep alive is based on RFC 1122. Even with the flag disabled the server will respond to endpoint keep alive. When the flag
is enabled the server will start sending TCP keep alive probes after 30 seconds of idle connection. The probes will be
periodically sent every 240 seconds; if there two consecutives probes failures then the TCP connection will be terminated.
Note: flag should only be enabled if all endpoints using TCP are compatible with TCP keep alive.
TCP connection lifetime: Lifetime in seconds for TCP connections, any TCP connection which is inactive for the lifetime will be
automatically closed.
TCP connect timeout: Time in seconds before an outgoing attempt to connect will be stopped.
TCP send timeout: Time in seconds after a TCP connection will be closed if it is not available. ]
Disable Answer sup.:If the Disable Answer Supervision for Emergency Calls flag is checked when a call is received on the
OSB (Proxy, Branch SBC or SBC-Proxy) from the OSV (Normal Mode) or from the SIP Endpoint (Survivable Mode) and DN part
of the Request-URI corresponds to an Emergency Call then the invite no answer monitoring timers and invite no answer
monitoring timer for outgoing calls will be canceled.
BFCP- (Branch SBC and SBC-Proxy mode only) Description: Long time duration timer for a BFCP connection that is
established over TCP or TLS. The value is entered in minutes with the default value of 12 hours. The TCP/BFCP connection
timer should be activated in order to avoid open TCP ports unintentionally
129
P31003-H81A0-M101-04-76A9, 15/11/21
OpenScape Branch V10, Configuration Guide
130
P31003-H81A0-M101-04-76A9, 15/11/21
OpenScape Branch V10, Configuration Guide
41 Branch SBC Mode
The OpenScapeBranch can operate as Session Border Controller (SBC) or SIP Proxy. The Session Border
Controller mode is designed to isolate the Branch and its internal networkcomponents in a different sub-net. In
this sense SIP headers, internal ports and internal addresses as well as RTP internal ports and internal addresses
are not propagated to the external network.
SBC Configuration requires a second network interface to be used. In small model this is the 4th interface while in
large model is the 2nd. For SBC mode the WAN interface should be activated. The system will reset upon saving
the configuration when the mode is changed. The most common scenario is the Branch-SBC connected to the
OSV via a OSS. Please refer to the Branch behind OSS chapter for more details.
Note 1: For Branch SBC mode, the WAN interface is used to access the OSV network. SIP phones should be
configured with OpenScapeBranch LAN IP and OSV.
Note 2: NAT flag must not be enabled for BranchSBC.
1. Create an Endpoint for OSB SBC (All OSB Endpoints that have been configured have step 1 profile).
Configuration > OpenScape Voice > BG > Main Office > Members > Endpoints > Add
Static Registered.
Note: End Point Profile must
be created before adding
End Points.
Full Privacy Needed for
OSS Profile.
OpenScape Voice BG
Profiles Endpoint Profiles
Add
Note: In OSV V4R1 flag was removed from CMP and is enabled by default. Step only needed if older version of OSV is used
After selecting the Branch Office user has access to Statistics, Registered Subscribers, Backup link Status
(if enabled), and Link Status (Advantech 50i only). License Information is covered on License Section.
Note: Depending on the changes made some processes or even the entire system will restart. GUI will alert user when
restart is required.
Selecting “Cancel Changes” will revert back all changes since the last “ApplyChanges”
Configuration > OpenScape Branch > Branch Office > Configuration > Security > Firewall > Wan
In order to make TDM calls using a GW that is located in the SBC branch; the Endpoint previously created for
SBC in OSV has to be associated to PAC, Destination, Route, etc.
Prefix access code, destination code, destination and a new route that is going to route the GW calls to this
Endpoint have to be added also.
Note: for SIPQ GWs one additional SBC OSV Endpoint is required with SIPQ checked to reflect the GW
behind the OSB Proxy. Same configurationof originally created Endpoint should be used. Only exception is
that alias will be empty since it is already being used on original SBC OSV Endpoint. Prefix that is used to make
the call can’t be sent to OpenScapeBranch because OpenScapeBranch doesn’t parse SIPQ MIME. All
manipulation has to be done in OSV this time (SIPQ ONLY).
NOTE2: On a SIPQ incoming call in Normal Mode, the trunkgroup FQDN is used in the INVITE contact's header
sent to the OSV> This FQDN should be configured in the endpoint alias list for the OSV to recognize that his call
has a SIPQ (SIPQv2) signaling.
If the OSV does not recognize the endpoint, it will reject the call and the OSB will fall back to SIP without
mapping any SIPQ Info Elements from the trunk.
In Nomal Mode, the OSB acts as a tunnel and does not manipulate and QSIG content received from the OSB or
the Trunk. Therefore, no TON configuration is applied on these QSIG calls.
In case of interconnection with old PBXs, the flag "truncated mime" should be activated in the OSV.
One entry shall have the routing prefix configured with the access code for external calls using the lines under the gateway.
The other entry shall match with the FXS DN prefixes in order to route the calls to the FXS under the gateway. This is necessary
because the OSB in SBC mode does not store registers from static endpoints the location table.
Media Server Listen Port: port the Media Server uses for
communication with the Call Agent.
Language: preferred language. Advanced: Advanced Media
Server configuration. Use System FQDN: Uses system FQDN on
media transaction, instead of IP.
Number of announcement ports: max amount of Number of Conference/whisper ports: max amount of
ports that are opened for providing announcements ports opened for conferences.
(Or Unlimited). Maximum announcement time: Maximum Conference time : max time, in seconds, a
max time, in seconds, an announcement session is conference is allowed to be active.
allowed to be active (Or Unlimited). Conference Prefix Access Code: Prefix in SIP R- URI
Stop announcement on DTMF: if enabled, required to access a Media Server conference.
announcement will stop when the Media Server
receives a DTMF. Note: Large Conference with MS will not show lock on
phone when SRTP is used
The language package provided during installation is English US, other packages (German Language)
can be installed by using GUI.
OpenScapeBranch uses the language packs from the Open Scape Application DVD.
Those language packs are RPM files located in the folder "noarch" of the DVD.
Note: only language packs from Application V6 and above work with OSBV7.
When the Media Server is used as external media server for other branches the Protocol must be configured
in OpenScape Voice as MGCP 1.0 NCS 1.0 and the treatments must be properly configured.
The log levels of MS, MS adapter and MS converter are set to the same level by setting Media Server log level.
In some situations it may be desired to have the main media server as the backup of the branch mediaserver. This is
entirely done in the OSV using the Media Server audit mechanism and routing. The steps to configure this are as follow:
NOTE: These steps are based on the “Distributed Deployment with Branches” instructions available with the OSV
manual “OpenScape Voice V7, Configuration, Administrator Documentation” or “OpenScape Voice V7,
Installation and Upgrades, Installation Guide”. (If MOP P30310-Q2575-Q140-03-7620 is installed refer to release
note for added instruction).
It is possible to have OpenScape Branch as the Main Media Server for the OSV. These steps also assume a
distributed deployment where an OpenScape Branch provides MS service at the main location.
If there is another Media Server in the Main location and branch support is being added, the main Media Server
configuration must be as follows to support this deployment.
Create Default Destinations for the main media server that will be used as default and for the Main Branch. The following
must be created:
DefDestAnn
DefDestCnf
DefDestCal
OSV -> Global Translation and Routing -> Destinations and Routes -> Destinations
Or
Do the same for default destination for conference and surveillance (DefDestCnf and DefDestCal).
Announcements for the Main Office (default) are now provided by OpenScapeBranch.
NOTE: The following instructions may change depending on the OpenScape Voice patch set level. For updated script information refer
to the OSV Media Server Configuration Instructions or OSV “OpenScape Voice V5, Configuration, Administrator Documentation” or
“OpenScape Voice V5, Installation and Upgrades, Installation Guide”.
If default configuration is desired for all treatments, one can also remove all treatments and assign everything default.
The following steps will show how to configure an OpenScape Branch server as the Media Server for a Branch.
1. Add and Configure OpenScape Branch as a Media server following Steps from previous section.
2. Create a Routing Area for the branch.
3. Destination for newly created Routing Area (announcement, conference and surveillance). Declare that it is a media server.
5. Origin Destinations for each traffic type must have been created for the main Media Server (See previous section).
OSV -> Global Translation and Routing -> Destinations and Routes -> Origin Destinations.
6. Add the Routing Area to the Origin destination’s routes. Repeat for conference and surveillance
i. The second way is to assign the Rate Area for the entire Branch: Assign the newly added Routing Area to the
Endpoint Profile of the Proxy serving the Branch Office. OSV -> Business Group -> BG(x) -> Profiles ->
Endpoint
OpenScapeBranch is now
configured to server the
Branch Office as Media
Server.
**Note: Can add more media servers for this branch in case the branch can’t handle all the media server needs.
iv. In cases that another OSB needs to be a media server, create another RA for each OSB (ex RAOSB2) and a
separate destination for each (ex RAOSB2ann, RAOSB2cnf and RAOSB2cal).
Via CMP go to Configuration OSV -> Administration -> Media Servers -> Audit
1. Enable the Media Server Audit by checking “Automatic Audit On”:
Select “Audit”
Via CMP open the Origin Destinations to get the Destination Name of the desired branch.
Go to Configuration OSV -> Global Translation and Routing -> Destinations and Routes -> Origin
Destination
the example below is for the created “AnnOrigDest”.
Go to the Routes Tab and press “Add” to add the main Media Server as a second Route
Steps 4 and 5 must be done for all destinations types (announcements, conference, etc)
The Main Media Server is now the backup of the Branch Media Server. When the Branch
Media server fails the audit mechanism of the OSV will set its Operational State to “Blocked”
and will forward the requests to the Main Media Sever.
The audit mechanism will keep trying until it gets a successful response from the Branch Media
Server and it will set its Operational State back to “Available”.
3. Login to OSB SSH with root access and copy zip file from /tmp to
/opt/siemens/mediaserver/application_host/deployment-custom
5. The synchronization of the files on the redundancy system occurs automatically after 6 minutes
6. If the .wav file is new, configure your intercept treatment in CMP with the following address line:
pa@*( an=file:///~la/newmoh.wav it=-1)
152 OpenScape Branch V10 Configuration Guide
(where newmoh.wav is replaced by customer’s announcement filename)
Note: The .wav files can be completely new or they can have the same name with an existing .wav file in the corresponding
language. If the name of an existing announcement file is used in the customized package the corresponding announcement
will be automatically replaced by Media Server.
7. For redundant systems only: restart the Active/Master OSB node and repeat steps 2 through 4
1. Create the server configuration file (If not already available please refer to attachment section 3)
Note: Regarding to the most common changed .cnf parameters, add default_md which can be changed from
sha1 to sha256 or sha384:
2. Create the Certificate Sign Request using the osbserver.cnf configuration file from previous section. You will be
prompted to enter organization information such as country, state, city and etc. The final prompt will ask for the
common name. Enter the IP address or FQDN of the server here. This command will create a new key pair for
osbserver and store the private key in osbserverkey.pemand enter the public key ina file called osbserver.csr.
The above command will prompt for following information, enter the fields you need If you enter '.', the field will be left blank.
If a new certificate needs to be issued, the stored certificate sign request file may simply be re- used. However,
if modifications had to be made to the configuration file, then a new certificate sign request needs to be issued
as follows after the modifications have been saved: from the config directory:
Note: store the private key (eg: osbserverkey.pem) in a secure place as it will be required to install the
certificates for OpenScapeBranch.
43.2 Submit the Certificate Sign Request file to the Certificate Authority
The signing CA may either be the CA of a customer's PKI or it may be the CA on an OpenScape Voice that
functions as CA for the customer's communications solution. If a customer's PKI is used, simply transfer the file
(e.g. using sFTP, e-mail) to the IT group responsible for the PKI and request a signed certificate. Note: User
must not send the private key (osbserverkey.pem) to CA or anyone else that matters.
Note: Please refer to attachment section 2 in case it is required to validate certificate from CA.
NOTE1.Local client certificate file - this certificate shall be configured if OSB uses 2 different certificates for acting as a TLS
client or TLS server.
NOTE2.Remote CA file - this certificate shall be configured if the remote endpoint uses a certificate from a different PKI than
OSB.
Certificate Verification: Please refer to the FRN8423 which provides a description of the different verification levels.
In V10R2, after full installation, the default value for Minimum TLS version has been changed to
TLS V1.2 in Certificate Profile.
It is still possible to select TLS V1.0 from menu.
Note: For security reasons SSLv23 and SSLv3 is not supported after V8R1
Minimum TLS TLS Version in OSS as TLS Server OSS as TLS Client.
Version Remote TLS Version offered to TLS
Configured in OSS/ Endpoint as server
OSB Client
TLSv1.2 Accept
TLSv1.0 TLSv1.1 Accept TLSv1.2
TLSv1.0 Accept
SSLv23/SSLv3 Reject
TLSv1.2 Accept
TLSv1.1 TLSv1.1 Accept TLSv1.2
TLSv1.0 Reject
SSLv23/SSLv3 Reject
TLSv1.2 Accept
TLSv1.2 TLSv1.1 Reject TLSv1.2
TLSv1.0 Reject
SSLv23/SSLv3 Reject
Cipher Suites:
It’s possible to define the groups of cipher suites which are supported for the endpoint associated to the
certificate profile. The definition of the cipher suites is done by means of 3 parameters:
Perfect Forward Secrecy – it defines the priority of the ephemeral Diffie-Hellman ciphers suites. This is a combo box
with the following options: Preferred PFS (default) or Without PFS.
Encryption – it defines the encryption cipher. Currently AES-128 is the most recommended option. This is a combo
box with the following options: Preferred AES-128 (default), Required AES-256.
Mode of Operation – it defines the encryption cipher mode of operation: CBC or GCM (TLS V1.2 only). This is a
combo box with the following options: Preferred GCM (default), CBC only, GCM only.
158
This profile defines the TLS version that will be
used/accepted for HTTPS access to the branch
159
44.1 Configuration of TLS in OpenScapeBranch/OSV
Note: Make Sure to set the OpenScapeBranch with current date/time ofOSV.
1. Open the OSV Endpoint created for OpenScapeBranch and update Transport protocol/Port to MTLS/5061.
Configuration > OpenScape Voice > Business Group > BG > Members > Endpoints > SIP Tab
Note: Configure Endpoint as trusted if Digest Authentication is used in the OSV.
Route Via Proxy and SIP Proxy must be set. Survivable Endpoint must be set if subscriber rerouting is
required for survivability.
OSB IP address must be configured for alias (Port is optional. Ex 10.234.1.70:5061). Note: if using OSB with
Redundancy then Alias should include Redundant IP and Physical IP addresses for both OSB nodes.
Important: OSB always uses TLS port 5061 to connect OSV. Even configured as TLS, the connection is
MTLS. Port 5061 must be used in order to set the endpoint OSB in the OSV configuration as well as port
5061 in the SIP server configuration in OSB.
TCP:5060,UDP:5060,
TLS:5061,
MTLS:5061
2. Configure Keep Alive to OSV to use TLS port (5061) in the OpenScapeBranch. Configuration
OpenScape Branch > Branch Office > Configuration > VoIP > General
Update Options
Destination Port to 5061
160
3. Configure required OSV SIPSM IPs in the OpenScapeBranch.
Configuration > OpenScape Branch > Branch Office > Configuration > VoIP > SIP Server Settings
161
TCP/UDP Port 5060 OSV Mode TLS/MTLS Port 5061
OSV 3.1/4.0 OSV OSV 3.1/4.0 OSV
4.1/5/6/7/8/9/10 4.1/5/6/7/8/9/10
Simplex
sipsm1_vip sipsm1_vip Node 1 sipsm3_vip sipsm3_vip
Primary Server
Collocated
sipsm1_vip sipsm1_vip Node 1 sipsm3_vip sipsm3_vip
Primary Server
Node 1
Secondary Server
sipsm2_vip sipsm2_vip Node 2 sipsm4_vip sipsm4_vip
Primary Server
Node 2
Secondary Server
Geo-Separated
sipsm1_vip sipsm1_vip Node 1 sipsm3_vip sipsm3_vip
Primary Server
sipsm2_vip2 sipsm2_vip Node 1 sipsm4_vip2 sipsm4_vip
Secondary Server
sipsm2_vip sipsm2_vip Node 2 sipsm4_vip sipsm4_vip
Primary Server
sipsm1_vip2 sipsm1_vip Node 2 sipsm3_vip2 sipsm3_vip
Secondary Server
162
4. Enable RTP Parameter for connectivity check (Note: only possible in certain OSV versions (Newer versions
of OSV is enabled by default). Srx/Sip/ServerVersionEnable = RTPTrue
The RTP parameter can be set by verifying the Configuration -> OpenScape Voice -> Administration -> Signaling
Management -> Digest Authentication -> General Tab (click: Enable TLS Keep-Alive for OpenStage phones).
From an OSV V8 perspective, if MTLS is configured as transport type for a Gateway endpoint then MTLS will be
enforced on every endpoint on the path from the gateway via the proxies and/or SBC to the OSV.
NOTE: In order for MTLS to work, at least 2 EP need to be configured on the OSV:
1) EP Configuration reflecting the Proxy with MTLS configured as transport protocol.
2) EP Configuration reflecting gateway behind the Proxy configured with corresponding transport protocol.
For integrated gateways’ EPs, only UDP or TCP are used. See examples below.
Configure EP for OSB 50i/500i Integrated Gateway NET5/NI2/CAS E1/CAS T1 with transport protocol
UDP (alias should have <FQDN>:5096)
Note: OSB 50i/500i integrated gateway endpoint must be created behind a Proxy Endpoint. So it should have as
associated endpoint EP for OSB Proxy.
Configure EP for OSB 50i/500i Integrated Gateway Qsig / Cornet with transport protocol TCP (alias
should have <FQDN>:5096)
Note : OSB 50i/500i Integrated gateway endpoint must be created behind a Proxy Endpoint.
Note : if using OSB with Splitterbox Configuration (PRI Redundancy) then Alias should include Redundant IP and
Physical IP addresses for both OSB nodes.
162
Example 2: OSB 500i/50i configured as GW only:
This endpoint should be configured with Attributes “Route Via Proxy” and “SIP Proxy” must be set. Attribute
“Survivable Endpoint” must be set if subscriber rerouting is required for survivability.
OSB IP address must be configured for alias (Port is optional. Ex 10.234.1.70:5061).
Important: OSB always uses TLS/MTLS on port 5061. Even configured as TLS, the connection is MTLS and
port 5061 is used.
Note: if using OSB with Redundancy then Alias should include Redundant IP and Physical IP addresses for both
OSB nodes.
Two additional endpoints shall be configured for each gateway in order to provide an alternative if the OSB Main
is not accessible:
Configure EP for OSB 50i/500i GW only
OSB 50i/500i Integrated Gateway Qsig / Cornet with transport protocol TCP or TLS (alias should have
<FQDN>:5096)
Note: OSB 50i/500i integrated gateway endpoint must be created behind a Proxy Endpoint. So it should have as
associated endpoint EP for OSB Proxy.
Note: Attribute Route via Proxy to route the calls via the associated endpoint. Attribute Public/ Offnet Traffic must
be also enabled.
OSB50i/OSB500i Integrated Gateway End Point should be configured with Attribute Public/Offnet Traffic.
Do not Send Invite without SDP attribute must NOT be selected on OSB50i/OSB500i Integrated Gateway End
Point.
OSB IP address and port 5096 must be configured for alias (Ex 10.234.1.70:5096).
Note: if using OSB with Splitterbox Configuration (PRI Redundancy) then Alias should include Redundant IP and
Physical IP addresses for both OSB nodes.
IMPORTANT: Do not Send Invite without SDP attribute must NOT be selected on OSB50i/OSB500i
Integrated Gateway EndPoint
Note: If a 500i/50i GW only is connected directly to an OSV with a single EP, the possible configurations are
UDP, TCP or TLS.
Note: The ATA can be configured with a MTLS EP, as their subscribers should be configured with UDP.
IMPORTANT: The transport MTLS for EP external gateway or SSP shall be used only if the connection
between the external gateway or SSP and OSB is TLS and TLS mode is set as Mutual Authentication.
163
44.3 Configuration of TLS in Phones
TLS OSV IPs and OSB IPs configured.
Note: if phones configured with different sipsm IP
address as OSB then this address must be included in
OSB trusted list (ex. OSB configured with sipsm3 and
Update Transport to TLS phones with sipsm1. In this case sipsm1 must be
(Outbound Proxy Flag is configured on trusted list of OSB.)
Checked)
ConnectvityCheckInterval
should be less than 240 secs.
Note: It is better to keep the
value to 10 seconds, which will
cause the phone to reattempt
the TLS connection in 10 Update Port Configuration
seconds if no response from from 5061 to 5161.
OSB. Note: For debugging the TLS
Packets between phone and
OpenscapeBranch set SIP
Local Port to a value other
than 5161 (ex. 6061).
Phone Transport and Port have to be updated to TLS/5161. Note: Time/Date has to match also with OSV and OSB.
164
165
44.4 Tracing with TLS
User can collect decoded traces from Logging menu by selecting the SIP/MGCP option from the Network Tracer
Menu. System collects decoded TLS traces from OSB with this option.
Configuration > OpenScape Branch > Branch Office > Configuration > Diagnostics & Logs > Debugging
166
45 Certificate verification process compliant with Baseline Security
Policy
This feature introduces the adaptation of specific certificate verification levels according to Baseline Security
Policy document. Please check the certificate management session.
The main implementation is the addition of the certificate verification levels as shown on picture below
Configuration > OpenScape Branch > Branch Office > Configuration > Security > General > Certificate
Management > Certificate Profile
167
46 Special characters in P-Preferred Identity of SIP INVITE
This feature introduces the allowance of special characters on default Home DN and the addition of the new flag
“Mandatory default Home DN – Normal Mode”
Configuration > OpenScape Branch > Branch Office > Configuration > Features > Sip Service Provider profiles
168
Enable LAN-WAN media interwork under Features Tab.
Enables media interworking between LAN and WAN side when they are configured with different
media profiles.
The Configure button shall be enabled only if Enable LAN-WAN media interwork is enabled.
If so, the Configure button shall direct to the VOIP > Media.
Default: Unchecked
169
LAN Media Configuration
Media profile
Assign a media profile that has been created in the Media profiles tab of the Voice over IP screen.
For the parameter definition and default, see Table 2: LAN WAN Media Interwork Disabled.
The media profile “default” shall be not configurable, so all its fields shall be grayed out.
Media profile
Assign a media profile that has been created in the Media profiles tab of the Voice over IP screen.
For the parameter definition and default, see Table 2: LAN WAN
Media Interwork Disabled.
Anchoring Media
Choose between forced and automatic media anchoring.
Values: ‘forced’, ‘auto’.
Default: ‘forced’
NOTE: The fields WAN Media Configuration and Anchoring Media shall
be grayed out if LAN-WAN media interwork is deactivated LAN-WAN
media interwork is activated and the OSB-mode is not Branch- SBC.
Media Profile
169
General
Name
A unique profile name can be entered.
Media protocol
The user chooses between unsecure and secure RTP or if the
payload is passed through
Values: ‘Strict Pass-Thru’, ‘Best Effort SRTP, ‘SRTP Only’,‘RTP’.
Default value: ‘Strict Pass-thru’
See the SRTP crypto context negotiation in Table 1: SRTP crypto context negotiation:
SRTP Configuration
The behavior of the Media Profile configuration parameters and their respective default values are
summarized in Table 2: LAN WAN Media Interwork Disabled.
170
Table 2: LAN WAN Media Interwork Disabled
(*) Notice that the flag “Enable LAN-WAN codec interwork” is not relevant for mode Proxy.
The media profile “default” is not configurable in order to avoid confusion for the user. For construction reason
the media profile “default” has effect on integrated gateway calls in proxy mode even if the configured media
profile for the integrated gateway is igw_lan. However, the media profile “default” is the default value for
Gateway / Trunk on the WAN, so if different values are required for its media profile, the user shall create a
new media profile.
171
Features tab > Gateways/Trunks tab > Gateway Configuration tab > Media Configuration
Media profile
Assign a media profile that has been created in the ‘Media profiles’ tab of the ‘Voice over IP
screen’.
Default: For the parameter definition and default value, see in Table
2: LAN WAN Media Interwork Disabled.
NOTE: The fields Media Profile, Anchoring Media, Media realm subnet IP address and Media
realm subnet mask shall be grayed out if:
LAN-WAN interworking is deactivated or
LAN-WAN interworking is activated and Interface = ‘LAN’
Anchoring media
Choose if media anchoring for gateway / trunk calls is enforced or decided by the OSB.
Possible values: forced, auto.
Default value: forced
172
o Record calls from this Gateway/Trunk
Enables recording using SIPREC protocol for this specific gateway.
Default is unchecked.
NOTE: This flag interacts with flag Voip > Media > Record All Calls. Please refer to the help
section for the complete description.
Asterisk non-integrated gateway features (like Auto-Attendant, MLHG, ACD or Call Park) have some special
requirements regarding to RTP / SRTP:
For calls to ACD, SRTP cannot be used because media is anchored in Asterisk for the duration of the call.
For calls to AA, SRTP cannot be used while playing the AA announcements but it is possible after the call is transferred.
For calls to MLHG, SRTP can be used. Media is not anchored by Asterisk.
173
SRTP Configuration
IMPORTANT: When the selected BCF ICE-priority is Passthrough, the SRTP configuration is disabled.
All fields are disabled and all flags revert to default state.
SRTP crypto context negotiation - following the option selected between the three flags
for the Media protocol selected, except for "Strict Pass-Thru"
MIKEY - Multimedia Internet KEYing
SDES - Security Descriptions Mark (ciphers supported: AES 128, AES 256, both)
DTLS - Datagram Transport Layer Security
Mark sRTP Call-leg as Secure - Checkmark the checkbox, if calls require secure media.
When active, this parameter identifies the network as secure if TLS and SRTP are not used,
i.e.,TCP or UDP for the signaling transport or RTP is used for the media protocol.
INFO: It is possible to see whether the SDP offer will have a single m-line SRTP, based on the media profile configuration.
This information is in the media profiles table (Voip > Media > Media Profiles).
When using SRTP Only as media protocol and only one Packetization Interval for all configured codecs,
the SDP offer will have one SRTP m-line.
RTCP Configuration
Some peers may need to receive RTCP packets. This configuration allows the application handling media to generate
RTCP when not being sent to it.
RTCP Mode
o Bypass: This is the default behavior. The media application does not generate any RTCP, it forwards
them. When the QoS is disa-bled, the packets are transparently forwarded
o Generate Always: The media application generates RTCP packets, regardless if the media (RTP) is
active (for example, call on hold).
o Generate only When RTP is active: The media application gener-ates RTCP packets only when the
media (RTP) is active.
RTCP generation timeout: The time (in seconds) that the media application must wait for an RTCP on the same
direction before it starts generating them
INFO: When configured to generate RTCP, the media application collects all the QoS statistics (process all
incoming/outgoing RTP/RTCP packets) to fill the generated RTCPs.
INFO: When configured to generate RTCP, there is no SRTP pass-through, since the media application needs to encrypt
the generated RTCP.
173
174
48 Media Transcoding
The OSB shall support media transcoding according to FRN 4358 The rules for
the media profile are the same as defined in the table on page 111.
Enable Codec Support for Transcoding checkbox was created in Features Tab.
Description: Enables the codecs that can be selected in media profiles configuration.
The ‘Configure’ button next to this check box shall be enabled only if the check box isenabled.
Default: Unchecked
Values: Available codecs are listed below. If a codec is already in the list of codecs for this codec profile
then it shall not appear in the drop-down list for adding codecs.
List of codecs
Description: The list shows the codecs in order of priority chosen for the mediaprofile.
174
Button Delete
Description: Remove codec from the list
175
For each codec in the list there shall be also a drop down list ‘packetization Interval’ next to each codec name in order to
select the packetization interval with the following available options: 10ms, 20ms, 30ms, 40ms, 50ms, and 60ms and pass-
through (auto) with default value auto.
Default: False
Note: The check box shall not be checked together with the ‘Allow unconfigured codecs’ check box.
A check box Allow unconfigured codecs
Description: If the received SDP offer contains codecs that are not configured in the media profile of the B-side these
codecs shall be passed through to the B-side
Default: True
Note: The check box shall not be checked together with the ‘Enforce codec priority in profile’ check box.
175
49 Security enhancements
OSB supports the security enhancements (message rate limiting and quarantine):
Drop Down box ‘Message Rate Limit (sec)’ was created in Network / Net Services Tab / Settings’ tab
Interface 2 (WAN)
section Values:
5,10,25,50,75,100
Description: Select message rate limit per second for the SIP listening IP:port for the WANinterface
Default value: 100.
Drop Down box ‘Trust Level’ was created in Network / Net Services Tab / Settings’ tab
Interfa
ce 2 (WAN) section
Values: ‘N/A’, ‘Minimal’, ‘Medium’
Description: This pull-down identifies the level of trust to be applied for the interface and is used to
determine the quarantine interval to be used if a network interface exceeds the provisioned “Message
RateLimit”:
Default value: ‘N/A’
The new ‘Denial of service mitigation’ tab was created in Security tab .
The following parameters are configured in the “Denial of Service Mitigation” tab/section:
“Enable gateway message rate limit” (checkbox) –
By default the checkbox is unchecked. When checked (feature enabled) the system applies message
rate limiting and quarantining according to the configuration of the OSB WAN SIP listening IP:Port
address.
An array of quarantine interval settings is provisional under a section titled “Trust Level Quarantine
Intervals“
Within this section each of the supported “Trust Levels” are displayed along with the quarantine time
interval in effect. The user may change the quarantine interval value according to the supported range
for each “Trust Level”.
Within this section each of the supported “Trust Levels” are displayed along with the quarantine time
interval in effect. The user may change the quarantine interval value according to the supported range
for each “Trust Level”.
176
Note: The default system-wide quarantine interval is variable (0-2 sec) and is not shown since it is not
configurable.
177
50 Support of near end NAT Firewall
The OSB shall support the external firewall address configuration according to FRN5693.
A new section External Firewall was created under Security tab > Firewall tab > Edit button
>Firewall Configuration pop up window
Checkbox External Firewall :Enables external firewall functionality in the OSB ,disabled by
default
Checkbox SIP ALG: Has to be checked if a firewall with SIP ALG functionality is used Default:
Grayed out and unchecked – may be activated in future FRNs
178
Blocking SIP or TLS will drop network packages coming from sources that are not configured in the
system, and this includes the requests coming from subscribers. The IP range of subscribers must be
added to the firewall white list.
Blocking RTP/sRTP will block requests for all ports configured for RTP/RTCP (media) as consequence
the voice path will not be established when these ports are blocked.
Blocking MGCP will block requests for the local media server so local announcements/media streaming
and large conferences will not work with MGCP blocked.
179
OpensScapeBranch Behind an OSS (OpenScape SBC)
The OpenScapeBranch can be used to connect to a OSV on a WAN interface through a OSS.
For the configuration details please check the V9 OpenScape SBC Configuration guide.
There are there different options in order to configure successful OSB iGW behind an SBC
1) FQDN configuration
In the OSV the OSB iGW and the OSB Proxy Endpoint is configured with FQDN. This FQDN needs to be resolved both from core and
access side of the SBC to the IP of the OSB. Then same FQDN as configured in the OSV endpoints needs to be defined under the
Remote Endpoint Configuration--> Remote Location domain list -->Remote URL.Same configuration should take place both for Proxy
and GW Remote Endpoint.
180
51 VOIP - Signaling and Transport Settings
VoIP tab ’Port and Signaling Settings’ tab
The field ‘INVITE timeout – Normal Mode (ms)’ was renamed to ‘INVITE no answer
timeout – NM (ms)’
The field ‘INVITE timeout – Survivable Mode (ms)’ was renamed to ‘INVITE no answer
timeout – SM (ms)’
Default value and ranges shall stay the same.
•
181
52 Open External Firewall - Pinhole
When the Open Scape Branch is under an external firewall, dummy UDP packets are sent towards the endpoint
media destination (connection address and port in the SDP) in order to dynamically open the firewall for the
incoming media streaming.
This feature avoids several rules to be added to the firewall in order to keep open all possible addresses and
ports used by the SBC for the media connection values.
NOTE: This feature only applies for the addresses and ports used for the media streaming. It is not applicable to
the SIP or MGCP protocols.
This configuration only takes effect when the flag Enable LAN-
WAN media interworking flag is set.
182
b) VoIP > Port and Signalling Settings
183
53 Table A: Fixed/Configurable Port Information
This table shows specific ports used by OpenScapeBranch.
Note: Proxy/Proxy ACD RTP and SIP ports are controlled/allocated by Endpoints/GWs/OSV.
184
54 Table B: OSB Configuration Limits
185
The following table shows specific limits for supported OpenScape Branch Models. OSB Configuration Guide
states that
OSB 250 supports a maximum of 10 SBC concurrent sessions. OSB Sales documentation states that OSB 250
supports a maximum of 30 SBC sessions
oa Advantech Advantech Advantech IBM 3250 Fujitsu/ Remarks
50i 250i 500i IBM3550
OSB250 OSB 500i OSB1000 OSB6000
Max allowed 88 300 600 1200 6200 For Keysets,
every line
Registered Lines counts as
(Endpoints) Subscriber
(Endpoint)
Max supported 250 250 500 1000 6000 For Keysets,
every line
active Lines counts as
(Endpoints) Subscriber
(Endpoint)
185
55 Table C: Hardware Types Table
Advantech SYS-2USM01-6M01E
Physical Dimension (W x H x D): 300 x 65 x 400
mm (11.8” x 2.6” x 15.8”)
OpenScape Branch 50i A024 - ADA565 /
L30220-D600-A565 (24 FXS ports)
OpenScape Branch 50i A048 - ADA566 /
L30220-D600-A566 (48 FXS ports )
Advantech SYS-2USM12-6M01E
Physical Dimension (W x H x D): 300 x 65 x 300
mm (11.8” x 2.6” x 11.8”)
Power: 100~240 V AC , 50-60 Hz, 60W Part
Number. ADA393 / L30220-D600-395
186
OpenScape Branch 500i
Advantech SYS-2USM03-6M01E
Physical Dimension (W x H x D): 425 x 65 x 320
mm (16.8” x 2.6” x 12.9”)
OpenScape Branch 500i DP4 ADA571 / L30220-
D600-A571
(Digital PRI – 4 E1/T1 PRI ports)
OpenScape Branch 500i DP8 ADA572 /
L30220-
D600-A572
(Digital PRI – 8 E1/T1 PRI ports)
187
Lenovo SR530 (Replacement for IBM x3550 M5)
188
56 Table D: Operating Modes Diagram
189
57 Table E: Routing Table
SIPManipulation External
GW table
Outgoing Add/delete/replace
GW Call from digits
Call in Phone Note: GW table is only
Strip /add digits
Survivability used if no registered
Mode subscriber is foundafter
SIP manipulation is
done.
Subscriber Call Add/delete/replac
from Phone edigits Subscriber
GW table
External
GW
GW Call to OSV
Incoming
Call in Note: OSB SIP Manipulation or
Normal GW manipulation not done in NM
for incomingcalls.
Mode
GW must be configured in OSBin
order for OSB to route incoming
Subscriber
GW call to OSV.
Subscriber Call to
OSV
190
GW Call to Phone
Incoming SIP ManipulationAdd/delete/replace Note: GW manipulation not
digits done in SM for incomingcalls.
Matching based on
“Routing Prefix” Best Match 2nd lowest priority Strip / add digits
Outgoing (ex. 91561) GW Found (ex. 2) (ex. Delete91) GW Target 2
Call GW Note: Re
Priority Re rerouting is GW Returns Error Code (ex. 503/480/etc)
Routing only
performed Matching based on
based on
(Both configured “Routing Prefix” Best Match 3rd lowest priority
Strip / add
digits
Modes) Error codes (ex. GW Found (ex. (ex. Delete 9)
provisioning 91561) 3) GW Target 3
.
GW Returns Error Code (ex. 503/480/etc)
No other GW
found “Routing Prefix”(ex. -Route to GW 0 (default) ifconfigured.
91561). -Route to MS (announcement) ifconfigured
-Disconnect Call
191
58 OpenScape Branch 50i
OSB integrated gateway supports FXO/BRI/PRI as well as 4 FXS ports.
Note: “Do not Send Invite without SDP” attribute must NOT be selected on OSB50i/OSB500i Integrated Gateway End Point.
58.1.1.1 -OSB50i: 8 FXO + 4 FXS Ports Note: cards or internal power cables must not
be removed with the system powered on.
192
58.1.1.3 -OSB50i: 1 PRI (E1 or T1) + 4 FXS Ports (DP14)
Note: 50i PRI can be ordered for T1 or E1.
58.1.1.4 - OSB50i: 2 PRI (E1 or T1) + 4 FXS Ports (DP24) Note: 50i with 2 PRIs can be configured as T1 or E1.
PRI 2 PRI 1
193
58.2 Enable Integrated GW and Discover card configuration
Configuration -> OpenScape Branch -> Branch Office -> Configuration -> Features
194
Verified Integrated Gateway Cards loaded correctly
Configuration -> OpenScape Branch -> Branch Office -> Configuration -> Features -> Enable integrated gateway ->
Configure
Configuration -> OpenScape Branch -> Branch Office -> Configuration -> Features -> Enable integrated gateway ->
Configure -> FXS -> Configuration
195
All ports: enabling only ports with subscriber number.
General:
Subscriber Configuration:
196
Loop current: loop current for analog phones.
Manual Ring Settings: Enables configuration for
Ring Frequency and Voltage.
Ring Frequency: ring frequency for analog
phones. Default is 20.
Ring Voltage: ring voltage for analog phones.
Default value is 75.
Hook Flash: turns on or off hook flash capabilities
for all ports.
Hook Flash Duration: Long (200ms to 1250ms)
or Short (80ms to 200ms) duration hook flash.
Enable path tagging: Allows a Branch (not in Proxy-ATA
mode) to include a "Path" header in SIP messages from
the FXS
Allow compression codecs over FAX lines: When this
checkbox is set, whichever codecs have been negotiated
for a call can be used, even when it is a FAX call. When
the checkbox is not set, then the G.711 codec will be used
exclusively for FAX calls.
CLIP:
When Country is configured as "United States/North
America" or "United States Circa 1950/North America"
CLIP is always enabled and will be gray out like picture
above.
It was included a new mechanism to audit invalid voltage values in FXS ports, this condition indicates that the FXS port is
unresponsive. The mechanism gracefully recovers the system and triggers an alarm while the invalid condition is read.
This new feature is enabled if the new “FXS Invalid Voltage Audit” flag is set and is valid for all FXS ports.
This new flag can be found under: Features -> Enable integrated gateway -> Configure -> FXS -> Configuration -> Card
Configuration
197
Hotline/Warmline Configuration:
Enable: This checkbox is used to enable the Hotline
or Warmline feature for an FXS port. Default setting is
unchecked.
Wait time (sec): This field is used to enter a delay time in
whole seconds. The default value is zero. When this field is
set to zero, Hotline behavior is assumed. When this field is
set to a non-zero value, Warmline behavior is assumed.
Destination: This field is used to store the Hotline or
Warmline destination number. This field can contain up to
24 digits, using digits 0 – 9.
Number of times to repeat: This field indicates how
many times to retry an external hotline/warmline
destination in the event that it is busy.
Repeat interval (sec): This field indicates, in whole
seconds, the time between retries and the time until the
first retry. Permissible values are 1 to 30. Default value is
5.
198
58.3.1 Endpoint Service Profile For FXS Subscribers
It is possible to configure/apply dial restriction rules per FXS subscriber. Digit sequences configured in table shall be rejected.
199
58.3.2 Location Information
200
58.3.3 Features (FXS subscribers)
58.3.3.5 Disable Call Waiting for Next Call: feature can be done in two ways
a) Go off-hook, dial *70 to activate, hear confirmation tone, dial the number of the person to reach (when call is
established, Call Waiting will not be accepted during the call)
b) Go off-hook, establish a call, hookflash, hear stutter dial tone, dial *70 to activate, hear confirmation tone,
hookflash again to retrieve (after this procedure, Call Waiting will not be accepted during the call)
201
58.4 FXO Configuration
The minimum Ring Voltage for the TDM808 card (FXO):
There are two modes: FCC and TBR21.
Below is the min-to-max ring voltage range of each:
FCC is 19.35 - 23.65 Vrms.
TBR21 is 13.5 - 16.5 Vrms.
202
Enable: Enable or disable the FXO physical port.
Physical port: port number of the FXO port (read-only field).
Signaling mode: It configures the signaling mode. Only Loopstart is
available.
Answer by polarity reversal: enable/disable the detection of
answer via silent reversal.
Disconnect by polarity reversal: enable/disable the detection of
disconnection via silent reversal.
Polarity reversal delay hangup: The minimum time interval
between the answer polarity switch and hang up polarity switch and
only used if Answer and Disconnect by polarity reversal are enabled.
Loop supervision: If enabled, the signaling mode is set to
Kewlstart.
Echo cancellation: enable/disable echo cancellation for the port.
Receive gain: sets the Gain of payload for receive.
Transmit gain: sets the Gain of payload for transmit.
203
Note - Busy Tone detection:
This feature can lead to detect false answers when a false busy tone pattern is perceived.
The BusyTone detection is currently configured only for standard U.S. and Argentina tones.
204
58.4.1 FXO - Trunk Group Configuration
Configuration
Type: port type (read only data).
FQDN: required for Trunk Group and to be used later on in
“Gateway/Trunk Configuration”/
Trunk group name: name of the Trunk Group
Trunk selection: selecting from High or Low Trunk first is possib
Hunt type: linear of circular selection
Direction: Specifies the direction of traffic flow supported on the
Mark sRTP call-leg as secure: if a secure media is negotiated f
(FXO, BRI or PRI), the call will be indicated as secure (ST- Siem
Type: secure)
Incoming Calls
Answer Supervision Timer – Incoming Calls: Value betwe
3600. Default is 360. Note: Corresponding Answer Superv
should be configured under 'Feature'->'Gateway/Trunk'.
Timers should be configured with a difference of at least 10 seco
Gateway/Trunk and Integrated Gateway to avoid racing conditio n
simultaneous disconnection.
Blacklist profile: Specifies the Blacklist profile that it will be che
incoming calls.
Outgoing Calls:
Set numbering plan to ISDN : it is set to enable/disable. Wh
Type is Unknown, it will set the Numbering Plan to ISDN. Othe
to Unknown (only PRI). NOTE: This flag applies only to “Called
Pre dial delay for DTMF: When an analog trunk is seized, it t a
until the DTMF receiver is allocated by CO. If DTMF digits are d
DTMF receiver is allocated, the first digits can be lost. It shall
configure a delay to start sending the DTMF digits.
Calling Party Number Presentation Restricted: Set calling par
presentation restricted to all outgoing call.
Answer Supervision Timer – Outgoing Call: Value between 1
3600. Default is 170. Note: Corresponding Answer Supervision
be configured under 'Feature'->'Gateway/Trunk'.
Timers should be configured with a difference of at least 10 seco
Gateway/Trunk and Integrated Gateway to avoid racing conditio
simultaneous disconnection.
205
Drop-down box is used to select the port
that it will be added to Trunk Group.
206
58.5 BRI Configuration
207
Fax T.38: Enables FXO card T.38 negotiation for fax. It is
enabled using the enable check box.
CNG Detection: Enables detecting CNG tone for T.38 fax
negotiation. The activation of the flag "CNG detection" will
only take effect if T.38 flag is also enabled.
Note: T.38 fax calls always start as a voice call and then
switch to the T.38 codec.
Configuration of the echo cancellation tail length for ISDN BRI ports via the GUI:
Possible values: none, 16, 32,64 and
128. Default value is 32
Upgrade from older versions: if flag Echo Cancelation is enabled the echo tail will be set to 32ms. If flag is disabled echo tail will
be set to none.
208
209
Far end disconnect with inband announcement: enable/disable disconnect with inband announcement.
B-channel parallel restarts: if flag is enabled RESTART message for each individual b-channel is sent
simultaneously for all b-channels. If flag is disabled RESTART is sent for first b-channel and RESTART
ACKNOWLEDGE is required for this b-channel before sending RESTART to next b-channel.
Always send PI8 in ALERT: if flag is enabled OSB sends ALERTING with PI8 (progress indicator: In-band
information or an appropriate pattern is now available) whenever a 180 Ringing (without SDP) is received.
Otherwise PI8 will be sent only when a 180 Ringing with SDP is received.
Setup progress indicator: Configures the Progress Indicator in SETUP message. If the received INVITE
does not contain any SDP, no progress indicator is sent, regardless of theconfiguration.
Start early media on CALL PROCEEDING: This command will cause the Branch to raise a SIP 183
Session Progress message with an SDP Answer as soon as it receives the ISDN CALL PROCEEDING
message. The SIP 183 Session Progress response will contain a "P-Early-Media" header field (RFC5009)
with a new proprietary value ("fast-connect"). If an ALERTING is received afterwards, the Branch will send
back a SIP 180 Ringing response with SDP Answer and without the "P-Early-Media" header. This flag will be
ignored if INVITE received does not contain SDP.
183 Session progress without SDP: OpenScape Voice sends a 183 Sesssion Progress response code
without SDP. Configuration item allows to choose how this response code must be informed to the PSTN
caller according to the carrier requirements. This action intends to stop timer T309 avoiding the disconnection
of call by the caller side.
Disable far end restart: In scenarios in which 50i is connected to a CO switch that does not accept
RESTART message during BRI span bring up. The flag is recommended for use in BRI PMP systems.
NOTE1: Always change the card configuration with the card unplugged. Be careful when changing the jumper position.
NOTE2: No features/Services supported in the S0 bus.
210
There are DIP switches for each port used to add a 100
ohm termination when the B410P is in NT mode.
DISCLAIMER: The proper GVS support should be contact in order to request for the activation for this feature.
211
58.5.2 BRI - Trunk Group Configuration
Configuration
212
Incoming Calls Outgoing Calls
Max overlap digit length: Maximum number of digits that can Send Redirect Number instead of calling number for redirected
be received in an overlap dialing incoming call. When the number calls: If selected (enabled), a call that is redirected to the PSTN will
of incoming digits matches this configuration, the called number is have the last redirecting or transferring party's identity as the Calling
considered complete even no sending complete information is Party Number information element. This attribute is primarily intended
received. If not configured then T302 timer would apply for use when connecting to a carrier that does not understand the
Specific overlap dialing patterns: Replaces "Max overlap digit Redirecting Party Number information element.
length" value. Indicates that the system must process incoming Calling Party Number Presentation Restricted: Set calling party
digits in accordance with the patterns defined in the table. If this number presentation restricted to all outgoing call.
parameter is enabled "Max Overlap Digit Length" is ignored and Connected line identification presentation outgoing: Default value is
unchecked. Only visible when the PRI Method is E1, or it is a BRI trunk
the table must have at least one entry.
group. This flag must not be visible when configuring T1 PRIs on both the
Connected line identification presentation incoming/outgoing: OSB 50i and OSB 500i.
Enables treatment for connected line identification presentation. Called Name Outgoing - Enable called name for outgoing calls (SIP-
When connected number is received in connect or connect ack isdn ISDN).If called name facility received in ISDN Alerting, with presentation
messages. allowed, it will be sent in PAI header in sip 180 ringing
Called Name Incoming - Enable called name for incoming calls
(ISDN-SIP). Answer Supervision Timer – Outgoing Call: Value between 120 and
If name received in PAI header in sip 180 ringing, and Privacy: id 3600. Default is 170. Note: Corresponding Answer Supervision Timers
not present,called name facility will be sent in ISDN Alerting. should be configured under 'Feature'->'Gateway/Trunk'.
Answer Supervision Timer – Incoming Calls: Value between Timers should be configured with a difference of at least 10 seconds
120 and 3600. Default is 360. Note: Corresponding Answer between Gateway/Trunk and Integrated Gateway to avoid racing
Supervision Timers should be configured under 'Feature'- conditions caused by simultaneous disconnection.
>'Gateway/Trunk'.
Timers should be configured with a difference of at least 10
seconds between Gateway/Trunk and Integrated Gateway to
avoid racing conditions caused by simultaneous disconnection.
Blacklist profile: Specifies the Blacklist profile that it will be
checked during incoming calls.
213
Drop-down box is used to select the port that it will
be added to Trunk Group.
214
58.6 PRI Configuration
Note: If the PRI Method is changed, the user will receive a warning message that says “The PRI Method will be changed.
The interfaces will be reset according to the default values for the newly selected Method. All PRI B-channels will be
removed from all trunk groups. Click OK to continue.
215
User can configure (restart/block/unblock
channels) individual PRI links or B-channels
216
Fax T.38: Enables FXO card T.38 negotiation for fax. It is
enabled using the enable check box.
CNG Detection: Enables detecting CNG tone for T.38 fax
negotiation. The activation of the flag "CNG detection" will
only take effect if T.38 flag is also enabled.
Note: T.38 fax calls always start as a voice call and then
switch to the T.38 codec.
217
Physical port: PRI card/port number (Read Only)
Signaling method (E1): ISDN or CAS-MFCR2 or CAS Ring Down (only
available for 50i DP24). Framing (T1): line formatting options ESF (Extended
Super Frame) or D4 (Superframe). The ty of framing used is determined by your
Telco.
Line build out: each number in the combo box corresponds the following value:
0 - 0 db (CSU) 133 feet (DSX-1), 5 - -7.5db (CSU), 6 - -15db (CSU), 7 - -22.5db
(CSU).
Note: LBO is only supported for OSB Configured as T1.
Coding: Line encoding method options AMI (Alternate Mark Inversion) or B8ZS
(Bipolar 8 with Z Substitution) for T1 and HDB3 (High Density Bipolar 3) for E1.
The line coding used is determin by your Telco.
Switch type: sets protocol
by a combo box. E1->
EuroISDN, QSIG and
CorNet-NQ. QSIG/Cornet-
NQ only for 50i DP24.
T1-> NI2, 4ESS, 5ESS Custom, T1CAS, QSIG and CorNet-NQ.
NOTEa:The LBO used by the OSB T1 line is 4ESS/5ESS/T1CAS/QSIG/CorNet-NQ only for 50i DP24
purely the attenuation of the line,by 7.5, 15 CRC: enable/disable CRC4 checking (only E1).
and 22.5 dB, for values 5, 6 and 7. BCAS: enable B-channel Availability Signaling Procedures. Only available for
Therefore the length should be depending 4ESS and 5ESS this parameter is enabled the user will be able to
also on the variation of the repeater Block/Unblock an individual B-channel in Chan Maintenance screen. Only when
configuration. BCAS is enabled Branch will answer isdn SERVICE messages. BCAS service
message after restart: selects behavior upon receiving isdn RESTART/RESTA
ACKNOWLEDGE messages when BCAS is enabled.
Receive gain: sets the Gain of payload for receive. A negative value decreases
NOTEb: The value zero is without attenuation the gain, an positive value increases the gain (mandatory).
and with pulse shaper set to default. Transmit gain: sets the Gain of payload for transmit. A negative value
The pulse shaper settings are not used by OSB, decreases the gain, an positive value increases the gain (mandatory).
but it would shape the pulse according to Default destination: destination number if no called party number received for
standard cabling and impedance to the ISDN incoming ca The default destination is also used if just one digit is received
distances. and there is not a rule to handle i the Specific Overlap Dialing Patterns table.
Clock source priority: determines whether the clock signal from the far end of
this T1/E1 port will be used as the master source of clock timing for this card or
NOTEc: The maximum cable length for the ISDN system. Available values are 1-4 for one card or 1-8 for two cards and should be
connectivity depends on the cable caracteristics. uniquely assigned. The value 1 is the highest priority. The value 0 indicates that
The card operates in a short haul mode. Typical cable this port will never be used as a source of clock timing for this card. If all ports
attenuation for .4 millimeter (mm) wire is 3 dB per 100 are set to 0 then the clock will be derived internally.
meter (m) (measured at 1024 kilohertz [KHz]). Exclusive channel: If enabled, indicates only the channel offered in the SETUP
It is not recommended to use cables longer then 40m message accepted, otherwise channel is preferred (only PRI). This field is
(133feet). editable only if port is configured terminal mode (user side), otherwise it will be
always enabled.
NOTEd:For T1 lines it's possible to use the use of Line Echo cancellation: enables the echo cancellation parameter.
Build-Out (waveform transmit) configuration. LBO Echo tail: echo tail for Hardware Echo Cancellation. The values available are:
values other than zero compensate for signal 32, 64 and 128. Echo training (ms): This parameter is available for PRI/CAS
attenuation due to the length of the cable connected to and FXS interfaces that have ec cancellation enabled. Possible values are
an ISDN PRIcard, according to the table below: disabled (default) and from 400 to 1200 ms (w granularity of 100 ms). Enabling
echo training will cause the OSB to briefly mute the channel bef opening the
0: 0 db (CSU) / 0-133 feet (DSX-1) audio channel, send an impulse with the configured duration in miliseconds,
1: 133-266 feet (DSX-1) and the impulse response to pre-train the echo canceller.
2: 266-399 feet (DSX-1) Extended Echo Cancellation: This flag applies only for DP14 configured with
3: 399-533 feet (DSX-1) RAM 2GB (p refresher hardware) and E1 Port, the default value is enabled.
4: 533-655 feet (DSX-1) Since the OSB50i DP14 p refresher uses SW-DSP OSLEC process, the echo
cancelation on 30 simultaneous E1 chann requires high dynamic processing
that may affect the system performance. This effect compensated by the
“Extended Echo Cancellation” functionality but with a possible perception the
audio quality level, depending on the phone (e.g. lower on OpenStages or
higher on phones). This function can now be disabled to improve voice quality.
218
T302: timer to wait for digits for overlap dialing.
T305: timer to wait for DISCONNECT ACK once DISCONNECT is sent out, if this timer
expires RELEASE is sent and T308 is started.
T308: timer to wait for RELEASE COMPLETE once RELEASE is sent out, if this timer
expires RELEASE retransmitted and T308 is restarted. If this timer expires twice the B-
channel is placed in maintenance condition and call reference is released.
T309: maintain active calls on layer 2 disconnection, calls are cleared if connection is
not established before T309 timer expires.
T313: wait for CONNECT ACK once CONNECT is sent out, if this timer expires
DISCONNECT is sent. Used only if port is configured as terminal mode (user side).
219
Far end disconnect with inband announcement: if enabled upon
receiving a DISCONNECT with PI-8 the call is not released, sending a
183 PROGRESS to open channel to send a disconnection message. If
disabled, the call is released upon receiving a DISCONNECT ignoring
PI-8 (only PRI).
Second screening indicator: second screening indicator will be used
in incoming setup message (E1 Only).
Data calls allowed: Incoming call with digital information bearer
capability is allowed or not.
Setup progress indicator: Configures the Progress Indicator in
SETUP message (New Zealand). The following options are supported:
Call is not end-to-end, Destination address is non ISDN, Origination
address is non ISDN and None
183 Session progress without SDP: OSV sends a 183 Session
Progress response code without SDP (i.e, without inband
announcement) in some situations (for ex, call processing delayed and
no information about the called party is available till this point). This
configuration item allows choosing how this response code must be
informed to the PSTN caller according to the carrier requirements. This
action intends to stop timer T309 avoiding the disconnection of call by
the caller side. Possible values: Progress, Alerting, Progress and
Alerting and None.
Always send PI8 in ALERT: if flag is enabled, OSB sends ALERTING
with PI8 (progress indicator: In-band information or an appropriate
Sending complete: add Sending Complete information element in pattern is now available) whenever a 180 Ringing (without SDP) is
SETUP messages (T1 Only) received. Otherwise PI8 will be sent only when a 180 Ringing with SDP
Calling name delay: Calling Name will be provided in a separate ISDN is received.
message. In this case, the SIP INVITE message will postponed until the QSIG ringback: Do not play ringback for QSIG/CORNET if flag is
Facility with Calling Name is received or after a fixed 2 seconds timer disabled.
expires. Start early media on CALL PROCEEDING: command will cause the
Send calling party name: enable/Disable the sending of the Calling OSB to raise a SIP 183 Session Progress message with an SDP
Name information in outgoing calls Answer as soon as it receives the ISDN CALL PROCEEDING
Calling party name: Indicates in which Information Element the Calling message.
Party Name information should be delivery: Facility IE or Display IE. Disable far end restart: scenarios in which 50i/500i is connected to a
Send redirect number: Enable/Disable the sending of the Redirecting CO switch like MUNDRA that does not accept RESTART message
Number in outgoing calls during PRI span bring up. The flag is for use only with NET5 type
Redirecting number: Indicates in which Information Element the switch and specific CO such as MUNDRA in India.
Redirecting Number information should be delivery in outgoing calls: Idle reset interval:
Facility IE or Redirecting number IE. Busy Detect Disconnect: If enabled the call is disconnected upon
Channel mapping: possible values: Logical/Physical busy tone detection.
Physical: channels from 1-15 17-31, channel 16 is not used. Do not send ISDN Status Message: If this flag is set OSB will never
Logical: channels from 1-30, channel 16 is used as "pseudo" b-channel. send ISDN Status Message out.
This is default for Qsig/Cornet switch types.
Restart link at start-up: if enabled send PRI restart message after link
start-up.
L3 trunk restart type: Restart Channel (a RESTART message is sent
for each channel) or Interface can be configured.
B-channel parallel restarts: if flag is enabled RESTART message for
each individual b-channel is sent simultaneously for all b-channels. If flag
is disabled RESTART is sent for first b-channel and RESTART
ACKNOWLEDGE is required for this b-channel before sending
RESTART to next b-channel
Group restarted b-channels in channel identification IE: ability to
daisy-chain channels within the Channel Identification Information
Element (CIIE). The multi-channel CIIE will be used in the RESTART
and RESTART ACKNOWLEDGE messages.
Ignore Dial Tone On Setup Without CPN: incoming SETUP is received
without Called Party Number and without Sending Complete the OSB
will play dial tone on the line if this flag is clear. If this flag is set the OSB
won't play dial tone in this scenario.
220
All channels: Enabling/Disabling all B-channels.
Enable: Enabling/Disabling a B-Channel for this PRI interface.
Number: The B-Channel number.
CAS initial state: ABCD bit position during startup, only for CAS for eachchannel.
List is showed when PRI Interface is configured with Signaling method as CAS Ring Down.
221
Advanced SIP to ISDN Cause Code Mapping
Adds new option to customize which ISDN cause code will be sent
upon receiving specific SIP error status.
222
E1 CAS MFC-R2 advanced settings
NOTE: This section changes the CAS timer values. All timer values are in milliseconds (ms). It
is not recommended to change them if you are not an advanced user.
Timeout for backward request to resume cycle: Resume the MF digit on DNIS timeout
timer.
Call forward safety: Forward Safety Timer.
Wait for seize acknowledge: How much time it is waited for a response to our SEIZE signal.
Wait for answer: How much time it is waited when the call has been accepted.
Double answer: When double answer is in effect, it is the interval between the ANSWER,
CLEARBACK and ANSWER again.
Answer delay: Short delay before answering to give the other end an additional time to detect
the tone off condition
Persistence check: How much time it is waited for CAS signaling before handling the new
signal.
DTMF start dialing: DTMF Start Dialing Timer
MF threshold time: Time that an MF tone should last before being handled.
Profile parameters can be edited in the table. A new, blank, profile can
be created by clicking the "Add" button and filling in the fields
accordingly. A profile can be deleted by wirst clicking on its row to select
it and then clicking the "Delete" button.
223
E1 CAS Ring Down profile
Table with a summary of E1 CAS Ring Down profiles.
It is possible to Add/Edit/Delete a profile.
Profile
Timer
224
Ring down channels
Table with the summary of E1 CAS channels configured as Ring Down.
225
T1 CAS Profiles
Table with the summary of T1 CAS profiles configuration.
It is possible to Add/Edit/Delete a profile.
Profile
Timer
226
58.6.1 PRI - Trunk Group Configuration
Configuration
227
Incoming Calls
Max overlap digit length: Maximum number of digits that can be received in an
overlap dialing incoming call. When the number of incoming digits matches this
configuration, the called number is considered complete even no sending complete
information is received. If not configured then T302 timer would apply
Specific overlap dialing patterns: Replaces "Max overlap digit length" value.
Indicates that the system must process incoming digits in accordance with the
patterns defined in the table. If this parameter is enabled "Max Overlap Digit
Length" is ignored and the table must have at least one entry.
Connected line identification presentation incoming:
Answer Supervision Timer – Incoming Calls: Value between 120 and 3600.
Default is 360. Note: Corresponding Answer Supervision Timers should be
configured under 'Feature'->'Gateway/Trunk'.
Timers should be configured with a difference of at least 10 seconds between
Gateway/Trunk and Integrated Gateway to avoid racing conditions caused by
simultaneous disconnection.
Blacklist profile: Specifies the Blacklist profile that it will be checked during
incoming calls.
Outgoing Calls
228
Collect Calls
Collect call control: who will check the permission for collect calls:
Server -> will add X-Siemens-header:collect-call in NM for calls with the indication
of collect call. In SM, these calls will be rejected if permission is denied.
Gateway -> Branch will check the permission in SM and NM, and reject calls with
the indication of collect call, if permission is denied.
Permission for receiving collect calls by category: In case of CAS, it will check
the permission for collect call by category. If this flag is not checked, the call with
the indication of collect call will be rejected if Collect Call Control is Gateway
(NM/SM) or Server (SM). In case of ISDN, if this flag is not checked, incoming calls
with Reverse Charge Indication will be rejected, if Collect Call Control is Gateway
(NM/SM) or Server (SM).
Unify Inc. Pag Permission for receiving collect calls by double answer: if Branch will check
the permission for collect call by double answer. If this flag is not checked, the call
is double answered, which causes the release of the collect calls. Only works for
CAS and Brazil.
229
E1 CAS – Ring Down
E1 CAS – MFC R2
E1 CAS profile: Select any of the created CAS profiles in CAS profiles table. CAS profile
association is mandatory for CAS E1 trunk groups.
Do Not Accept Call on Offer: If set, the gateway waits for subscriber state (free, busy,
unallocated) before sending backward tone from Group B. If not set, the gateway always
sends free subscriber backward tone immediately after receiving a CAS call. The default is
disabled.
CAS Answer for Early Media: If set allows answer in CAS calls to play announcements.
Otherwise, send the appropriate backward tone.
Send End of ANI with Presentation Allowed: If set sends end of identification with
presentation allowed. Otherwise, sends end of identification with presentation restricted.
(Only Argentina)
CAS Send Early Media: If set sends 183 Session Progress to the SIP side when making
outgoing calls in E1 CAS. Otherwise, sends 180 Ringing.
230
T1 CAS
231
Filter: this drop-down box is used to filter the list of available
channels to a specific Port on a specific card. Selecting the blank
entry in the drop-down list will display all channels of all ports of
all cards.
The left-hand list shows the list of PRI channels that are
available. Any channel that is already in use on this or another
trunk group will not be shown here.
To add a channel to the "Selected Channel" list, first click it to
select it, and then click the double-right chevron button. Multiple
channels can be selected by holding down the Ctrl key while
selecting them.
232
58.7 Integrated Gateway – General Settings
58.7.2 SIPQ V2
50i DP24 supports QSIG and Cornet-NQ.
In normal mode QSIG and Cornet-NQ messages are tunneled to OSV through SIPQ V2. In survivable mode QSIG and
The support of QSIG by OSB is required to allow subscribers on an OSV to interwork with subscribers on networked
HiPath3000/4000 and 3rd party PBXs. SIPQ V2 is required in order to support SRTP over connections established via
SIPQ.SIPQv1 will not be supported by OSB.
In case of interconnection with old PBXs, the flag "truncated mime" should be activated in the OSV.
58.7.3 Blacklist
233
Max of 20 profiles can be created
234
Each trunk group can have a
profile associated
Codec: This drop-down box presents a list of codecs that are available to be added to the
profile. Selecting a codec and then clicking the "Add" button will result in the codec appearing
in the table below.
Note: Codecs can be selected/enable under Features->Enable Codec Support for
transcoding->Configure->Select codecs.
Priority: This table presents the list of codecs that are assigned to the media profile. The
"Priority" column indicates their relative priority to each other. The priority order can be
adjusted by clicking the "Move up" or "Move down" buttons. The delete a codec from the
table first click it to select it and then click the "Delete" button.
NOTE: For OSB, Multiple packetization interval is not allowed, the same value for all rows MUST be used.
SIP ISDN
Post TON OUT Normal TON IN
Mode
Add PNAC+Prefix
Received TON
GNF
International
None Match
INVITE Prefixes
R-URI SETUP
Received TON Called Party
Add PNAC+Prefix International
Survivable
None National Mode
Subscriber Incoming
digits Subscriber
Outgoing
SIP ISDN
Post TON OUT TON IN
Add PNAC+Prefix
Normal
Received TON
GNF Mode
International
None Match
INVITE Prefixes
From SETUP
Calling Party
Add PNAC+Prefix Received TON
None Survivable
International
Mode
Prefixes
International PNAC: configuration of the international
Public Network Access Code (PNAC)
International prefix: configuration of the international
prefix.
National PNAC: configuration of the national PNAC.
National prefix: configuration of the national prefix.
Subscriber PNAC: configuration of the subscriber PNAC.
Subscriber prefix: configuration of the subscriber prefix
Incoming calling and called party numbers are sent as received to the proxy’s Number Manipulation function, prefixed with
PNACs and prefixes.
Outgoing calling party numbers are sent to the PSTN as received from the proxy’s Number Manipulation function without post-
manipulation.
Outgoing called party numbers are sent to the PSTN as received from the proxy’s Gateway Routing function without post-
manipulation.
Note that not having post-manipulation enabled means that if the OSB 50i/500i receives prefixed numbers from the OSB proxy, these
numbers are mostly sent without the prefixes to the PSTN. In order to still send the prefixes, the post-manipulation must be set to ‘Send
Prefixes’.
The integrated gateway will perform best when it receives numbers with PNACs and prefixes. That way the number modification can be
easily controlled.
When determining TON-IN, “TON via length check” is disabled unless “Match prefixes for Unknown numbers” is checked.
Both flags can be checked at the same time.
Match Prefixes for Unknown Numbers (calling and called): If set, the leading digits of the incoming calling or called party
number with Unknown Type of Number is matched against (in this order) the International Prefix, National Prefix and Subscriber
Prefix. The prefix field must have a non-empty value to match. In case a number remains Unknown after the prefix check, the
default Type of Number of Subscriber is taken.
TON via Length Check (calling and called): If set and if number lengths are specified in National Number Length and/or
Subscriber Number Length, the length of the incoming number is checked against these lengths and if a length match is found the
appropriate Type of Number is assumed for the incoming number.
The following are the possible options on the drop-down list boxes:
Incoming calls from the PSTN during Normal Mode
Calling Party Number Called Party Number
Preferred TON to SIP Post Manipulation Preferred TON to SIP Post Manipulation
Same as TON-IN None Same as TON-IN None
International Add PNAC and Prefix International Add PNAC and Prefix
GNF GNF
Match PNACs and Prefixes (calling and called): If set, the leading digits of the incoming calling or called party number are
matched against (in this order) the International PNAC and Prefix, National PNAC and Prefix and Subscriber PNAC and Prefix.
The combination of PNAC and prefix field must have a non-empty value to match.
TON via Length Check (calling and called): If the TON after the previous checks is still Unknown and if this check is set and if
number lengths are specified in National Number Length and/or Subscriber Number Length, the length of the incoming number is
checked against these lengths and if a length match is found the appropriate Type of Number is assumed for the incoming
number.
The following are the possible options on the drop-down list boxes:
Outgoing Calls to the PSTN
Calling Party Number Called Party Number
Default TON Preferred TON Post Default TON Preferred TON Post
from SIP to PSTN Manipulation from SIP to PSTN Manipulation
International Same as TON- None International Same as TON- None
National IN National IN
Subscriber International Unknown TON Subscriber International Unknown TON
Unknown National Unknown National
Subscriber Add Prefix + Subscriber Add Prefix +
Unknown TON Local Toll Table Unknown TON
Post-Manipulation Settings:
None: the number is sent on the PSTN interface without adding a prefix or setting the Type of Number to Unknown.
Add Prefix + Unknown TON: the number is sent on the PSTN interface prefixed with the prefix appropriate for the TON determined by
the Preferred TON to PSTN setting.
Unknown TON: the number is sent on the PSTN interface after setting the Type of Number to Unknown.
Step 1a (Outgoing Calls): Determine the TON-IN of the From/PAI/P-Preferred-Identity/Diversion/Request-URI number received in the
SIP INVITE message as follows:
Step 1b (Incoming Calls): Determine the TON-IN of the Calling/Redirecting/Called Party number received in the ISDN SETUP
message as follows:
Step 2a: Determine the TON-OUT for the Calling Party based on the Preferred TON setting:
IF the OSB is in Survivable Mode AND the “Local Toll Table” checkbox (see Error! Reference source not found.) is checked:
o Look up the Called Party/Calling Party relationship in the Local Toll Tables (see section Error! Reference source not f
ound.) and use the resulting output to create an X-Oscar header to insert into the INVITE message. Proceed with the
next bullet in the sequence.
IF Preferred TON is International:
o IF TON-IN is INT, TON-OUT is INT (leave number unchanged)
Step 2b: Determine the TON-OUT for the Called Party based on the Preferred TON setting:
Step 3: Determine the Post Manipulation based on the TON-OUT from 2a or 2b:
IF there is an LTT Header and Post Manipulation is set to Add PNAC and Prefix
o IF LTT lookup result is INT, add International PNAC and Prefix to the X-Oscar-LTT-Calling-DN Header
o ELSE IF LTT lookup result is NAT, add National PNAC and Prefix to the X-Oscar-LTT-Calling-DN Header
o ELSE IF LTT lookup result is SUBSwAC, add Subscriber PNAC and Prefix to the X-Oscar-LTT-Calling-DN Header
o ELSE IF LTT lookup result is SUBS, add Subscriber PNAC and Prefix to the X-Oscar-LTT-Calling-DN Header
Local Toll Tables are created on the OSV and then imported into
an OSB using mechanisms described further below. The OSB
will have no mechanisms for creating or updating local Toll
Tables.
Local Toll Tables will apply to the OSB 50i and OSB 500i
integrated gateways only. They will not apply to SSPs or other
types of external gateways.
For incoming calls, the LTT will be used for the calling party
number.
• To create the file, the user must start the RTP CLI on the OSV and enter the following command:
• The ‘output file name and path’ will typically point to a location on the user’s computer, or a network share location
Notes:
500i can be configured as T1 or E1
Cards or internal power cables must not be removed with
the system powered on
59.1.1.2 -OSB500i DP8 The LEDs status:(rear of box) - PRI cards will be red if the
link is disconnected.
Per card clock source: - This checkbox applies for the OSB 500i only. For the OSB 500i
with a single PRI card, the checkbox is set and disabled. For the OSB 500i with two PRI
cards, when set the Clock Source Priority is split between each card. In other words, the PRI
clock information is not transmitted from one card to the other. If not set, the user can use any
of 8 ports as the clock source for the system by setting the Clock Source Priority field for the
various PRI links from 1 to 8. A special Timing Cable must be installed to be able to utilize
this capability.
List is showed when PRI Interface is configured with Signaling method as CAS Ring Down.
Timeout for backward request to resume cycle: Resume the MF digit on DNIS timeout
timer.
Call forward safety: Forward Safety Timer.
Wait for seize acknowledge: How much time it is waited for a response to our SEIZE signal.
Wait for answer: How much time it is waited when the call has been accepted.
Double answer: When double answer is in effect, it is the interval between the ANSWER,
CLEARBACK and ANSWER again.
Answer delay: Short delay before answering to give the other end an additional time to detect
the tone off condition
Persistence check: How much time it is waited for CAS signaling before handling the new
signal.
DTMF start dialing: DTMF Start Dialing Timer
MF threshold time: Time that an MF tone should last before being handled.
Profile parameters can be edited in the table. A new, blank, profile can
be created by clicking the "Add" button and filling in the fields
accordingly. A profile can be deleted by wirst clicking on its row to select
it and then clicking the "Delete" button.
Profile
Timer
Profile
Timer
Configuration
Max overlap digit length: Maximum number of digits that can be received in an
overlap dialing incoming call. When the number of incoming digits matches this
configuration, the called number is considered complete even no sending complete
information is received. If not configured then T302 timer would apply
Specific overlap dialing patterns: Replaces "Max overlap digit length" value.
Indicates that the system must process incoming digits in accordance with the
patterns defined in the table. If this parameter is enabled "Max Overlap Digit
Length" is ignored and the table must have at least one entry.
Connected line identification presentation incoming:
Answer Supervision Timer – Incoming Calls: Value between 120 and 3600.
Default is 360. Note: Corresponding Answer Supervision Timers should be
configured under 'Feature'->'Gateway/Trunk'.
Timers should be configured with a difference of at least 10 seconds between
Gateway/Trunk and Integrated Gateway to avoid racing conditions caused by
simultaneous disconnection.
Blacklist profile: Specifies the Blacklist profile that it will be checked during
incoming calls.
Outgoing Calls
Collect Calls
Collect call control: who will check the permission for collect calls:
Server -> will add X-Siemens-header:collect-call in NM for calls with the indication
of collect call. In SM, these calls will be rejected if permission is denied.
Gateway -> Branch will check the permission in SM and NM, and reject calls with
the indication of collect call, if permission is denied.
Permission for receiving collect calls by category: In case of CAS, it will check
the permission for collect call by category. If this flag is not checked, the call with
the indication of collect call will be rejected if Collect Call Control is Gateway
(NM/SM) or Server (SM). In case of ISDN, if this flag is not checked, incoming calls
with Reverse Charge Indication will be rejected, if Collect Call Control is Gateway
(NM/SM) or Server (SM).
Permission for receiving collect calls by double answer: if Branch will check
the permission for collect call by double answer. If this flag is not checked, the call
is double answered, which causes the release of the collect calls. Only works for
CAS and Brazil.
E1 CAS – MFC R2
E1 CAS profile: Select any of the created CAS profiles in CAS profiles table. CAS profile
association is mandatory for CAS E1 trunk groups.
Do Not Accept Call on Offer: If set, the gateway waits for subscriber state (free, busy,
unallocated) before sending backward tone from Group B. If not set, the gateway always
sends free subscriber backward tone immediately after receiving a CAS call. The default is
disabled.
CAS Answer for Early Media: If set allows answer in CAS calls to play announcements.
Otherwise, send the appropriate backward tone.
Send End of ANI with Presentation Allowed: If set sends end of identification with
presentation allowed. Otherwise, sends end of identification with presentation restricted.
(Only Argentina)
CAS Send Early Media: If set sends 183 Session Progress to the SIP side when making
outgoing calls in E1 CAS. Otherwise, sends 180 Ringing.
The left-hand list shows the list of PRI channels that are
available. Any channel that is already in use on this or another
trunk group will not be shown here.
Time synchronization: with redundancy enabled, it is mandatory that both nodes (master and slave) should have a time/date
synchronized (both boxes must have the same time).
The state "FAULT" indicates that there is no network connectivity between the redundant systems.
Splitter box
500i Box 2
IMPORTANT: It is not possible to use both, the new 500i Refresh (SYS-2USM13-6M01E) together with old one 500i (SYS-
2USM03-6M01E), in the 500i redundancy systems.
59.4.3 SIPQ V2
500 supports QSIG and Cornet-NQ.
In normal mode QSIG and Cornet-NQ messages are tunneled to OSV through SIPQ V2.
In survivable mode QSIG and Cornet-NQ will be translated to regular SIP with a limitation on feature support.
The support of QSIG by OSB is required to allow subscribers on an OSV to interwork with subscribers on networked HiPath3000/4000
and 3rd party PBXs.
SIPQ V2 is required in order to support SRTP over connections established via SIPQ. SIPQv1 will not be supported by OSB.
59.4.4 Blacklist
Configuration
Media Protocol: Media security supported for calls to and from the
Integrated GW.
Key Exchange Method: if Best Effort SRTP is selected then is
possible to configure mikey (Multimedia Internet KEYing) or sdes
(Security Descriptions).
Mark SRTP call-leg as Secure: if checked then the call will be
marked as secure with the SIP X-Siemens Call-Type: ST-Secure
header for all FXS ports when TLS/SRTP is used. Otherwise, the SIP
X-Siemens-Call-Type: ST-Insecure header will be sent.
Codec: This drop-down box presents a list of codecs that are available to be added to the
profile. Selecting a codec and then clicking the "Add" button will result in the codec appearing
in the table below.
Note: Codecs can be selected/enable under Features->Enable Codec Support for
transcoding->Configure->Select codecs.
Priority: This table presents the list of codecs that are assigned to the media profile. The
"Priority" column indicates their relative priority to each other. The priority order can be
adjusted by clicking the "Move up" or "Move down" buttons. The delete a codec from the
table first click it to select it and then click the "Delete" button.
digits Subscriber
Outgoing
Prefixes
International PNAC: configuration of the international
Public Network Access Code (PNAC)
International prefix: configuration of the international
prefix.
National PNAC: configuration of the national PNAC.
National prefix: configuration of the national prefix.
Subscriber PNAC: configuration of the subscriber PNAC.
Subscriber prefix: configuration of the subscriber prefix
Incoming calling and called party numbers are sent as received to the proxy’s Number Manipulation function, prefixed with
PNACs and prefixes.
Outgoing calling party numbers are sent to the PSTN as received from the proxy’s Number Manipulation function without post-
manipulation.
Outgoing called party numbers are sent to the PSTN as received from the proxy’s Gateway Routing function without post-
manipulation.
Note that not having post-manipulation enabled means that if the OSB 50i/500i receives prefixed numbers from the OSB proxy, these
numbers are mostly sent without the prefixes to the PSTN. In order to still send the prefixes, the post-manipulation must be set to ‘Send
Prefixes’.
The integrated gateway will perform best when it receives numbers with PNACs and prefixes. That way the number modification can be
easily controlled.
When determining TON-IN, “TON via length check” is disabled unless “Match prefixes for Unknown numbers” is checked.
Both flags can be checked at the same time.
Match Prefixes for Unknown Numbers (calling and called): If set, the leading digits of the incoming calling or called party
number with Unknown Type of Number is matched against (in this order) the International Prefix, National Prefix and Subscriber
Prefix. The prefix field must have a non-empty value to match. In case a number remains Unknown after the prefix check, the
default Type of Number of Subscriber is taken.
TON via Length Check (calling and called): If set and if number lengths are specified in National Number Length and/or
Subscriber Number Length, the length of the incoming number is checked against these lengths and if a length match is found the
appropriate Type of Number is assumed for the incoming number.
The following are the possible options on the drop-down list boxes:
Incoming calls from the PSTN during Normal Mode
Calling Party Number Called Party Number
Preferred TON to SIP Post Manipulation Preferred TON to SIP Post Manipulation
Same as TON-IN None Same as TON-IN None
International Add PNAC and Prefix International Add PNAC and Prefix
GNF GNF
Match PNACs and Prefixes (calling and called): If set, the leading digits of the incoming calling or called party number are
matched against (in this order) the International PNAC and Prefix, National PNAC and Prefix and Subscriber PNAC and Prefix.
The combination of PNAC and prefix field must have a non-empty value to match.
TON via Length Check (calling and called): If the TON after the previous checks is still Unknown and if this check is set and if
number lengths are specified in National Number Length and/or Subscriber Number Length, the length of the incoming number is
checked against these lengths and if a length match is found the appropriate Type of Number is assumed for the incoming
number.
The following are the possible options on the drop-down list boxes:
Outgoing Calls to the PSTN
Calling Party Number Called Party Number
Default TON Preferred TON Post Default TON Preferred TON Post
from SIP to PSTN Manipulation from SIP to PSTN Manipulation
International Same as TON- None International Same as TON- None
National IN National IN
Subscriber International Unknown TON Subscriber International Unknown TON
Unknown National Unknown National
Subscriber Add Prefix + Subscriber Add Prefix +
Unknown TON Local Toll Table Unknown TON
Post-Manipulation Settings:
None: the number is sent on the PSTN interface without adding a prefix or setting the Type of Number to Unknown.
Add Prefix + Unknown TON: the number is sent on the PSTN interface prefixed with the prefix appropriate for the TON determined by
the Preferred TON to PSTN setting.
Unknown TON: the number is sent on the PSTN interface after setting the Type of Number to Unknown.
Step 1a (Outgoing Calls): Determine the TON-IN of the From/PAI/P-Preferred-Identity/Diversion/Request-URI number received in the
SIP INVITE message as follows:
Step 1b (Incoming Calls): Determine the TON-IN of the Calling/Redirecting/Called Party number received in the ISDN SETUP
message as follows:
Step 2a: Determine the TON-OUT for the Calling Party based on the Preferred TON setting:
IF the OSB is in Survivable Mode AND the “Local Toll Table” checkbox (see Error! Reference source not found.) is checked:
o Look up the Called Party/Calling Party relationship in the Local Toll Tables (see section Error! Reference source not f
ound.) and use the resulting output to create an X-Oscar header to insert into the INVITE message. Proceed with the
next bullet in the sequence.
IF Preferred TON is International:
o IF TON-IN is INT, TON-OUT is INT (leave number unchanged)
Step 2b: Determine the TON-OUT for the Called Party based on the Preferred TON setting:
Step 3: Determine the Post Manipulation based on the TON-OUT from 2a or 2b:
IF there is an LTT Header and Post Manipulation is set to Add PNAC and Prefix
o IF LTT lookup result is INT, add International PNAC and Prefix to the X-Oscar-LTT-Calling-DN Header
o ELSE IF LTT lookup result is NAT, add National PNAC and Prefix to the X-Oscar-LTT-Calling-DN Header
o ELSE IF LTT lookup result is SUBSwAC, add Subscriber PNAC and Prefix to the X-Oscar-LTT-Calling-DN Header
o ELSE IF LTT lookup result is SUBS, add Subscriber PNAC and Prefix to the X-Oscar-LTT-Calling-DN Header
o ELSE nothing to be done
Local Toll Tables are created on the OSV and then imported into
an OSB using mechanisms described further below. The OSB
will have no mechanisms for creating or updating local Toll
Tables.
Local Toll Tables will apply to the OSB 50i and OSB 500i
integrated gateways only. They will not apply to SSPs or other
types of external gateways.
For incoming calls, the LTT will be used for the calling party
number.
• To create the file, the user must start the RTP CLI on the OSV and enter the following command:
• The ‘output file name and path’ will typically point to a location on the user’s computer, or a network share location
60.1.1 One endpoint for the OSB Main as the main destination of all calls to the
gateway.
Note: Do not Send Invite without SDP must NOT be selected on OSB50i/OSB500i Integrated Gateway EndPoint.
OSB IP address must be configured for alias. When using OSB with Splitterbox Configuration (PRI Redundancy),Alias
should include Redundant IP and Physical IP addresses for both OSB nodes.
If OPTIONS port is set to a different port (e.g. 5062), then it is necessary to add this port as an alias
(21.21.31.10:5062)
OSB IP address must be configured for alias (Port is optional. Ex 10.234.1.70:5060).
Note: if using OSB with Redundancy then Alias should include Redundant IP and Physical IP addresses for both
OSB nodes.
RTP Parameter:
Srx/Sip/CentralSbcSupport must be
RtpTrue (this will make OSV look for ports
in aliases)
When using OSB with Splitterbox Configuration (PRI Redundancy), Alias should
include Redundant IP and Physical IP addresses for both OSB nodes.
All SIP Requests shall be sent to the OSB Main and if the OSB Main is not accessible, the SIPRequests will be
directly sent to the 50i/500i gateway.
The OSB Main shall be configured as a regular SIP Proxy/ Branch SBC. Operation modes SBC- Proxy and Proxy ACD are
also possible.
If OSB Main is not able to communicate to both OSV Node 1 and OSV Node 2 it shall switch to survivable mode. The
OSB Main will be responsible for providing the survivable features to the branch
The OSB Main shall not perform any PNAC handling in outgoing calls to the external gateways. The PNAC shall be
performed by TON handling in the gatewayitself.
60.2.1 VoIP
TCP/Port 5060 OSV Mode TLS/Port 5061
Simplex
Node 1
sipsm1_vip sipsm3_vip
Primary Server
Collocated
60.2.6 Redundancy
It shall be possible to configure a redundant SIP Proxy. The SIP Proxy shall be addressed by means of a Virtual IP.
60.2.8 DNS
The OSB Main shall be configured as DNS Server as slave or forward to a DNS Master in the Data Center.
60.2.9 NTP
The OSB Main shall be configured to synchronize with an NTP server and it can also be configured to operate as NTP
server for the external gateways
60.2.11 Licensing
The OSB Main shall control the licenses which are applicable to the branch, that means:
. Base license.
User licenses.
Auto-Attendant license.
Backup ACD license.
SBC session licenses
60.3.4 DNS
If the OSB 50i/500i is set as Gateway only, the flag Enable DNS
Server shall be grayed out
60.3.1. Licensing
If the OSB 50i/500i is set as Gateway only, a Base License shall be required. For the FXS, no licenses shall be required on the
Gateway Only box because they will be controlled by the OSB Main or by OSV.
With this functionality the OSB can be used as standalone unit for legacy TDM PBX systems to be connected to new SIP
Trunking providers. The OSB supports NT PRI links to interconnect deployed PBX systems and be able to support same
capacity of SIP Trunking channes to SIP Service providers.
This configuration introduction requires a new 'Standalone' operating mode.
Supported Models:
OSB500i DP4/8
OSB50i DP24
OSB50i DP14E/T
OSB50i D44
Standalone Mode can be enabled via flag under Administration >System >Settings >General
The enabling of the Standalone flag is possible only if the OSB Branch mode is SBC-Proxy.
OSB 50i D44: a single "PRI Ports” license would activate all 4 BRIs.
62 Proxy ATA
Proxy ATA HW supports 24/48 FXS ports.
The Proxy ATA registers with only one Proxy/OSV and only supports FXS subscribers. PSTN connectivity/routing during
Survivability mode is handled by the Proxy. Connection to OSV can be done directly or via Proxy while in Normal Mode
operation.
Note: only FXS-FXS calls are possible using Proxy ATA if Proxy and OSV are not available.
62.1.1 Proxy ATA behind OSB Proxy (ex. OSB500i) connected to OSV
62.1.1.1 OSV/CMP
Configuration > OpenScape Branch > Branch Office > Configuration > Features > Enable gateways/trunks >
Configure > Gateways/Trunks
Configuration > OpenScape Branch > Branch Office > Configuration > VoIP > Sip Server Settings
Note: Licenses are not required to be installed on ProxyATA (Only on OSV/OSB Proxy)
62.2.1 OSV/CMP
If subscriber rerouting (regular or enhanced) is NOT required, then configure FXS subscribers of the
Proxy ATA under the OSV's "Main Office".
Attributes “Route Via Proxy” and “SIP Proxy” must be set
Alias is configured with IP address of ProxyATA.
No ports need to be set to trusted if using OSV V6 PS23 or OSV V7 PS08. If the OSV is running an older
patch set then the OPTIONS port needs to be set to Trusted.
If subscriber rerouting (regular or enhanced) IS required, then you must create a branch office for the
Proxy ATA, using the Proxy ATA Endpoint as the representative endpoint. You must also create the
Proxy ATA FXS subscribers behind that ProxyATA branch.
Attributes “Route Via Proxy”, “Survivable Endpoint” and “SIP Proxy” must be set
Alias is configured with IP address of ProxyATA.
--> No ports need to be set to trusted if using OSV V6 PS23 or OSV V7 PS08. If the OSV is running an older
patch set then the OPTIONS port needs to be set to Trusted.
Configuration OpenScape Branch Branch Office Configuration Features Enable integrated gateway
Configure
Gateway Configuration Configure
CLIP:
When Country is configured as "United States/North
America" or "United States Circa 1950/North America"
CLIP is always enabled and will be gray out like picture
above.
Subscriber Configuration:
It is possible to configure/apply dial restriction rules per FXS subscriber. Digit sequences configured in table shall be
rejected.
Note1: Music on Hold will be played when an FXS subscriber places a call on hold by hookflashing. The music that is
played is not configurable, and the capability cannot be turned off. This capability applies to FXS ports on the ATA only.
The FXS ports on the OSB 50i do not have this capability."
Note2: if power to the card is lost, an alarm will be generated. During the power loss, FXS ports will not be able to make
or receive calls, but callers to the FXS ports will hear audible ringback tone since the ports are still registered.
Three-Way Calling: Go off-hook, establish a call, hookflash, hear stutter dial tone, dial the 3rd
party, hookflash, now in conference. Subsequent hookflash will drop the 3rd party.
If the 3rd party goes on-hook before the conference is established, original parties
are left in conversation.
Call Hold: Go off-hook, establish a call, hookflash, hear stutter dial tone, hookflash again to retrieve.
Call Transfer: Go off-hook, establish a call, hookflash, hear stutter dial tone, dial the 3rd party, go on-hook, call is now
transferred.
Call Waiting: Make or receive a call, receive a 2nd call and hear call waiting tone, hookflash to toggle to the waiting
party, hookflash again to toggle back.
Disable Call Waiting for Next Call: feature can be done in twoways.
Go off-hook, dial *70 to activate, hear confirmation tone, dial the number of the person to reach
(when call is established, Call Waiting will not be accepted during the call)
Go off-hook, establish a call, hookflash, hear stutter dial tone, dial *70 to activate, hear confirmation tone, hookflash
again to retrieve (after this procedure, Call Waiting will not be accepted during the call)
Disable Caller ID for Next Outgoing Call: Go off-hook, dial *67 to activate, hear confirmation tone, dial the number of
the person to reach.
Do Not Disturb: Go off-hook, hear dial tone, dial *78 to activate, or *79 to deactivate.
Call Forwarding Unconditional: Go off-hook, hear dial tone, dial *72 to activate, or *73 to deactivate. After dialing
*72, dial the number to forward to.
Call Return: Go off-hook, hear dial tone, dial *69 to hear the number of the last caller. Only works if
Caller ID was present.
End Dialing: ‘#’ digit as the 2nd or later digit as dialing is complete
Example:
Subscriber DNs for OSB1 > 561-555-1xxx
Subscriber DNs for OSB2 > 561-555-2xxx
Subscriber DNs for OSB3 > 561-555-3xxx
Each OSB to be configured in the cluster is created in the OSV via the “Add” button in “Branch Offices” as in all branch creation.
Each OSB to be part of a cluster is created in the OSV with its Representative Endpoint and shared Office Code.
The concept of the cluster from the OSB point of view is the “Peer OSB”; the concept of the cluster from the OSV point of view is that
the OSBs are geographically collocated and share an Office Code as well as LAN connectivity.
For accessing trunks within the cluster, Destinations are created which contained a prioritized Route List pointing to the Endpoint
destined for each corresponding OSB (OSV limits the reroute to 4 routes).
Calls are then distributed between the gateway trunks in the OSBs based on the configured routes for each OSB Destination.
If a route is unavailable, the prioritized list is used to select the next route to ensure the outbound call can find an available trunk via
one of the OSBs in the cluster.
On this OSB1, while in Survivability Mode, any calls initiated from its own registered subs (424-923-0XXX) destined for
subscribers registered to OSB2 will use the Routing Prefix of 4249231% and send the calls via its Peer OSB route to OSB2 at
10.234.1.210.
Any calls initiated from its own registered subscribers (424-923-0XXX) destined for subscribers registered to OSB3 will use the Routing
Prefix of 4249232% and send the calls via its Peer OSB route to OSB3 at 10.234.1.209.
All OSB subscribers can communicate amongst the clustered OSBs while in Survivability Mode via the Peer OSB concept by
establishing Routing Prefixes pointing to the destined Peer OSBs.
This slide represents how the Gateways/Trunks Table in the OSBs are provisioned for trunk access within the clustered OSBs.
The graphic above provides an example where a subscriber for this OSB must dial the prefix 9 to access and outside trunk and send
the call to a destined gateway (Routing Prefix is 9305%).
As stated previously, the OSV handles all call routing decisions involving trunk access while the OSBs are in Normal Mode. Peer
OSB’s will have the Functional Type set to “Survivability Mode Egress / Ingress” for OSB routing to the peers during Survivability Mode.
In Survivability Mode, the concept is that the originating OSB makes all the routing decisions for trunk access based on its Priority
rankings, and use of the Peer OSBs simply complete the calls if they have available trunks. If the Peer OSBs have no available trunks,
then they return error codes back to the originating OSB who then uses its own configured Priorities to control trunk access
Select and add the OpenScape Branch SPA and image files
Under the OpenScape Branch configuration select the Branch Office just created and click “Edit”.
NOTE: This flag must always be unchecked to perform a Simplified Installation of the OSB. During the installation process a security
process takes place between OSB and CMP and the “Security Status” is automatically changed to “Secured”
Proceed to the next section to upload the desired files during installation.
After all the desired files have been uploaded press Ok.
Configuration is complete and automated installation could be started.
NOTE: The Logical ID folder used for the next steps will be automatically created in the CMP server after the steps described in the
above procedure. The Logical ID is created as:
<OSV Name>:<BG Name>:<Branch Office Name>
tab.
Locate the configuration file and press the Add button The file will be uploaded to CMP into the following directory:
Offboard CMP: /opt/siemens/openbranch/ob_config/<Logical_ID>/Configuration_data/
Integrated CMP: /enterprise/openbranch/ob_config/<Logical_ID>/Configuration_data/
Configuration OpenScape Branch Select Branch Office Edit Configure Installation ACD Announcements Files/ACD
MusicOn Hold Files Add
NOTE: The total size of ACD announcements and ACD music on hold combined cannot exceed 100MB.
NOTE: For Integrated systems a packet filter to allow communication to port 444 should be created. This is the port used to transfer the
files during simplified installation.
Using a Windows based PC create the USB stick with the following options enabled:
This flag must be set for the IBM 3250M3 and 3550M3
Once the USB stick is created plug it into a USB stick port in the OpenScape Branch. Please refer to the Software Installation section
for BIOS settings if required. First boot up option must be the USB port.
Power up the OpenScape Branch and the image from the USB stick will automatically be installed in the device. When the installation is
complete, the device will alert the user by providing one audible beep for 10 cycles.
Power off the OpenScape Branch and remove the USB stick. Device is ready for delivery
DHCP Configuration
It is a pre-requirement that the DHCP server is configured to provide the CMP IP with Option 43.
The OpenScape device will broadcast a DHCP Discover message with: Option 60: Vendor class identifier = “OpenScapeBranch”
A temporary IP address
When receiving the specified Options 60 it should provide Option 43 vendor specific information
Type = 01 only
If multiple IP addresses are used they must be separated by a comma “,”. (Only two IP addresses for CMP are supported)
For more information about configuring the DHCP for the OSB´s phones, please refer to the DHCP Configuration section in the
OpenScape Branch Configuration Guide or in the OpenScape Branch V2 Administrator and Installation documents.
64.2.1.1 Connect the OpenScape Branch device LAN interface to the network.
Note: For Branch-SBC scenarios where the link to CMP is via the WAN interface, this interface (WAN) must be connected to
the network. The LAN MAC ID is still needed in the installation configuration in CMP forvalidation purposes.
The OpenScape Branch device will receive via DHCP a temporary IP address as well as the CMP information andit will
automatically download and install the software image, configuration file and announcement files if necessary.
When the installation is finished the device will alert providing 10 audible beeps (single beep followed by a pause and the cycle is
repeated 10 times)
Note: The simplified installation does not cover any pre configuration like, but not limited to, certificates, logos, DNS Zones files or
Customer MOH.
These services shall be configured after the installation procedure.
This flag must be set for the IBM 3250M3 and 3550M3
When the USB is created, remove it and plug it into a USB port in the OSB Server.
The OpenScape device will broadcast a DHCP Discover message with: Option 60: Vendor class identifier = “OpenScapeBranch”
A temporary IP address
When receiving the specified Options 60 it should provide Option 43 vendor specific information
Type = 01 only
If multiple IP addresses are used they must be separated by a comma “,”. (Only two IP addresses for CMP are supported)
For more information about configuring the DHCP Server please refer to the DHCP Configuration section in the OpenScape Branch
Configuration Guide or in the OpenScape Branch V2 Administrator and Installation documents.
Connect the USB stick previously created to a USB port in the OpenScape Branch server.
The OpenScape Branch device will boot up off of the USB stick and receive via DHCP a temporary IP address aswell as the CMP
information and it will automatically download and install the software image, configuration file and announcement files if
necessary.
OSB Assistant will show the installation progress in the Status column.
When the installation is finished the device will alert providing 10 audible beeps (single beep followed
by a pause and the cycle is repeated 10 times).
When the installation finishes remove the USB Stick. This will automatically restart the server. After the
restart the server will be online and the status in OSB Assistant will be updated.
This flag must be set for the IBM 3250M3 and 3550M3
When the USB is created, remove it and plug it into a USB port in the OSB Server
Connect the USB stick previously created to a USB port in the OpenScape Branch server.
The OpenScape Branch device will boot up off of the USB stick and receive via DHCP a temporary IP
address. It will get the CMP information from the USB Stick and it will automatically download and
install the software image, configuration file and announcement files if necessary.
OSB Assistant will show the installation progress in the Status column.
When the installation is finished the device will alert providing 10 audible beeps (single beep followed
by a pause and the cycle is repeated 10 times).
When the installation finishes remove the USB Stick. This will automatically restart the server. After the
restart the server will be online and the status in OSB Assistant will be updated.
This flag must be set for the IBM 3250M3 and 3550M3
Connect the USB stick previously created to a USB port in the OpenScape Branch server.
The OpenScape Branch device will boot up off of the USB stick with the defined IP address. It will
get the CMP information from the USB Stick and it will automatically download and install the
software image, configuration file and announcement files if necessary.
OSB Assistant will show the installation progress in the Status column.
When the installation is finished the device will alert providing 10 audible beeps (single beep
followed by a pause and the cycle is repeated 10 times).
When the installation finishes remove the USB Stick. This will automatically restart the server. After
the restart the server will be online and the status in OSB Assistant will be updated.
NOTE: This installation option makes a configuration with OSB in Branch SBC Mode only. So, interface WAN must be connected to the
network. After first boot, CMP could send xml files with any other operational mode.
This flag must be set for the IBM 3250M3 and 3550M3
Enable IPSec
NOTE: All customer certificates could be imported here. For example, it is possible to have one certificate for the Boot VPN and
other for the hosted OSB secured management. All imported certificates are kept after installation.
NOTE: To establish VPN IPSec tunnel, only authentication RSA with customized certificates is possible. The authentication type
PSK (pre-shared key) is not available.
When the USB is created, remove it and plug it into a USB port in the OSB Server
NOTE: It is required that DHCP Server is installed on the WAN side. No other DHCP Server should be available on the LAN side.
But DHCP Server is just an option. If there is no server available, manual settings are required via NetBoot or existing xml file could
be selected (like Option 4) for temporary IP address of LAN and WAN, Subnet Mask, Default Gateway and DNS IP.
NOTE: Data Center must have a VPN concentrator previously configured to establish the VPN connection with OSB for Simplified
Installation. This VPN concentrator must consider that the VPN connection should be done with the OpenScape Branch’s WAN
address as partner.
Connect the USB stick previously created to a USB port in the OpenScape Branch server.
Connect the OpenScape Branch device LAN interface to the network. This option will need that WAN
interface is also connected to the network for IPSec establishment. The LAN MAC ID is still needed
in the installation configuration in CMP for validation.
Power the OpenScape Branch device up
The OpenScape Branch device will boot up off of the USB stick and receive via DHCP a temporary IP
address (if used, because if not, then takes the defined IP address).
In this point, the VPN tunnel is created and CMP is contacted. If IPSec tunnel is not OK, installation will not continue.
If everything is OK, the OpenScape Branch will get the CMP information from the USB Stick and it will automatically download and
install the software image, configuration file, announcement files (optional) and additional certificates if necessary.
OSB Assistant will show the installation progress in the Status column.
When the installation is finished the device will alert providing 10 audible beeps (single beep
followed by a pause and the cycle is repeated 10 times).
When the installation finishes remove the USB Stick. This will automatically restart the server. After
the restart the server will be online and the status in OSB Assistant will be updated.
65.1.3 Gateways
PSTN gateways are required in the Data Center as well as the Branch. These gateways must support clearmode. This is also
referred to as clear-channel data or 64 Kbit/s unrestricted .
Go to OpenScape Voice -> Administration -> Call Admission Control -> Resource Management
Go to OpenScape Voice -> Administration -> Call Admission Control -> Groups
- Create a CAC Group for each branch and add the members based on the branch’s subnets and enter all the
subnets for the branch:
Configure the BLS IP Address in Data Center Router SNMP Configuration entry in the OpenScape Voice. This is only
possible via StartCli. Select the following options:
Application-level Management. 6
Network Traffic Management. 9
Call Admission Control Management. 1
CAC Access Link Status Monitoring. 6
Modify Data Center Router SNMP Configuration .. 3
Enter the IP address of the BLS as the Data Center Router and select default values for all other parameters.
Data Center Router IPv4 Address < (max length: 46)> (default: 0.0 0.0): 10.234.3.21
Snmpv2c Community string < (max length: 2048)> (default: public): public o Snmp version used to access router
< 2 = Snmpv2c, 3 = Snmpv3 >: 2
The Data Center Router SNMP configuration should look like this once completed:
Data Center Router 1 SNMP Configuration:
Username: None
Authentication Key: None OpenBranch BLS IP Address.
Authentication Protocol: None
SnmpV2c Community String: public
IPv4 Address: 10.234.3.21
Sends Snmpv2 Traps/Informs: true
Go to OpenScape Voice -> Administration -> Signaling Management -> SIP Under Rerouting Tab:
Set the Subscriber Rerouting Prefix Access Code
Enable Rerouting for SIP Subscribers
Add a Routing Area and DID Pool to each Branch Office, including BLS.
Go to OpenScape Voice -> Business Group -> Branch Office Lists and select the branch office
Assign a Routing Area and a DID Pool
Select subscribers.
These cannot be
used for anything
else.
NOTE1 : The subscribers selected in this pool cannot be used for anything else. One DID number is required per 180
subscribers in the branch office, but it’s recommended to have at least 2 DID numbers assigned to each one.
NOTE 2: All subscribers in the remote branch must be added to their respective branch office.
First, create a virtual endpoint and use it as a representative Endpoint for the Data Center’s Branch Office. This is required
to provide survivability functionality to subscribers in the Data Center via the backup link when the CAC policy is into
effect. i.e. calls from branch to data center subscribers
Enter an inexistent
IP address
NOTE: Add all Data Center subscribers to this branch office. For all those subscribers kept in the ‘Main Office’ calls will
only work in the direction from data center to branch office.
NOTE: For previous OSV versions, the configuration of “Do Not Audit Endpoint” flag can only be done via StartCli.
In this case, select the following options:
Application-level Management. 6
Zone Management. 5
Modify Endpoint. 2
Go to OpenScape Voice -> Business Group -> Branch Offices List and select the branch office Do
not assign a Routing Area and assign a DID Pool.
NOTE: The subscribers selected in this pool cannot be used for anything else.
Select subscribers.
These cannot be
used for anything
else.
This should not have a
Routing Area.
Ensure the DID Home DNs selected for the DID Pool are set to “Service” type “DID Pool
Number”
This is done automatically by Assistant when the Home DN is selected for the DID Pool. To verify the service is set
check the DN in the Home DN Table (Global Translation and Routing -> Home Directory Numbers)
65.3.2.4 Configure Destinations to Gateways serving all branches and data Center
Add a second pattern to point to the branch endpoint (for calls from branch to data
center)
NOTE: The branch needs to have a Routing Area.
The gateway in the branch must be configured for symmetric signaling (GW is behind proxy)
The Code Index will then have multiple patterns. For each branch with a Routing Area and with no Routing Area
for the DataCenter.
To allow rerouting to Voice Mail Server, go to OpenScape Voice -> Business Group -> Members -> Endpoint and select
your Voice Mail endpoint (e.g. Xpressions). Check if the following attributes are enabled.
NOTE: If gateways are used for networking with PSTN, do not enable “Rerouting Direct Incoming Calls” because it may
lead to loops with PSTN.
After login to the OSB Assistant go to the OpenScape Branch -> Configuration -> VoIP
option and under General select “Server” for Backup link mode and click on
“Configure…”:
NOTE 1: The configuration of “PPP Subnet IP/Netmask bits” should be enough to fit the amount of BLC devices on the
network. To have this, the number of hosts must be at least 2 times the number configured for “Max backup links” (this is
because each backup link has one PPP address for BLS and other for BLC).
For example, in the subnet 10.124.10.0/27 we have 32 PPP addresses (10.124.10.0 to 10.124.10.31) that must be greater or
equal to 2 times the number configured in “Max backup link” (in this case up to 16 BLCs are possible with this subnet).
NOTE 2: The PPP subnet IP addresses shall not conflict with any IP/subnets in the branch or data center
Tunnel Name: Any desired name for this tunnel. It must match the name assigned to the tunnel in
OSV CAC group policy (See CAC configuration section)
BLC Hostname: The configured hostname of the OSB client (BLC) that will be using this tunnel. This
name must match the hostname of each BLC.
Priority: This is the priority used by BLS for accept or reject each BLCs tunnel request. If the
maximum number of backup links or B channel is achieved, the BLS will decide which BLC request
must be prioritized. Lower the number, higher the priority of BLC’s tunnel.
NOTE: Each BLS Client (BLC) must have a different Priority
PPP authentication, Username, Password: Configure the PPP authentication method as None,
PAP or MS-CHAP. If PAP or MS-CHAP is chosen, Username and Password must be used.
NOTE: PPP authentication, username and password must be the same on BLS and BLC sides.
Retry After: BLS send this timer to BLC to indicate how long BLC must wait until retry link
establishment in case of rejection due to priority evaluation.
Under VOIP -> General -> Gateways click on “Configure…”. Enter the following line in the
Gateway Table:
Port: Port 5086 is the only acceptable option. This is the port the BLS uses for backup link
Routing prefix/FQDN: This is the DID number that is dialed through the GW to establish the link
Transport: UDP is the only acceptable protocol for backup link connection.
Type: Backup Link Server is the only option allowed for a backup link call.
After login to the OSB Assistant go to the VOIP option and under General select
“Client” for Backup link mode and click on “Configure…”:
Minimum number of B channel: This number will define the minimum bandwidth configured.
Maximum number of B channels: This number will define the maximum bandwidth configured. It is also used to
initial bandwidth when there is a transition from survivable to backup mode.
Initial number of B channels: This number will define the initial bandwidth of backup link, i.e. how many channels
will start the PPP link when transition from normal to backup mode
High Watermark: Indicate the percentage of usage of the last channel that will trigger BLC to add a new channel to
the multilink bundle.
High Watermark detection window: after achieving High watermark, this is the timethat BLC will stay over the high
watermark before adding a new channel to thebundle.
Low Watermark: Indicate the percentage of the seizure of the last channel that will trigger BLC to delete a channel
from the multilink bundle.
Low Watermark detection window: after achieving Low Watermark, this is the time that BLC will stay below the low
watermark before delete a channel from thebundle.
NOTE 1: If multilink achieves 100 % of bandwidth usage, BLS will detect a state of congestion and will
send an order to BLC immediately add a new channel, if possible, irrespectively of the High Watermark
configuration. During congestion, new calls will be rejected with a retry-after timer response.
NOTE 2: If BLC is using TCP or UDP as SIP transport protocol, PPP tunnel is compressed and
channels are optimized. For TLS, the channels are uncompressed. In case of TLS, OSB should
send signaling to OSV sipsm3 address.
NOTE 3: The default values for Initial, Maximum and Minimum number of B-Channels are
according to the table below (this table can be used as reference for TCP and UDP):
Under Routing, configure trusted addresses for backup mode. Enter all IP Addresses that will be in the
routing table when backup mode is achieved. For example, enter here the IP address of ccm05 address
of OpenScape Voice to have Media Server working on Backup Mode.
Note: OSV’s SIPSM node address and SNMP trap destination are already trusted and must not be entered here. A
maximum of 6 addresses are allowed.
- In OpenScape Branch under the Gateway Table configure the BLC to route the call to the gateway when receiving the
configured subscriber rerouting access code:
Under VOIP -> General -> Gateways click on “Configure…”.
Verify routing to the DID is configured in the gateway configuration:
Note 1: In this case, only one routing rule was created because prefix access code to dial DID in Survivable Mode is the
same as the code for rerouting in Normal Mode. If not, 2 different routing rules must be entered.
Note 2: Gateways must support clearmode. This is also referred to as clear-channel data or 64 Kbit/s unrestricted . If
OSB 50i PRI is used, check if “data calls allowed” flag is enable (go to CMP on OpenScape Branch
-> Integrated Gateway -> General -> Configuration, Edit the PRI link and check for flag)
- Add a SNMP trap to CMP server. This is used to inform CMP that OpenScape Branch started or stopped
backup mode.
This is the IP
address of CMP
management
To avoid unnecessary
transitions, use these
values. The minimum
OPTIONS value is 10
seconds. Please see Note2
Increase the transition mode below**.
threshold to 3, to have a lower
OPTIONS interval.
Please see Note1 below*.
*NOTE 1: OPTIONS interval value should be long enough to avoid survivable mode on the transition from Normal to
Backup Mode and at the same time the lowest possible value to have a fast transition to Normal Backup Mode. So, the
timers and thresholds must be configured according to the following formula:
Mtt <= Tt * Oi + (Tt -1 ) * Ot
Where:
Mtt = Maximum time in transition mode (60 seconds if only Primary link is configured – Simplex or Collocated
- or 120 seconds if also Secondary link is configured – Geo Separation)
If the criteria are not fulfilled, system will show an error message.
**NOTE 2: If BLC is in Normal Backup Mode, unnecessary system transitions due to network issues, like packet
losses, TCP retransmissions and others should be avoided. So, to optimize the link transition, we must consider that
Failure threshold (pings) multiplied by OPTIONS timeout (sec) must be at least 30 seconds.
65.5.1 Configuring the OpenScape Voice for Backup Data Link Support
Go to OpenScape Voice -> Administration -> Call Admission Control -> Groups
- Create a CAC Group for each branch and add the members based on the branch’s subnets and enter all the
subnets for the branch:
Add the CAC policy and limit based on ‘Bandwidth’. Enter ‘0’ for the Backup Max Bandwidth
value.
The Srx/Lsm/CheckRouter flag can be set to RtpFalse or RtpTrue, depending on Data Center Router configuration.
Check Appendix A for more details of router configuration.
If true, the Data Center Router is queried for the current tunnel status when the synchronization timer expires. If
false, the Tunnel status timestamp is simply reset.
Application-level Management. 6
Network Traffic Management. 9
Call Admission Control Management. 1
CAC Access Link Status Monitoring. 6
Modify Data Center Router SNMP Configuration. 3
Enter the IP address of the BLS1 as the Data Center Router 1, the IP address of the BLS2 as the Data Center Router 2
and default values for all other parameters.
The Data Center Router SNMP configuration should look like this once completed:
Data Center Router 1 SNMP Configuration:
Username: None
Authentication Key: None Data Center Router 1 tunnel IP
Authentication Protocol: None SnmpV2c
Community String: public IPv4
Address: 10.10.1.1
Sends Snmpv2 Traps/Informs: true
Note: In this documentation, OpenScape Voice is using SNMPv2c to traps/informs. However, SNMPv3 is also allowed. For
configuration of SNMP parameters for SNMPv3, check for documentation “Link Status Manager (LSM)” that can be found at
Wiki-LIP Development Published Website.
Go to OpenScape Voice -> Administration -> Signaling Management -> SIP Under
Rerouting Tab:
Set the Subscriber Rerouting Prefix Access Code
Enable Rerouting for SIP Subscribers
Follow the same steps used for the configuration for Simplex/Collocated (item 3.1.2.2).
Select subscribers.
These cannot be
used for anything
else.
Branch must have a
Routing Area.
NOTE: All subscribers in the remote branch must be added to their respective branch office.
First, create a virtual endpoint and use it as a representative Endpoint for the Data Center’s
Branch Office of Primary Node.
Enter an inexistent
IP address
NOTE: Add all Data Center 1 subscribers to this branch office. For all those subscribers kept in the ‘Main Office’ calls will
only work in the direction from data center to branch office.
NOTE: For previous OSV versions, the configuration of “Do Not Audit Endpoint” flag can only be done via StartCli.
In this case, select the following options:
Application-level Management. 6
Zone Management. 5
Modify Endpoint. 2
Select subscribers.
These cannot be used
for anything else.
Ensure the DID Home DNs selected for the DID Pool are set to “Service” type “DID Pool
Number”.
This is done automatically by Assistant when the Home DN is selected for the DID Pool. To verify the service is set
check the DN in the Home DN Table (Global Translation and Routing -> Home Directory Numbers)
Create a Branch Office virtual Endpoint for Data Center 2 following the same procedure of Data Center 1.
Enter an inexistent
IP address
NOTE: Add all Data Center 2 subscribers to this branch office. For all those subscribers kept in the ‘Main Office’ calls will
only work in the direction from data center to branch office.
Select subscribers.
These cannot be used
for anything else.
65.5.1.6 Configure Destinations to Gateways serving all branches and Data Center
Following the same configuration steps for Simplex/Collocated configuration (see 3.1.2), add a pattern to point to both
Data Center Gateway (for calls from data center to branch) and for all branches.
Add a Destination OSB-BLS1 from Data Center 1 and another Destination OSB-BLS2 from
Data Center 2:
Go to OpenScape Voice -> Business Group -> Destination and Routes -> Destinations
Following the procedure for a Simplex / Collocated (see 3.1.3), create a PAC and
Destination Code for OSB-BLS1 and OSB-BLS2.
NOTE 1: If gateways are used for networking with PSTN, do not enable “Rerouting Direct Incoming Calls” because it may
lead to loops with PSTN.
NOTE 2: Only one Voice Mail can be used for both Data Centers. However, if Voice Mail Server is located on Data Center
1 then an alternate route to a redundant Voice Mail EndPoint on Data Center 2 is desired.
After login to the OSB Assistant go to the OpenScape Branch -> Configuration -> VoIP
option and under General select “Server” for Backup link mode and click on
“Configure…”:
NOTE 1: The configuration of “PPP Subnet IP/Netmask bits” should be enough to fit the amount of BLC devices on the
network. To have this, the number of hosts must be at least 2 times the number configured for “Max backup links” (this is
because each backup link has one PPP address for BLS and other for BLC).
For example, in the subnet 10.123.10.0/27 we have 32 PPP addresses (10.124.10.0 to 10.124.10.31) that must be greater
or equal to 2 times the number configured in “Max backup link” (in this case up to 16 BLCs are possible with this subnet).
NOTE 2: The PPP subnet IP addresses shall not conflict with any IP/subnets in the branch or data center
Under VoIP -> General -> Gateways click on “Configure…”. Enter the following line in
the Gateway Table:
Under VoIP -> Comm System -> Configure BLS1 at the OSV Node in the same Data
Center Router 1:
After login to the OSB Assistant go to the OpenScape Branch -> Configuration -> VoIP
option and under General select “Server” for Backup link mode and click on
“Configure…”:
Note: The configuration must be the same than BLC1 for values under Clients tab.
Under VOIP -> General -> Gateways click on “Configure…”. Enter the following line in the
Gateway Table
- Under VoIP -> Comm System -> Configure BLS2 at the OSV Node in the same Data Center Router 2:
Note: Even though we have a Geo Separated environment, we should configure OSV’s System Type as Simplex,
pointing to the Node collocated on the same Data Center. This is because in a case of Node failure, BLS should go to
Survivable Mode.
The following are the configuration steps for the OpenBranch located in the Branch (BLC). (Supported OpenScape
Branch modes are Proxy, SBC and SBC-Proxy only)
After login to the OSB Assistant go to the VOIP option and under General select
“Client” for Backup link mode and click on “Configure…”:
Note: OSV’s SIPSM node address and SNMP trap destination are already trusted and must not be entered here. A
maximum of 6 addresses are allowed.
In OpenScape Branch under the Gateway Table configure the BLC to route the call to the gateway when receiving the
configured subscriber rerouting access code:
Note 1: In this case, only one routing rule was created because the prefix access code to dial DID in Survivable Mode is
the same as the code for rerouting in Normal Mode. If not, more routing rules should be entered.
Note 2: Gateways must support clearmode. This is also referred to as clear-channel data or 64 Kbit/s unrestricted". If
OSB 50i PRI is used, check if “data calls allowed” flag is enable (go to CMP on OpenScape Branch
-> Integrated Gateway -> General -> Configuration, Edit the PRI link and check for flag)
This is the IP
address of CMP
management
Under VoIP -> Comm System -> Configure BLC to access a Geo Separated OpenScape
Voice
Set Geo-Separated
Note 1: If BLC is using TCP or UDP as SIP transport protocol, PPP tunnel is compressed. For TLS, the channels
are uncompressed.
Note 2: For TCP, BLC should point traffic to sipsm1/sipsm2. In case of TLS, sipsm3/sipsm4 are preferred.
To avoid unnecessary
transitions, use these
values. The minimum
OPTIONS value is 10
seconds. Please see Note2
Increase the transition mode below**.
threshold to 3, to have a lower
OPTIONS interval.
Please see Note1 below*.
*NOTE 1: OPTIONS interval value should be long enough to avoid survivable mode on the transition from Normal to
Backup Mode and at the same time the lowest possible value to have a fast transition to Normal Backup Mode. So, the
timers and thresholds must be configured according to the following formula:
Mtt <= Tt * Oi + (Tt -1 ) * Ot
Where:
Mtt = Maximum time in transition mode (60 seconds if only Primary link is configured – Simplex or
Collocated
- or 120 seconds if also Secondary link is configured – Geo Separation)
Tt = Transition Mode threshold
Oi = OPTIONS interval (min. 11 sec.)
Ot = OPTIONS timeout (min. 10 sec.)
If the criteria are not fulfilled, system will show an error message.
**NOTE 2: If BLC is in Normal Backup Mode, unnecessary system transitions due to network issues, like packet
losses, TCP retransmissions and others should be avoided. So, to optimize the link transition, we must consider that
Failure threshold (pings) multiplied by OPTIONS timeout (sec) must be at least 30 seconds.
Note: In this configuration a Cisco Router is used, following the recommendations from BO2707 - Back-up Link for
Survivable Branch for Free Media Choice.
Note: SNMP link status information depends on the OSV Srx/Lsm/CheckRouter flag set to RtpTrue.
interface GigabitEthernet0/1
description DCR1 to WAN
ip address 10.10.1.1 255.255.255.252
duplex auto
speed auto
Note: The name of the IPSec interface (in this case “tunnel1”) must be the configured on the CAC Group of OpenScape
Voice (see 4.1.1)
interface GigabitEthernet0/1
description DCR2 to WAN
ip address 10.20.1.1 255.255.255.252
duplex auto
speed auto
Note: The destination is a branch router, but if the BLC is using Branch SBC mode, it is recommended to configure an
IPSec tunnel directly to the BLC’s interface.
10.100.122.0 / 24 BLS1
address = 10.100.123.20
network 10.0.0.0
ip route 10.100.122.0
255.255.255.0 10.100.123.20
160
Note: This command shows that alternate route uses priority = 160. This mean that the route to BLS will be valid
only on the case that directly connected interfaces (priority =1) or dynamic router (e.g. RIPv2 with priority = 120)
are down.
10.100.122.0 / 24 BLS2
address = 10.100.124.50
network 10.0.0.0
ip route 10.100.122.0
255.255.255.0 10.100.124.50
The following steps need to be taken in OSB for configuring SIP Service Provider:
Registration required - This flag enables sending of SIP REGISTER to the SSP. This flag must be enabled for the new
configuration item "Registration Mode" take effect.
Once the "Registration required" is set the Default home DN becomes mandatory. The Default home DN is used to
populate the "To:" and "From:" headers of the REGISTER request. It shall be configured accordingly to the phone number
blocks provided by the provider to the SIP-PBX.
Use SIP Service Address for all identity headers: If enabled, for both normal and survivability modes, identity header fields are
modified to include the SIP Service Address network domain field.
SIP Service Address: FQDN or IP address identifying the network domain for the SIP Service Provider.
Registration Required: If selected (enabled), the OpenScape Branch will send registrations to SSP (60-7200
seconds).
Note: For Skype SSP, Registration info (TO, FROM, Contact headers sent to Skype SSP) contains what is
populated in the Business Identity DN field.
Interval: Registration interval in seconds.
Note: Alarm of loss of communication with SIP Service Provider will show after 4 registration failures
Business Identity Required: if enabled, requires the caller identified in the From header field contain the Business Identity DN.
Business identity DN: Contains the Business DN. Parameter takes precedence over Default Home DN if both are configured for the
From Header.
Note: For Skype SSP, this field is mandatory and must contain the Skype User ID assigned by Skype for
populating the From and Diversion headers (in addition to Registration info).
IMPORTANT: If this flag is activated, the OSB will not be able to for these SSP
endpoints.
Do not send Re-Invite when no media type change -Do not se change in the
media typ characteristics towards SSP (e.g. audio to INFO: Old Codecs from
the SSP would be reused towards the LA one common codec should exist
between all endpoints including S
Do not send Re-Invite -Do not send re invite at all to the SSP. Enable local
MOH in Survivable Mode (OSB only) - When MOH, i.e., no re-INVITE is sent
to destination endpoint for media n when MOH is enabled and the target SSP
does not re-INVITEs or Remove Silence Supression parameter from SDP -
Remove th in the SDP towards the SIP Service Provider.
Keep Digest Authentication Header – after receiving the first challenge, SBC
will keep sending the authentication header, incrementing the nonce count
each time. The SSP must challenge again if the registration fails at some point.
Enable pass-through of Optional parameters - When ena configure up to 10
394 OpenScape
optional SIP - Header parameters Branch V10 Configuration
passthrou
Service Providers (SSPs).Guide
It is only needed to add the parameter n
Most of SSPs send the calling party number only in the user party of From or P-Asserted-Identity headers. However,
some provides send the user and display name parts of those headers as described in RFC2161. This configuration
item allows to configuration which information shall be used.
The possible options are:
From header user and display name part: Preserves the user and display name parts of From
header. Default value.
From header user part: Uses the From user part as the Calling Party Number. If present, the display
name is removed from this header.
From header display name part: Uses the display name part of the From header as the Calling Party
Number. If present, the display name replaces the user part in From header. Otherwise, no
manipulation is done.
P-Asserted-Identity user part: Uses the P-Asserted-Identity user part as the Calling Party Number. If
present, the display name is removed from this header.
P-Asserted-Identity display name part: Uses the display name part of the P-Asserted-Identity header
as the Calling Party Number. If present, the display name replaces the user part in P-Asserted-Identity
header. Otherwise, no manipulation is done.
NOTE: This configuration applies to both Normal and Survivability modes of OSB. When in Survivability
mode, the SIP Manipulation configured in the OSB may apply to From and P-Asserted-Identity headers.
However, the SIP Manipulation is applied only after the SSP Calling Party Number manipulation.
SIP Connect
Use Tel URI - When the SSP requires the use of tel URIs the user must
check this check box, in which case the SBC shall convert all SIP URIs
to Tel URIs towards the SSP and vice versa.
The Registration Mode flag is the one that enables the special handling
in the register process: adding of option tag 'gin', 'path' and 'vp-rtcpxr'
and contact with 'bnc'.
INFO: Once the Use SIP service address is set, the SIP Service address
configuration becomes mandatory.
Note : Outgoing SIP Manipulation (SSP) can be used for outgoing calls in both Normal and
Survivability Mode.
NOTE: when the SIP Trunk is configured in terms of DNS SRV or FQDN, it is necessary to configure at least
2 mapped ports, max of 10 ports, in order to assign one mapped port to each ip resolved.
Routing Prefix: This box defines a valid Dial Number to be used in search for the Service Provider.
Gateway/Trunk type: This field should be set as “SIP Trunk”
Functional type: For SIP Trunk this field must be set as All Modes Egress/Ingress.
Trunk profile: selecting a SIP Service Provider Profile
Output digit strip: The number of digits to be deleted of the destination URI. The digits are deleted from
the beginning.
Output digit add: This box configures a digit string to be added to digits of URI. The digits are added to
the beginning.
Priority: This combo defines which gateway/trunk will be used first if more than one matches. Lowest
number has the highest priority. If a default gateway is required this gateway priority should be set to 0.
Operational Mode in Options Response: This flag controls if the operational state will be returned as part of the
response for OPTIONS messages sent by the gateway.
Once the routes are entered or deleted the save button will save the configuration and the window will close. To
apply this configuration the user must click on Apply Changes button.
67.5 Do not send invite without SDP and MOH in Survivability Mode
To provide the MOH for Gateways in survivability mode OSB needs to send a reINVITE without SDP. It happens even if
the flag "Do not send invite without SDP" is enabled in the SIP Service Provider Profile.
To be able to provide MOH to the SIP Service Providers that do not accept INVITEs without SDP, the flag Enable local
MOH in Survivable Mode shall be enabled.
Under Features > Sip Service Provider Profiles > Sip Service Provider Profile:
The flag Do not send invite without SDP shall be enabled.
In this configuration, placing the SSP on hold OSB will send a reINVITE with SDP inactive.
Under Features > Sip Service Provider Profiles > Sip Service Provider Profile:
In this configuration, placing the SSP on hold OSB switches the source of media stream to the Media Server (MOH)
internally. +No INVITE is sent to the SSP+
By default, OSB will increase the CSeq when responding to a challenge from the SIP Service Provider.
This mechanism can be disabled by setting the flag "trackCseqUpdatesEnable” to 0 in the configuration XML.
The flag "trackCseqUpdatesEnable" is not available in the GUI.
To disable CSeq Updates, follow the instructions below:
1. Export the current xml file.
2. Edit the xml.
3. Search for <trackCseqUpdatesEnable>1</trackCseqUpdatesEnable>
4. Change the value of the flag to 0 -> <trackCseqUpdatesEnable>0</trackCseqUpdatesEnable>
5. Save the changes
6. Import the modified xml.
7. Apply Changes
Feature implements License enforcement to the OpenScape Branch. The OpenScape Branch license file can be installed
and maintained via CMP or Stand Alone. License types include:
OSB Base License (per OpenScape Branch): provides full usage of the basic switch software. Note: OSB Configured as
“Gateway only” requires only Base license.
OSB Register Lines License (per User): controls the number of lines that can register with an OpenScape Branch. Note:
each device registering to the OpenScape Branch will deduct from license total (Ex. Device with Main Line and 2 Line
Appearances will require 3 licenses).
OSB Auto Attendant License (per OpenScape Branch): allows access to Auto Attendant feature.
OSB Backup ACD License (per OpenScape Branch): allows access to ACD feature/mode.
OpenScape SBC Session License (per Session): controls the maximum number of system wide SBC Sessions.
OSB Single Load Line License: allows the decrease in sustaining costs and maintenance and then evolves to the release
of new features faster and with a better ROI. During the "Grace Period" (30 Days), no License applied, or no Licence
Version available, the OSB /OS-SBC allows only the Implementation/Feature set based on V8R1 version.
The Base License Version and the SID will be stored in the XML file.
Currently the CMP applied License message doesn't contain the License Version as well as the SIEL ID info.
Regular License Files (RLF): licenses purchased by customer (no expiration date).
o OpenScape Branch Base Licenses (maximum allowed 3,000).
o OpenScape Branch User Licenses (maximum allowed 100,000).
o Auto Attendant Licenses (maximum allowed 3,000).
o Backup ACD Licenses (maximum allowed 3,000).
o OpenScape SBC Session Licenses (Maximum allowed 160K for Branches) SBC/SBC-
Proxy modes only.
Evaluation License: Regular License File with an expiration time of 180 days.
o 1 OpenScape Branch Base License.
o 1 Auto Attendant Feature License.
o 1 Backup ACD Feature License.
o 50 OpenScape Branch User licenses.
o 100 OpenScape SBC Session Licenses. SBC/SBC-Proxy modes only.
Demo License: Regular License File with no expiration.
o 1 OpenScape Branch Base License.
o 1 Auto Attendant License.
o 1 Backup ACD License.
o 50 OpenScape Branch User licenses.
o 100 OpenScape SBC Session Licenses. SBC/SBC-Proxy modes only.
Attempts to exceed license amounts results in blocked registrations and a critical alarm is generated.
The alarm must be manually cleared.
Note: For redundant OpenScape Branch systems, the active node populates its’ licensing to the backup node. No
additional licenses are required.
o How often does the branch check the CMP server for the licenses?
Once a day.
o If because of a network issue the branch fails to connect with CMP server, then how
often will the branch try to reach the CMP license server and at what interval?
Once a day (if the first request fails the branch will try again after 30 minutes, third attempt
15 minutes after that, and a fourth attempt 5 minutes later. In other words, 4 try’s during one
hour and after that 24 hours later).
o If OSB fails to get connected for specified time interval then how long does the branch
go into the grace period?
30 days.
o Does OSB continuously try to connect to the license server during the grace period
and how often?
Yes, Once a day.
o If the OSB gets connected to the CMP license server during the grace period, does the
branch return back to normal? Does the graces period value reset to 0?
OSB goes back to normal and the grace period is reset to 0.
o If the grace period expires is the branch blocked? Does the branch check for the
license server if the grace period expires?
If grace period expires licensed features stop working. OSB continues to check for license
server and if license server is found the OSB goes back to normal.
o What is the expected behavior in a branch if more users attempt registration than what
is allowed?
Some additional registrations are allowed. The number of additional registrations allowed
depends on the OSB type.
Generates and manages the license files. A license file is generated when the License Authorization Code is sent to the CLS
by Common Management Portal. The transfer of the license file to Common Management Portal occurs automatically via the
internet.
OpenScape Branch Base licenses are configured via the Common Management Portal (Using MAC Address of CMP in
CLS) or Stand Alone (Using MAC Address of OSB eth0/LAN in CLS).
Upload License File using the Common Management Portal Maintenance > Licenses >
Information > Offline Activation
StandAlone mode License - is a special license that defines the number of PSTN ports that can be used:
In this case, an OSB DP24 are using a PSTN license for two PRI Ports.
If a license for a single PSTN PRI Port had been applied, this system would have being restricted to use only its
first PRI Port.
License Type Branch: reports usage calculated based on the configured license usage
(Branch Users)
License Type OsSBC: reports usage based on the high watermark of the number
consumed SBC session licenses in the month (SBC Sessions).
OSB can be configured in Proxy ACD mode to support Automatic Call Distribution.
Under ACD menu user can configure Automatic Call Distribution parameters. New window is opened
when selecting ACD.
Note: ACD user has access to ACD configuration only (Local GUI)
Important: ACD currently uses the rrmemory hunt mechanism (round robin with memory, remember
where we left off last ring pass)
Note: If the Agent timeout is lower than the Queue advance timeout, when the ACD call rings on the
agent until the Agent timeout expiration, the agent will stop ringing, will be logged off and the next
available agent will be called. If the Agent timeout is equal or greater than the Queue advance
timeout, when the ACD call rings on the agent until the Queue advance timeout expiration, the agent
will stop ringing (but not logging off) and the next available agent will be called.
DID List: DIDs used to reach queue (DIDs must be unique and
can not be the same as login/logoff/toggle key codes). There is no
limit on the amount of DIDs that can be configured.
Logs: user can download a tar file containing the log files for all queues.
File contains the queue logs that can be used by an external application to
generate call, agent, and queue statistics. Each of these files will contain
log information for events occurred in the last 24 hours.
Note: using Assistant it is possible to schedule announcements to be applied. This is used to substitute
the announcements without needing to edit the queues and to apply same announcements to several
OSBs at the same time. Functionality is under Configuration OpenScape Branch Job Management
Add Action (Transfer WAV Files).
In the media select drop down menu user must select “Virtual Machine ISO image” and then select
“Already existent database file” and import the xml from the native box
vApps directory contains 3 subdirectories, each one corresponding to the appropriate hardware type
After selecting the corresponding ovf file, user must select “Next”
Enter name for the virtual machine and select a location. When done, select “Next”
Select “Next”
Select “Finish”
Enter name for the virtual machine and select a location. When done, select “Next”
Select destination storage for the VM files. When done, select “Next”
Select “Linux” and version “Other 2.6.x Linux (32-bit)”. Select “Next”
Select “Next”
Hardware Type Virtual OSB 250 Virtual OSB 1000 Virtual OSB 6000
Memory (GB) 2 2 4
Hardware Type Virtual OSB 250 Virtual OSB 1000 Virtual OSB 6000
Memory (GB) 4 4 6
Select “Next”
[ Adapter “VMXNET3” and flag “Connect at Power On” is set by default for both network cards ]
Disk provisioning must be set to “Thick Provision Lazy Zeroed”. Depending on the hardware type, set the hard disk
capacity
Virtual Virtual Virtual
OSB OSB OSB
Hard Disk (GB) 40 40 60
Select “Next”
Select to edit the settings of the VM (either created manually or using vApp)
In the “Resources” tab (vSphere client), select Memory. Configure “Reservation” and “Limit”
value to the same value as the VM memory size. Shares set to Normal.
* Please note that for the OSB virtual solution, core processor minimum is 2.5 GHz.
Based on this value, “Reservation” and “Limit” values are displayed for each hardware type.
In case, core processor speed is lower than 2.5 GHz, values must be modified according to the
following equation [#vCPU]*[physical_CPU_freq] regardless if VM was created manually or with
vApp.
When deploying vApp these values are set automatically (based on the 2.5 GHz core processor)
After completing the previous step, select OK to apply the settings described above.
When using vSphere client, highest version available is VM version 8 and it is set by default.
When using vSphere web client, higher versions are available and VM version is set to 10 by default. Please note that VM
version 10 can only be managed from vSphere web client.
VM version 8 @ ESXi 5.0 and later > compatible with 5.1 & 5.5, some VM hardware features are unavailable
with this option in the ESXi 5.5 environment
VM version 9 @ ESXi 5.1 and later > compatible with 5.5, some VM hardware features are unavailable with this
option in the ESXi 5.5 environment
VM version 10 @ ESXi 5.5 and later > Provides best performance and latest features in ESXi 5.5
Once the VM has booted up, user can login to the local GUI page in order to complete the installation procedure, in the
same way as it is executed for native hardware.
Once the installation is completed, before the first reboot user is prompted by the OSB to detach the ISO file from the VM’s
CD/DVD drive
Select “Yes” in the vSphere prompt and then “OK” on the OSB local GUI in order to reboot and complete the installation
procedure.
It is strongly recommended to edit the VM settings and set the CD/DVD drive to “Host Device” option and remove the
“Connect at power on” flag
Select the virtual machine, right click and then select Guest -> Install/Upgrade Vmware Tools .
The path /vm/sbin does not exist currently. This program is going to
create it, including needed parent directories. Is this what you want?
[yes]
[/vm/lib/vmware-tools]
Before running VMware Tools for the first time, you need to configure
it by invoking the following command: /vm/bin/vmware-config-tools.pl
. Do you want this program to invoke the command for you now?
[yes]
Initializing...
Making sure services for VMware Tools are stopped. Stopping
VMware Tools services in the virtual machine:
Guest operating system daemon: done
Unmounting HGFS shares: done Guest filesystem
driver: done
Before you can compile modules, you need to have the following
installed... make
gcc
kernel headers of the running kernel
This program could not find a valid path to make. Please ensure that
the make binary is installed in the system path.
This program could not find a valid path to the gcc binary.
Please ensure that the gcc binary is installed on this sytem.
This program could not find a valid path to the kernel headers of the
running kernel. Please ensure that the header files for the running
kernel are installed on this sytem.
[ Press Enter key to continue ]
The fast network device driver (vmxnet module) is used only for our
fast networking interface. The rest of the software provided by
VMware Tools is designed to work independently of this feature.
If you wish to have the fast network driver enabled, you can install
the driver by running vmware-config-tools.pl again after making sure
that gcc, binutils, make and the kernel sources for your running
kernel are installed on your machine. These packages are available
on your distribution's installation CD.
[ Press Enter key to continue ]
No X install found.
You must restart your X session before any mouse or graphics changes take effect.
To enable advanced X features (e.g., guest resolution fit, drag and drop, and file and text
copy/paste), you will need to do one (or more) of the following:
Manually start /vm/bin/vmware-user
Log out and log back into your desktop session; and,
Restart your X session.
To overcome this issue, user must shut down the VM and power it back on (restart will not work) (reminder) User can
manage a VM version 10 only from vSphere Web Client
Branch and SBC are now distributed in an Open Virtual Appliance (OVA) package to simplify the deployment on a VMware
installation, including OSEE/THIG for SBC.
This OVA contains a pre-installed software of the Branch or SBC, with the following configuration:
At first boot, the system will try to find a DVD/CDrom on the VM, and will look for an XML configuration file. If this file is
present, the system will automatically apply it.
Branch: /cdc/CDC_OSB_Config.xml
SBC: /cdc/CDC_SBC_Config.xml
This is also a solution for customer which needs to manage OpenScape Branch located under a public network and connected to
OpenScape SBC Server.
The VPN Concentrator shall be configured to establish an IPSec tunnel to each Hosted OpenScape Branch. When creating the VPN
Concentrator IPSec tunnel, it must be taken into account that the following configuration is accepted by OpenScape Branch:
71.1.2 Firewall
It is possible to use a Firewall Server between CMP and hosted secured network (firewall could be possibly included within the VPN
Concentrator equipment). If enabled, firewall shall be configured with the following rules to access some of the applications:
For the WAN connection, it is required that VPN Concentrator and OpenScape Branch have a public IP following the external public
IP routing requirements. These addresses should be routed separated from the public addresses used for VoIP, even if the sub
network has some overlaps.
The management address (Admin IP) used for the secured access to the OpenScape Branches is a private IP and should be routed
internally only. This address must be routed from the CMP (or from any other management Server within secured management
network) to the VPN concentrator of respective Data Center.
Go to OpenScape Branch Assistant > Configuration > Security and select IPSec tab. Click on the Add button to
create a VPN connection.
Note 1: For the first configuration, CMP must use the WAN address of OpenScape Branch for management. If
WAN is not possible, so a local management using the LAN address isrequired.
Note 2: The configuration of IPSec is possible over WAN interface only. Due to this, this feature is only allowed to
OpenScape Branches configured as Branch SBC or SBC-Proxy mode.
For Authentication type X.509 selected, it is necessary to create a VPN profile. Before the configuration of IPSec,
create a new profile under OpenScape Branch Assistant > Configuration > Security and select Certificate
Management Configuration button under General tab.
To upload customized certificates, go to General Configuration tab and Certificate upload.
To verify the tunnel status, go to Log Files Viewer and check for System Log
Go to Management > Nodes, select Branch Office, and under Dashboard, go to Actions > Log Files.
Select log: System
Tunnel name
Go to OpenScape Branch Assistant > Configuration > Network Service. Select Interface WAN (Interface2)
and Edit. Configure the IP address for management under Admin IP Address:
Verify under OpensCape Branch > Branch Office if Admin IP is being used for management.
By default, OSB only supports the English language for those features. All three features provide mechanism to
upload customized announcements however it is not allowed for all sound files used in the feature.
If desired to change the language used for those features, it shall be done manually.
Usually the voice prompts have the same name in all languages so they can be easily replaced.
Asterisk voice prompts are stored in the OSB in the following directory structure:
/var/lib/asterisk/sounds
/var/lib/asterisk/sounds/dictate
/var/lib/asterisk/sounds/digits
/var/lib/asterisk/sounds/silence
/var/lib/asterisk/sounds/ann (link to /opt/siemens/openbranch/var/mngmt/announcements)
/var/lib/asterisk/sounds/greet (link to /opt/siemens/openbranch/var/mngmt/greetings)
/var/lib/asterisk/sounds/vm-osb-en (link to /opt/siemens/openbranch/var/mngmt/vm-osb-en)
/var/lib/asterisk/sounds/vmgreet (link to /opt/siemens/openbranch/var/mngmt/vmgreetings)
The files under the sounds directory and in the subdirectories dictate, digits and silence are general purpose
voice prompts and cannot be changed via local GUI.
/var/lib/asterisk/sounds
/var/lib/asterisk/sounds/dictate
/var/lib/asterisk/sounds/digits
/var/lib/asterisk/sounds/silence
The voice prompts in these directories are the Asterisk default ones, excepting:
/var/lib/asterisk/sounds/agent-alreadyoff-simple.wav
/var/lib/asterisk/sounds/agent-alreadon-simple.wav
/var/lib/asterisk/sounds/agent-incorrect-literal.wav
/var/lib/asterisk/sounds/agente-user-logoff.wav
/var/lib/asterisk/sounds/queue-minute.wav
They are not found in the default Asterisk sound package. They were created based on other available English
voice prompts specially to OSB.
For other languages, these files can be also created based on other voice prompts in a specific language or
recorded according to the customer decision. The file names shall be preserved to replace them in the OSB.
This directory stores the voice prompts for "queue join", "queue wait" or "agent announcement" selection.
/opt/siemens/openbranch/var/mngmt/announcements/queue-periodic-announce.wav
/opt/siemens/openbranch/var/mngmt/announcements/queue-thankyou.wav
/opt/siemens/openbranch/var/mngmt/announcements/pri-introsaved.wav
New voice prompts can be copied directly to this directory or uploaded via local GUI.
/opt/siemens/openbranch/var/mngmt/greetings
This directory stores the voice prompts for AA "Destination selection greeting", "Failure prompt", "Final
prompt", "Default destination prompt" or "Transfer prompt" selection.
/opt/siemens/openbranch/var/mngmt/greetings/goodbye.wav
/opt/siemens/openbranch/var/mngmt/greetings/transfer.wav
/opt/siemens/openbranch/var/mngmt/greetings/num-not-valid.wav
/opt/siemens/openbranch/var/mngmt/greetings/enter-num-to-call.wav
/opt/siemens/openbranch/var/mngmt/greetings/connect-to-party.wav
New voice prompts can be copied directly to this directory or uploaded via local GUI.
/opt/siemens/openbranch/var/mngmt/vmgreetings
o VoiceMail Greeting
o VoiceMail Retrieve Prompt (From Own Extension)
o VoiceMail Retrieve Prompt (From Other Extension)
o Voicemail Retrieve Wrong PIN
o Voicemail Retrieve Change PIN
o VoiceMail Retrieve Change PIN failed
o VoiceMail Retrieve Wrong Box Number
/opt/siemens/openbranch/var/mngmt/vm-osb-en/vm-incorrect-mailbox.wav
/opt/siemens/openbranch/var/mngmt/vm-osb-en/vm-login.wav
/var/lib/asterisk/sounds/vm-mismatch.wav
/var/lib/asterisk/sounds/vm-newpassword.wav
/opt/siemens/openbranch/var/mngmt/vm-osb-en/vm-password.wav
/opt/siemens/openbranch/var/mngmt/vmgreetings/vm-welcome.wav
New voice prompts can be copied directly to this directory or uploaded via local GUI.
If desired to have the default ones in other language, they can be also created based on other voice prompts in
a specific language or recorded according to the customer decision. The file names shall be preserved to
replace them in the OSB.
The osb-pt_br-sounds.zip file were created based on voice prompts provided by the Disc-OS project.
(http://downloads.sourceforge.net/disc-os/Disc-OS-Sounds-1.0-pt_BR.tar.gz?use_mirror=osdn)
The files in there are organized following the OSB directory structure to make the installation easier:
/sounds
/sounds/digits
/sounds/ann
/sounds/greet
/sounds/vmgreet
/sounds/vm-osb-en
a) SSH to OSB using WinSCP or another tool. Ensure you have the root access to the OSB
b) Under /var/lib/asterisk/sounds/ replace the voice prompts by the ones in the sounds directory
of the zip file.
/var/lib/asterisk/sounds/ann
/var/lib/asterisk/sounds/greet
/var/lib/asterisk/sounds/vmgreet
/var/lib/asterisk/sounds/vm-osb-en
This procedure needs be done only once after OSB V9 release. Once installed, the modified voice prompts can
be exported and imported easily via local GUI. The files can be preserved in case of a new installation.
a) Go to Maintenance>Import/Export
b) Under Export section, select group Media (AA/VM/ACD/MOH)
c) Click on Export
d) A tar file will be generated with voice prompts used for the features