Latest DGW

Mediatrix Products
Child pages
  • Upgrading from SIP 5 to DGW
Skip to end of metadata
Go to start of metadata

Download PDF Document

2019-11-01
Mediatrix 4102S
DGW 45.1.1870
Top

1 Disclaimer

The DGW 2.0 platform contains major differences compared to the SIP 5.0 platform. You may thus encounter some behavioral differences after upgrading to DGW 2.0. Media5 strongly recommends to fully test your scenarios in a controlled environment before deploying a live unit running DGW 2.0.

Top

2 Limitations

Feature Details
DHCP vendor options The DHCP vendor options from SIP 5.0 are no longer supported. The following parameters will now need to be configured manually or via configuration scripts:
Image Primary Server Fpu.MfpTransferSrvHostname
Image Secondary Server Fpu.MfpTransferSrvHostname
Management Server Snmp.TrapDest

Snmp.EnableTrap

File fetching host Conf.ScriptsTransferSrvHostname
SIP Registrar SipEp.DefaultStaticRegistrarServerHost
SIP Proxy SipEp.DefaultStaticProxyHomeDomainHost
Outbound Proxy SipEp.DefaultStaticProxyOutboundHost
SIP Presence Compositor SipEp.DefaultStaticPresenceCompositorServerHost
Network Mask

SIP 5.0 supported a netmask of 255.255.255.254 (/31) and a default router 0.0.0.0.

In DGW, the limitation is a netmask of 255.255.255.252 (/30).

A network configuration with /31 will not be transferred, and the rest of the configuration will also not be transferred.

PPPoE (4102S only ) Do not use the PAP authentication protocol during the upgrade from SIP 5.0 to DGW.

The PPPoE server should be configured to use CHAP during the upgrade procedure from SIP 5.0 to DGW 2.0

Both CHAP and PAP are supported in DGW, but only one at a time. With SIP 5.0, the authentication protocol was detected automatically. When upgrading to DGW, the CHAP username and password will be transferred and the device will be configured in CHAP mode. The PAP protocol can be configured manually or via a script.

Special characters

Please note that the following MIB parameter may not contain the “:” character, or any other special characters (é à è : > | ^ * ? etc). If one of these characters is present, part of the configuration will not be transferred during the upgrade process.

  • configFileFetchingStaticHost
  • sntpStaticHost
  • syslogStaticHost
  • msStaticHost
PPPoE Link The SIPGatewayState is Network down even if Uplink interface is Active in PPPoE. This means you will obtain an IP address via PPPoE, the SIP registration will be successful, but the SIP Gateway will show Network down . You will still however be able to operate your Mediatrix gateway.
Public and private keys

DGW contains a single key parameter for the configuration file encryption (Conf.ScriptsSecretKey). Therefore only one of the public and private keys will be transferred, according to the following algorithm: The configFilePrivacyEnable must be set to Enable for parameters to be transferred.

DHCP WAN Address On units with two network interfaces, DGW assigns the 192.168.0.10 address to the LAN interface. If the DHCP server provides an address to the WAN interface in the 192.168.0.0/24 subnet, the unit disables the LAN interface.
Static DNS configuration On SIP 5.0 units configured with static DNS server addresses, the localHostDnsOverrideEnable MIB parameter needs to be set to Enable to keep the static DNS configuration in DGW.
Config file fetching server When using the File Fetching feature in SIP 5.0 or the Configuration Script feature in DGW, a valid server IP/FQDN address and protocol must be configured. To avoid upgrade problems, the server must be reachable by the Mediatrix unit during the upgrade or downgrade procedure.
Top

3 Requirements to Perform an Upgrade

  • A TFTP, FTP, HTTPS, or HTTP server (Media5 recommends using the Pumpkin TFTP server)
  • Unit Manager Network
  • DGW 2.0.126.464 transition Pack File
    • helm_Mediatrix4102_Dgw_2.0.126.464_4102-MX-D2000-132.zip
  • DGW 2.0.26.451 firmware Pack File
    • Mediatrix41XX_Dgw_2.0.26.451_41XX-MX-D2000.zip
  • DGW 2.0.42.768 firmware Pack File
    • Mediatrix4102_Dgw_2.0.42.768_4102-MX-D2000-264
  • Latest GA DGW, if needed

Note

The firmware versions are subject to change. Please refer to our Support Portal at https://media5.secure.force.com/supportportal .

Top

3.1 Upgrading from SIP 5.0 to DGW

Context
SIP 5.0.31.260. is the version of the firmware this procedure starts from.
Steps
  1. Choose the procedure according to the type of server you intend to use.
  2. Export your SIP 5.0 Configuration file. Refer to Exporting a SIP 5.0 Configuration Script for DGW .
  3. Extract all required firmware packs for your unit type. Refer to Requirements to Perform an Upgrade and Extracting the Firmware Pack ZIP File .
  4. Install the DGW 2.0.126.464 firmware pack. Refer to Installing the DGW 2.0.126.464 Firmware Pack .

    Note

    The DGW 2.0.126.464 firmware pack, is the first transition load and is installed using UMN. All other firmware packs are installed using the DGW Web interface.

  5. Install the DGW 2.0.26.451 firmware pack. Refer to Installing a DGW Firmware Version Using the DGW Web Interface .
  6. Import the SIP 5 configuration file taken at step 2 to the unit File Management System. Refer to Importing a Configuration Script to the Unit File Management System .
  7. Transfer the SIP 5 configuration file to DGW. Refer to Executing a Configuration Script from the Unit File Management System .

    Note

    It is important to import the configuration file before moving to the next step, as the Mediatrix 4102 does not support to import a configuration script from the unit file management system if it is running on a firmware version more recent than DGW 2.0.26.451.

  8. Remove the DGW 2.0.126.464 configuration file and the SIP 5 configuration file previously imported at step 6 from DGW. Refer to Deleting a File from DGW .

    Important

    Removing the DGW 2.0.126.464 and SIP5 configuration file from DGW is important otherwise the upgrade procedure will not work.

  9. Install the DGW 2.0.42.768 firmware pack. Installing a DGW Firmware Version Using the DGW Web Interface .
  10. Install the latest DGW firmware, if needed.

    Note

    Our QA tests cover five (5) major releases back for each new release. If you are upgrading from a load older than five (5) major releases back, you must install an intermediate version before upgrading to the newest one. The only exception is when upgrading from DGW 2.0.26.451 to DGW 2.0.42.768.

  11. .
Top

4 Requirements to Perform a Downgrade

  • A TFTP, FTP, HTTPS, or HTTP server (Media5 recommends using the Pumpkin TFTP server)
  • Unit Manager Network
  • DGW 2.0.36.672
    • Mediatrix4102_Dgw_2.0.36.672_4102-MX-D2000-198.zip
  • DGW 2.0.26.451
    • Mediatrix41XX_Dgw_2.0.26.451_41XX-MX-D2000.zip
  • SIP 5.0.28.229
    • Dgw_Mediatrix4102_SIP_5.0.28.229_MX-S5003-01-R.zip
  • SIP 5.0.31.260 if needed
    • SIP_v5.0.31.260_Profile_MX-S50xx_41xx.zip
Top

4.1 Downgrading from DGW to SIP 5.0

Context
Once restarted, if the unit was running DGW 2.26.451 and if no factory reset was done, the Mediatrix unit will have the same configuration as it did before upgrading to DGW. If the unit was not running DGW 2.26.451 and if no factory reset was done, the Mediatrix unit will have the factory default configuration.
Steps
  1. Choose the procedure according to the type of server you intend to use.
  2. Extract all required firmware packs for your unit type. Refer to Extracting the Firmware Pack ZIP File .

    Note

    To perform the following steps, you must have a DGW version that supports multiple file upload. (version 2.0.42.768 or more recent.

  3. Install the DGW 2.0.36.672 firmware pack. Refer to Installing a DGW Firmware Version Using the DGW Web Interface .
  4. Install the DGW 2.0.26.451 firmware pack. Refer to Installing a DGW Firmware Version Using the DGW Web Interface .
  5. Install the SIP 5.0.28.229 firmware pack. Refer to Installing the SIP 5.0.28.229 Firmware Version Using the DGW Web Interface .
  6. Install the SIP 5.0.31.260 firmware pack if needed.
Top

5 File servers

Top

5.1 Configuring the FTP Server

Before You Start
If you are not familiar with the procedure on how to set the FTP root path, please refer to your FTP server's documentation.
Context

Perform this procedure if you plan to use the FTP transport protocol.
Steps
  1. Set an FTP service on the assigned server.
  2. Make sure the FTP server can be reached by the Mediatrix unit.

    Note

    If the file server is located behind a firewall, make sure that TCP port 21 is open.

Top

5.2 Configuring the TFTP Server

Before You Start
If you are not familiar with the procedure on how to set the TFTP root path, please refer to your TFTP server's documentation.
Context
Perform this procedure if you plan to use the TFTP transport protocol.
Steps
  1. Set a TFTP service on the assigned server.
  2. Make sure the TFTP server can be reached by the Mediatrix unit.

    Note

    If the file server is located behind a firewall, make sure the UDP port 69 is open.

Top

5.3 Configuring the HTTP Server

Before You Start
If you are not familiar with the procedure on how to set the HTTP root path, refer to your HTTP server's documentation.
Context
Perform this procedure if you plan to use the HTTP transport protocol.
Steps
  1. Set an HTTP service on the assigned server.
  2. Make sure the HTTP server can be reached by the Mediatrix unit.

    Note

    If the file server is located behind a firewall, make sure the TCP port 80 is open.

Top

5.4 Configuring the HTTPS Server

Before You Start
If you are not familiar with the procedure on how to set the HTTPS root path, please refer to your HTTPS documentation.

Make sure the unit is set to the proper date (refer to task_ofy_g2q_5q .
Context
Perform this procedure if you plan to use the HTTPS transport protocol.
Steps
  1. Set an HTTPS service on the assigned server.
  2. Make sure the HTTPS server can be reached by the Mediatrix unit.

    Note

    If the file server is located behind a firewall, make sure the TCP port 443 is open.

  3. Make sure that in the Management /Certificates tab, in the Certificate Import Through Web Browser table, there is a certificate that authenticates the HTTPS server selected in the Path field, and that Other is selected in the Type field.
  4. Set the configuration parameters.
Top

6 Firmware Packs

Top

6.1 Exporting a SIP 5.0 Configuration Script for DGW

Steps
  1. Open UMN.
  2. Right click the MAC address of your unit.
  3. Select Configuration File/Save to DGW config script .
  4. In the Action Unit Selection dialog box, check Transfer configuration file from unit before proceeding .

    Note

    Warning messages received during this procedure will also be available as comments in the DGW script files. If an error message is received, the procedure must be restarted once the error is corrected.

  5. Copy the configuration script to the root directory of either your FTP, TFTP, HTTPS, or HTTP server according to the server you have chosen.
Result

The UMN then takes the unit's SIP5 configuration file located in the UnitManager\CfgFile folder, and converts it to the DGW format. The new file is saved as XXXXXXXXXXXX_DGW_Script.cfg in the UnitManager\CfgFile folder of the server (HTTP or TFTP), where the Xs correspond to the unit's MAC address.

Note
Top

6.2 Extracting the Firmware Pack ZIP File

Before You Start
Your file server must be configured. One of the following procedures must first be completed.
Steps
  1. Unzip the firmware pack ZIP file (MediatrixXXXX_Dgw_2.0.2X.XXX_XXXX-MX-D2000.zip).

    Note

    You can unzip the files on any computer. However, keep in mind that the upgrade will be performed using the firmware pack files located on the file server only. Therefore, the folder containing the unzipped files must be copied to the file server (MediatrixXXXX folder).

    Important

    Do not change the name of the unzipped folder.

  2. Copy the MediatrixXXXX folder, containing the unzipped files of the firmware pack, to the file server you have chosen to use (FTP, HTTPS,TFTP, or HTTP server).

    Note

    The MediatrixXXXX folder is typically installed at the root folder of the file server. You may choose another path, but the root of the path must be on the file server, otherwise the upgrade will fail.

Result
The Firmware Pack files are ready to be imported to the system.
Top

6.3 Installing the DGW 2.0.126.464 Firmware Pack

Before You Start
The FTP, TFTP, HTTPS, or HTTP server configuration step must be completed. The Firmware Pack ZIP file must also be extracted to the root directory of the chosen server (FTP, TFTP, HTTPS or HTTP ).

Note

The extracted firmware folders should have these names (depending on the model):

  • helm_Mediatrix4102_Dgw_2.0.126.464_4102-MX-D2000-132

Important

If a Factory reset is done at any time after the upgrade procedure, the configuration file for SIP 5.0 will be lost and the Mediatrix unit will not be configured after the Downgrade Procedure to SIP 5.0 is completed. If for some reason the DGW unit becomes unreachable, the partial reset feature will allow the unit to obtain or use a known IP address.
Steps
  1. Start your FTP, TFTP, HTTP, or HTTPS server (depending on what you have chosen to use).
  2. In UMN, double-click Software Download .
  3. Set the address of the Primary Server to the address of the FTP, TFTP, HTTPS, or HTTP server (depending on what you have chosen to use).
  4. Clear the UseDHCP box located at the top of the screen.
  5. On the Static Image Location area , SetImage Location to the transition firmware folder according to your unit.
  6. Right-click on the unit.
  7. Select Action .
  8. Select Download Software (Abrupt) .
Result
When the upgrade is completed, the unit will restart and apply basic configuration settings and networking parameters.

The unit will restart again and be ready for configuration.
Top

6.4 Installing a DGW Firmware Version Using the DGW Web Interface

Before You Start
Make sure to make a backup of your configuration and save the configuration script before proceeding to the next step.

Note

Our QA tests cover five (5) major releases back for each new release. If you are upgrading from a load older than five (5) major releases back, you must install an intermediate version before upgrading to the newest one. The only exception is when upgrading from DGW 2.0.26.451 to DGW 2.0.42.768.

Important

This procedure is only valid for version 44.0 or previous of the DGW Web interface. If you are using the v44.1, or more recent, of the DGW Web interface refer to DGW Configuration Guide - Firmware Upgrade from DGW v44.1 or Newer published on the Media5 documentation portal at https://documentation.media5corp.com/

Depending on the type of protocol you will use, the following procedures must be completed.

Steps
  1. Go to Management /Firmware Upgrade .
  2. In the Firmware Packs Configuration table, in the Version field, enter the version of your Firmware Upgrade Pack.
  3. If you wish the unit to automatically restart immediately after the upgrade, select Enable from the Automatic Restart Enable selection list.

    Note

    If you choose Disable , the unit must be manually restarted in order to complete the upgrade. A message will be displayed to restart the unit.

  4. If you chose Enable from the Automatic Restart Enable , complete the Automatic Restart Grace Delay field (optional).

    Note

    This provides a delay for the telephony calls to be terminated before the unit is restarted. When there are no active calls, the unit will restart immediately. If you wish to allow a delay for the services, set the same parameter under System /Services .

  5. If you wish to restart the system with the default settings, set the Default Settings On Restart field to Enable .
  6. In the Firmware Pack field, enter Dgw .

    Note

    Remember that the name is case sensitive.

  7. In the Transfer Configuration table from the Transfer Protocol selection list, select the type of protocol you wish to use to transfer your Firmware Upgrade.

    Note

    This must be consistent with the file server you have configured.

  8. In the Host Name field, enter the file server IP address or FQDN.
  9. In the Location field, enter the path where the MediatrixXXXX folder is located relative to the root of the file server.

    Note

    If the MediatrixXXXX folder was copied in the root of the file server, this field must remain empty.

  10. If your server requires authentication, enter your username and password.

    Note

    Make sure the file server is started.

  11. Apply Install Now

    Note

    When the firmware pack update fails, the Mediatrix unit tries to download the firmware three times.

Result
All LEDs will cycle from left to right. The upgrade process should take less that 3 minutes and the unit will be restarted a few times. Once the upgrade will be completed, the new firmware pack version will appear under the Firmware Pack Installed table (Management /Firmware Upgrade ).
Top

6.5 Installing the SIP 5.0.28.229 Firmware Version Using the DGW Web Interface

Before You Start
The unit should be running the DGW transition Firmware before reverting to the SIP version.

Note

Depending on your Mediatrix unit model, one of the following firmware pack should be extracted to the root of your server (FTP, TFTP, HTTPS, or HTTP ). Refer to Extracting the Firmware Pack ZIP File .
Steps
  1. Start your TFTP or HTTP server (depending on what you have chosen to use).
  2. Access the DGW Web page.
  3. Go to Management /Firmware Upgrade .
  4. From the Firmware Packs Configuration table, in the Version field, enter 5.0.28.229 .
  5. In the Firmware Pack field, enter sip .
  6. From the Transfer Protocol selection list, select the protocol corresponding to the type of server you have chosen (FTP, TFTP, HTTPS, or HTTP).
  7. In the Host Name field, enter the IP address chosen when you configured the servers.
  8. In the Installation Configuration table, from the Automatic Restart Enable selection list, choose Enable .
  9. From the Default Settings On Restart selection list, choose Enable .
  10. Click Apply .
Result
Once restarted, if the unit was running DGW 2.26.451 and if no factory was done, the Mediatrix unit will have the same configuration as it did before upgrading to DGW. If the unit was not running DGW 2.26.451 and if no factory was done, the Mediatrix unit will have the factory default configuration.
Top

6.6 Importing a Configuration Script to the Unit File Management System

Before You Start
This option is not available on the Mediatrix 4102 running a firmware version more recent than DGW 2.0.26.451
Steps
  1. Go to Management /File .
  2. If you are not using HTTPS, click Activate unsecure file importation from the Web browser located at the top of the page.
  3. In the Import File Through Web Browser table, from the Path selection list, select Conf/ .
  4. Browse to the location of the configuration file.
  5. Click Import .

    Note

    A factory reset will remove the file from the Internal file.

Result
The imported configuration file will appear in the Internal files table, under Management /File .
Top

6.7 Executing a Configuration Script from the Unit File Management System

Before You Start
A configuration script must have been imported to the unit's file management system. Refer to Importing a Configuration Script to the Unit File Management System .
Steps
  1. Go to Management /Configuration Scripts /Execute .
  2. In the Execute Scripts table, in the Generic File Name and/or Specific File Name field, indicate the name of the files you wish to import, or use the Suggestion selection list.

    Note

    The file name is case sensitive, and may be replaced by a macro. For more details, refer to the Unit Macros section. Make sure to add the *.cfg file extension.

  3. From the Transfer Protocol selection list, select File .

    Note

    This option is not available on the Mediatrix 4102 running a firmware version more recent than DGW 2.0.26.451

  4. If the file is encrypted, complete the Privacy Key field.

    Note

    The privacy key must match the privacy key used to encrypt the file.

  5. As a best practice, enable the Allow Repeated Execution field.
  6. Click Apply & Execute .
Result
The configuration script will be imported from the unit's file management system, and any changes to the script will be applied to the running configuration. Keep in mind that if you import a generic and specific file, the commands of the specific file will override the commands of the generic file.
Top

6.8 Deleting a File from DGW

Before You Start
This option is not available on the Mediatrix 4102.
Steps
  1. In the Web interface of DGW, go to Management /File .
  2. Click located on the same line of the file you wish to remove.
  3. Click OK .
  4. A message will be displayed asking: Are you sure you want to delete this file? , click OK .
Result
The file will no longer appear in the table.
Top

6.9 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

7 Parameters

Top

7.1 Transferred Parameters

Note

Please note that when upgrading to the DGW v44.1 firmware version, some parameters were deprecated. Please refer to the RElese Notes - DGW Release Notes v44.1.1605 bug DGW-10122 published on the Media5 documentation portal at https://documentation.media5corp.com/

SIP 5.0 Parameter DGW Equivalents *
qosVlanIeee8021qTaggingEnable Bni.NetworkInterfaces.LinkName
localHostSelectConfigSource
  • Bni.NetworkInterfaces.ConnectionType
  • Hoc.DefaultRouterConfigSource
  • Hoc.DnsServersConfigSource
localHostStaticAddress Bni.NetworkInterfaces.StaticIpAddr (Uplink - Wan)
localHostStaticSubnetMask
lanStaticAddress Bni.NetworkInterfaces.StaticIpAddr (Lan)
lanStaticNetworkMask
pppoeEnable Bni.NetworkInterfaces.ConnectionType
pppoeServiceName Bni.PppServiceName
pppSecuritySecretsIdentity Bni.PppIdentity (CHAP)
pppSecuritySecretsSecret Bni.PppSecret (CHAP)
configFileFetchingStaticHost Conf.ScriptsTransferSrvHostname
configFileFetchingStaticPort
configFileFetchingFileName Conf.ScriptGenericFileName
configFileFetchingSpecificFileName Conf.Script Specific FileName
configFiletransferProtocol Conf.ScriptsTransferProtocol
configFileFetchingFileLocation Conf.ScriptsLocation
configFileTransferUsername Conf.ScriptsTransferUsername
configFileTransferPassword Conf.ScriptsTransferPassword
configFileAutoUpdateOnRestartEnable Conf.ScriptsTransferOnRestartEnable
configFileAutoUpdatePeriodicEnable Conf.ScriptsTransferPeriodicEnable
configFileAutoUpdateTimeUnit Conf.ScriptsTransferPeriodicTimeUnit
configFileAutoUpdatePeriod Conf.ScriptsTransferInterval
configFileAutoUpdateTimeOfDay Conf.ScriptsTransferTimeRange
configFilePrivacyEnable Conf.ScriptsSecretKey
configFilePrivacyGenericSecret
ConfigFilePrivacySpecificSecret
sysConfigNetworkEthernetSpeed Eth.Ports.Speed
sysConfigComputerEthernetSpeed
qosVlanIeee8021qVirtualLanId
  • Eth.Vlan.VlanId
  • Bni.NetworkInterfaces.LinkName
qosVlanIeee8021qDefaultUserPriority Eth.Vlan.VlanDefaultUserPriority
sntpTimeZoneString Hoc.StaticTimeZone
sntpSelectConfigSource Hoc.SntpConfigSource
sntpStaticHost Hoc.StaticSntpServers.HostName.
sntpStaticPort
sntpSynchronizationPeriod Hoc.SntpSynchronizationPeriod
sntpSynchronizationPeriodOnError Hoc.SntpSynchronizationPeriodOnError
localHostDnsOverrideEnable Hoc.dnsServersConfigSource
localHostStaticPrimaryDns Hoc.StaticDnsServers.IpAddress
localHostStaticSecondaryDns
localHostStaticDefaultRouter Hoc.StaticDefaultRouter
syslogStaticHost Nlm.SyslogRemoteHost
syslogStaticPort
localHostStaticSnmpPort Snmp.Port
msStaticHost Snmp.TrapDest
msStaticTrapPort
msEnable Snmp.EnableTrap
httpServerPort Web.ServerPort
* Configuration fields not listed in the table will need to be either reconfigured manually or via the use of configuration scripts.
Top

7.2 SIP to DGW Parameter Name Equivalents

SIP 5.0 Parameters DGW equivalents
Sip SipEp
Port Gateway[default].Port
Domain Gateway[default].Domain
ServerSelectConfigSource Must be set to static otherwise a warning is sent
HomeDomainProxyStaticHost DefaultStaticProxyHomeDomainHost
HomeDomainProxyStaticPort
OutboundProxyStaticHost DefaultStaticProxyOutboundHost
OutboundProxyStaticPort
TransportRegistrationEnable TransportConfig[Uplink].RegistrationEnable
TransportContactEnable TransportConfig[Uplink].ContactEnable
TransportEnable TransportConfig[Uplink].UdpEnable

TransportConfig[Uplink].TcpEnable

TransportQValue TransportConfig[Uplink].UdpQValue

TransportConfig[Uplink].TcpQValue

RegistrarStaticHost DefaultStaticRegistrarServerHost
RegistrarStaticPort
UAIfTable.sipUAMainUsername UserAgent.UserName
UAIfTable.sipUADisplayName UserAgent.FriendlyName
UAIfTable.sipUAOtherAcceptedUsernames Not converted, a warning is sent
UAIfTable.sipUAMaximumSessionExpirationDelay DefaultSessionTimerMaximumExpirationDelay
UAIfTable.sipUAMinimumSessionExpirationDelay DefaultSessionTimerMinimumExpirationDelay
UAIfAuthenticationTable.sipUAAuthRealm Authentication.Realm
UAIfAuthenticationTable. sipUAAuthUsername Authentication.Username
UAIfAuthenticationTable. sipUAAuthPassword Authentication.Password
UAIfAuthenticationTable. sipUAAuthValidateRealm Authentication.ValidationRealm
ReRegistrationTime DefaultRegistrationRefreshTime
PenaltyBoxEnable PenaltyBox Enable
PenaltyBoxTime PenaltyBoxTime
RegistrationProposedExpirationvalue DefaultRegistrationProposedExpirationValue
ifAdmin epAdm
InitialAdminState Endpoint.InitialAdminStateConfig
rtpConf mipt
rtpConfigbasePort IpTransportRtpBasePort
voiceIf mipt
Table.voiceIfG711VoiceActivityDetectionEnable EpSpecificCodec.GenericVoiceActivityDetection
Table.voiceIfG729VoiceActivityDetectionEnable
CodecTable.voiceIfCodecPreferred Set priority 10 on the preferred codec
CodecTable.voiceIfCodecPcmuEnable EpSpecificCodecG711Mulaw.VoiceEnable
CodecTable.voiceIfCodecPcmuMinPTime EpSpecificCodecG711Mulaw.MinPTime
CodecTable.voiceIfCodecPcmuMaxPTime EpSpecificCodecG711Mulaw.MaxPTime
CodecTable.voiceIfCodecPcmaEnable EpSpecificCodecG711Alaw.VoiceEnable
CodecTable.voiceIfCodecPcmaMinPTime EpSpecificCodecG711Alaw.MinPTime
CodecTable.voiceIfCodecPcmaMaxPTime EpSpecificCodecG711Alaw.MaxPTime
CodecTable.voiceIfCodecG729Enable epSpecificCodecG729.VoiceEnable
CodecTable.voiceIfCodecG729MinPTime epSpecificCodecG729.MinPTime
CodecTable.voiceIfCodecG729MaxPTime epSpecificCodecG729.MaxPTime
CodecTable.voiceIfCodecG723Enable EpSpecificCodecG723.VoiceEnable
CodecTable.voiceIfCodecG723MinPTime EpSpecificCodecG723.MinPTime
CodecTable.voiceIfCodecG723MaxPTime EpSpecificCodecG723.MaxPTime
CodecTable. voiceIfCodecG72616kbpsEnable EpSpecificCodecG726r16kbps.VoiceEnable
CodecTable. voiceIfCodecG72616kbpsMinPTime EpSpecificCodecG726r16kbps.MinPTime
CodecTable. voiceIfCodecG72616kbpsMaxPTime EpSpecificCodecG726r16kbps.MaxPTime
CodecTable. voiceIfCodecG72624kbpsEnable EpSpecificCodecG726r24kbps.VoiceEnable
CodecTable. voiceIfCodecG72624kbpsMinPTime EpSpecificCodecG726r24kbps.MinPTime
CodecTable. voiceIfCodecG72624kbpsMaxPTime EpSpecificCodecG726r24kbps.MaxPTime
CodecTable. voiceIfCodecG72632kbpsEnable EpSpecificCodecG726r32kbps.VoiceEnable
CodecTable. voiceIfCodecG72632kbpsMinPTime EpSpecificCodecG726r32kbps.MinPTime
CodecTable. voiceIfCodecG72632kbpsMaxPTime EpSpecificCodecG726r32kbps.MaxPTime
CodecTable. voiceIfCodecG72640kbpsEnable EpSpecificCodecG726r40kbps.VoiceEnable
CodecTable. voiceIfCodecG72640kbpsMinPTime EpSpecificCodecG726r40kbps.MinPTime
CodecTable. voiceIfCodecG72640kbpsMaxPTime EpSpecificCodecG726r40kbps.MaxPTime
dataIf mipt
CodecTable.dataIfClearChannelCodecPreferred Set priority 10 on the preferred codec
CodecTable.dataIfCodecT38Enable EpSpecificCodecT38.DataEnable
CodecTable.dataIfCodecT38ProtectionLeve EpSpecificCodecT38.RedundancyLevel
T38FinalFramesRedundancy DefaultCodecT38FinalFramesRedundancy
T38NoSignalEnable DefaultCodecT38NoSignalEnable
T38NoSignalTimeout DefaultCodecT38NoSignalTimeout
dataIfT38basePort IpTransportT38BasePort mip
dataIf tellIf. specificMachineDetection
dataIfCngToneDetectionEnable CngToneDetection
dataIfCedFaxToneEnable BehaviorOnCedToneDetection
dataIfAnalogCedDetectionBehavior
digitMap pots
ProcessDigitsWhenPressed dtmfMapDigitDetection
digitMaps epServ
AllowedTable.digitMapAllowedEnable CallDtmfMapAllowed.Enable
AllowedTable.digitMapAllowedDigitMap CallDtmfMapAllowed.DtmfMap
AllowedTable.digitMapPrefixedDigitRemovalCount CallDtmfMapAllowed.DtmfTransformation
AllowedTable.digitMapPrependedString
AllowedTable.digitMapSuffixStringToRemove
AllowedTable.digitMapAllowedLineToApply CallDtmfMapAllowed.EpId
RefusedTable.digitMapRefusedEnable CallDtmfMapRefuse.Enable
RefusedTable.digitMapRefusedDigitMap CallDtmfMapRefuse.DtmfMap
RefusedTable.digitMapRefusedLineToApply CallDtmfMapRefuse.EpId
TimeoutCompletion DtmfMapTimeoutCompletion
TimeoutFirstDigit DtmfMapTimeoutFirstDtmf
TimeoutInterDigit DtmfMapTimeoutInterDtmf
subscriberServicesIfEnablingTable epServ
subscriberServicesHoldEnable EpSpecificHold.EnableConfig

EpSpecificHold.Enable

subscriberServicesCallWaitingEnable EpSpecificCallWaiting.EnableConfig

EpSpecificCallWaiting.Enable

subscriberServicesSecondCallEnable EpSpecificSecondCall.EnableConfig

EpSpecificSecondCall.Enable

subscriberServicesBlindTransferEnable EpSpecificTransfer.EnableConfig

EpSpecificTransfer.BlindEnable

subscriberServicesAttendedTransferEnable EpSpecificTransfer.EnableConfig

EpSpecificTransfer.AttendedEnable

subscriberServicesConferenceEnable EpSpecificConference.EnableConfig

EpSpecificConference.Enable

subscriberServicesCallForwardUnconditionnalEnable EpSpecificForwardUnconditional.EnableConfig

EpSpecificForwardUnconditional.Enable

subscriberServicesCallForwardOnBusyEnable EpSpecificForwardOnBusy.EnableConfig

EpSpecificForwardOnBusy.Enable

subscriberServicescallForwardOnNoAnswerEnable EpSpecificForwardNoAnswer.EnableConfig

EpSpecificForwardNoAnswer.Enable

subscriberServicesIfCallForwardActivationTable epServ
CallForwardUnconditionalActivation ForwardUnconditionalConfig.Activation
CallForwardUnconditionalForwardingAddress ForwardUnconditionalConfig.ForwardingAddress
CallForwardOnBusyActivation ForwardOnBusyConfig.Activation
CallForwardOnBusyForwardingAddress ForwardOnBusyConfig.ForwardingAddress
CallForwardOnNoAnswerActivation ForwardNoAnswerConfig.Activation
CallForwardOnNoAnswerForwardingAddress ForwardNoAnswerConfig.ForwardingAddress
CallForwardOnNoAnswerTimeout ForwardNoAnswerConfig.Timeout
subscriberServices epServ
callForwardUnconditionalEnableDigitMap DefaultForwardUnconditionalDtmfMapActivation
callForwardUnconditionalDisableDigitMap DefaultForwardUnconditionalDtmfMapDeactivation
callForwardOnBusyEnableDigitMap DefaultForwardOnBusyDtmfMapActivation
callForwardOnBusyDisableDigitMap DefaultForwardOnBusyDtmfMapDeactivation
callForwardOnNoAnswerEnableDigitMap DefaultForwardNoAnswerDtmfMapActivation
callForwardOnNoAnswerDisableDigitMap DefaultForwardNoAnswerDtmfMapDeactivation
callWaitingCancelDigitMap DefaultcallWaitingCancelDtmfMap
telephonyAttributes epServ
IfFeaturesTable.AutomaticCallEnable EpSpecificAutoCall.Enable
IfFeaturesTable.AutomaticCallTargetAddress EpSpecificAutoCall.TargetAddress
IfFeaturesTable.HookFlashProcessing Not converted. Warning sent when Out of Band using RTP if selected in SIP 5.0
telephony tellIf
CountrySelection CountrySelection

Some countries are not supported

countryCustomizationToneTable.Override CountryCustomizationTone.Override
countryCustomizationToneTable.Pattern CountryCustomizationTone.Pattern
SipInterop tellIf
SdpDirectionAttributeEnable InteropSdpDirectionAttributeEnable
OnHoldSdpStreamDirection InteropOnHoldSdpStreamDirection
OnHoldAnswerSdpStreamDirection InteropOnHoldAnswerSdpStreamDirection
sipInterop sipEp
TransmissionTimeout InteropTransmissionTimeout
qos lQos
SignalingDiffServ ServiceClasses[100].DiffServ
VoiceDiffServ ServiceClasses[200].DiffServ
T38FaxDiffServ ServiceClasses[300].DiffServ
SignalingIeee8021qEnable Ethernet8021QTagging[*].EnablePriorityTagging
SignalingIeee8021qUserpriority Ethernet8021QTagging[100].UserPriority

Set to 0 if qosSignalingIeee8021qEnable is disabled

VoiceIeee8021qEnable Ethernet8021QTagging[*].EnablePriorityTagging
VoiceIeee8021qUserPriority LQos.Ethernet8021QTagging[200].UserPriority

Set to 0 if qosVoiceIeee8021qEnable is disabled

T38FaxIeee8021qEnable LQos.Ethernet8021QTagging[*].EnablePriorityTagging
T38FaxIeee8021qUserPriority LQos.Ethernet8021QTagging[300].UserPriority

Set to 0 if qosT38FaxIeee8021qEnable is disabled

Top

8 Online Help

If you are not familiar with the meaning of the fields and buttons, click Show Help , located at the upper right corner of the Web page. When activated, the fields and buttons that offer online help will change to green and if you hover over them, the description will be displayed.

Top

9 DGW Documentation

Mediatrix units are supplied with an exhaustive set of documentation.

Mediatrix user documentation is available on the Documentation Portal at http://documentation.media5corp.com

Several types of documents were created to clearly present the information you are looking for. Our documentation includes:

  • Release notes : Generated at each GA release, this document includes the known and solved issues of the software. It also outlines the changes and the new features the release includes.
  • Configuration notes : These documents are created to facilitate the configuration of a specific use case. They address a configuration aspect we consider that most users will need to perform. However, in some cases, a configuration note is created after receiving a question from a customer. They provide standard step-by-step procedures detailing the values of the parameters to use. They provide a means of validation and present some conceptual information. The configuration notes are specifically created to guide the user through an aspect of the configuration.
  • Technical bulletins : These documents are created to facilitate the configuration of a specific technical action, such as performing a firmware upgrade.
  • Hardware installation guide : They provide the detailed procedure on how to safely and adequately install the unit. It provides information on card installation, cable connections, and how to access for the first time the Management interface.
  • User guide : The user guide explains how to customise to your needs the configuration of the unit. Although this document is task oriented, it provides conceptual information to help the user understand the purpose and impact of each task. The User Guide will provide information such as where and how TR-069 can be configured in the Management Interface, how to set firewalls, or how to use the CLI to configure parameters that are not available in the Management Interface.
  • Reference guide : This exhaustive document has been created for advanced users. It includes a description of all the parameters used by all the services of the Mediatrix units. You will find, for example, scripts to configure a specific parameter, notification messages sent by a service, or an action description used to create Rulesets. This document includes reference information such as a dictionary, and it does not include any step-by-step procedures.

Top

10 Copyright Notice

Copyright © 2019 Media5 Corporation.

This document contains information that is proprietary to Media5 Corporation.

Media5 Corporation reserves all rights to this document as well as to the Intellectual Property of the document and the technology and know-how that it includes and represents.

This publication cannot be reproduced, neither in whole nor in part, in any form whatsoever, without written prior approval by Media5 Corporation.

Media5 Corporation reserves the right to revise this publication and make changes at any time and without the obligation to notify any person and/or entity of such revisions and/or changes.

Top