This Configuration Note describes how to use the Mediatrix units’ functionality that allows it to fetch the firmware and configuration files automatically from a provisioning server by using either TFTP or HTTP. This Configuration Note can be used to configure the Mediatrix 2102, Mediatrix 1100/1200 series and Mediatrix 4100 series (SIP v5.0 only).
This Configuration Note will refer to the following scenario as an example throughout the document.
Figure 1. Network Diagram
In this document we will cover:
Preparing Windows Web Server for Auto-Provisioning
Ensure that the HTTP Server functionality is activated and that the configuration files and binaries are located under (IIS default):
Media5 recommends that the administrator creates a subdirectory for the firmware and another subdirectory for the configuration files under the web server root directory:
Preparing the TFTP Server for Auto-Provisioning
Ensure that the TFTP Server allows proper file or folder permission. For example, for the PumpKIN TFTP server, select the options as shown in the figure below. In the figure, the PumpKIN TFTP Server root directory is C:\PumpKIN. The TFTP root directory is where the firmware and configuration folders and binaries will be located. Media5 recommends that the administrator creates a subdirectory for the firmware and another subdirectory for the configuration files under the TFTP root.
For the example scenario, here is what each folder would look like:
< TFTP or Web root>\Mtx_ConfigFiles
< TFTP or Web root>\Mtx_Firmware
We will explain the use of each file and folder later in this document.
Media5 recommends using the file selection method for automatic image download. This method consists of fetching a file called <product>targetimage.inf. This file contains a single line outlining the directory where the binary files are located (see example below). When the Mediatrix unit downloads this file, it fetches the Setup.inf file located in the folder specified in the <product>targetimage.inf file. The Mediatrix unit then proceeds to check if its firmware on the system matches the name of the firmware specified in the Setup.inf. If there is no match, the Mediatrix unit proceeds with the complete download of the binary files. You must create this file and place it in the same directory as the folder containing the binaries.
The auto-provisioning feature on the Mediatrix units can fetch two types of files:
The Generic XML configuration file contains parameters that can be applied to all Mediatrix units in the field. For example, generic parameters such as SIP Proxy server address or voice codec can be specified in this file. This means that all Mediatrix units in the field will point to the same Service Provider SIP Proxy Server and use the same codec. To add flexibility, Media5 created a feature that allows the Mediatrix units to fetch the generic file with its product name as filename. The Mediatrix unit can be configured to fetch a generic file called: %product%.xml where %product% is a macro replaced by the product name of the unit.
The Specific XML configuration file contains parameters that are specific to each Mediatrix unit. For example, specific parameters are SIP username and SIP authentication parameters. To simplify the configuration of the specific XML file, Media5 created a feature that allows the Mediatrix unit to fetch the specific file with its MAC address as filename. The Mediatrix unit can be configured to fetch a specific file called: %mac%.xml where %mac% is a macro replaced by the MAC address of the unit.
Creating a Configuration File
To create a configuration file in XML format that can be used with the auto-provisioning feature, the Unit Manager Network (UMN) software is required.
1. Once you have connected to the unit using the auto-detect feature of UMN, right-click the unit and select Configuration File and then Save to XML…
2. In the Action Unit Selection window, check the Transfer configuration file from unit before proceeding box and check the Include SNMP specific settings in generated XML configuration file if you intend to use SNMPv3 in your configuration files.
3. Wait for the operation to complete. It can take several seconds for the task to complete, especially on a slow network or when using SNMPv3.
4. At this point, UMN has created a CFG file and a XML file. To retrieve the XML file, browse to the default directory:
5. The newly created file will have the name <mac address>.xml where <mac address> is the MAC address of the unit.
Media5 provides an encryption tool to secure the XML configuration files on the server. Once the file is encrypted, the transfer of the information over the network is secure. The encryption tool uses symmetric block cipher to encrypt data. The encryption key supported by the tool can be up to 128-bits with increment of 8-bits. This encryption key must be configured on the Mediatrix units in order to decipher the information. The tool provided by Media5 can be used on Windows, Linux or Unix operating systems.
The following is an example of the tool running on Windows:
The following are some examples of MxCryptFile commands:
Ensure that the Mediatrix unit is configured with the proper key in order to decipher the information. Without the proper key, the parameters in the encrypted XML file would not be applied to the Mediatrix unit.
Please refer to the Technical Bulletin 0582 – Configuration Files Encryption Using MxCryptFile tool or the MxCryptFile documentation for more details on the encryption tool.
You can configure the auto-provisioning in three ways:
1. Using the Administration web page
2. Using the Unit Manager Network
3. Using a MIB Browser
We will explain method one in length and present method two with screenshots throughout this section. If you wish to use method 3, use the variable names that are in parenthesis.
1. Once you have gained access to the administration web page (Method 1) or connected (Method 2/3) to the unit, access the Firmware Download section:
2. Server configuration
3. Download configuration
In our example the Firmware Location would be set to: Mtx_Firmware/ SIP_v220.127.116.11_Profile_MX-S5000-05-R-Cert/2102
4. Automatic update configuration
5. Here is what the configured interface would look like for Methods 1 and 2. In this example, the unit will check for a new firmware every day at 2h00 (24h format) on the HTTP server httpserver.media5corp.com. The unit will fetch the file mediatrix2102targetimage.inf in the Mtx_Firmware folder to verify if a new version is available.
Configuration File Fetching
1. Once you have gained access to the administration web page (Method 1) or connected (Method 2/3) to the unit, access the Configuration file section :
2. Server configuration
3. Download configuration
4. Automatic update configuration
6. Here is what the configured interface would look like for Methods 1 and 2. In this example, a Mediatrix 2102 with MAC address 0090F8XXXXXX will download two configuration files every day at 1h00 (24h format) on the HTTP server httpserver.media5corp.com. The unit will fetch the files Mediatrix 2102.xml and 0090F8XXXXXX.xml in the Mtx_ConfigFiles folder. If the configuration has changed, the unit will reboot to apply the changes.
With the auto-provisioning feature, it was explained how to configure the Mediatrix units to automatically fetch configuration files and firmware. However, as explained, this feature requires the Mediatrix units to be manually configured.
By using the Unit Manager Network (UMN) software, it is possible to have the Mediatrix units automatically configure themselves using pre-created configuration files.
Mediatrix units, by default, send DHCP requests to acquire an IP address. If the management server (UMN) vendor-encapsulated-option is found in the server’s answer, the Mediatrix unit will contact the management server to acquire a configuration file.
The value of the vendor-encapsulated-option (Option 43) needs to be formatted for the unit to understand the option.
Please consult your DHCP server documentation for information on how to add vendor-encapsulated-options to DHCP answers. More details on the vendor-encapsulated-option can be found in your Mediatrix unit documentation.
When UMN receives a trap from a unit, the server will send a default configuration file. This configuration file needs to be modified with the correct settings to allow the Mediatrix unit to get its configuration.
The files need to be in CFG format. To create a sample CFG file, follow the instructions in the “Creating a configuration file” section.
Refer to the Unit Manager Network documentation for more detail.
Note: The Unit Manager Network server uses SNMP and TFTP to send the unit a configuration file. This automatic configuration
technique is not recommended when either the units and/or the server are behind a NAT or a Firewall.