Top
Getting started
Danger, Warning, Caution, and Note Definitions
Top
Logon
Logging on to the Mediatrix Unit Web Interface
Top
Mediatrix Unit Reset
Basic Reset Concepts
Partial Reset
The partial reset provides a way to contact the Mediatrix unit in a known and static state while keeping most of the configuration unchanged.
A partial reset can be performed at the initial start-up of the Mediatrix unit or on a unit already in use where the configuration was modified in such a way that the user can no longer access the system by the Web page or otherwise. In both cases, the user can manage the Mediatrix unit through its Rescue interface, which is bound to the unit's WAN port (wan for the Mediatrix 4102S, and ETH1 for all other Mediatrix units). The IP address of the Rescue interface is 192.168.0.1 (IPv4) or an IPv6 Link Local address.. These connections give access to the Rescue Management Interface where the configuration of a new unit can be completed and where an existing configuration can be modified.
By default the Rescue Network Interface is disabled. When a partial reset is performed, the Rescue network Interface becomes enabled and the "Power" and "Ready" LEDs are blinking at 1Hz with 75% duty and all other LEDs are off. Once the configuration has been modified to solve the problem that required the partial reset, it is important to disable the Rescue Network Interface to make sure that you are no longer working in the Rescue Network Interface.
- Rollback Local Firewall settings that are not yet applied.
- Add a Local Firewall rule to allow complete access to the Rescue interface.
- Rollback NAT settings that are not yet applied.
- Add NAT rule to allow complete access to the Rescue interface.
- Cancel the changes that were being modified but not yet applied to the configuration.
- Disable any Network Interface in conflict with the Network Rescue Interface.
- Configure and enable the Rescue Network Interface to:
- use the link as the default value used by the Uplink Network Interface
- set the IP address to 192.168.0.1 and the Network Mask to 255.255.255.0.
- set the IPv6 link-local address on all network links. The IPv6 link-local address can be found underneath the unit.
Service | Parameter | Default Value |
---|---|---|
AAA | Users.Password | User(s) from profile are restored with their factory password. All other usernames keep their password. |
Users.AccessRights | User(s) from profile are restored with their factory rights. | |
ServicesAaaType (table) | Each service will be configured to use Local authentication and no accounting mechanism. | |
CLI | EnableTelnet | Disable |
TelnetPort | 23 | |
EnableSsh | Enable | |
SshPort | 22 | |
InactivityTimeOut | 15 | |
HOC | ManagementInterface | Rescue |
SNMP | Port | 161 |
EnableSnmpV1 | Enable | |
EnableSnmpV2 | Enable | |
EnableSnmpV3 | Enable | |
Web | ServerPort | 80 |
SecureServerPort | 443 |
Top
Factory Reset
The Factory reset reverts the Mediatrix unit back to its default factory settings.
- User files stored in the File service
- Certificates, except for factory installed ones
- Log files of the File service
- Directly on the unit. Refer to Performing a Factory Reset.
- Via the web interface of the Mediatrix unit (Management/Firmware Upgrade).
- Via the Command Line Interface of the Mediatrix unit by using the fpu.defaultsetting parameter.
Top
RESET/DEFAULT Button
The Reset/Default button is a switch that can be used to perform a partial or factory reset while the unit is running.
- Cancel an action that was started.
- Revert to known factory settings if the Mediatrix unit refuses to work properly for any reason or the connection to the network is lost.
- Reconfigure a unit.
LED Pattern | Action | Comment |
---|---|---|
Power1 blinking, all other LEDs OFF | Restarts the Mediatrix unit. | No changes are made to the Mediatrix unit settings. |
All LEDs blinking, 1cycle per second, 50% duty | Initiates a Partial Reset of the Mediatrix unit. Note: The partial reset is
optional as it can be disabled with the CLI
Hardware.ResetButtonManagement parameter. For more details,
refer to the DGW Configuration Guide - Reference Guide
published on the Media5 Documentation Portal. |
Restarts the unit in a known and static state while keeping most of the configuration unchanged. |
All LEDs steady ON | Initiates a Factory Reset of the Mediatrix unit. | Reverts the unit back to its default factory settings. |
All LEDs will become OFF after blinking and being steady on. | No action is taken. This is useful if you accidentally pushed the button and do not need and action to be applied. | The action is ignored. |
Top
Basic Reset Tasks
Performing a Partial Reset
The Rescue Network Interface is displayed when accessing the Management Interface. Several parameters and services are modified, refer to Partial Reset. Do not forget to perform the Disabling the Rescue Interface step.
Top
Disabling Partial Reset - ResetButtonManagement
- Open CLI (Command Line Interface).
- Set ResetButtonManagement to DisablePartialReset.
Top
Performing a Factory Reset
Top
Personnal Data Usage and Protection
Personal Data Exposure
Personal Data Collection
Mediatrix products collect the basic personal data required for the proper delivery of the telecommunication service. The actual collected data depends on the type of users and how the Mediatrix products are administrated.
Type of users | Collected Personal Information | Collected Activity Information |
---|---|---|
End-Users | Name and phone number used to register to the telecommunication provider service. | Calls history for billing purposes and call details and recordings for
troubleshooting purposes. For example:
|
System Administrators and Technical Support | Account name and password used to access the product for administrative and troubleshooting purposes. |
|
Top
Personal Data Processing
Personal data is processed in Mediatrix products through the following activities:
- Configuring and storing end-user data
- Recording voice and fax calls
- Logging call history (CDR)
- Logging administration audit trails
- Access of the personal data by an authorised system administrator
- Provisioning data
- Maintenance, administration and technical support records
- Audit trails
- End-user activity records
- End-User personal content
- Recording voice and fax calls for troubleshooting
Top
Personal Data Transfers
The following collected personal data may be transferred to other systems, depending on how the device administrators configure the Mediatrix products.
- Call Details Records (CDR) may be sent to an external call accounting system.
- Logs may be sent over an external monitoring system for live troubleshooting.
- Administration activity logs may be sent over an external monitoring system for auditing.
- Backups of the Mediatrix products, containing collected personal data, may be retrieved by an authorised system administrator.
- Network captures from the Mediatrix products, containing collected personal data, may be retrieved by an authorised system administrator for troubleshooting purposes.
Top
Personal Data Protection
System and Data Protection
To protect the end-user personal data stored inside the Mediatrix devices, the device administrator should control and restrict access to the management interfaces by:
- Forcing the use of a strong authentication password
- Authorising LAN access only
- Using the device firewall service to limit the remote access to the device to only authorized peers and authorised services
- Using an external firewall
- Enabling IEEE 802.1x authentication of Ethernet link
The device administrator may also enforce the use of encryption and authentication for a secure administration of the Mediatrix devices:
- Authenticated Management Interfaces:
- Web Interface: HTTPS with trusted certificates
- CWMP: HTTPS with trusted certificates
- CLI: SSH
- Secure Management Operations:
- Consult or retrieve the stored personal data: HTTPS with trusted certificates
- Provisioning: HTTPS with trusted certificates
- Firmware upgrades: HTTPS with trusted certificates
- Backup/restore: HTTPS with trusted certificates
Top
Communications Protection (VoIP Calls)
The device administrator may configure the encryption of the data that transits through Mediatrix products:
- Call signalling: SIP over TLS with trusted certificates
- Media packets: SRTP
Top
Access and Communications
- Administrator
- User (no password access)
- Observer (read-only)
All the management interfaces are restricted to authorised accounts only, verified by username and password. Refer to the System and Data Protection section for the list of management interfaces and how to protect them.
The account credentials may be stored locally in the Mediatrix devices or in an external RADIUS authentication server.
In all cases, the device administrator should restrict the physical access to the Mediatrix products.
Top
Data Deletion
The Mediatrix products allow an authorised system administrator to delete end-user registration information (name and number).
- call history
- call recordings
- network captures
A factory reset can be performed by a system administrator to revert a Mediatrix device back to its default factory state through a factory reset, thus erasing all the collected data and configuration.
Top
Audit
Audit trail logs of the system administrator activities may be enabled by the device administrator. These audit logs may be temporarily stored locally or sent through syslog to an external monitoring system.
Top
Management Interfaces

Top
IPv6
Basic IPv6 Concepts
IPv6
IPv6 (Internet Protocol version 6) is the successor to the most common Internet Protocol today (IPv4).
This is largely driven by the fact that IPv4 32-bit addresses are quickly being consumed by the ever-expanding sites and products on the Internet. IPv6 128-bit address space should not have this problem for the foreseeable future.
IPv6 addresses, in addition to being longer, are distinguished from IPv4 addresses by the use of colons ":", e.g. 2001:470:8929:4000:201:80ff:fe3c:642f. An IPv4 address is noted by 4 sets of decimal numbers separated by periods ".", e.g. 192.168.10.1.
Please note that IPv6 addresses should be written between [ ] to allow port numbers to be set.
For instance, [fd0f:8b72:5::1]:5060.
Top
IPv6 Availability
- CPE WAN Management Protocol (CWMP)/TR-069
- DHCP embedded sever
- IP Routing
- Local Firewall (LFW)
- Network Firewall (NFW)
- Network Address Translation (NAT)
- Online Certificate Status Protocol (OSCP)
- Remote Authentication Dial In User Services (RADIUS)
- Session Border Controller (SBC)
- Simple Network Management Protocol (SNMP)
- PPPoE
Top
IPv6 link-local Addresses
IPv6 link-local addresses start with fe80 and must include the scope identifier
Therefore, the format of a link-local address is: [IPv6 link-local%ScopeIdentifier].
- On Windows: the network link used to contact the IPv6 link-local address.
- On Linux: the link name or the interface number.
For example, if the unit must contact a server at the IPv6 link-local fe80::201:80ff:fe3c:642f address, you must check on which network link the server is available. Some units have WAN or LAN. If it is on the WAN link, the IP address would then be "[fe80::201:80ff:fe3c:642f%wan]".
Top
IPv6 Basic Tasks
Locating the Scope Identifier of fe80 IPv6 Addresses on Windows

Top
Locating the Scope Identifier of fe80 IPv6 Addresses on Linux

Top
Naming Conventions
When defining a name for a parameter, only ascii characters are authorised.
This is valid when defining a name for a parameter in a Web Page of the Management interface, but also for parameters accessed via the CLI, the MIB, or a script.
For example, to be valid, the Service Name defined during PPPoE configuration must only contain ascii characters. Special characters such as " " (space), """ (double quote), "“" (left double quote), "‘" (left single quote), "#", "£", "¢", "¿", "¡", "«", "»" will cause the system to display a syntax error message.
Top
ASCII Special Characters
Top
Unit Macros
Macro | Description |
---|---|
%mac% | the MAC address of the unit |
%version% | the MFP version of the unit (firmware version) |
%product% | the Product name of the unit |
%productseries% | the Product series name of the unit. |
Top
Command Line Interface (CLI)
CLI Basic Concept
Command Line Interface (CLI)
The Command Line Interface (CLI) provides an access to interactively configure all the Mediatrix unit parameters.
The command interpreter interface of the CLI allows the user to browse the unit parameters, write the command lines, and display the system's notification log.
Top
CLI Basic Tasks
Creating the Telnet Session Activation Configuration Script

Top
Accessing the CLI via a Telnet Session
Top
Accessing the CLI via an SSH Session
Top
File Servers
Configuring the FTP Server
Perform this procedure if you plan to use the FTP transport protocol.
Top
Configuring the HTTP Server
Top
Configuring the HTTPS Server
Make sure the unit is set to the proper date (refer to Configuring the Mediatrix Unit to Use an SNTP Server.
Top
Configuring the TFTP Server
Top
Bypass Feature (4402plus/4404plus Models)
In the event of a power failure or network failure, the optional bypass feature permits users to make and receive calls even when the Mediatrix unit is not operating.
- The connector on which the SCN line is connected must be configured as a TE.
- The other connector must be configured as a NT.
During normal operation, the direct connection between the BRI 1 and BRI 2 connectors is switched out through commuting relays and both ports resume normal functions. When power is removed from the Mediatrix unit, the relay setting is restored to a connected state and the SCN line can be used as an emergency line. Consequently, a BRI telephone used on the other port is directly connected to this SCN line. When the power is restored, this automatically removes the Bypass connection; this means that any ongoing call on the Bypass connection is terminated.
Top
System
Information
Activating a Licence Using the Web Interface

Top
Services
Basic Service Concepts
Services
The Mediatrix unit uses many services to carry out tasks and support features.
- system services : You cannot perform service commands on system services. The service is
restarted by using the Reboot
button located under the Reboot
tab of the DGW Web interface.Note: If the unit is in use when clicking Reboot, all calls are terminated.
- user services: You can perform service commands on user services. The service is restarted by using the start

When a service needs to be restarted, the restart required services is systematically displayed. If you are not able to restart a service because it is a system service, click the Reboot link in the top menu. The Reboot page then opens. You must click Reboot. This restarts the Mediatrix unit. If the unit is in use when you click Reboot, all calls are terminated
Services can also be restarted via the CLI using the Scm.ServiceCommandsRestart parameter.
Top
System Services vs User Services
The Mediatrix unit uses many services to carry out tasks and support features.
- Start
- Stop
- Restart
- system services: the user cannot perform service commands. The service can only be restarted by rebooting the unit. Refer to Restarting a System Service.
- user services: the user can perform service commands. The service can be restarted by the user. Refer to Setting the Service Start-up Type
When a system or a user service needs to be restarted, the Some changes require to restart a service to apply new configuration message is systematically displayed on the DGW Web pages. Also, every service has the NeedRestartInfo CLI/MIB parameter to indicate if the service needs to be restarted for the configuration to fully take effect.
Top
DGW User Services
User Service | Description |
---|---|
Basic Network Interface (Bni) | Manages the layer 3 network interfaces. |
Call Detail Record (Cdr) | Allows the administrator to generate custom call notifications with information such as endpoints, point of origin, duration, etc. |
Command Line Interface (Cli) | Allows the administrator to manage the unit using the SSH or TELNET protocols. |
Call Routing (Crout) | Transforms properties and routes calls between telephony interfaces and SIP endpoints. |
CPE WAN Management Protocol (Cwmp) | Allows the administrator to manage the unit using the TR-069 protocol. |
DHCP Server (Dhcp) | Manages a DHCP server on each network interface. |
E&M Channel Associated Signaling (Eam) | Manages the E&M CAS telephony interfaces. |
Element Management System for Virtuo (EMS) | Makes the unit compatible with the Virtuo EMS infrastructure. |
Endpoint Administration (EpAdm) | Allows for high-level management of telephony endpoints. |
Endpoint Services (EpServ) | Manages the telephony services of each endpoint. |
IP routing (IpRouting) | Manages the unit's IP routing table. |
Integrated Services Digital Network (Isdn) | Manages the ISDN parameters for BRI and PRI telephony interfaces. |
Local Firewall (Lfw) | Allows the administrator to filter the network with the unit as final destination. |
Link Layer Discovery Protocol (Lldp) | Manages the IEEE 802.1ab protocol used for advertising the unit's capabilities on the network. |
Media IP Transport (Mipt) | Manages the voice and data encodings over the IP network. |
Music on Hold (Moh) | Manages the option to play an audio file when a telephony endpoint is on hold. |
Network Address Translation (Nat) | Allows the administrator to change the source or destination IP address of a packet. |
Network Firewall (Nfw) | Allows the administrator to filter traffic that is routed between networks. |
Network Traffic Control (Ntc) | Allows the administrator to perform traffic shaping on the network interfaces. |
Plain Old Telephony System Line (Pots) | Manages the FXS and FXO analog telephony interfaces. |
R2 Channel Associated Signaling (R2) | Manages the E1 CAS telephony interfaces |
Session Border Controller (Sbc) | Allows the administrator to perform SIP to SIP normalization, call routing, NAT traversal, and survivability. |
SIP Endpoint (SipEp) | Allows the administrator to associate telephony endpoints with SIP user agents. |
SIP Proxy (SipProxy) | The SIP Proxy (SipProxy) service is used to add local survivability for local endpoints and SIP phones. |
Simple Network Management Protocol (Snmp) | Allows the administrator to manage the unit using the SNMP protocol. |
Telephony Interface (TelIf) | Manages tone generation and detection on the telephony interfaces. |
Virtual Machine (Vm) | Allows the administrator to manage virtual machines. |
Web Service (Web) | Manage the unit using HTTP(S) web pages. |
Top
DGW System Services
System Service | Description |
---|---|
Authentication, Authorization and Accounting (Aaa) | Manages the administrator accounts and grants or denies access to various parameters. |
Certificate Manager (Cert) | Manages the security certificates used for the authentication of the unit and its peers before establishing a secure connection. |
Configuration Manager (Conf) | Allows executing configuration scripts as well as performing backup/restore of the unit configuration. |
Device Control Manager (Dcm) | Manages the hardware properties as well as the licence activation keys. |
Ethernet Manager (Eth) | Manages the unit Ethernet link interfaces. |
File Manager (File) | Allows the administrator to manage the files stored on the unit. |
Firmware Pack Updater (Fpu) | Manages firmware upgrade, downgrade and rollback operations. |
Host Configuration (Hoc) | Manages the IP host parameters and other system settings. |
Local Quality Of Service (LQos) | Manages the QoS parameters applicable to the unit. |
Notifications and Logging Manager (Nlm) | Manages the routing and filtering of the unit's event notification messages. |
Process Control Manager (Pcm) | Manages the startup and shutdown sequence of the system. |
Service Controller Manager (Scm) | Allows the administrator to enable or disable services. |
Top
Basic Service Tasks
Setting the Service Start-up Type
- Go to System/Services.
-
In the User Service
table, from the Startup Type selection list
located next to the service you wish to set.
- choose Auto if you wish the service to start automatically when the system starts, or
- choose Manual to start to the service manually when needed.
- Click Apply.
Top
Starting/Stopping/Restarting a User Service Using the DGW Web Page
- If you clicked
, the tab from which you can access the service from the Web pages are greyed out
- If you clicked
, the tab from which you can access the service from the Web pages are no longer greyed out.
Top
Disabling a Service
Top
Restarting a Service with a Grace Delay
- Go to System/Services.
- In the Restart Required Services table, set the Graceful Delay (min) field.
- Click Restart Required Services.

Top
Restarting a System Service
Top
Advanced Service Tasks
Starting/Stopping/Restarting a User Service Using a MIB Browser
- Open a MIB Browser
- Navigate to the Service that needs to be restarted.
- Locate the needRestartInfo parameter to determine if the service needs to be restarted.
- In the scmMIB, locate the serviceCommandsTable .
-
In the serviceCommandsName column, locate the service to
restart.
Top
Starting/Stopping/Restarting a Service Using the CLI
Top
Hardware
Hardware Basic Tasks
Selecting the Source of the Clock Reference
- Go to System/Hardware.
- From the Clock Reference Configuration table, select from the Suggestion list, several clock reference sources.
- Click Apply.

Top
Selecting the Port Used for Synchronisation
- Access the DGW Web interface of your unit.
- Go to System/Hardware.
- In the Clock Reference Configuration table, from the Suggestion selection list, choose SYNCIN.

Top
Associating a PRI Port to a Line Type and Protocol
- Go to System/Hardware.
- In the PRI Ports Configuration table, from the Line Type selection list, select either E1 or T1.
- From the Signaling selection list, associate a type of signaling to the PRI port.
- Click Apply.
- Restart the unit.
Top
Setting the Mediatrix Unit to Use the R2 Signaling Protocol

Top
Setting the Mediatrix Unit to Use the E&M Signaling Protocol

Top
Cabling Several Units for TDM Synchronisation
- Connect a standard Ethernet cable to the SYNC OUT port of the first device.
- Connect the other end of the Ethernet cable to the SYNC IN port of another device.
- Connect all your units in the same fashion.

Top
Hardware Advanced Parameters
Some aspects of the Hardware configuration can only be completed with the MIB parameters.
- using a MIB browser
- using the CLI
- creating a configuration script containing the configuration variables
Top
Endpoints State Configuration
Basic Endpoints State Concepts
Administrative State of Unit
The administrator can disable the use of specific endpoints or all endpoints of a unit through the administrative state configuration. It is also possible to select the initial endpoint state to be applied on unit start-up.
- in a multi-tenant environment, if a tenant stops its service subscription, the administrator can lock the unit so the FXS port can give either a fast busy tone or no tone to signal the line is decommissioned. Then later the administrator can send a technician on site to re-wire and make the port available to another tenant.
- if a user does not pay his service, the administrator can simply lock the endpoint.
- to prevent calls during unit maintenance
Top
Basic Endpoint State Tasks
Locking All Unit Endpoints - Gracefully
- Go to System/Endpoints.
- In the Unit States table, from the Action selection list, choose Lock.
- If the state of the unit is Idle or Idle Unusable, the unit is locked right away.
- If the unit is either Busy or Active, the unit will be
locked only when it will become Idle.
Top
Locking All Unit Endpoints - Immediately
- Go to System/Endpoints.
- In the Unit States table, from the Action selection list, choose Force Lock.

Top
Unlocking All Unit Endpoints
- Go to System/Endpoints.
- In the Unit States table, from the Action selection list, choose Unlock.

Top
Locking an Endpoint - Gracefully
- Go to System/Endpoints.
- In the Endpoint States table, from the Action selection list of an endpoint, choose Lock.
- If the state of the endpoint is Idle or Idle Unusable, the endpoint is locked right away.
- If the endpoint is either Busy or Active, the endpoint will be
locked only when the unit will become in Idle.
Top
Locking an Endpoint- Immediately
- Go to System/Endpoints.
- In the Endpoint States table, from the Action selection list of an endpoint, choose Force Lock.
Top
Unlocking an Endpoint
- Go to System/Endpoints.
- In the Endpoint States table, from the Action selection list of an endpoint, choose Unlock.
Top
Setting the Endpoint Behavior after a Unit Restart
- Go to System/Endpoints.
- In the Endpoint States table, from the Initial Administrative selection list of an endpoint, choose Lock or Unlock.
- If the Initial Administrative selection list is set to Lock, when the unit restarts, the endpoint will remain locked, therefore unusable.
- If the Initial Administrative selection list is set to Unlocked, when the unit restarts, the endpoint will become usable.
Top
Disabling the Unit Endpoints when No Gateways are Ready
- Go to System/Endpoints.
- In the Administration table, select Enable next to Disable Unit (All Endpoints) when No Gateways Are In State Ready .

Top
Shutting Down Endpoint if in Idle-Unusable State

Top
Disabling All Gateways when Trunk Lines are Down

Top
Advanced System/Endpoints Parameters
- using a MIB browser
- using the CLI
- creating a configuration script containing the configuration parameters
For more details on the following advanced parameters, refer to the DGW Configuration Guide - Reference Guide published on the Media5 Documentation Portal.
Setting the toggle delay to disable the SIP gateways when trunk lines are down
EpAdm.DisableSipGatewaysWhenTrunkLinesDownToggleDelaySetting the Behavior of the unit While in Shutting Down State
EpAdm.BehaviorWhileInUnitShuttingDownStateTop
Event Log
Basic Event Log Concepts
Event Notifications
An event is something that happens in the system and that needs to be reported. Event notifications are formatted text messages issued by the DGW software to signal something of interest to the unit administrator.
- for which service event notifications will be reported;
- which event notifications will be reported based on the severity level of the event;
- if a specific event notification should be reported or not;
- where the event notifications will be logged.
- Internal destination
- Log to File to a file in the DGW File management system (not available on the 4102S and the Mediatrix C7 series).
- Log Locally to the Local Logs page of the DGW Web interface.
- External destination
- to a SIP server via NOTIFY.
- to a Syslog server via syslog transport.
Top
Send via Syslog
Event notifications can be logged by a Syslog server.
Top
Send via SIP
It is possible to send the event notifications to a SIP server.
The event notifications sent to a SIP server are included in the SIP Notify messages. When choosing to send event notifications to a SIP server, it is not allowed to send all notifications, i.e. select the All criteria when configuring event notifications. This has been implemented to avoid sending high volumes of traffic and risking the overload of the SIP server.
The destination can be configured with the sipEp.sipNotificationsGateway parameter and the sipEp.maxNotificationsPerNotify parameter is used to define how many messages can be sent in a single "SIP NOTIFY" request the
For more details, refer to DGW Configuration Guide - Reference Guide published on the Media5 documentation portal at https://documentation.media5corp.com
Top
Log Locally
The DGW Local Log displays the Event Notifications related to the events occurring on the Mediatrix unit that are generated by the Mediatrix Notifications and Logging Manager (Nlm) service.
Notifications will be displayed in the Local Log Entries table of the DGW Web interface provided the issuing of events for a service is enabled, and if the event meets the selected severity level chosen to be reported.
- Number of displayed event notifications is limited
- Newer notifications replace older ones.
- The routing criteria should be designed to avoid overloading the log.
- The local log has no persistence. Its content is erased when the unit or the Nlm service is restarted.
- The local log does not accept messages from the SNMP service with a ‘Debug’ severity level. This is to prevent an issue when reading the local log with SNMP. The SNMP walk through the table would not catch up with the increasing index because of the DEBUG events generated by the SNMP service itself.
Top
Log to File
The event notifications can be logged in a file saved in the DGW File Management system.
Event notifications logged to a file will be available in the DGW Web interface, under Management/File tabs. The log to file feature is not available on the Mediatrix 4102S and C7 Series as they do not have more than 1MB or more user storage. The number of files stored in the unit is limited. When the maximal number is reached, the oldest stored file is deleted. The limit is configured in the LogFileMaxNb Mib parameter.
Top
Send via SNMP
The event notification can be sent via the SNMP transport.
- The traps will be sent according to the Trap Destination(s) and SNMP Protocols configured in the Management/SNMP tab of the unit.
- By default, Notifications are only sent at severity level Warning or higher. This means you will only get traps in case of an error. To also get the recovery events for a particular service, set its severity to « Info » in System/Event Log/Service Notification Configuration.
- For SNMP traps, the notification queue is limited to 100 notifications per second for bandwidth limitation purposes.
- Newer traps replace older ones.
- The routing criteria should be designed to avoid overloading the queue
Top
Basic Event Notification Tasks
Logging Event Notifications

Top
Logging Specific Event Notifications

Top
Disabling Event Notification Reporting for a Service
- Go to System/Event Log.
- In the Service Notification Configuration table, from the drop-down list located next to a service name, select Disable.
Top
Modifying the Severity Level Triggering the Reporting of a Notification
- Go to System/Event Log.
- In the Service Notification Configuration table, from the drop-down list located next to a service name, select the severity level an event should have to issue a notification.
Top
Local Log
Basic Local Log Tasks
Clearing the Local Logs
- Go to System/Local Log.
- Click Clear Local Log.
Top
Updating the Local Logs
- Go to System/Local Log.
- Click Refresh Local Log.
Top
Packet Capture
Basic Packet Capture Concepts
Packet Captures
Packet captures are data packets intercepted when passing through a specific computer network.
Captured packets can be sent to a specific location where they can be analysed. The content of the capture can therefore be used to diagnose or troubleshoot network problems and determine if network security policies are being followed.
- With the pcapture CLI command available only via the CLI. This method displays the captured packet directly in the CLI or allows streaming the captured packet to a SSH tunnel to a remote Wireshark client.
- With the Nlm.PCaptureStart command. This is a muse command, it can be executed via SNMP, a script, and the CLI. This is the same command used when performing packet captures via the DGW Web page. This method sends the captured file to a file or to a HTTP server via a standard HTTP upload.
- With the DGW Web Interface, under System/Packet Capture.
Top
Basic Packet Capture Tasks
Starting a Network Capture
Top
Starting a Network Capture on a Specific VLAN
This method is performed with the PCaptureStart command of the Nml service.
Top
Starting a Network Capture Remotely On Windows
- You must know the IP address of the unit running the DGW software.
- The Mediatrix unit must be running a DGW v2.0.39.689 firmware or higher.
- You must have a PC running Wireshark.
- The first time the unit is connected via plink/wireshark, do not forget to answer y to the Store key in cache? (y/n) question displayed in the CMD window.
- Make sure there are no other plink sessions already running.
Top
Starting a Network Capture Remotely On MacOS or Linux
- The Mediatrix unit must be running a DGW v2.0.17.285 firmware or higher.
- You must know the IP address of the unit running the DGW software.
- You must have a PC running Wireshark.
Top
Examples
Filter Examples
- Filter: port 5060
- Captures all traffic on (either source or destination) port 5060 (SIP)
- Filter: port 5060 and host 192.168.0.99
- Captures all traffic on port 5060 and source or destination IP 192.168.0.99
- Filter: port 5060 and dst host 192.168.0.99
- We can enter “dst” or “src” before “host” (or “port”) to specify the destination or source host (or port
- Filter: not broadcast and not multicast
- Filter out the broadcast and multicast traffic
Top
Examples of pcapture Commands for Windows
plink.exe -ssh -no-antispoof -pw "administrator" admin@192.168.0.10 "pcapture -raw -i eth1 not broadcast and not multicast" | wireshark -k -i -
Capture
from the uplink interface of the Mediatrix unit, the packets of the VLan for which the VlanId
is 100
only.plink.exe -ssh -no-antispoof -pw "administrator" admin@192.168.0.10 "pcapture -raw -i eth1.100" | wireshark -k -i -
Capture
from the uplink interface of the Mediatrix unit, the packets going through the Ethernet port
eth1, but using RTP
only.plink.exe -ssh -no-antispoof -pw "administrator" admin@192.168.0.10 "pcapture -raw -i eth1 -t rtp " | wireshark -k -i -
Capture
from the uplink interface of the Mediatrix unit, the packets going through the Ethernet port
eth1, but using port 5060 only (either source or
destination).plink.exe -ssh -no-antispoof -pw "administrator" admin@192.168.0.10 "pcapture -raw -i eth1 port 5060 " | wireshark -k -i -
Capture
from the uplink interface of the Mediatrix unit, the packets going through the Ethernet port
eth1, but using port 5060 as the source
only.plink.exe -ssh -no-antispoof -pw "administrator" admin@192.168.0.10 "pcapture -raw -i eth1 src port 5060 " | wireshark -k -i -
Capture
from the uplink interface of the Mediatrix unit, the packets going through the Ethernet port
eth1, but using port 5060 as the destination
only.plink.exe -ssh -no-antispoof -pw "administrator" admin@192.168.0.10 "pcapture -raw -i eth1 dst port 5060 " | wireshark -k -i -
Capture
the packets going through the Ethernet port eth1, for traffic for which the source or the
destination is the unit with the 00:90:F8:07:5A:6D MAC
address.plink.exe -ssh -no-antispoof -pw "administrator" admin@192.168.0.10 "pcapture -i eth1 ether host 00:90:F8:07:5A:6D " | wireshark -k -i -
Capture
the packets going through the Ethernet port eth1, for traffic for which the source or the
destination is the units whit the 10.5.128.11 or host 10.5.128.4 IP
addresses.plink.exe -ssh -no-antispoof -pw "administrator" admin@192.168.0.10 "pcapture -i eth1 host 10.5.128.11 or host 10.5.128.4 " | wireshark -k -i -
Top
Examples of pcapture Commands on MacOs and Linux
ssh admin@192.168.0.10 "pcapture -raw -i eth1 not broadcast and not multicast" | wireshark -k -i -
ssh admin@192.168.0.10 "pcapture -raw -i eth1.100" | wireshark -k -i -
Forces capture to interpret all packets as rtp packeta. Typically, this is used with a filter that only keeps rtp packets.
ssh admin@192.168.0.10 "pcapture -raw -i eth1 -T rtp " | wireshark -k -i -
Capture only rtp packets, going through the Ethernet port eth1, but using port 5006 only (either source or destination)
ssh admin@192.168.0.10 "pcapture -raw -i -T rtp eth1 port 5006 " |wireshark -k -i -
ssh admin@192.168.0.10 "pcapture -raw -i eth1 port 5060 " | wireshark -k -i -
ssh admin@192.168.0.10 "pcapture -raw -i eth1 src port 5060 " | wireshark -k -i -
ssh admin@192.168.0.10 "pcapture -raw -i eth1 dst port 5060 " | wireshark -k -i -
ssh admin@192.168.0.10 "pcapture -raw -i eth1 ether host 00:90:F8:07:5A:6D " | wireshark -k -i -
ssh admin@192.168.0.10 "pcapture -raw -i eth1 host 10.5.128.11 or host 10.5.128.4 " | wireshark -k -i -
Top
Diagnostic
Basic Diagnostic Concept
Diagnostic Traces
Diagnostic Traces are specifically used for troubleshooting purposes. As for Event Notifications, they report errors, warnings, or system information.
Diagnostic Traces do not need to be activated, except at the specific demand of Media5 Technical Assistance Center.
Top
Basic Diagnostic Trace Tasks
Enabling the Automatic Diagnostic Log Dump
- Go to System/Diagnostic.
- In the Diagnostic Log Configuration table, select Enable.
- Click Apply.
Top
Manually Starting a Diagnostic Log Dump
- Go to System/Diagnostic.
- In the Diagnostic Log Configuration table, select Dump Now.
Top
PCM Traces
Basic PCM Traces Concepts
PCM Traces
The PCM traces are two different RTP streams made specifically to record all analog or digital signals that are either sent or received by the telephony ports of the Mediatrix unit.
These RTP streams are sent to a configurable IP address, normally an IP address on your network where it can be recorded with a packet sniffer (such as Wireshark). Moreover, they are independent from the regular RTP streams of the VoIP call. On the analog devices, the streams are sent instantly at device start-up, with an average ptime of 5 ms. The resulting streams, depending on the model, are around 15 kB/s.
Only the configured port, port #1 and/or #2 send the PCM traces for a maximum of four simultaneous RTP streams.
All streams are sent instantly at start-up with an average ptime of 15 ms. This means that until the PCM traces are disabled, even an idle unit will continuously send up to 66.6 packets/s X 4 streams = 267 packets/s using approximately 174 bytes each, for a total of 46 Kbytes of upstream bandwidth.
On digital devices, the streams will be sent once a call is in process of being established (ISDN SETUP, SIP INVITE). This means no data will be sent if the gateway is idle with no calls in progress.
- Echo in the network
- DTMF signals
- Caller ID signals
- Fax signals (or false Fax detection)
- Message Waiting Indicator signals
- Any other analog signal
- Any voice quality issue
Top
Basic PCM Tasks
Enabling the PCM Traces - SIP 5.0


Top
Enabling the PCM Traces of a Port Using UMN

Top
Endpoint Examples
Endpoint Name | Description |
---|---|
Bri1-2 | BRI port 1, channel 2 |
Slot2/E1T1-3 | Channel 3 of the E1 port located in slot 2 |
Port09 | Port 09 of a Mediatrix 4108-16-24 unit |
Phone-Fax1 | Port 1 of a Mediatrix 4102S unit |
FXS1 | Port 1 of the FXS card of a Mediatrix C7 unit |
FXO1 | Port 1 of the FXO card of a Mediatrix C7 unit |
All possible endpoint names are listed in the Endpoint table displayed in the DGW Web interface (System/Endpoints). You may also access this table via the CLI by using the EpAdm.Endpoint command or directly via UMN.
Top
Enabling PCM Traces of a Port Using the Configuration Script

Top
VM
Virtual Machine Basic Concepts
Important Information on Virtual Machines
Top
RAM and SSD Sizes
Description | Possible Values |
---|---|
RAM size 1 |
|
SSD size 2 |
|
Top
RAM Allocation to Virtual Machines
To reduce the wear-and-tear of the Solid State Drive, make sure to allocate the maximum amount of RAM possible to the virtual machine.
Installed RAM on Mediatrix Units | Available RAM for Virtual Machine |
---|---|
2 Gb | 1.5 Gb |
4 Gb | 3.5 Gb |
8 Gb | 7 Gb ( 87.5% of available RAM) |
16 Gb | 10 Gb |
Top
VM name
The name is set when adding a new virtual machine with the CreateVm command. The user cannot modify the name after.
When the CreateVm command is called without a name, the index is used to generate a unique name such as VM_Index.
Top
VM Memory
When adding a VM with the CreateVm command, the amount of allocated memory is set; this amount cannot be modified after adding the VM.
When the CreateVm command is called without an amount of allocated memory, a minimal value of 128 MB is set.
- a minimum of 512 MB, or
- 12.5% of the total volatile memory capacity if more than 512 MB is available
Top
USB Usage
The VM config allows the user to associate none or all USB Ports to a virtual machine.
A USB port can be associated with one VM. The first VM that is configured with USB can use all available USB ports.
If an another VM tries to use a USB port already in use, the Vm service ignores this config and starts the VM as if it was configured with NONE, and sets its configuration status (ConfigStatus) to USBNotAvailable.
Top
Virtual Switch
Enabling the Virtual Switch with the Eth.Links.VirtualSwitch parameter grants network access to the VM. Once enabled, the virtual switch creates a bridge between the VM and the associated Ethernet link.
When the Virtual Switch is enabled, the Vm.Vm.NetworkAdapter parameter configures its virtualised network adapter.
Top
Behaviour on Factory Reset
The unit can be preinstalled with a factory-installed VM stored in the vm/images/factory folder. This folder can only be created in factory and must have the factory-installed VM files.
- When one or more factory-installed VM is present, VM images and configurations are returned to their original factory state.
- When no factory-installed VM is present, the VM images and configurations stay unchanged, i.e. the files present in vm/images/ are not erased.
- The files in the vm/images/ folder are erased, which removes the VM snapshots and all VMs created, modified, or installed by users.
- Note: this is done even if the vm/images/factory folder exists and is empty.
- For each factory-installed VM (visible in the vm/images/factory folder), the configuration file (.cfg) is copied in the vm/images folder and a snapshot of the VM image is also created in the vm/images folder. The snapshot file is given the .snapshot extension and is always in a QCOW2 format. When this VM is used, the snapshot file changes over time but the base image (located in vm/images/factory) is never modified, allowing the next factory reset to restore the factory VMs to their original state again.
- The admin can use, configure, convert, and delete a VM with a snapshot image like any other VM, but after a factory reset, the snapshot image is deleted and a new one is created.
- When a snapshot file is converted into a VM image file, the resulting file is a new image file combining the base VM plus the history contained in the snapshot file.
- Users cannot add or delete files on the vm/images/factory folder. This can only be done in factory.
- The VM images under vm/images/factory can have either the RAW or QCOW2 format.
- The RestoreAfterFactory parameter in the VM configuration file is ignored. The factory-installed VMs are always restored.
In all cases, the content of /vm/drives is erased.
Top
What are the Meltdown and Spectre Security Vulnerabilities
These vulnerabilities allow a non-privileged process to read sensitive data in memory, thus accessing privileged information from the kernel or other processes.
A Virtual Machine (VM) running inside the Sentinel 400 may be vulnerable to Meltdown (CVE-2017-5754) and to the two variants of Spectre (CVE-2017-5753 and CVE-2017-5715).
For more information on these vulnerabilities:
Top
How to Protect my VM against Spectre
There are different mitigation techniques against Spectre:
- Mitigation #1: A microcode update from the CPU vendor for better control over the branch speculation. Also need an updated kernel to enable these new features (IBRS and IBPB).
- Mitigation #2: Different techniques (like "retpoline" and "LFENCE") that require recompiling the kernel, packages and applications.
As the time this document was written, Mitigation #1 could not be applied, as Intel had not yet released a microcode update for the CPU of the Sentinel 400.
Top
How to Protect my VM against Meltdown
Linux kernels have a new feature called KPTI (previously known as KAISER) that protects against Meltdown.
If your Virtual Machine is vulnerable, Media5 recommends that you upgrade your kernel to a version that supports KPTI, and enable it.
Top
SSD Lifespan
Mediatrix units running a Virtual Machine are equipped with various sizes of Solid State Drive (SSD) for storage.
A Solid State Drive (SSD) is a form of flash-based storage. Media5 uses high quality, enterprise grade SSDs in its products. However due to its technical nature, flash memory can handle so many read/write cycles. Beyond that, the performance may degrade or in extreme cases, the drive may fail. For customers using a Mediatrix unit running a Virtual Machine, special attention should be paid to the number of writes caused by the Operating System running in the virtual machine, as well as by the application. If the Virtual Machine is not optimised, it will lead to excessive read/write access to the SSD, and hence significantly reduce the lifespan of the SSD. For more details, please refer to Technical Bulletins - Virtual machine installation published on the Media5 Documentation Portal.
Top
SSD Lifespan Extrapolation
SSD lifespan can be extrapolated and Virtual Machine optimisation can be validated.
For example, let the virtual machine run for a month (or a week), read and compare the WearPercentage parameter at different times during this interval. Use the collected information to extrapolate the lifespan.
For example: the Wear Percentage increased from 19% to 20% in 2 months. Take the remaining 80% divided by a monthly increase of 0.5% gives 160 months left. Therefore at least 13 years left at the current increase rate.
- disable some of the logging
- log to an external device
- assign more RAM to the Virtual Machine
- consider ordering a bigger SSD for future installations
Top
Is all the System Vulnerable?
The DGW firmware in the Mediatrix system, by itself, is not vulnerable since it does not allow running rogue code:
But it is theoretically possible, for a Virtual Machine compromised by the Spectre vulnerability, to read memory outside the Virtual Machine and access sensitive data of the Mediatrix system. The best protection against this is to secure your VM, to make sure there is no known means an attacker can use to break into your VM.
Media5 also recommends to always keep your Sentinel 400 up-to-date with to the latest DGW firmware version.
Top
Basic Virtual Machine Actions
Stopping the Virtual Machine
- Go to System/VM.
-
In the Virtual Machine Configuration
table, click
located on the same row as the VM you wish to stop.
Top
Stopping the Virtual Machine - Graceful Stop
Top
Rebooting a VM
- Go to System/VM.
-
Click
.
Top
Rebooting a VM - Graceful Reboot
Although the virtual machine can be rebooted via the Web page, rebooting the virtual machine using a VNC Client is the preferred way to reboot the virtual machine.
Top
Setting the Virtual Machine to Automatic Start
If the virtual machine you wish to start requires resources equivalent to the available resources on the unit, then it will not be possible to start another virtual machine. It is only possible to start a virtual if there are enough resources on the unit.
- Go to System/VM.
- In the Virtual Machine Configuration table, from the Startup dropdown list, select Auto.
- Click Apply.

Top
Setting the Virtual Machine to Manual Start
- Go to System/VM.
- In the Virtual Machine Configuration table, from the Startup dropdown list, select Manual.
- Click Apply.

Top
Deleting a VM
- Go to System/VM.
-
In the Virtual Machine Configuration
table, click
located on the same row as the virtual machine you wish to delete.
Top
Monitoring the SSD Wear Percentage Using the CLI
- Open the Command Line Interface ( CLI).
- At the prompt, enter the following command: Dcm.PersistentWearPercentage
Top
Monitoring the SSD Wear Percentage Using a MIB Browser
The Mediatrix UMN Mib browser can be used for this procedure.
Top
Virtual Machine Installation
Adding a Virtual Machine
You must have a virtual machine licence and the VM service must be started.

Top
Configuring the VM Network Adapter (VirtIO)
The virtual machine Network Adapter will be set to VirtIO.

Top
Installing the OS on the Virtual Machine Using an ISO image

Top
Installing the Virtual Machine OS using a USB External Device
The virtual machine will be started only if it is started manually

Top
Disabling Swap on Linux
Top
Virtual Machine Modification
Modifying the Virtual Machine Configuration
- Go to System/VM.
- In the Virtual Machine Configuration table, modify the fields as required.
- Click Apply.
Top
Network
Host
Basic Network Host Concepts
DNS Servers
The DNS server list is the ordered list of DNS servers that the device uses to resolve network names.
Up to four servers can be used. The DNS servers can be specified statically or obtained automatically (for example through DHCPor PPP). DNS query results are cached on the system to optimise name resolution time. For more details, refer to DGW Configuration Guide - DNS Behavior with Mediatrix Gateways published on the Media5 Documentation Portal.
Top
Simple Network Time Protocol (SNTP)
The Simple Network Time Protocol (SNTP) is used to update and synchronise the clock of the Mediatrix unit (day, month, time) when it is restarted.
Mediatrix units do not all include a real time clock allowing them to maintain accurate time when they are shutdown. Your system needs to have access to accurate time, for example if you are using HTTPS or for the caller ID feature. The Mediatrix unit implements a SNTP client, which can synchronise the local clock with remote NTP/SNTP servers. The configuration can be automatic (through DHCP for example), with fallback, or static, with up to four servers.
Top
Time Format
The time format (also known as 'TZ' format) is based on the format described by the IEEE 1003.1 standard (i.e. POSIX specification).
- The first part, mandatory, is the system timezone expressed in the IEEE 1003.1 POSIX format (also known as 'TZ' format).
- The second part, available since 46.0 is optional. It is the timezone used for the time displayed in some of the SBC Web pages (Live Calls, Events, and Registration). This part is only useful for units with the Sbc service. This string must be expressed in the IANA format. If this part is not present, the UTC time zone is used on the SBC Web pages.
STDOFFSET[DST[OFFSET],[START[/TIME],END[/TIME]]]
where: STD / DST
: Three or more characters for the standard (STD) or alternative daylight saving time (DST) time zone. Only STD is mandatory. If DST is not supplied, the daylight saving time does not apply. Lower and upper case letters are allowed. All characters are allowed except:- digits
- leading colon (:)
- comma (,)
- minus (-)
- plus (+), and
- ASCII NUL.
OFFSET
: Difference between the GMT time and the local time. The offset has the format h[h][:m[m][:s[s]]]. If no offset is supplied for DST, the alternative time is assumed to be one hour ahead of standard time. One or more digits can be used; the value is always interpreted as a decimal number.- The hour value must be between 0 and 24. IMPORTANT: If preceded by a minus sign (-), the time zone is east of the prime meridian, otherwise it is west, which can be indicated by the preceding plus sign (+). For example, New York time is GMT 5.
- The minute and second values, if present, must be between 0 and 59.
- The hour value must be between 0 and 24.
START / END
Indicates when to change to and return from the daylight saving time. The START argument is the date when the change from the standard to the daylight save time occurs; END is the date for changing back. If START and END are not specified, the default is the US Daylight saving time start and end dates. The format for start and end must be one of the following:- n where n is the number of days since the start of the year from 0 to 365. It must contain the leap year day if the current year is a leap year. With this format, you are responsible to determine all the leap year details.
- Jn where n is the Julian day number of the year from 1 to 365. Leap days are not counted. That is, in all years – including leap years – February 28 is day 59 and March 1 is day 60. It is impossible to refer to the occasional February 29 explicitly. The TIME parameter has the same format as OFFSET but there can be no leading minus (-) or plus (+) sign. If TIME is not specified, the default is 02:00:00.
- Mx[x].y.z where x is the month, y is a week count (in which the z day exists) and z is the day of the week starting at 0 (Sunday). For instance: M10.4.0 is the fourth Sunday of October. It does not matter if the Sunday is in the 4th or 5th week. M10.5.0 is the last Sunday of October (5 indicates the last z day). It does not matter if the Sunday is in the 4th or 5th week. M10.1.6 is the first week with a Saturday (thus the first Saturday). It does not matter if the Saturday is in the first or second week. The TIME parameter has the same format as OFFSET but there can be no leading minus (-) or plus (+) sign. If TIME is not specified, the default is 02:00:00.
Top
Time Format Examples

Time Zone | String | IANA format (Optional, 46.0+) |
---|---|---|
Atlantic Time (Canada) | AST4ADT,M3.2.0,M11.1.0 | America/Halifax |
Australia Eastern Standard Time | AEST-10AEDT,M10.1.0,M4.1.0/3 | Australia/Sydney |
Central European Time | CET-1CEST,M3.5.0,M10.5.0/3 | Europe/Brussels |
Central Time (Canada & US) | CST6CDT,M3.2.0,M11.1.0 | America/Chicago |
China Standard Time | CST-8 | Asia/Shanghai |
Eastern Time Canada & US) | EST5EDT,M3.2.0,M11.1.0 | America/Toronto |
Greenwich Mean Time | GMT0BST,M3.5.0/1,M10.5.0 | Europe/London |
Mountain Time (Canada & US) | MST7MDT,M3.2.0,M11.1.0 | America/Denver |
Pacific Time (Canada & US) | PST8PDT,M3.2.0,M11.1.0 | America/Los_Angeles |
Japan Standard Time | JST-9 | Asia/Tokyo |
UTC (Coordinated Universal Time) | UTC0 | Etc/UTC |
Western Europe Time | WET0WEST,M3.5.0/1,M10.5.0 | Europe/Lisbon |
Top
Basic Network Host Tasks
Choosing the Network Providing the IPv4 Automatic configuration
- Go to Network/Host.
- In the Automatic Configuration Interface table, from the Automatic IPv4 config source network selection list, choose a network.
- Click Apply.
Top
Choosing the Network Providing the IPv6 Automatic configuration
- Go to Network/Host.
- In the Automatic Configuration Interface table, from the Automatic IPv6 config source network selection list, choose a network.
- Click Apply.
Top
Configuring the Host Name and Domain Name of the Mediatrix Unit
Top
Configuring the Default Network Gateway to a Static IP Address
- Go to Network/Host.
- In the Default Gateway Configuration table, from the IPv4/Configuration Source selection list, select Static.
- In the IPv4/Default Gateway field, enter the IP address used as the Static Default Router for the Uplink Network Interface.
- In the Default Gateway Configuration table, from the IPv6/Configuration Source selection list, select Static.
- In the IPv6/Default Gateway field, enter the IP address used as the Static Default Router for the Uplink Network Interface.
- Click Apply.

Top
Configuring the Default Network Gateway to an Automatic IP Address

Top
Configuring DNS Servers - Automatically
- Go to Network/Host.
- In the DNS Configuration table, from the Configuration Source selection list, choose Automatic IPv4 or Automatic IPv6 .
- Click Apply.

Top
Configuring DNS Servers - Manually
Top
Configuring the SNTP Server to a Static IP Address

Top
Configuring the SNTP Server to an Automatic IP Address

Top
Configuring the SNTP Server to an Automatic IP Address with Fallback

.
Top
Configuring the Mediatrix Unit to Use an SNTP Server

Top
Selecting the Unit's Time Zone
Any DGW parameter referring to a time value will use the local time described by this time zone reference. The Hoc.SystemTime will return the unit local time in accordance with the configured time zone.
Top
Advanced Network Host Parameters
- using a MIB browser
- using the CLI
- creating a configuration script containing the configuration parameters
Configuring Dns Cache Randomisation:
- Hoc.DnsCacheRandomization
Configuring Pre-resolved Static FQDNs
Up to 10 pre-resolved FQDNs can be configured. The StaticHosts table allows configuring FQDNs with static IP addresses. When a device attempts to reach a FQDN configured in this table, the static IP addresses will be used instead of resolving the FQDN.- Hoc.InsertStaticHost: To insert a new static host
- Hoc.StaticHosts.Delete: To delete a static host:
Updating the system name or system location
The name and location of the Mediatrix unit can be specified. This information is for display purposes only and does not affect the behavior of the unit.- Hoc.SystemName: To set the system name
- Hoc.SystemLocation: Set the system location
Top
Interfaces
Basic Interface Concepts
IP Address Reservation
Before connecting the Mediatrix unit to the network, Media5 strongly recommends to reserve an IP address in your network server – if using one – for the unit you are about to connect.
This way, the IP address associated with a particular unit will be known. Network servers generally allocate a range of IP addresses for use on a network and reserve IP addresses for specific devices using a unique identifier for each device. The Mediatrix unit unique identifier is the media access control (MAC) address. Refer to Locating the MAC Address of Your Mediatrix Unit.
Top
Locating the MAC Address of Your Mediatrix Unit
- printed on a label located under the Mediatrix unit
- displayed in the Current Status table of the Web Interface (System/Information)
Top
Important Information About Network Interfaces
Naming
- The name of the network interface is case sensitive.
- Using the special values All, Loop, LoopV6, and Rescue are not allowed to name a network interface
- A valid network interface name:
- must start with a letter
- cannot contain characters other than letters, numbers, and underscores
Configuration
- It is not possible to have different IP addresses from the same subnet on one interface.
- It is possible to create up to 48 network interfaces.
- LLDP cannot be activated on multiple network interfaces simultaneously.
- If no network is configured in IPv6, the unit does not have any IPv6 address, not even the Link-Local address. When a network is configured in IPv6, the Link-Local (FE80 ::...) address is automatically created and displayed in the Network Status information.
- In case of address conflicts between two or more network interfaces, the network interface with the highest priority will remain enabled and the other interfaces will be disabled. If the priority is the same, only the first enabled network interface will be able to use the IP address. When a conflict ends, all network interfaces concerned automatically return to an operational state.
- Media5 recommends to reserve an IP address with an infinite lease for each Mediatrix unit on the network.
- The Rescue Network Interface cannot be deleted.
Top
Default Network Interfaces
There are four Network Interfaces created by default on the Mediatrix unit: Uplink, Lan 1, UplinkV6, and Rescue.
- The Uplink network interface defines the uplink information required by the Mediatrix unit to properly connect to the WAN. (By default eth1 for all platforms, except for the 4102S which is WAN . By default, this interface uses the IpDhcp (IPv4 DHCP) connection type. If you are using only one Network Interface, you must use Uplink.
- The Lan1 network interface defines the information required by the Mediatrix unit to properly connect to the LAN.(By default eth2-5 for all platforms, except for the 4102 which is LAN) By default, the Lan1 Network Interface uses the IpStatic (IPv4 Static) connection type. The Lan1 network interface can only be added on units with 2 network ports.
- The Rescue network interface,
is used to display the Rescue
Management Interface when a partial reset of the unit is performed. By default, the
Rescue network interface
- is disabled and automatically enabled when a partial reset is performed.
- uses the IpStatic (IPv4 Static) or the Ip6Static (IPv6 Static) addresses.
- The UplinkV6 network interface defines the IPv6 uplink information required by the Mediatrix unit to properly connect to the WAN. By default, this interface uses the IP6autoConf (IPv6 Auto-Conf) configuration mode.
Top
Link Default Values for the Uplink Network Interface
Unit Type | Link Default Value |
---|---|
Sentinel 400 | eth1 |
Sentinel 100 | eth1 |
Mediatrix G7 | eth1 |
Mediatrix S7 | eth1 |
Mediatrix C7 series | eth1 |
Mediatrix 4104 | eth1/eth |
Mediatrix 4108/16/24 | eth1 |
Mediatrix 4102S | Wan |
Mediatrix 4400 series | eth1 |
Mediatrix LP series | eth1 |
Mediatrix 4108 IPPBX | eth1 |
Top
Link Default Values for the Lan1 Network Interface
Unit Type | Link Default Value |
---|---|
Sentinel 400 | eth2-5 |
Sentinel 100 | eth2-5 |
Mediatrix G7 series | eth2-5 |
Mediatrix S7 series | eth2-5 |
Mediatrix C7 series | eth2 |
Mediatrix 4104 | eth2 |
Mediatrix 4108/16/24 | eth2 |
Mediatrix 4102 | lan |
Mediatrix 4400 series | eth2 |
Mediatrix LP series | eth2 |
Mediatrix 4108 IPPBX | eth2 |
Top
Link Layer Discovery Protocol (LLDP)
The Link Layer Discovery Protocol (LLDP) service is used by network devices for advertising their identity, capabilities, and neighbors on a IEEE 802 local area network, usually wired Ethernet.
LLDP cannot be activated on more than one network interface at a time.
Top
Link Connectivity Detection
Each Ethernet port of the Mediatrix unit is associated with an Ethernet link.
An Ethernet link has connectivity if at least one of its port status is not disconnected. The link connectivity is periodically polled (every 500 milliseconds). It takes two consecutive detections of the same link state before reporting a link connectivity transition. This avoids reporting many link connectivity transitions if the Ethernet cable is plugged and unplugged quickly.
Top
PPP Negotiation
When the Mediatrix unit restarts, it establishes the connection to the access concentrator in conformance with RFC 2516 section 5.1.
- Discovery phase: The Mediatrix unit broadcasts the value of the Service
Name field. The access concentrator with a matching service name answers the Mediatrix
unit.
- If no access concentrator answers, this creates a PPPoE failure error.
- If more than one access concentrators respond to the discovery, the Mediatrix unit tries to establish the PPP connection with the first one that supports the requested service name.
- Authentication phase: If the access concentrator requests authentication, the Mediatrix unit sends the ID/secret pair configured in the User Name and Password fields. If the access concentrator rejects the authentication, this creates an “authentication failure” error.
- Network-layer protocol phase: The Mediatrix unit negotiates an IP address. The requested IP address is the one from the last successful PPPoE connection. If the Mediatrix unit never connected by using PPPoE (or after a factory reset), it does not request any specific IP address.
Top
IPv6 Autoconfiguration Interfaces
When the Type drop-down menu is set to IPv6 Auto-Conf, the network interface is an IPv6 over Ethernet connection with IP parameters obtained by stateless auto-configuration or stateful (DHCPv6) configuration.
- The router explicitly required stateful autoconfiguration by setting the “managed” or “other” flag of the router advertisement.
- No router advertisement was received after 3 router solicitations. RFC 4861 defines the number of router solicitations to send and the 4 seconds interval between the sent router solicitations.
Top
Stateless Autoconfiguration
All IPv6 addresses present in the router advertisements are applied to the network interface
- GU (Global Unique)
- UL (Unique Local)
- LL (Link-Local)
Top
Spanning Tree Protocol vs Stateless Autoconfiguration
Many network switches use the Spanning Tree Protocol (STP) to manage Ethernet ports activity.
STP uses a detection timeout before a router advertisement is sent to the Mediatrix unit. The default value for this timeout is usually 30 seconds. However, when the unit wants to get an IPv6 address in Stateless autoconfiguration, this timeout is too long and the unit falls into Stateful Autoconfiguration mode before it receives the router advertisement. This results in the unit receiving a DHCPv6 address. To solve the issue, check if the default STP detection timeout value in your router can be modified. If so, set it to a value of 8 s or less. If you cannot modify the timeout value, Media5 recommends to disable the Spanning Tree Protocol on the network to which the unit is connected.
Top
Statefull Autoconfiguration
Stateful autoconfiguration is managed by DHCPv6. The DHCPv6 lease is negotiated according to the limitations listed in section 1.5 of RFC 3315.
- IPv6 addresses (when the router advertisement “managed” flag is set)
- Other configuration (when the router advertisement “other” flag is set)
Top
Speed and Duplex Detection Issues
There are two protocols for detecting the Ethernet link speed: parallel detection and auto-negotiation (IEEE 802.3u).
The auto-negotiation protocol allows the detection of the connection speed and duplex mode. It exchanges capabilities and establishes the most efficient connection. When both endpoints support the auto-negotiation, there are no problems. However, when only one endpoint supports auto-negotiation, the parallel detection protocol is used. This protocol can only detect the connection speed; the duplex mode cannot be detected. In this case, the connection may not be established. The Mediatrix unit has the possibility to force the desired Ethernet link speed and duplex mode by disabling the auto-negotiation and selecting the proper setting. When forcing a link speed at one end, be sure that the other end (a hub, switch, etc.) has the same configuration. To avoid any problem, the link speed and duplex mode of the other endpoint must be exactly the same.
Top
Basic Interface Tasks
Creating a Network Interface
- Media Interface Configuration table under the SBC/ Configuration tabs (provided you have the Sbc service)
- Signaling Interface Configuration table under SBC/ Configuration tabs (provided you have the Sbc service)
- DHCP Server Configuration table under the Network/ DHCP Server tabs
- Signaling Network table under the SIP/Gateways tabs
- Network Interface table under the SIP Proxy/Configuration tabs.
- Network Interface table under the Management/Misc tabs.
- Forward To Network table under the Network/IP Routing tabs.
Top
Configuring a Network Interface
Top
Associating an Ethernet Link to a Network Interface

Top
Configuring the PPPoE Connection Type
- Go to Network/Interfaces.
- In the PPPoE Configuration table, complete the fields as required.
- Click Apply.
Top
Configuring the Link Layer Discovery Protocol (LLDP)
Top
Configuring a Link as a Virtual Switch
- Go to Network/Interfaces.
- In the Ethernet Link Configuration table, from the Virtual Switch selection list, select Enable located on the same row as the link you wish to enable for the virtual switch.
- Click Apply.

Top
Configuring the Ethernet Link linked to a Network Interface
Top
Selecting the IEEE 802.1x Version
- Go to Network/Interfaces.
- In the EAP 802.1x Configuration table, select the IEEE 802.1x version.
- Click Apply if you do not need to set other parameters.

Top
Advanced Network Interface Parameters
- using a MIB browser
- using the CLI
- creating a configuration script containing the configuration parameters
Network Interfaces Priority
Refer to eth.networkInterfacesPriorityDHCP Client Identifier Presentation
Refer to bni.dhcpClientIdentifierPresentationEthernet Connection Speed
Refer to eth.portsSpeedTop
VLAN
Basic VLAN Tasks
Creating a VLAN
Top
Associating a VLAN to an Ethernet Link
- Go to Network/VLAN.
- From the Link selection list, select the Ethernet link the VLAN interface will use.
- In the VlanId field, set the VLAN ID used by the VLAN interface.
- In the VLAN configuration table, click +.
- Set the default user priority value.
- To create another VLAN, repeat steps 1 to 5.
- Click Apply.

Top
Configuring the Default User Priority on an Existing VLAN
Top
Configuring the Default User Priority on a New VLAN
Top
QoS
Basic QoS Concepts
Quality of Service (QoS)
QoS (Quality of Service) features enable network managers to decide on packet priority queuing.
- Differentiated Services (DS) Field (for IPv4)
- Traffic Class Field (for IPv6)
- 802.1Q taggings
Top
Differentiated Services (DS) Field (for IPv4 only)
Differentiated Services (DiffServ, or DS) is a protocol for specifying and controlling network traffic by class so that certain types of traffic (for example voice traffic which requires a relatively uninterrupted flow of data) might get precedence over other kinds of traffic.
DiffServ replaces the first bits in the ToS byte with a differentiated services code point (DSCP). It uses the existing IPv4 Type of Service byte. In DGW the entire ToS byte is currently configurable, thus the ToS decimal value is used. Please refer to:
- https://tools.ietf.org/html/rfc2474 for the definition of the Differentiated Services Field (DS Field) in the IPv4 and IPv6 Headers.
- https://en.wikipedia.org/wiki/Differentiated_services for the differentiated services.
TOS (Dec) | TOS (Hex) | TOS (Bin) | TOS Precedence (Bin) | TOS Precedence (Dec) | TOS Precedence Name | TOS Delay flag | TOS Throughput flag | TOS Reliability flag | DSCP (Bin) | DSCP (Hex) | DSCP (Dec) | DSCP/PHB Class |
---|---|---|---|---|---|---|---|---|---|---|---|---|
0 | 0x00 | 00000000 | 000 | 0 | Routine | 0 | 0 | 0 | 000000 | 0x00 | 0 | none |
4 | 0x04 | 00000100 | 000 | 0 | Routine | 0 | 0 | 1 | 000001 | 0x01 | 1 | none |
8 | 0x08 | 00001000 | 000 | 0 | Routine | 0 | 1 | 0 | 000010 | 0x02 | 2 | none |
12 | 0x0C | 00001100 | 000 | 0 | Routine | 0 | 1 | 1 | 000011 | 0x03 | 3 | none |
16 | 0x10 | 00010000 | 000 | 0 | Routine | 1 | 0 | 0 | 000100 | 0x04 | 4 | none |
32 | 0x20 | 00100000 | 001 | 1 | Priority | 0 | 0 | 0 | 001000 | 0x08 | 8 | cs1 |
40 | 0x28 | 00101000 | 001 | 1 | Priority | 0 | 1 | 0 | 001010 | 0x0A | 10 | af11 |
48 | 0x30 | 00110000 | 001 | 1 | Priority | 1 | 0 | 0 | 001100 | 0x0C | 12 | af12 |
56 | 0x38 | 00111000 | 001 | 1 | Priority | 1 | 1 | 0 | 001110 | 0x0E | 14 | af13 |
64 | 0x40 | 01000000 | 010 | 2 | Immediate | 0 | 0 | 0 | 010000 | 0x10 | 16 | cs2 |
72 | 0x48 | 01001000 | 010 | 2 | Immediate | 0 | 1 | 0 | 010010 | 0x12 | 18 | af21 |
80 | 0x50 | 01010000 | 010 | 2 | Immediate | 1 | 0 | 0 | 010100 | 0x14 | 20 | af22 |
88 | 0x58 | 01011000 | 010 | 2 | Immediate | 1 | 1 | 0 | 010110 | 0x16 | 22 | af23 |
96 | 0x60 | 01100000 | 011 | 3 | Flash | 0 | 0 | 0 | 011000 | 0x18 | 24 | cs3 |
104 | 0x68 | 01101000 | 011 | 3 | Flash | 0 | 1 | 0 | 011010 | 0x1A | 26 | af31 |
112 | 0x70 | 01110000 | 011 | 3 | Flash | 1 | 0 | 0 | 011100 | 0x1C | 28 | af32 |
120 | 0x78 | 01111000 | 011 | 3 | Flash | 1 | 1 | 0 | 011110 | 0x1E | 30 | af33 |
128 | 0x80 | 10000000 | 100 | 4 | FlashOverride | 0 | 0 | 0 | 100000 | 0x20 | 32 | cs4 |
136 | 0x88 | 10001000 | 100 | 4 | FlashOverride | 0 | 1 | 0 | 100010 | 0x22 | 34 | af41 |
144 | 0x90 | 10010000 | 100 | 4 | FlashOverride | 1 | 0 | 0 | 100100 | 0x24 | 36 | af42 |
152 | 0x98 | 10011000 | 100 | 4 | FlashOverride | 1 | 1 | 0 | 100110 | 0x26 | 38 | af43 |
160 | 0xA0 | 10100000 | 101 | 5 | Critical | 0 | 0 | 0 | 101000 | 0x28 | 40 | cs5 |
176 | 0xB0 | 10110000 | 101 | 5 | Critical | 1 | 0 | 0 | 101100 | 0x2C | 44 | voice-admit |
184 | 0xB8 | 10111000 | 101 | 5 | Critical | 1 | 1 | 0 | 101110 | 0x2E | 46 | ef |
192 | 0xC0 | 11000000 | 110 | 6 | InterNetwork Control | 0 | 0 | 0 | 110000 | 0x30 | 48 | cs6 |
224 | 0xE0 | 11100000 | 111 | 7 | Network Control | 0 | 0 | 0 | 111000 | 0x38 | 56 | cs7 |
Top
Network Traffic Control
It is possible to apply bandwidth limitations to the network interfaces.
The limitations are applied on the raw data of the physical link and not only on the payload of the packets. All headers, checksums and control bits (TCP, IP, CRC, etc.) are considered in the actual bandwidth. A bandwidth limitation is applied on a physical link and not on a virtual network interface. All high-level network interfaces (including VLANs) using the same physical link are affected by a configured limitation. This limitation is applied to outgoing traffic only (egress). Bandwidth limitation is an average of the amount of data sent per second. Thus, it is normal that the unit sends a small burst of data after a period of silence.
Top
Basic QoS Tasks
Creating the Default Unit QoS
Top
Configuring the Default User Priority on Physical Links (802.1Q Tagging)
Top
Overriding the DiffServ and QoS Service Class Default Values
- Go to Network/QoS.
- In the Service Class Configuration table, for each service class, set for IPv4 packets the DiffServ value or the Traffic Class value for IPv6 packets, .
- Set a specific User Priority for each class under the User Priority column.
- Click Apply.
- Click restart required services, located at the top of the page.
Top
Configuring Network Traffic Control
Top
Example
Default Unit QoS and Service Class Configuration for IPv4
Any IPv4 packet sent from the unit has the value applied in the Default DiffServ (IPv4) field of the Differentiated Services Field Configuration table under Network/QoS tab. This default value is overridden on what concerns the specific service classes defined under the same area and in the Service Class Configuration table.



Top
Local Firewall
Basic Local Firewall Concepts
Local Firewall
The local firewall allows you to create and configure rules to filter incoming packets that have the Mediatrix unit as destination.
The Local Firewall is therefore a security feature that allows you to protect your Mediatrix unit from receiving packets from unwanted or unauthorized peers. As a best practice, the way the Local Firewall should work is to, by default, drop all incoming packets (i.e. not forward the packet to its destination) and let incoming packets go through only if they match a rule requirements. However, incoming packets for an IP communication established by the Mediatrix unit are always accepted (Example : If the Mediatrix unit sends a DNS request, the answer will be accepted).
When configuring the Local Firewall, enabling the default policy to drop all incoming packets should be the last step you perform otherwise, you may lose contact with the Mediatrix unit, even if you are performing the initial configuration of your system. Therefore, start by creating the rules that allow the Mediatrix unit to accept some packets. This way communication will not be lost and you will not need to perform a partial or factory reset to reconnect with the Mediatrix unit.
You can use a maximum of 20 rules, but the more rules are enabled, the more overall performance is affected.
Top
Firewall Rule Order - Important
The order in which the incoming packets are tested against the rules is important if you want to make sure that they actually have a filtering effect on incoming packets.
Rules can be configured to accept or to decline packets. But, always put the most restrictive rules first as they are executed sequentially starting with the first one listed at the top of the table i.e. make sure that the order in which the rules are executed does not cause a rule to be systematically excluded.
- If the first rule excludes all packets coming from a specific net mask, providing a second rule for an IP address with that same net mask will have no effect.
- If the first rule indicates actions to be taken for a specific IP address with a given net mask, and the second rule indicates to exclude all IP addresses with that net mask, both rules will be applied and have a result on the incoming packets.
Top
Basic Local Firewall Tasks
Configuring the Local Firewall
If a rule with the Black listing enable box checked matches a packet and no Rate Limit Value was set, then the source address of the packet will be black listed and all packets coming from this address will be blocked for the duration of the Blacklist Timeout.
If a rule with the Black listing enable box checked matches a packet and the Rate Limit Value has been reached, then the source address of the packet will be black listed and all packets coming from this address will be blocked for the duration set for the Blacklist Rate Limit Timeout.
Top
Disabling the Local Firewall
Top
Setting the No Match Local Firewall Default Policy
Top
Configuring Black Listing Duration
If a rule with the Black listing enable box checked matches a packet and no Rate Limit Value was set, then the source address of the packet will be black listed and all packets coming from this address will be blocked for the duration of the Blacklist Timeout.
If a rule with the Black listing enable box checked matches a packet and the Rate Limit Value has been reached, then the source address of the packet will be black listed and all packets coming from this address will be blocked for the duration set for the Blacklist Rate Limit Timeout.
Top
Local Firewall Examples
Generic Whitelist
All incoming calls are dropped unless they match one of the firewall rules which are acting on the incoming packets going towards the Mediatrix gateway.

Result:
Rule # | |
---|---|
1 | Any incoming packet from the LAN subnet having the unit's LAN host IP address as a destination is allowed. |
2 | Any incoming packet from the Uplink subnet is allowed (assuming this is a private network). |
3 | Any HTTP incoming packet from the selected IP address having the unit's Uplink IP address as a destination through TCP port 80 is allowed. |
4 | Any HTTPS incoming packets from the selected IP address having the unit's Uplink IP address as a destination through TCP port 443 is allowed, but rate limited to 10 new connection attempts per 60 sec. |
5 | Any SSH incoming packets from the selected subnet having the unit's Uplink IP address as a destination through TCP port 22 is allowed. |
6 | Any SIP incoming packets from the selected subnet having the unit's Uplink IP address as a destination through UDP port 5060 is allowed. |
7 | Any RTP and T.38 incoming packet from the selected subnet having the unit's Uplink IP address as a destination through UDP port range 5004-6020 is allowed. |
Default | All other incoming packets are rejected. |
Top
Whitelist for Internet Hacker Protection
Simple Local Firewall rules to protect the unit from Internet hackers. All incoming calls are dropped unless they match one of the local firewall rules which are acting on the incoming traffic towards the Mediatrix gateway.

Result:
Rule # | Description |
---|---|
1 | Any incoming packet from the LAN subnet is allowed. |
2 | Any incoming packet from the Uplink subnet is allowed (assuming this is a private network). |
3 | Any incoming packet from selected IP address is allowed (e.g. this is the management server). |
4 | Any incoming packet from the selected subnet is allowed (e.g. this is the Core SIP server, SBC and its media gateways). |
Default | Any incoming packet not meeting the criteria of these rules is dropped. |
Top
Generic Blacklist
The default policy is set to "Accept" but the firewall rules are Blacklists acting on incoming traffic towards the Mediatrix gateway:

Result:
Rule # | Description |
---|---|
1 | Any incoming packet going to the Uplink interface through TCP port 22 (SSH) is dropped. |
2 | Any incoming packet coming from the specified subnet is dropped. |
3 | Any HTTP incoming packet coming from the specified IP address to the Uplink interface through TCP port 80 is dropped. |
4 | Any incoming packet from the specified subnet to the Lan1 interface is rejected, and an ICMP message is returned. |
5 | Any SIP incoming packets from the specified IP address to the Lan1 interface through UDP port 5060 is rate limited to 10 new connection attempts per 60 sec. |
Default | All other incoming packets are accepted. |
Top
IP Routing
Basic IP Routing Concepts
Important Information About IP Routing
- The Mediatrix unit’s IP Routing settings do not support IPv6.
- A packet matching a route uses the custom routing table first and then the main routing table if no route in the custom routing table was able to send the packet to the desired destination IP address.
- When creating an advanced IP routing Rule, leaving the Source Address or/and Source Link fields empty, indicate that any source of address or/and link will match the rule
- IP Routing works together with the following services:
- Network Firewall
- NAT
- DHCP server
- Network Traffic Control
- When the IP Routing service is started and the IPv4 Forwarding is enabled, IP routing is activated even if there is no configured rule (the Mediatrix unit will forward received packets). If the IP Routing service is stopped, IP forwarding is disabled, this tab is greyed out and the parameters are not displayed.
- Enabling the IP routing service and adding rules has an impact on the Mediatrix unit’s
overall performance as IP routing requires additional processing. The more rules are
enabled, the more overall performance is affected. Note: Media5 recommends to use a 30 ms packetization time when IP routing is enabled (instead of a 20 ms ptime, for instance) in order to simultaneously use all the channels available on the unit.
Top
IP Routing Rule Order - Important
Top
Static IPv4 vs Advanced IP Routing
Network IP routing defines the routes for outgoing network traffic, where each route is associated with a network interface. The selection of which route a network packet should follow is generally based on the destination IP address criteria.
The Static IPv4 Routes are used to specify additional routes from the default ones automatically created by the configuration of the various network interfaces (see the BNI service).
The Advanced IP Routes are used only when IPv4 Forwarding is enabled, and allow to select a route, not just from the destination IP address, but also from the source IP address and interface criteria.
Top
Basic IP Routing Tasks
Enabling IPv4 Forwarding
- Go to Network/IP Routing.
- In the IP Routing configuration table, select Enable.
- Click Save.

Top
Creating an IP Routing Rule

Top
Creating a Static IPv4 Route

The current routes available are displayed in the Network/Status under the IP4 Routes IPv4 Routes table.

Top
Advanced IP Routing Parameters
- using a MIB browser
- using the CLI
- creating a configuration script containing the configuration parameters
- To define whether or not the Classless Static Route Option is enabled: Bni.DhcpClientClasslessStaticRouteOption
- To define a list of user classes: Bni.DhcpClientUserClass
Top
IP Routing Configuration Examples
Top
Network Firewall
Basic Network Firewall Concepts
Network Firewall
The Network firewall allows you to dynamically create and configure rules to filter incoming packets forwarded by the Mediatrix unit among its network interfaces, when the unit is used as a router. Its main functionality is to secure the traffic routed from and to the devices inside the local network.
Since this is a network firewall, rules only apply to incoming packets forwarded by the unit. The traffic is analyzed and filtered by all the rules configured. If no rule matches the incoming packet, the default policy is applied. A rule's priority is determined by its index in the table. Rules using Network Names are automatically updated as the associated IP addresses and network mask are modified. If the Network Firewall service is stopped, all forwarded traffic is accepted, this tab is greyed out and the parameters are not displayed.
Of course, the more rules are enabled, the more overall performance is affected. You can use a maximum of 20 rules.
Top
Firewall Rule Order - Important
The order in which the incoming packets are tested against the rules is important if you want to make sure that they actually have a filtering effect on incoming packets.
Rules can be configured to accept or to decline packets. But, always put the most restrictive rules first as they are executed sequentially starting with the first one listed at the top of the table i.e. make sure that the order in which the rules are executed does not cause a rule to be systematically excluded.
- If the first rule excludes all packets coming from a specific net mask, providing a second rule for an IP address with that same net mask will have no effect.
- If the first rule indicates actions to be taken for a specific IP address with a given net mask, and the second rule indicates to exclude all IP addresses with that net mask, both rules will be applied and have a result on the incoming packets.
Top
Basic Network Firewall Tasks
Configuring the Network Firewall

Top
Disabling the Network Firewall
Top
Configuring Black Listing Duration
If a rule with the Black listing enable box checked matches a packet and no Rate Limit Value was set, then the source address of the packet will be black listed and all packets coming from this address will be blocked for the duration of the Blacklist Timeout.
If a rule with the Black listing enable box checked matches a packet and the Rate Limit Value has been reached, then the source address of the packet will be black listed and all packets coming from this address will be blocked for the duration set for the Blacklist Rate Limit Timeout.
Top
Firewall Port Opening Example
This generic example shows how to allow remote clients to communicate with the IP office located at the LAN side of the Mediatrix unit.
- The default policy is Drop, meaning that any packet that does not match the network firewall rules configured in the Network Firewall Configuration table will be dropped.
- To use the network firewall, IPv4 Forwarding (under IP Routing" tab), must be enabled. Without the forwarding, the network firewall is irrelevant because no packet will get passed from Uplink to LAN.

Rule | |
---|---|
1 | All packets matching an existing connexion are accepted. |
2 | All packets coming through UDP are accepted. |
3 | New packets coming from the IP address 1 and port 1 with a destination to IP address 9 and port 7 through TCP, will be allowed. |
4 | New packets coming from Subnet 2 and port 2 with a destination to Subnet 10 and port 8 through TCP, will be allowed. |
5 | New packets coming from the IP address 3 and port 3 with a destination to IP address 11 with any port through TCP, will be allowed. |
6 | New packets coming from the Subnet 4 and port 4 with a destination to Subnet 12 with any port through TCP, will be allowed. |
7 | Any packet coming from IP address 5 and port 5 to any destination and port through TCP, will be allowed. |
8 | Any packet coming from Subnet 6 and port 6 to any destination and port through TCP, will be allowed. |
9 | This rule will not be applied as it is disabled. |
10 | Any packet coming from Subnet 8 and any port to any destination and port through TCP, will be allowed. |
Default | Packets are dropped. |
Top
NAT
Basic Concepts
Network Address Translation (NAT)
Network Address Translation (NAT, also known as network masquerading or IP masquerading) rewrites the source and/or destination addresses/ports of IP packets as they pass through a router or firewall. It is most commonly used to connect multiple computers to the Internet (or any other IP network) by using one IP address. This allows home users and small businesses to cheaply and efficiently connect their network to the Internet.
The basic purpose of NAT is to multiplex traffic from the internal network and present it to the Internet as if it was coming from a single computer having only one IP address. The Mediatrix unit’s NAT service allows the dynamic creation and configuration of network address translation rules. Depending on some criteria, the packet matching the rule may see its source or destination address modified.
- Source rules: They are applied on the source address of outgoing packets.
- Destination rules: They are applied on the destination address of incoming packets.
Top
Understanding Network Address Translation Rules
A NAT rule specifies a set of matching conditions for network packets.
- Source Address
- Destination Address
- Protocol (All, TCP, UDP or ICMP).
- Source Port
- Destination Port
Top
NAT Rule Order - Important
The NAT rules are applied on a first match basis, in the order they appear in the configuration.
Because the first match is applied, you must ensure that specific rules come before more general rules, or the specific rules might not be applied as desired.
Top
Destination or Source IP Address Format
- An empty string, meaning that the rule will match any IP address
- An IP address, for example 192.168.0.11
- A network address, for example 192.168.1.0/24, which corresponds to all IP addresses in the range 192.168.1.0 to 192.168.1.255
- Specifying the interface name without a trailing slash represents the IP address
- The same name with the trailing slash represents the network.Note: This is case sensitive (the first letter must be uppercase)
- Lan1 will be replaced by the current IP address of the lan interface, 192.168.0.10
- Lan1/ will be replaced with the network of the lan interface, /24, meaning the range from 192.168.0.0 to 192.168.0.255.
If the specified interface is disabled or removed, the rule is automatically disabled thus removed from the NAT. When the network interface is enabled or added back, the rule is automatically enabled and applied in the NAT.
Top
Source or Destination Port Format
- An empty string, meaning that the rule will match any port
- Single port, for example for a web server: 80
- A range of ports, for example to forward RTP: 5004-5099
Top
Interaction of NAT rules with the Firewall Service
When using the Network Firewall service, it is important to configure it with respect to the Destination NAT rules because:
- Source NAT (SNAT) rules are executed after the routing decision, before the packet leaves the unit.
- Destination NAT (DNAT) rules are executed before the routing decision, as the packet enters the unit.
An example of this would be port forwarding where the DNAT changes the routed address of a packet to a new IP address/port. The Network Firewall must also accept connection to this IP/port in order for the port forwarding to work.
Top
Basic Tasks
Starting/Stopping/Restarting the NAT Service Using the DGW Web Page
- If you clicked
, the tab from which you can access the service from the Web pages are greyed out
- If you clicked
, the tab from which you can access the service from the Web pages are no longer greyed out.
Top
Creating a Source NAT Rule
Top
Creating a Destination NAT Rule
Top
NAT Rule Examples
Creating a Source NAT Rule to Forward the Lan to the Uplink Network Interface
- Go to Network/NAT.
-
In the Source Network Address Translation Rules, click
.
- From the Activation selection list, click Enable.
- In the Source Address field, enter Lan1/.
- From the Protocol selection list, choose All.
- In the New Address field, enter Uplink.
- Click Save & Apply.
Top
DHCP Server
Basic Concepts
DHCP Service
The DHCP service allows the Mediatrix unit to act as a DHCP server. The Mediatrix will be able to allocate a range of IP addresses to use on a network, reserve, and distribute the IP addresses and network configuration parameters for specific devices using the MAC address as unique identifier for each device.
Top
DHCP Server
The Mediatrix unit contains an embedded DHCP server that allocates IP addresses and provides leases to the various subnets that are configured
These subnets could have PCs or other IP devices connected to the unit’s LAN Ethernet connectors. These devices could be any combination of switches, PCs, IP phones, etc. If the DHCP service is stopped (which is the default configuration), the DHCP Server tab is greyed out and the parameters are not displayed.
Top
Default vs Specific DHCP Server Configurations
- Default configurations that apply to each subnet of all network interfaces of the Mediatrix unit
- Specific configurations that override the default configurations. You can define specific configurations for each subnet in your Mediatrix unit. For instance, you could define a lease time for all the subnets of the Mediatrix unit and use the specific configuration parameters to set a different value for one specific subnet.
Top
Available Configuration Sources
A parameter’s configuration source can be toggled. Here are the possible configuration sources:
Static | Parameter is defined as a static parameter locally |
Automatic | Parameter is obtained from the Uplink network via DHCP or IPCP (PPPoE) |
HostConfiguration | Parameter is obtained from the HOC Service |
HostInterface | Parameter is obtained from network interface matching the subnet |
Top
Parameters Configuration Sources
The following table lists the configuration parameters and their available configuration sources:
Parameter name | Configuration sources | |||
---|---|---|---|---|
Static | Automatic | HostConfiguration | HostInterface | |
Domain name | X | X | ||
Lease time | X | |||
Default router | X | X | ||
List of DNS servers | X | X | X | |
List of NTP servers | X | X | X | |
List of NBNS servers | X |
Top
Subnet Server
The DHCP server manages hosts’ network configuration on a given subnet. Each subnet can be seen as having a distinct DHCP server managing it, which is called a subnet server.
To activate a subnet server for a given network interface, the name of that network interface and the name of the subnet must match, the subnet enable option must be enabled and the configuration of the subnet must be valid. Only one subnet can be defined per network interface.
The network interface can be a physical interface or a logical interface (ex: sub-interface using VLAN). The subnet server status is updated dynamically according to many parameters.
Top
Sending Configuration Parameters to a Client
When an address is leased to a host, several network configuration parameters are sent to that host at the same time according to the options found in the DHCP request. Parameters are set to default at subnet creation time. A parameter can be defined with a subnet specific configuration.
The subnet server will not send a parameter with an empty value. This means that if a client requests a domain name and the subnet server domain name parameter contains an empty field, the subnet server will not add the domain name option in the DHCP response.
Top
Lease Assignment
In order to assign leases, the subnet server draws from an IP address pool (or subnet scope) defined by a start address and an end address. The subnet mask assigned to hosts is taken directly from the network interface. All hosts on the same subnet share the same configuration. The maximum number of supported hosts on a subnet is 254.
Specific IP addresses (static leases), designated by their MAC address, can be defined as reserved for specific hosts.
The subnet server will always assign leases within the IP address pool with an exception for static leases. When a static lease is defined for the host requesting an address, this lease will be assigned to the host if the IP address is within the subnet range even if the address is not within the IP address pool.
Top
DHCP Server Configuration Options
- Lease Time (Option 51): The Mediatrix unit DHCP server offers a lease time to its subnets. You can use a default lease time for all subnets or define a lease time specific to one or more subnets.
- Domain Name (Option 15): The Mediatrix unit DHCP server offers a domain name to its subnets. You can use a default domain name for all subnets or define a domain name specific to one or more subnets.
- Default Gateway (Option
3): The
Mediatrix unit DHCP server offers a default gateway (also called default router) to its
subnets.Note: The default gateway parameters are not available in the Default interface. You must access the specific subnets configuration to set its parameters.
- DNS (Option 6): The Mediatrix unit DHCP server offers up to four DNS addresses to its subnets. You can use the default DNS addresses for all subnets or define static DNS addresses specific to one or more subnets.
- NTP (Option 42): The Mediatrix unit DHCP server offers the addresses of up to four NTP (Network Time Protocol) servers to its subnets. You can use the default NTP addresses for all subnets or define static NTP IP addresses specific to one or more subnets.
- NBNS (Option 44):The NetBIOS Name Server (NBNS) protocol, also called Windows Internet Name Service (WINS) can be configured through this option. This is only needed if you need file sharing on old Windows 95/98/Me/NT PCs. The Mediatrix unit DHCP server offers up to four NBNS addresses to its subnets. You can use the default NBNS addresses for all subnets or define static NBNS addresses specific to one or more subnets.
- Server Name (Option 66): The Mediatrix unit DHCP server offers a server name to its subnets. You can use a default server name for all subnets or define a server name specific to one or more
- Bootfile Name (Option 67): The Mediatrix unit DHCP server offers a Bootfile name to its subnets. You can use a default Bootfile name for all subnets or define a Bootfile name specific to one or more.
Top
Basic DHCP Tasks
Configuring the LAN1 DHCP Server Subnet
- Go to Network/DHCP Server.
- In the Select Subnet drop down menu located at the top of the page, select Lan1.
- In the DHCP Server Configuration table, set the DHCP Server Enable to Enable.
- In the Start IP Address and End IP Address fields, indicate the IP range to use
- Set Automatic Configuration Interface to Uplink.
-
Complete the fields of the Lease Time (Option 51) section.
Make sure to set the
- Subnet Specific selection list to Yes
-
Complete the fields of the Domain Name (Option 15) section.
Make sure to set the
- Enable Option selection list to Enable
- Subnet Specific selection list to Yes
- Configuration Source selection list to Static
-
Complete the fields of the Default Gateway (Option
3)
section. Make sure to set the
- Enable Option selection list to Enable
- Configuration Source selection list to Host Interface.
-
Complete the fields of the DNS (Option 6) section. Make
sure to set the
- Enable Option selection list to Enable
- Subnet Specific selection list to Yes
- Configuration Source selection list to Static
-
Complete the fields of the NTP (Option 42) section. Make
sure to set the
- Enable Option selection list to Enable
- Subnet Specific selection list to Yes
- Configuration Source selection list to Static
-
Complete the fields of the NBNS (Option 44) section. Make
sure to set the
- Enable Option selection list to Enable
- Subnet Specific selection list to Yes
- Do not enable Option 66 or 67.
- Click Apply.
Top
Advanced DHCP Tasks
Creating A VLAN DHCP Server Subnet

The Vlan10 subnet will be available for configuration from the Select Subnet field under Network/DHCP Server.
Top
Adding a Static Lease Using the DGW Web Interface
Top
Configuring the DHCP Server Subnet Lease Time (Option 51)
- Go to Network/DHCP Server.
- From the Select Subnet selection list, choose the subnet requiring Option 51 configuration.
- In the DHCP Server Configuration table, make sure the DHCP Server Enable selection list is set to Enable.
-
Under the Lease Time (Option 51) section,
from the Subnet Specific selection list, choose
- No to use the default lease time
- Yes to override the default lease time.
- If you chose Yes, complete the Lease Time field.
-
- Click Apply.
Top
Configuring the DHCP Server Domain Name Parameters (Option 15)
- Go to Network/DHCP Server.
- From the Select Subnet selection list, choose the subnet requiring Option 15 configuration.
- In the DHCP Server Configuration table, make sure the DHCP Server Enable selection list is set to Enable.
-
Under the Domain Name (Option 15) section,
from the Enable Option
selection list, choose
- Disable to use the default domain name
- Enable to override the default domain name.
- If you chose Enable, complete the fields as required.
- Click Apply.
Top
Configuring the DHCP Server Default Gateway (Option 3)
Top
Configuring the DHCP Server DNS Parameters (Option 6)
- Go to Network/DHCP Server.
- From the Select Subnet selection list, choose the subnet requiring Option 6 configuration.
- In the DHCP Server Configuration table, make sure the DHCP Server Enable selection list is set to Enable.
-
Under the DNS (Option 6)
section, from the Enable Option selection list,
choose
- Disable to use the default DNS address
- Enable to override the default router.
- If you chose Enable, complete the fields as required.
- Click Apply.
Top
Configuring the DHCP Server NTP Parameters (Option 42)
- Go to Network/DHCP Server.
- From the Select Subnet selection list, choose the subnet requiring Option 42 configuration.
- In the DHCP Server Configuration table, make sure the DHCP Server Enable selection list is set to Enable.
-
Under the NTP (Option 42)
section, from the Enable Option selection list,
choose
- Disable to use the default NTP servers
- Enable to override the NTP servers.
- If you chose Enable, complete the fields as required.
- Click Apply.
Top
Configuring the DHCP Server NBNS (Option 44)
- Go to Network/DHCP Server.
- From the Select Subnet selection list, choose the subnet requiring Option 51 configuration.
- In the DHCP Server Configuration table, make sure the DHCP Server Enable selection list is set to Enable.
- Under the NBNS (Option 44) section, make sure the Enable Option is set to Enable
-
from the Subnet Specific selection list, choose
- No to use the default configuration,
- Yes to override the specific configuration as defined in the following parameters: SpecificNbnsServers.StaticNbns1 , SpecificNbnsServers.StaticNbns2 , SpecificNbnsServers.StaticNbns3 , and SpecificNbnsServers.StaticNbns4.
- If you chose Yes, complete the fields as required.
- Click Apply.
Top
Configuring the DHCP Server Name Parameters (Option 66)
- Go to Network/DHCP Server.
- From the Select Subnet selection list, choose the subnet requiring Option 66 configuration.
- In the DHCP Server Configuration table, make sure the DHCP Server Enable selection list is set to Enable.
- Under the Server Name (Option 66) make sure the Enable Option is set to Enable,
-
From the Subnet Specific selection list, choose
- No to use the default server name
- Yes to override the default server name.
- If you chose Yes, complete the fields as required.
- Click Apply.
Top
Configuring the DHCP Server Bootfile Parameters (Option 67)
- Go to Network/DHCP Server.
- From the Select Subnet selection list, choose the subnet requiring Option 67 configuration.
- In the DHCP Server Configuration table, make sure the DHCP Server Enable selection list is set to Enable.
- Under the Bootfile Name (Option 67) section, from the Enable Option selection list, choose Enable to override the default DHCP Server Bootfile Name.
-
From the Subnet Specific selection list, choose
- No to use the default configuration.
- Yes to override the default configuration.
- If you chose Yes, complete the Bootfile Name field.
- Click Apply.
Top
SIP Proxy
Configuring the SipProxy Service

Top
SBC
Sentinel on the LAN
The Sentinel 100 or 400 is designed to fit different network roles and topologies. It can be deployed inside a LAN behind a NAT firewall.

In this scenario, the Sentinel is usually configured as follows:
- Private (local) IP assigned to LAN port, Internal SIP clients (e.g. IP phones and IP PBX) also on the same LAN network.
- The Uplink Network interface is associated with the Wan/Eth1 physical link.
- The Lan1 Network interface is associated with the LAN/Eth2-5 physical link.
- The LAN signaling and media interfaces are not used.
- A signaling and media interface (pbx_s and pbx_m) wil be created to avoid port conflicts when configuring the Call agents. They will be assigned associated to the LAN/Eth2-5 network interface
- Local firewall rules created to protect the SBC from outside attack (to complement the Edge NAT firewall router, optional). For more details refer to the Configuring Local Firewalls Configuration guide published on the Media5 documentation portal at https://documentation.media5corp.com
- Port forwarding for SIP and RTP ports set up on the edge NAT firewall router
- SBC SIP near end NAT traversal is configured
- SBC rules to process VoIP calls
Top
Sentinel on the Edge
The Sentinel 100 or 400 is designed to fit different network roles and topologies. It can be deployed on the network Edge, with a public IP address and firewall enabled.

The Sentinel located on the Edge is usually configured as follows:
- Public IP assigned to WAN/Eth1 port
- Uplink Network interface is associated with the WAN/Eth1
- Lan1 network interface is associated with the LAN/eth2-5
- Private (local) IP assigned to LAN port
- Local firewall rules created to protect the SBC from outside attack, for reference: https://documentation.media5corp.com/display/DGWLATEST/Configuring+Local+Firewalls
- NAT, IP forwarding and Network Firewall are enabled if Sentinel is used as a router (this is optional, the Sentinel by default does not forward any IP packets between the WAN and LAN) for local IP clients, for reference: https://documentation.media5corp.com/display/DGWLATEST/Configuring+a+Mediatrix+unit+as+a+NAT-Firewall+between+the+LAN+and+the+Internet , https://documentation.media5corp.com/display/DGWLATEST/Configuring+the+Network+Firewall
- SBC rules to process VoIP calls
Top
Configuration
Basic SBC Configuration Concepts
Call Agents
Call Agents represent logical end-points that connect the Mediatrix unit to peers.
For security reasons, the Mediatrix unit communicates by default only with well-known and defined peers. When a request cannot be associated with a Call Agent, it is rejected. Each Call Agent is tied to a specific peer, ensuring all inbound and outbound communications with that peer. Routing rulesets are used to route SIP signaling between Call Agents, where inbound requests from a Call Agent are sent to another (or the same) Call Agent that will send an outbound request to it's related peer. Call Agents can be associated with one or several Rulesets which can be applied to the inbound or the outbound requests.
When there is an inbound request, to determine the Call Agent the inbound request will go through, the Mediatrix unit uses the destination IP address to choose the Network interface. Then the destination port of the inbound request will determine the Signaling or Media Interface used. Finally, the source address and the source port, will allow the Mediatrix unit to direct the request to the appropriate Call Agent. At this point any Rulesets associated with the Call Agent will be applied in order of priority.

When a request is sent out, i.e. there is an outbound request, the Routing Rulesets will determine which Call Agent will be used. Then the Call Agent Rulesets will be applied to the outbound request, in reverse priority order. The outbound request will then be sent through the Signaling and Media Interface associated with the Call Agent. If the public IP address is used, then the SIP request will use this address as the source IP address. The outbound request will then be sent to the peer address of the Call Agent or according to the routing Ruleset if the peer is a Network.

In addition, a Call Agent tracks REGISTER requests or monitor the peer host using SIP options. When these features are activated, the Call Agent registration state and monitoring state are updated allowing a Routing Ruleset to select another Call Agent based on the state of a primary Call Agent.
Eight default types of Call Agents were created for Mediatrix unit. This should be enough to cover all your needs. However, for advanced users, it is possible to create new Call Agents.
Seven of the eight default Call Agents allow the Mediatrix unit to communicate with seven different types of end-points.
Call Agent Name | SIP or Endpoint Peer |
---|---|
wan_ip_trunk_ca | SIP server located on the WAN. |
trunk_lines_ca | Public Switch Telephony Network (PSTN), through PRI, BRI or FXO ports. |
phone_lines_ca | Telephones, through FXS ports. |
lan_ip_pbx_ca | IP Private branch exchange (PBX) located on the LAN. |
local_users_ca | Users via SIP telephony located on the LAN. |
remote_users_ca | Users using SIP telephony located on the WAN. |
registration_ca | Used to route the registrations issued by the Registration Agent. |
secondary_ip_trunk_ca | SIP server if the wan_ip_trunk_ca Call Agent is not available. |
Top
phone_lines_ca Call Agent
The phone_lines_ca Call Agent is used to route calls via an FXS port of the Mediatrix unit.
Typically it will route calls to and from analog phones and faxes within the enterprise premises. This Call Agent will be used for example when a call is routed from one colleague to another using analog phones connected on the FXS ports of the Mediatrix unit. In such a scenario, the call does not go through the LAN network nor the Internet. Since by default this Call Agent uses the loop_m Media Interface to route the media, the media_relay Ruleset is usually associated with this Call Agent.

The phone_lines_ca Call Agent is associated with the phone_lines_gw gateway of the SipEp service. By default, each FXS port sends a REGISTER by the phone_lines_ca Call Agent. Therefore, the administrator must make sure to route these REGISTERs to a server, or to disable them in the SipEp service. If needed, FXS ports can be configured in the Pots service.

Top
trunk_lines_ca Call Agent
The trunk_lines_ca Call Agent is used to route calls to the Public Switch Telephony Network (PSTN) or a enterprise's existent PBX through the PRI, BRI or FXO ports of the unit.
Calls made outside the enterprise premises to telecommunication service providers or calls made within the enterprise through a PBX will typically be routed through this Call Agent. Since by default this Call Agent uses the loop_m Media Interface to route the media, the media_relay Ruleset is usually associated with this Call Agent.
If there are no PRI, BRI or FXO card on the unit, calls through trunk lines can also be routed by the wan_ip_trunk_ca or secondary_ip_trunk_ca Call Agent, provided there is an analog or digital gateway to convert the VoIP call to an analog or digital call, or vice versa.

Further more, the trunk_lines_ca Call Agent is associated with the trunk_lines_gw of the SipEp service. FXO/PRI/BRI ports will need to be configured in either the Pots, Isdn, R2 or Eam services for the calls to be routed properly.

Top
local_users_ca Call Agent
The local_users_ca Call Agent is used to route calls from and to local users, i.e. located in the LAN, via VoIP calls.
For the call to use this Call Agent, the endpoint must belong to the company and use the company's system. This Call Agent is often used as a regrouping point of all local endpoints to be routed to a PBX or Trunk lines. For instance, if you are a Media5 corporation employee, with a cell phone using the Media5 fone application and the entreprise IP-PBX, then your call will be routed through the local_users_ca Call Agent. If an internal employee is using an analog phone, the call can also be routed through this Call Agent provided the call goes first through a gateway to convert the analog call into a VoIP call.

Top
remote_users_ca Call Agent
The remote_users_ca Call Agent is used to route calls from users working out the office and using VoIP calls through an external network or Internet.
Calls are routed through a WAN then to the Mediatrix unit via the remote_users_ca Call Agent.

Top
lan_ip_pbx_ca Call Agent
The lan_ip_pbx_ca Call Agent routes calls to and from an IP PBX located in the LAN. The IP PBX manages all internal communications between different SIP clients (soft phones or SIP gateways).
This Call Agent is usually used to link a local PBX with an external trunk (IP or PSTN).

Top
wan_ip_trunk_ca Call Agent
The wan_ip_trunk_ca Call Agent is used to route VoIP calls.
Calls are routed from or to the main SIP server or provider located in the WAN. Typical peers for this Call Agent are the head office of the enterprise, an Internet telephony service provider (ITSP) or an IP Multimedia Core Network Subsystem (IMS).

Top
secondary_ip_trunk_ca Call Agent
The secondary_ip_trunk_caCall Agent is used to route VoIP calls.
This Call Agent is identical to the wan_ip_trunk_ca Call Agent. The secondary_ip_trunk_ca can be used for different purposes. The most common use for this Call Agent, is to route calls to and from the backup server in the event the primary server does not respond. However, this Call Agent can also be used, for example, to route calls directly to and from a Branch Office or route a specific type of call such as international calls. Typical peers for this Call Agent are the head office of the enterprise, an Internet telephony service provider (ITSP) or an IP Multimedia Core Network Subsystem (IMS).

Top
registration_ca Call Agent
The registration_ca Call Agent is used to route the registrations issued by the Registration Agent.
The registration_ca Call Agent should not be used for other purposes. The registrations issued by the Registration Agent must be routed from the registration_ca to the Call Agent facing the destination Sip registrar (typically wan_ip_trunk_ca_ca or secondary_ip_trunk_ca).
The registration is routed using the User Name, Password and Domain to build the AOR and the R-URI . The Contact is the contact header of the registration, it should contain the IP-address or FQDN of the Mediatrix unit.

Top
Signaling and Media Interfaces
The Signaling Interface is used for SIP signaling and the Media Interface is used for media ( RTP, UDPTL ) processing.
When configuring a Call Agent, you must select a Signaling Interface and a Media Interface. These interfaces are used whenever SIP signaling or media packets are sent to or received by the Call Agent.
It is possible to create several Signaling and Media Interfaces on the same Network Interface but for different purposes. For example, one set of Signaling and Media Interfaces for a WAN SIP Trunk and another set of Signaling and Media Interfaces for remote user calls. This means, for instance, that two Signaling Interfaces will be created on the same Network Interface, using the same IP address, but with a port range that will differ according to their intended use and to avoid conflicts.
A Media or Signaling Interface can be used by more than one Call Agent, but a specific Signaling or Media Interface can be created for a specific Call Agent. This provides the liberty to define non conflicting range of contactable interfaces on any physical network interfaces of the units for your network structure needs (such as Vlans, PPPoE interfaces, multiple Ethernet ports or multiple addresses on a link).
- lan1_m
- lan1_s
- loop_m
- loop_s
- uplink_s
- uplink_m
loop_m and loop_s interfaces are used to communicate with the internal services of the unit. For example, the loop interfaces can be used to communicate with the SipEp service to access phone ports.
Top
Penalty Box
The penalty box feature is enabled for a specific Call Agent to temporarily avoid contacting the peer hosts (addresses) that are expected not to answer.
Without the use of the penalty box, DNS SRV failover is delayed until the SIP transaction times out. In a DNS SRV failover, without the use of the penalty box, the Call Agent will first try to communicate with the peer host on the first server, then once the SIP transaction has timed out, it will try the second and so on, always waiting for the SIP transaction timer to expire. With the penalty box, the call Agent will not try any servers that are already in the penalty box. Remember, dynamic call routing (e.g. survivability) based on server availability requires the penalty box to be enabled.
- If the transaction timer of a communication is expired, the peer host will be considered Down and will be put in the penalty box.
- If the transaction timer of a keep-alive communication is expired, the peer host will be considered Down and will be put in the penalty box.
- If after sending a keep-alive request or any other message to a peer host, the Call
Agent receives one of the selected error codes, the peer host will be put in the penalty
box. It is the error code that will indicate that the peer host cannot be used. Note: When configuring the Call Agent it is possible to indicate the error codes that will trigger the peer host to be sent to the penalty box.( SBC/Configuration/Blacklisting Error Codes)
It is possible to configure how much time a peer host will remain in the penalty box, and the delay before which a peer host is considered down. This delay starts after the expiration of the transaction timer. It is also possible to disable the penalty box feature by using the special value 0 as the duration the peer host will remain in the penalty box.
Top
Keep-Alive
The Keep-Alive monitoring parameter allows the unit to periodically send messages to a server to make sure the server can still be reached.
The Keep-Alive parameter is set individually for each Call Agent. SIP options are sent periodically for each Call Agent to their corresponding server. Any response received from the server means that it can be reached. No additional processing is performed on the response. If no response is received after the retransmission timer expires, the Sbc service considers the server as unreachable. In this case, any call attempt through the Call Agent is refused and the peer host will be sent to the Penalty Box. SIP options are still sent when the server cannot be reached and as soon as it can be reached again, new calls are allowed.
Top
Basic SBC Configuration Tasks
Configuring a Call Agent
Top
Creating a Media Interface
Top
Creating a Signaling Interface
Top
Configuring the Call Agent Penalty Box
- Go to SBC/Configuration.
-
Click
next to the Call Agent you wish to configure.
- In the Configure Call Agent table, set the Keep-Alive field to 30.
- Set the Blacklisting Duration to 60.
- Click Save.

Top
Setting the Keep-Alive Interval
Top
Rulesets
Basic Ruleset Concepts
Rulesets
Rulesets define one or several rules used to filter, manipulate or route inbound or outbound requests.
- Call Agent Rulesets: they describe how inbound or outbound requests are handled by a specific Call Agent. They can also implement services or collect data.
- Routing Rulesets: they are used to globally route outbound requests, i.e. that they apply to all Call Agents.
When a request arrives at a Call Agent from a peer, the inbound rules of the Rulesets associated with the Call Agent are executed. Then, Routing Rulesets are executed until a Call Agent is selected for the destination. Last, the outbound rules of the Rulesets associated with the destination Call Agent are executed before sending the request to the peer.
Inbound rules of the Ruleset are executed in ascending Ruleset priority order. Outbound rules are executed in descending Ruleset priority order.
The Mediatrix unit is fundamentally rule driven. This means that almost all features can be activated based on certain conditions evaluated at run-time, based on parts of the signaling messages or media payload. All rules are constructed using the same pattern. They consist of a set of one or more conditions. If all conditions apply (logical conjunction), a set of one or more actions is executed. It is important to understand that rules are generally applied only on incoming or outbound requests. However, some rules have a scope that goes beyond these incoming or outbound requests. For example, header filters apply to all requests exchanged, including incoming requests.
- Factory: Read only Ruleset delivered with the application.
- Custom: User defined Ruleset.
Call Agent Rulesets have an *.crs extension and Routing Rulesets use the *.rrs extension. For more details on Ruleset conditions and descriptions, refer to the DGW Configuration Guide - Reference Guide document published on the Media5 Documentation Portal.
Top
Ruleset Replacement Expressions
Ruleset replacement expressions are used when the value of a parameter, a command or an action is not known in advance, i.e. the value depends on the result of the SIP message processing.
A Ruleset replacement expression is a string that represents a SIP processing status. Replacement expressions always start with the dollar (“$”) sign followed by an identifier. When the Ruleset uses a replacement expression, the replacement expression is replaced by the value of the SIP processing status representing the replacement expression.
- $aU uses the User part of the P-Asserted-Identity header
- $th uses the Host part of the To header
- sip:$aU@$th, used as the parameter of the Set R-URI action, uses the P-Asserted-Identity and To headers of the incoming request and puts them into the Request URI of the outgoing request.
Top
Ruleset Replacement Expression Exhaustive List
Macro | Replacements | Description |
---|---|---|
$r | Request-URI (R-URI). The expression refers to current Request-URI which may be changed during the course of request processing | |
$r. | Complete R-URI header | |
$ru | user@host[:port] part of R-URI | |
$rU | User part of the R-URI | |
$rd | R-URI domain (host:port) | |
$rh | Host part of the R-URI | |
$rp | Port number of the R-URI | |
$rP | R-URI Parameters | |
$f | From header | |
$f. | Complete From header field | |
$fu | user@host[:port] part of the From URI | |
$fU | User part of the From URI | |
$fd | From URI domain (host:port) | |
$fh | Host part of the From URI | |
$fp | Port number of the From URI | |
$fn | Display name of the From header field | |
$fP | Parameters of the From header field. Does not include the parameters of the URI. | |
$ft | The tag of the From header field | |
$fH | The name of the From header field, exactly as it is stated in the SIP request. | |
$t | To header | |
$t. | Complete To header | |
$tu | user@host[:port] part of the To URI | |
$tU | User part of the To URI | |
$td | To URI domain (host:port) | |
$th | Host part of the To URI | |
$tp | Port number of the To URI | |
$tn | Display name of the To header field | |
$tP | Parameters of the To header field. Does not include the parameters of the URI. | |
$tt | The tag of the To header | |
$tH | The name of the To header, exactly as it is stated in the SIP request. | |
$a | P-Asserted-Identity (PAI) | |
$a. | Complete PAI header. | |
$au | user@host[:port] part of the PAI URI | |
$aU | User part of the PAI URI | |
$ad | PAI URI Domain (host:port). | |
$ah | Host part of the PAI URI | |
$ap | Port number of the PAI URI | |
$aP | Parameters of the PAI header field. Does not include the parameters of the URI. | |
$at | The tag of the PAI | |
$aH | The name of the PAI header field, exactly as it is stated in the SIP request. | |
$p | P-Preferred-Identity (PPI) | |
$p. | Complete PPI header field. | |
$pu | user@host[:port] part of the PPI URI. | |
$pU | User part of the PPI URI. | |
$pd | PPI URI Domain (host:port). | |
$ph | Host part of the PPI URI. | |
$pp | Port number of the PPI URI. | |
$pP | Parameters of the PPI header field. Does not include the parameters of the URI. | |
$pt | The tag of the PPI header field. | |
$pH | The name of the PPI header, exactly as it is stated in the SIP request. | |
$c | Call-ID | |
$ci | Call-ID of the SIP request | |
$s | Source party | |
$si | Source IP address of the inbound SIP request | |
$sp | Source port number of the inbound SIP request | |
$d | Expected destination party | |
$di | Destination IP address of the outbound SIP request. This replacement expression is only available in outbound rules. | |
$dp | Destination port number of the outbound SIP request. This replacement expression is only available in outbound rules. | |
$R | Interface of the inbound SIP request | |
$Ri | IP address of the Signaling Interface on which the inbound SIP request was received | |
$Rp | Port number of the Signaling Interface on which the inbound SIP request was received | |
$Rf | ID of the Signaling Interface on which the inbound SIP request was received | |
$Rn | Name of the Signaling Interface on which the inbound SIP request was received | |
$RI | The configured address of the SignalingInterface.PublicIpAddr parameter on which the inbound SIP request was received | |
$H | Arbitrary Headers. The replacement expressions in this group mention the name of an arbitrary header between parentheses. The core headers (From, To, Call-ID, Via, Route, Record-Route, Contact) cannot be replaced. Example: $H(Server) will be replaced by the value of the Server header field. |
|
$H(headername) | Value of the 'headername' header | |
$HU(headername) | User part of the URI in the 'headername' header. | |
$Hd(headername) | URI Domain (host:port) of the 'headername' header. | |
$Hu(headername) | user@host[:port] part of the URI in the 'headername' header. | |
$Hh(headername) | Host part of the URI in the 'headername' header. | |
$Hp(headername) | Port number of the URI in the 'headername' header. | |
$Hn(headername) | Display name of the 'headername' header. | |
$HP(headername) | Parameters of the 'headername' header field. Does not include the parameters of the URI. | |
$HH(headername) | Header headername (as URI) headers | |
$m | Request method | |
$m | The method of the request. | |
$V | Call parameter | |
$V(gui.varname) | Value of the 'varname' call parameter. | |
$B | Cnum and Rnum | |
$B(cnum.rnum) | Value of the regular expression backreference.
|
|
$U | Register cache | |
$Ua | Originating AoR from the registration cache. This replacement expression can only be used after the execution of a‘Restore contact from registrar’ or a ‘Retarget R-URI from cache’ action. | |
$UA | Originating alias from the registration cache. This replacement expression can only be used after the execution of a ‘Restore contact from registrar’ or a ‘Retarget R-URI from cache’ action. | |
$_ | Operations on Values | |
$_u(value) | Changes the value to uppercase. | |
$_l(value) | Changes the value to lowercase. | |
$_s(value) | Size of the value. | |
$_5(value) | MD5 sum of the value. | |
$_r(value) | Random number from 0 to 'value' - 1. Example: $_r(5) gives 0, 1, 2, 3 or 4. | |
$# | URL-encoded | |
$#(value) | Encodes the value into a URL format with appropriate escaping for characters outside the ASCII character set. | |
$attr | Global Attributes | |
$attr(version) | Version number of the DGW firmware. The returned value matches with the %version% macro in DGW firmware. | |
$attr(profile) | Profile identification of the DGW firmware. The returned value matches with the %profile% macro in DGW firmware. | |
$attr(serial) | Serial number of the Mediatrix unit. The returned value matches with the %serial% macro in DGW firmware. | |
$attr(mac) | MAC address of the Mediatrix unit. The returned value matches with the %mac% macro in DGW firmware. | |
$attr(product) | Product name of the Mediatrix unit. The returned value matches with the %product% macro in DGW firmware. | |
$attr(productseries) | Product series name of the Mediatrix unit. The returned value matches with the %productseries% macro in DGW firmware. |
Top
Basic Ruleset Tasks
Creating a New Ruleset
Top
Cloning a Ruleset
Top
Modifying a Ruleset
Top
Adding Rules to a Ruleset
Top
Changing the Name and Description of a Ruleset
Top
Deleting a Ruleset
Top
Changing the Execution Priority Level of a Call Agent Ruleset
Top
Changing the Execution Priority Level of a Routing Ruleset
Top
Changing the Execution Priority Level of a Ruleset Rule
Top
Changing the Execution Priority Level of a Rule Action
Top
Changing the Execution Priority Level of a Rule Condition
Top
Importing Rulesets

Top
Associating Call Agent Rulesets to a Call Agent
- The Call Agents must be configured.
- Importing Rulesets must be completed.

Top
Associating Routing Rulesets to Your Configuration

Top
Registration
Basic SBC Registation Concepts
Registration Agent
The Registration Agent is a feature that performs REGISTERs on behalf of other users.
- When users cannot register themselves.
- To separate internal and external networks in Demarcation Point scenarios
Top
Registration Caching
Registration processing allows maintaining an endpoint reachable even from behind NATs.
When a call is routed by a Ruleset that includes the REGISTER throttling and Enable REGISTER caching actions, the SBC replaces the information of the Contact header with its own IP address before forwarding the call to an endpoint. Because a private IP address is used as the contact address in the Contact header field of the REGISTER messages, it becomes impossible to reach the user from the public Internet without going through the SBC since the contact's address is private.
The manipulated registration information is then registered in the registrar. When a Call is destined to the user, the call will be directed to the SBC. In order for the SBC to know which user is actually being contacted, the SBC keeps a local copy of the user's registration. The local copy includes the private IP address and the user’s SIP URI as well as the public IP address included in the IP header that was assigned to the SIP message by the NAT.
If periodic request-response traffic does not cross the NAT behind which the user is located, the NAT address binding expires and the user becomes unreachable. Therefore, the SBC forces re-registration to keep NAT bindings alive.
Top
Registration Throttling
Registration throttling protects SIP infrastructures against registration overloads.
Although registration overloads are often self-inflicted by the keep-alive functionality, it may also be caused by a router outage, broken client or Denial of Service attack. The SBC fends off such overloads by using high-performance in-memory registration cache that serves upstream registrations at high-rate, handles them locally, and propagates them down-stream at substantially reduced rate. That’s the case if the registrations were to create new bindings, deleting existing ones or if they were to expire downstream. The propagated registration changes become effective on the SBC only if confirmed by the downstream server. If a registration expires without being refreshed the SBC issues a warning event.
Top
Registration Cache Clearing
Clearing the registration cache will remove all inaccurate information that could remain if an equipment connecting to the SBC is restarted with new information such as a new IP address.
When the registration cache is cleared, all equipments connecting to the SBC need to re-register themselves before being able to receive SIP requests because without re-registration the SBC will not have the private contact address to know where to route the SIP.
Top
Basic SBC Registration Tasks
Configuring a Registration Agent
Configure the registration agent used to issue the registrations.

Top
Finding a Specific AoR in the Registration Cache
- Go to SBC/Registration
- In the Filter table, enter the AoR.
- Click Search.
Top
Clearing the Registration Cache
- Go to SBC/Registration.
- Click Clear Registration Cache located under the Registration Cache table.
Top
SBC Advanced Parameters
SBC/Configuration Parameters
- using a MIB browser
- using the CLI
- creating a configuration script containing the configuration parameters
Tcp Connect Timeout
Refer to Sbc.SignalingInterface.TcpConnectTimeout .Tcp Idle Timeout
Refer to Sbc.SignalingInterface.TcpIdleTimeout.Registration Expiration
Refer to Sbc.RegistrationAgent.ExpireValue.Registration Expiration
Refer to Sbc.RegistrationAgent.RetryInterval.Min Severity
Refer to Sbc.MinSeverity.Top
SBC/Status Parameters
- using a MIB browser
- using the CLI
- creating a configuration script containing the configuration variables
Tcp Connect Timeout
Refer to Sbc.SignalingInterfaceStatus.TcpConnectTimeout.Tcp Idle Timeout
Refer to Sbc.SignalingInterfaceStatus.TcpIdleTimeoutNeed Restart Info
Refer to Sbc.NeedRestartInfo.Top
POTS
Basic Concepts
Caller ID Information
The caller ID is a generic name for the service provided by telephone utilities that supply information such as the telephone number or the name of the calling party to the called subscriber at the start of a call.
In typical caller ID systems, the coded calling number information is sent from the central exchange to the called telephone. This information can be shown on a display of the subscriber telephone set. In this case, the caller ID information is usually displayed before the subscriber decides to answer the incoming call. If the line is connected to a computer, caller information can be used to search in databases and additional services can be offered.
In call waiting, the caller ID service supplies information about a second incoming caller to a subscriber already busy with a phone call. However, caller ID on call waiting is not supported by all caller ID-capable telephone displays.
The following basic caller ID features are supported:
- Date and Time
- Calling Line Identity
- Calling Party Name
- Visual Indicator (MWI)
Top
Caller ID Generation
Caller ID information is sent depending on the application and country-specific requirements: Caller ID generation using DTMF signalling and Caller ID generation using Frequency Shift Keying (FSK)
- DTMF signalling performed during or before ringing, depending on the country settings or
endpoint configuration. The Mediatrix unit provides the calling line identity according to
the following standards:
- Europe: ETSI 300 659-1 January 2001 (Annex B):
- Access and Terminals (AT)
- Analogue access to the Public Switched Telephone Network (PSTN)
- Subscriber line protocol over the local loop for display (and related) services
- Part 1: On-hook data transmission
- Country-specific custom DTMF variations:
- Telebras DTMF (Brasil and Argentina)
- TDK DTMF (Denmark)
- Europe: ETSI 300 659-1 January 2001 (Annex B):
- Frequency Shift Keying (FSK). Different countries use different standards to send caller
ID information. The Mediatrix unit is compatible with the following widely used
standards:
- ETSI 300 659-1
- Continuous phase binary FSK modulation is used for coding that is compatible with:
- BELL 202
- ITU-T V.23
Top
Caller ID Transmission
For most countries, the caller ID is transmitted after the first ring.
One notable exception is the UK, where Caller ID is sent after the dual tone alerting state tone on an inverted polarity line.
Other modes of transmission can be configured with the Caller ID Transmission parameter (under POTS/Config/General Configuration).
Top
Flash Hook
Flash hook can be described as quickly depressing and releasing the plunger or the actual handset-cradle to create a signal indicating a change in the current telephone session.
- call waiting
- second call
- call on hold
- conferences
Top
Country Override Flash Hook Detection Range
This is the range in which the hook switch must remain pressed to perform a flash hook.
When selecting a country (under Telephony/Misc/Country Selection), each country has a default minimum and maximum time value within which pressing and releasing the plunger is actually considered a flash hook. However, these values can be overridden and customised with the Country Override Flash Hook Detection Range (under POTS/FXS Configuration/Country Customisation).
- The minimal delay and maximal delay, in ms, separated by a “-”.
- The minimal value allowed is 10 ms.
- The maximum value allowed is 1200 ms.
- The space character is not allowed.
Top
FXO Force End-of-Call
The forced end-of-call service regroups all features permitting the unit to terminate a call. This can be required in a telephony network where the FXO loop current drops are not always detected.
- On call failure: This feature is set by setting the Force End of Call On Call Failure parameter to Enable. When a call failure happens, the call is terminated after the timeout configured with the Call Failure Timeout (sec) parameter has elapsed and an error tone is played.
- On silence detection: A call is ended when silence is detected for a delay higher than the value configured by in the Silence Detection Timeout (sec) parameter (Refer to the FXO Silence Detection). The mode is set with the Force End Of Call On Silence Detection Mode parameter.
- On tone detection: A call is ended when a selected tone is detected. The tone for this purpose depends on the detection mode specified by the Force End Of Call On Tone Detection Mode parameter which can be country specific (not available in all countries) or a custom tone. (Refer to FXO Tone Detection).
All previously mentioned parameters are available under POTS/FXO Configuration/ FXO Force End of Call.
Top
FXO Silence Detection
Silence detection allows the Mediatrix unit to close a line when no voice activity or silence is detected for a specified amount of time.
Top
FXO Tone Detection
The FXO Tone Detection feature is used to resolve scenarios in which the far-end disconnection tone cannot be detected.
- Tone Detection Custom Frequency
- Tone Detection Custom Cadence
- Detection Custom Repetition
- on is a numerical value representing the time, in milliseconds, during which the tone can be detected
- off is a numerical value representing the time, in milliseconds, during which the tone cannot be detected
- the on and off values can range from 0 to 32,767 ms.
- Specifying more than 4 pairs will only use the first 4 pairs (eight first values).
- If less than 4 pairs are specified, 0 values will be added as necessary.
- The first zero (0) found in the string signals the end of the cadence (i.e. “200, 0, 300, 400” is the same as “200”).
- If it starts with a value of zero (0) , the ring pattern is invalid.
Top
FXS Country Override Loop Current
When a remote end-user goes on-hook, the Mediatrix unit signals the far end disconnect by performing a current loop drop (< 1 mA) on the analog line.
This current loop drop is typically used for disconnect supervision on analog lines. If the Line Supervision Mode parameter (under POTS/FXS Configuration) is set to DropOnDisconnect then the Mediatrix unit signals the far end disconnect by performing a current loop drop on the analog line. By default, the Mediatrix unit maintains a current drop for 1000 ms,, then a busy tone is generated to indicate the user to hang up. The current loop drop duration can be configured with the Power Drop on Disconnect Duration parameter (under POTS/FXS Configuration). (For more details, refer to the FXS Line Supervision Mode parameter in the DGW Configuration Guide - Reference guide published on the Media5 Documentation Portal).
When an FXS analog line goes off hook, it causes current to flow by closing the loop. The Country Selection parameter (Telephony/Misc/Country) allows the selection of predefined country settings for the tone profiles, ring patterns, and other parameters such as input and output gains. The value of the loop current for each country is by default 30 mA but can be overridden to a value ranging from 20 mA to 32 mA with the Country Override Loop Current parameter (under POTS/FXS Configuration/Country Customisation) provided the Override Country Configuration parameter is enabled (under POTS/FXS Configuration/Country Customisation).
Top
Basic FXS Tasks
Selecting the Detection/Generation Method of the Caller ID
- Go to POTS/Config.
- In the General Configuration table, complete the fields are required.
- Click Apply.
Top
Configuring FXS Parameters
- Go to POTS/FXS Configuration.
- In the FXS Configuration table, complete the fields as required.
- Click Apply.

Top
Overriding FXS Default Country Parameters
- Go to POTS/FXS Configuration.
- In the Country Customisation table, complete the fields as required.
- Click Apply.

Top
Basic FXO Tasks
Configuring FXO Dialing Parameters
- Go to POTS/FXO Configuration.
- In the FXO Dialing Configuration table, complete the fields as required.
- Click Apply.

Top
Configuring FXO Answering Configuration

Top
Configuring the FXO Incoming Call Behavior

Top
Configuring FXO Line Verification
- Go to POTS/FXO Configuration.
- In the FXO Line Verification table, for each endpoint, complete the fields as required.
- Click Apply.

Top
Configuring FXO Force End of Call
- Go to POTS/FXO Configuration.
- In the FXO Force End of Call table, complete the fields as required.
- Click Apply.

Top
Configuring the Dial Tone Detection

Top
Configuring the Answering Delay
Top
Configuring the Far End Disconnect Parameters

Top
Disabling Dial Tone Detection
- Go to POTS/FXO Configuration.
- In the FXO Dialing Configuration table, from the Dial Tone Detection Mode dropbox, select Disable.
- Click Apply.

Top
Advanced POTS Parameters
- using a MIB browser
- using the CLI
- creating a configuration script containing the configuration parameters
For FXS
- specify the Calling Party Name of the caller ID (CLIP) : Pots.FxsCallerIdPrivateCallingPartyName
- to override a set of services that are activated during an emergency call: Pots.FxsEmergencyCallOverride
- To set the period before the phone starts to ring in the event where the originator of an emergency call hangs-up before the emergency call center disconnects the call: Pots.FxsEmergencyRingTimeout
- To customise a distinctive ringID: Pots.FxsDistinctiveRingId
- To customise a distinctive ring pattern: Pots.FxsDistinctivePattern
For FXO
- To override the FXO Custom Basic Parameters: Pots.FxoCustomBasicParameters.OverrideDefaultCountryParameters and Pots.FxoCustomBasicParameters.Impedance
Top
FXS Distinctive Ring
The FXS endpoints support four distinctive ringing for basic incoming calls.
To use the distinctive ringing with the Mediatrix unit, the received SIP INVITE message must contain the Alert-Info header field with the proper Call Property value.
The following is an example of an Alert-Info via SIP INVITE:
Alert-Info: <http://127.0.0.1/Bellcore-dr2>
The custom distinctive ring configuration allows the administrator to modify the ring pattern. These parameters can only be configured by the CLI or SNMP. Refer to the Advanced POTS Parameters . section.
- on is a numerical value representing the time, in milliseconds, during which ring tone will be active on the phone.
- off is a numerical values representing the time, in milliseconds, during which the phone will not ring.
For instance, 2000, 1000, 2000, 0 or 2000, 1000, 2000 is a cadence in which the frequency plays for 2 seconds, stops for 1 second, and plays for 2 more seconds.
- It can have up three pairs of “on,off”. If less than 3 pairs are specified, 0 values will be added as necessary. Specifying more than six will only use the six first values.
- If it starts with a value of zero (0) , the ring pattern is invalid.
- The first zero (0) found in the string signals the end of the cadence (i.e. “200, 0, 300” is the same as “200”).
Top
Examples of FXO Tone Detection
Configuring the Detection of an 8 second 425 Hz Continuous Tone
- Go to POTS/FXO Configuration.
- In the FXO Force End of Call table, from the Force End Of Call On Tone Detection Mode selection list, choose Custom Tone.
- In the Tone Detection Custom Frequency field, enter 425.
- In the Tone Detection Custom Cadence field, insert 8000,0 or 8000.
- Click Apply.

Top
Configuring an On/Off British Reorder Tone
- Go to POTS/FXO Configuration.
- In the FXO Force End of Call table, from the Force End Of Call On Tone Detection Mode selection list, choose Custom Tone.
- In the Tone Detection Custom Frequency field, enter 400.
- In the Tone Detection Custom Cadence field, enter 400, 350, 225, 525 .
- Click Apply.

Top
Configuring the Detection of the Special Information Tone (SIT)
- Go to POTS/FXO Configuration.
- In the FXO Force End of Call table, from the Force End Of Call On Tone Detection Mode selection list, choose Custom Tone.
- In the Tone Detection Custom Frequency field, enter 950.
- In the Tone Detection Custom Cadence field, enter 330,660 .
- Click Apply.
Top
Cascade for Incoming Calls
A corporate PBX uses two VoIP gateways for inbound and outbound communication through a VoIP provider.
- Two Mediatrix devices connected to a SIP Trunk
For example: Cascade for incoming calls:

Top
Cascade for Outgoing Calls
Corporate IP-PBX uses two VoIP gateways for inbound and outbound communication through the PSTN
- Two Mediatrix units in the LAN
For example:

Top
ISDN
Cabling Information
ISDN Reference Points
ISDN specifies a number of reference points that define logical interfaces between the various equipment types on an ISDN access line.
- S: The reference point between user terminals and the NT2. This is used in point-to-multipoint BRI connections.
- T: The reference point between NT1 (Modem) and NT2 (PBX) devices. This is used in point-to- point PRI/BRI connections.

Top
BRI S/T Connection (RJ-48)

Pin# | TE mode | NT mode |
---|---|---|
1 | Not Connected | Not Connected |
2 | Not Connected | Not Connected |
3 | Tx + | Rx + |
4 | Rx + | Tx + |
5 | Rx - | Tx - |
6 | Tx - | Rx - |
7 | Not connected | Not Connected |
8 | Not connected | Not Connected |
Top
PRI Connection (RJ-48)

Pin # | NT Mode | TE Mode |
---|---|---|
1 | Transmit #2 (+) | Receive #2 (+) |
2 | Transmit #1 (-) | Receive #1 (-) |
3 | Not connected | Not connected |
4 | Receive #2 (+) | Transmit #2 (+) |
5 | Receive #1 (-) | Transmit #1 (-) |
6 | Not connected | Not connected |
7 | Not connected | Not connected |
8 | Not connected | Not connected |
Top
Status
Basic ISDN Concepts
Preset Configuration
The ISDN Preset Configuration contains a set of values for the configuration of the parameters used by the ISDN connections.
The preset configuration files are located in the file system persistent memory. Depending on the Mediatrix unit you are using, the available ISDN Preset configuration files will differ or, it may also be possible that no preset configuration files are available depending on the Profile. Preset configuration files are provided by Media5 or can be user-defined, i.e. the current ISDN configuration was exported from a unit.
- units that do not use the default values provided by Media5 (for instance, using T1 instead of E1)
- using the same configuration on several units
Top
Integrated Services Digital Network (ISDN)
ISDN is a set of digital transmission protocols defined by a few international standards body for telecommunications, such as the ITU-T. One or the other of these protocols are accepted as standards by virtually every telecommunications carrier all over the world.
- The user side is implemented in ISDN terminals (phones, terminal adapters, etc.)
- The network side is implemented in the exchange switches of the network operator.
- Both sides have different signaling states and messages.
- ISDN Basic Rate Interface (BRI)
- ISDN Primary Rate Interface (PRI)
Top
Supported Signaling Protocols
Protocol | Description |
---|---|
DSS1 | Digital Subscriber Signaling System No.1 |
DMS100 | Digital Multiplex System 100 |
NI2 | National ISDN No.2 |
5ESS | 5 Electronic Switching System |
QSIG | ECMA's protocol for Private Integrated Services Networks |
Top
Auto configuration
- Endpoint Type
- Clock Mode
- Port Pinout (PRI interfaces only)
- Line Coding (PRI interfaces only)
- Line Framing (PRI interfaces only)
Top
ISDN Parameters Auto-Configured by Auto-Sensing
- PortPinout
- ClockMode
- LineFraming
- LineCoding
- EndpointType
Top
Basic ISDN Tasks
Auto-Detecting and Auto-Configuring ISDN Interfaces


Top
Verifying the ISDN Status
At any time, it is possible to check the status of the ISDN links.
- Go to ISDN/Status
- The Physical Link and Signaling status will be displayed for each interface.
If the ISDN cables are properly connected and the basic interface settings are correct, the Physical Link should be Up.

Top
Advanced ISDN Concepts
Definitions
Term | Definitions |
---|---|
Originating Side | Where the call is initiated on the ISDN network. At the originating side, the USER (TE) uni-side initiates the call by sending a SETUP message towards the NETWORK (NT). Then, the NT interface redirects the call to some other network, for example SS7 or VoIP. |
Destination Side | Where the call reaches its ISDN destination. The NT interface at the destination receives the call from another network, then sends a SETUP message over the ISDN link to one or more TE interfaces. |
ISDN Interface | A physical ISDN port, either a BRI or PRI interface. |
IsdnInterface | This is the 4th layer of the ISDN stack, referred in ITU-T Q.931 (05/98) as the Resource Management and Call Control entities. |
Top
Inband Tones Generation
In an ISDN network, most of the call setup tones are played locally by the TE equipments (i.e. telephone handset), although some require that the tones be played inband by the NT peer.
When interworking with other networks occurs, such as in the IsdnInterface, the need for the tones to be played inband is more likely to arise.
The IsdnInterface has configurability to enable inband tones to be played locally, on a per-interface basis. This option is present when the IsdnInterface is acting as both the NT and the TE UNI-side. However, in TE mode only, the ringback tone is played.
The Call Setup tones (dial tone, ringback, etc.) are played in the direction where the call has been initiated. The call disconnection tones are played in both directions, but of course will not arrive to the peer who disconnected the call.
When an inband tone is played, a Progress Indicator IE #8 "Inband information or appropriate pattern available" is added to the ISDN message corresponding to the call state change, and in a PROGRESS ISDN message if no state change is occurring.
On TE interfaces, as soon as the NT peer advertises that it plays inband tones through a Progress Indicator IE #8 or #1, the local inband tones generation is disabled for the rest of the call. Refer to the UseImplicitInbandInfoEnable interop parameter for special handling of Progress Indicator #1.
Whenever a tone is played inband locally or when the ISDN peer advertises that inband information is available, the CallManager is notified. The IP media path can then be opened earlier in the call, and can be closed with some delay after the call disconnection initiation. However, the configuration and associated behaviors of the higher-level entities are out of the scope of this document.
The following tables summarize the inband tones generation behaviour for both NT and TE endpoint types.
Signal IE Handling Enabled | Inband Tones Generation Enabled | Inband Tone Played |
---|---|---|
No | No | No |
No | Yes | Yes |
Yes | Don't Care | No |
Signal IE Handling Enabled | Signal IE Received | Inband Tones Generation Enabled | NT Peer Advertised Inband Tones | Inband Tone Played |
---|---|---|---|---|
No | Don't care | No | Don't Care | No |
Yes | Yes | No | Don't Care | Yes |
Yes | No | Don't Care | Don't Care | No |
No | Don't Care | Yes | Yes | No |
Top
Signal Handling
The Signal IE is used by the NT ISDN interface to tell its TE interfaces peers that they must generate an inband tone locally. Thus, the Signal IEs are sent by the NT only.
When the Signal IE handling is enabled on a given TE interface, the inband tones will be played towards the IP gateway when a Signal IE is received. On a NT interface, a Signal IE will be inserted in the ISDN messages sent to the TE peer when appropriate.
Top
Interop Parameters
Interop parameters allow the Mediatrix unit to properly work, communicate, or connect with specific ISDN devices.
Top
Channel Allocation Strategy
- ascending;
- descending;
- round-robin ascending;
- round-robin descending.
Top
Ascending
In this mode, the IsdnInterface always allocates the free channel that has the lowest number.
Top
Descending
The highest-numbered free channel is allocated.
Top
Round-Robin Ascending
Starting from the enabled channel with the lowest number, the channels are selected increasingly at each allocation.
Top
Round-Robin Descending
Same as round-robin ascending, except that it is exactly the opposite!
Top
Ressource Management
Reservation of Channels for Incoming and Outgoing Calls
Channels can be reserved for incoming calls or for outgoing calls.
The IncomingChannelRange and OutgoingChannelRange parameters are defined for this purpose.
Top
Supplementary Services
Supplementary Services Support
Three generic protocols are defined for the control of supplementary services, two of which are stimulus, the third being functional.
- Keypad protocol;
- Feature key management protocol;
- Functional protocol.
The FacilityServicesEnable parameter is used to control the second category, called the common information element procedure, which uses the FACILITY information element.
When the facility services are disabled and the interface receives a FACILITY message, it answers it with a STATUS. When the facility services are enabled, the interface processes the FACILITY messages.
Top
CLIP
In ISDN, the Calling Line Information Presentation (CLIP) is an optional service offered to the called party which provides the calling party’s ISDN number. When the service is enabled, a Calling Party Number Information Element (CPN IE) containing the caller’s IA5 digits is sent in the SETUP ISDN message.
CLIP is supplemented by privacy rules defined by CLIR and CLIR Override. Refer to the diagrams in the Interaction between CLIP, CLIR, and CLIR override section for details.
For all ISDN signaling protocols except QSIG, operation is as follows: on the originating side, the TE interface always sends the Calling Party Number IE (unless CLIP is disabled). It is up to the NT interface at the destination side to apply the appropriate privacy rules. If the originating side is NT, the Calling Party number is sent only if the Calling Number parameter is not set to 'Restricted' or if the Override flag parameter is set to 'Enabled'.
CLIP is enabled through the ClipEnable parameter, which can take the following values:
Disable | Calling Party Number IE is not sent. |
Enable | Calling Party Number IE is sent in the SETUP message. |
UserOnly | Calling Party Number IE is sent in the SETUP message only if the ISDN interface is configured as a TE. |
Top
CLIR
The Calling Line Information Restriction (CLIR) is a supplementary service offered to the calling party to restrict presentation of the calling party’s ISDN number to the called party.
CLIR uses the Calling Party Number (CPN) IE’s Presentation Indicator (PI) to disable presentation of the calling number to the called party. CLIR can be disabled by the CLIR override option, described later. Refer to the diagrams in the Interaction between CLIP, CLIR, and CLIR override section for details.
For all ISDN signaling protocols except QSIG, operation is as follows: when the service is enabled on a TE originating interface, the Calling Party Number IE’s Presentation Indicator field is set to "Restricted" upon transmission of an ISDN SETUP message from TE to NT. However, the TE must include the IA5 digits in the Calling Party Number.
When the service is enabled on a NT interface that receives a call, the Calling Party number IE Presentation Indicator is set to "Restricted" in the calling property returned to the call managing system.
For QSIG, when the service is enabled at the outgoing interface, the Calling Party number IE Presentation Indicator parameter is set to 'Restricted'. At the incoming side, this parameter has no effect. However, if the PI flag is set to "Restricted" in the received CPN IE, the calling party number is removed. See ECMA-148 section 8.
CLIR is enabled through the ClirEnable parameter, which can take the following values:
Disable | There is no privacy restriction applied on the CLIP service. |
Enable |
ISDN signaling protocols (except QSIG):
QSIG signaling protocol:
|
Top
CLIR Override
CLIR override is an option that allows the calling party number to be presented to the destination party even when the Calling Party Number (CPN) IE’s Presentation Indicator (PI) is set to "Restricted". This option is typically used for police or emergency services.
For all ISDN signaling protocols except QSIG, operation is as follows: if the CLIR Override is enabled on the NT interface at the originating side, the Calling Party Number IA5 digits is included in the Calling Party Number IEs even if the Presentation Indicator is set to "Restricted".
For QSIG, the Calling Line Information Restriction Override is a service offered at the destination interface. If the CLIR Override is not enabled and the Presentation Indicator is set to "Restricted" then the Calling Number is not presented. See ECMA-148 section 8.
Refer to the diagrams in the Interaction between CLIP, CLIR, and CLIR override section for details.
CLIR override is enabled through the ClirOverrideEnable parameter, which can take the following values:
Disable | The parameter has no effect. |
Enable |
ISDN signaling protocols (except QSIG):
QSIG signaling protocol:
|
Top
Interaction between CLIP, CLIR, and CLIR override
The following diagrams show how CLIP, CLIR and CLIR Override override work together to bring (or not) the calling party number from the call originator to the call destination. Refer to the ISDN Signaling Protocols (Except QSIG) and QSIG Signaling Protocol sections for the corresponding diagrams. Call flow must be read from the left (originating network side) to the right (destination network side).
These diagrams also show on which interfaces the ClipEnable, ClirEnable and ClirOverrideEnable parameters have an effect. This is where they must be configured.
Top
ISDN Signaling Protocols (Except QSIG)
- TE interface at the Originating Network Side;
- NT interface at the Originating Network Side;
- TE interface at the Destination Network Side;
- NT interface at the Destination Network Side.

Top
QSIG Signaling Protocol
To describe how CLIP/CLIR/CLIR override work together, we only need to identify the interface that sends the SETUP message and the interface that receives it.

Top
COLP
In ISDN, the Connected Line Identification Presentation is an optional service offered at the originating interface by the NT peer. When the service is enabled, a Connected Line Identification Presentation Element containing the connected number IA5 digits is sent under some conditions in the CONNECT ISDN message.
On the originating side, the TE interface always sends the Connected Party Number IE, it is up to the NT interface at the destination side to apply the appropriate privacy rules. If the originating side is NT, the Connected Party number is sent only if the Connected Number is not set to Restricted or if the Override flag is enabled.
For QSIG, the Connected Line Information Presentation is also an optional service offered at the outgoing and incoming interface. If available, the Connected Party Number IE containing the connected IA5 digits is included in the CONNECT ISDN message at the outgoing interface. However, the Connected Party Number is not presented at the incoming interface if the Connected Number is "Restricted" and the Override flag is not enabled see ECMA-148, section 6.
The COLP can also be affected by the uCP_ISDN_COLP_NUMBER call property in the same way that the CONP is affected by uCP_ISDN_CONP_NAME call property. See CONP section for more information.
Top
COLR
Generally, the Connected Line Identification Restriction is a service offered to the TE at the originating interface.
When the service is enabled on a TE originating interface, the Connected Party Number IE’s Presentation Indicator field is set to "Restricted" upon transmission of an ISDN CONNECT message from TE to NT interface. However, the TE interface must include the IA5 digits in the Connected Party Number.
For QSIG, when the service is enabled at the outgoing interface, the Connected Party number IE Presentation Indicator parameter is set to 'Restricted'. At the incoming side, this parameter has no effect. See ECMA-148 section 8.
Top
COLR Override
In ISDN, the Connected Line Identification Restriction Override is a service offered at the originating interface by the NT peer.
If the CLIR Override is enabled on the NT interface at the originating interface, the Connected Party Number IA5 digits are included in the Connected Party Number IEs even if the Presentation Indicator is set to "Restricted".
For QSIG, this parameter has no effect. See ECMA-148 section 8.
Top
CONP
The Connected Name identification Presentation (CONP) is a supplementary service which provides the name of the answering or alerting user to the calling user.
For ISDN-PBX to IP-PBX calls, if the PrivacyHeadersInResponse parameter is enabled, the uCP_ISDN_CONP_NAME call property will be set from the 180 Ringing, 183 Session Progressing, or 200 OK SIP message accordingly to the values of the P-Asserted-Identity SIP header. If the ConpEnable is enabled, the ISDN CONP called name and connected name will be set accordingly to the value of the uCP_ISDN_CONP_NAME call property respectively in the ISDN Alerting and Connect message.
The following diagram shows a detailed call from ISDN-PBX to IP-PBX with the parameters involved on both the IP and ISDN sides.
For IP-PBX to ISDN-PBX calls, if the ConpEnable parameter is enabled, the uCP_ISDN_CONP_NAME call property will be set from the ISDN Alerting, ISDN Progress, or ISDN Connect from the value of the Called or Connected Name Facility Information Element. If the PrivacyHeadersInResponse parameter is enabled, the P-Asserted-Identity SIP header friendly name will be set to the uCP_ISDN_CONP_NAME call property.
The following diagram shows a detailed call from IP-PBX to ISDN-PBX with the parameters involved on both the IP and ISDN sides.
If the number of characters in the connected/called party name exceeds 50, the gateway will truncate the excess characters.
Top
Facility Message Waiting Delay
Upon reception of a SETUP from the remote peer, the interface can optionally wait for a configurable amount of time for a FACILITY message before processing the call. As soon as it receives a FACILITY message or the delay expires, it goes on with normal call processing. The delay is configured via the MaximumFacilityWaitingDelay parameter.
Top
MSN (Multiple Subscriber Number)
The Multiple Subscriber Number is a service allowing the TE to configure up to three numbers. This service is available only for a BRI interface configured in TE Point To Multipoint. When this service is enabled in the TE, the Called Party Number (Called E.164) received from IE is matched with these numbers. If the Called Party Number is found, the call can be processed. In the case where the E.164 is not matched, the call is silently discarded.
Top
Notify
The NOTIFY is an ISDN service independent of the HOLD and RETRIEVE. It serves only to notify an ISDN endpoint when the remote peer, usually a SIP endpoint, holds or resumes a call. So a NOTIFY REMOTE HOLD message is sent to the ISDN endpoint when the remote peer puts the call on hold, and a NOTIFY REMOTE RETRIEVAL message is sent when the remote peer resumes the call.
If the ISDN SignalingChannelOutgoingNotifyEnable paramater is disabled, no NOTIFY message is sent.
The BRI phone can use this message to inform the user of the new call state, by displaying the remote hold or retrieval message on its LCD screen for example. Note that the BRI phone keeps the voice path opened, so the hold tone or MOH can be heard.
Top
Calling Party Name
- Facility information element;
- Display information element;
- User-User information element.
- Display
- Facility
- User-User
Calling Party Name is accepted in a Display Information Element only when explicitly identified as a Calling Party Name (i.e. only when "Display Type" = "Calling Party Name" in the information element).
Protocol | CallingNameDelivery | |||
---|---|---|---|---|
eFacility | eDisplay | eUserUser | eSignalingProtocol | |
DSS1 | IE User-User | IE User-User | IE User-User | IE User-User |
Dms100 | IE Facility | IE Display | IE Display | IE Display |
NI-2 | IE Facility | IE Facility | IE Facility | IE Facility |
5ESS | IE Facility | IE Facility | IE User-User | IE Facility |
QSIG | IE Facility | IE Facility | IE Facility | IE Facility |
Top
Call Rerouting
The Call Rerouting supplementary service allows to reroute an incoming public ISDN call (originated from PSTN) within or beyond the private ISDN network (such a PBX) as specified in the ETS30020701, section 10.5. The Rerouting data are received and relayed through a FACILITY message containing a Facility Information Element. The Rerouting data are encoded in a CallRerouteing invoke component as specified in the ETS30020701, section 7.
In a Mediatrix typical CallRerouting scenario, when the CallRerouting supplementary service is enabled (the Isdn.SignalingChannelFacilityServicesEnable parameter is enabled and the Isdn.SignalingChannelCallReroutingBehavior parameter is set to "RelayReroute" or "ProcessLocally") and a Facility Information Element containing a CallRerouteing invoke component is received via a FACILITY message on a TE endpoint (from the private network), the ISDN service parses the CallRerouting data and forward it to the CallManager via a specific CallMessage.
To prevent infinite CallRerouting loops, the ISDN service inspects the rerouteingCounter value and returns an error if a loop is detected or if the maximal rerouteingCounter value allowed by the ETS300 207 01 is reached (>5). When the CallRerouting service is not supported (Isdn.SignalingChannelFacilityServicesEnable parameter is disabled or Isdn.SignalingChannelCallReroutingBehavior set to "Unsupported"), the CallRerouting request is automatically rejected.
Upon reception of a CallMessage specifying a Rerouting request, the ISDN service inspects the CallRerouting properties set and according to the Isdn.SignalingChannelCallReroutingBehavior parameter, the services takes an action. If the parameter is set to "RelayReroute", a Facility Information Element containing a CallRerouteing invoke component is transmitted to the ISDN peer (public network side) via a FACILITY message. The ISDN service waits for an answer from the peer.
If the parameter is set to "ProcessLocally" or a negative CallRerouting answer is received (a negative answer received would mean that the public network side (PSTN) is unable to complete the call Rerouting request), the Isdn service initiates a new call to process locally the call Rerouting request. The new call is requested to the CallManager without specifying a destination interface to force the CallRouter service to select the appropriate route. If the new call is routed to an ISDN interface, the ISDN service sends a SETUP containing a DivertingLegInformation2 invoke component in the Facility IE as specified in the ETS 300 207 01, section 10.2 and section 10.4. The data related to the call diversion set in the DivertingLegInformation2 are transferred from the CallRerouting properties.
An illustration of a typical ISDN Call Rerouting scenario (Call Forward Unconditionnal) in a Mediatrix device would be as the following sequence diagram:

Top
Malicious Call Identification
Malicious Call Identification (MCID) is a supplementary service that enables the service provider to identify the source of malicious calls. A user who receives a malicious call from another network can notify the PSTN of the malicious nature of the call, allowing the offnet system to take action, such as notifying legal authorities.
To invoke the MCID supplementary service, the called user shall send a mCIDRequest invoke component carried by a Facility information element in a FACILITY message.
- if accepted, a mCIDRequest return result component, or
- if rejected, a mCIDRequest return error component carried by a Facility information element in a FACILITY message
To enable the MCID supplementary service, the Isdn.SignalingChannel.FacilityServicesEnable and Isdn.SignalingChannel.McidEnable parameters must both be set to Enable. Further more, the MCID feature is only available for DSS1 signaling.
An illustration of a typical ISDN MCID scenario in a Mediatrix device:
On the reception of a SIP INFO message containing the P-Call-Info: malicious
proprietary header, the associated ISDN call will send an ISDN FACILITY message indicating
that this call is tagged as malicious.
Top
InformationFollowing Operation
The "informationFollowing" operation is supported for NI2 signaling only.
When a SETUP message is received containing an "informationFollowing" operation, the unit immediately sends a PROCEEDING message. The unit then waits normally for a FACILITY message containing the calling party name, for a maximum time configured with the MaximumFacilityWaitingDelay parameter.
The only difference between this behavior and the usual behavior (i.e. without the "informationFollowing" operation), is the immediate sending of the PROCEEDING message before waiting for the calling party name.
Note that the "informationFollowing" operation is mutually exclusive with the configuration parameter CallProceedingDelay, which configures a delay before sending the PROCEEDING message. If the PROCEEDING message is sent due to the "informationFollowing" operation, the CallProceedingDelay parameter is ignored.
Top
Advice of Charge
To enable the Advice of Charge (AOC) support on the ISDN interface you must enable the FACILITY services and at least one of the following AOC support: AOC-E (End of Call) or AOC-D (During the Call).
Top
Default Values for Call Properties
Each ISDN interface can be configured with default values for the following parameters in the Calling Party Number IE and the Called Party Number IE.
Information Element (IE) | Parameter | Configuration Parameter |
---|---|---|
Calling Party Number | Type of Number (TON) | DefaultCallingTon |
Calling Party Number | Numbering Plan Indication (NPI) | DefaultCallingNpi |
Calling Party Number | Presentation Indicator (PI) | DefaultCallingPi |
Calling Party Number | Screening Indicator (SI) | DefaultCallingSi |
Called Party Number | Type of Number (TON) | DefaultCalledTon |
Called Party Number | Numbering Plan Indication (NPI) | DefaultCalledNpi |
These parameters provide default values that are inserted in the Calling Party Number IE and the Called Party Number IE when these values are not already provided by the call properties.
Another way to control these values is by using the "Properties Manipulation" feature of the Call Router. This method has precedence over the parameters described here.
- TON and NPI: If the value is not available from the Call Properties, the corresponding value from DefaultCallingTon, DefaultCalledTon. DefaultCallingNpi or DefaultCalledNpi parameter is used directly.
- PI: If PI is not available from the Call Properties, its value is determined by the
following two steps.
- First, it is set to the default value defined by "DefaultCallingPi".
- Second, it can be overridden by the CLIP and CLIR services: the value can be set to "Restricted" by the CLIR service and the value can be set to "NotAvailable" if there is no number to forward.
- SI: Like the other parameters, the DefaultCallingSi parameter is ignored if the SI
value is provided by the Call Properties. If SI is not provided by the call properties, it is
set to the value provided by DefaultCallingSi except for one special case:
when the DefaultCallingSi parameter is set to "Context Dependent", the unit applies
internal rules to set SI to the value that makes most sense according to context. These
internal rules are as follows:
- For all signaling protocols except QSIG:
- If interface is configured as NT (network side), SI is set to "NetworkProvided"
- If interface is configured as TE (user side), SI is set to "UserProvidedNotScreened"
- For QSIG signaling protocol:
- If the calling party number string is not empty, SI is set to "UserProvidedVerifiedAndPassed"
- If the calling party number string is empty, SI is set to "NetworkProvided"
- For all signaling protocols except QSIG:
Top
Advanced ISDN Tasks
Exporting a Preset Configuration File

The preset configuration file will be displayed under Management/File, in the Internal files table.
Top
Primary Rate Interface
PRI (E1/T1) Configuration
Important Information for North America
Mediatrix units are configured to default for E1, which is used in most countries in Europe, Middle-East, Africa and Oceania. For the T1 interface used in North America, some settings MUST be changed.
Setting | T1 (North America) | E1 (Default) |
---|---|---|
Line Coding | B8ZS | HDB3 |
Line Framing | ESF (usually), or SF(D4) | CRC4 (usually), or NO-CRC4 |
Signaling Protocol | NI2 (usually) | DSS1 (usually) |
Preferred Encoding Scheme | u-Law | a-Law |
Fallback Encoding Scheme | a-Law | u-Law |
Channel Range | 1-23 | 1-30 |
Top
Supported Signaling Protocols
Protocol | Description |
---|---|
DSS1 | Digital Subscriber Signaling System No.1 |
DMS100 | Digital Multiplex System 100 |
NI2 | National ISDN No.2 |
5ESS | 5 Electronic Switching System |
QSIG | ECMA's protocol for Private Integrated Services Networks |
Top
Important PRI Settings
- In TE (Terminal Equipment) mode, the unit is normally in slave mode and will automatically update its clock from the other (telco) side.
- In NT (Network Termination) mode, the unit is normally in master mode and will provide the clock to the other side.
- For more information on clock reference when using multiple interfaces, refer to the Mediatrix Gateways and ISDN Clock Synchronisation and Synchronising Unit Operation (TDM Sync) published on the Media5 Documentation Portal.
Refer to the Supported Signaling Protocols section.
Only valid when receiving a SETUP message. The user sending the SETUP message does not indicate an alternative bearer capability.
This is typically used for fractional T1 or E1 service.
- Channels start at 1 and make abstraction of the synchronisation and signaling timeslots.
- Channels outside of the range defined for this field are ignored. For example:
- Fractional T1 512K: Channel Range 1-8 (corresponds to B channels 1-8, D channel 24)
- Fractional E1 on ramp 10: Channel Range 1-10 (corresponds to timeslot 0 + B channels 1-10 + D channel 16)
- Fractional E1 on ramp 10: Channel Range 1-20 (corresponds to timeslot 0 + B channels 1-15 + D channel 16 + B channels 17-21)
- Bearer channels are by default usable for both incoming and outgoing calls. Use this range to reserve channels for incoming or outgoing calls.
- Channels outside of the range defined by ChannelRange parameter are ignored.
- Channels reserved in both IncomingChannelRange and OutgoingChannelRange parameters are considered usable for both incoming and outgoing calls.
- The space character is ignored and duplication is not allowed.
- Channels must be specified in low to high order.
The value for calls from SIP to ISDN is set to 34 by default, but ranges from 0 to 82.Some telephone companies do not allow customers to pass Calling Name and will drop calls if it is not set to zero.
Call properties set in the Call Router have precedence over the default values of the table. For more details on the Call Router, refer to the Call Router user guide published on the Media5 Documentation Portal.
Top
Using a Preset Configuration File

Top
Associating a PRI Port to a Line Type and Protocol
- Go to System/Hardware.
- In the PRI Ports Configuration table, from the Line Type selection list, select either E1 or T1.
- From the Signaling selection list, associate a type of signaling to the PRI port.
- Click Apply.
- Restart the unit.
Top
Configuring the E1T1 Interface (PRI)
Top
Advanced Primary Rate Interface (PRI) Tasks
Modifying Port Pinout

Top
Basic Rate Interface (BRI)
ADvanced BRI Tasks
Configuring the BRI Interface
It is important to take into consideration the following information:
- Endpoint Type: Values used for the Mediatrix unit must be opposite to the value used for the PBX. For instance, if the PBX is set to TE, then the Mediatrix unit must be set to NT. When the BRI interface Signaling Protocol is set to QSIG, the endpoint type is only used in the second layer (LAPD) since it is a concept that does not exist in QSIG. NOTE: To use a specific interface as the clock reference, this parameter must be set to TE. For more information on Clock Synchronisation, refer to the Technical Bulletin - Mediatrix Gateways and ISDN Synchronisation and Synchronising Unit Operation (TDM Sync) published on the Media5 Documentation Portal.
- Preferred Encoding Scheme: Only G.711 u-Law and G.711 a-Law codecs are allowed. G.711 u-Law may not be supported by DSS1 NT and TE endpoints. It is recommended to use G.711 a-Law as preferred encoding protocol.
- Fallback Encoding Scheme: Only G.711 u-Law and G.711 a-Law codecs are supported. Only valid when receiving a SETUP message. The user sending the SETUP message does not indicate alternative bearer capability.
- Clock Mode: "Auto" should be the value to use. In a BRI configuration, setting the clock mode to slave for a NT endpoint can be set for interop usage, while setting the clock mode to master for a TE endpoint is invalid (slave mode is automatically applied in this case). For more information on Clock Synchronisation, refer to the Technical Bulletin - Mediatrix Gateways and ISDN Synchronisation and Technical Bulletin - Synchronising Unit Operation (TDM Sync) published on the Media5 Documentation Portal.
- Calling Name Max Length: The value for calls from SIP to ISDN ranges from 0 to 82.
- Exclusive B-Channel Selection: When the parameter is enabled only the requested B channel is accepted when a call is initiated; if the requested B channel is not available, the call is cleared.
- Monitor Link State Parameter: When enabled with the Ignore OPTONS on no usable endpoints also enabled under the SIP/Interop page, this will influence how the SIP options are answered.
- Connection Type: depends on the equipment to which the Mediatrix unit port is connected to and it must be the same for all interconnected pieces of equipment.
- Signaling Protocol: Must match the connected ISDN equipment or network.
- TEI Negotiation : Only applies on Point to Multipoint connections.
- Call properties set in the Call Router have precedence over the default values of the Interface Configuration table. For more details on the Call Router, refer to the DGW Configuration Guide - Call Router user guide published on the Media5 Documentation Portal.
- In strings, the space character is ignored and duplicating causes is not allowed.
- Some ISDN switches may require that the Sending Complete information element be included in the outgoing SETUP message to indicate that the entire number is included and there are no further destination digits to be sent.
- An ISDN telephone may send INFORMATION messages that contain a “Keypad Facility”. You can thus trigger a supplementary service (Hold, Conference, etc.) by sending a keypad facility. Since the keypads can be received via several INFORMATION messages, they are accumulated until they match or reset if the keypad reception timeout (second) has elapsed since the last keypad has been received. The keypad reception timeout can only be modified via SNMP. If the keypad reception timeout is set to 0, it disables the timeout, thus assuming that all keypads will be received in a single INFORMATION message
Top
Setting the Clock Mode
- Go to ISDN/Basic Rate Interface.
- In the Select Endpoint dropdown menu, select the endpoint you want to configure.
- In the Interface Configuration table, set the Clock Mode.

Top
Interop
Advanced Interop Concepts
Interop Parameters
Interop parameters allow the Mediatrix unit to properly work, communicate, or connect with specific ISDN devices.
Top