Skip to end of metadata
Go to start of metadata

Download PDF Document

2018-07-12

For All Mediatrix Units

v. 42.3.986


1 Configuration Backup and Restore

Performing a configuration backup allows you to have a copy of the entire configuration at the time the backup was performed.

The configuration backup can be used:

  • to revert the running configuration to a valid configuration when the running configuration generates error messages or no longer works;
  • to deploy a valid configuration on other units;
  • to revert to a known configuration when too many changes were made to the running configuration;
  • to deploy a backup configuration on a replacement unit.

The configuration backup includes every aspects of the configuration, i.e.

  • the status and configuration parameters;
  • the certificates;
  • the Rulesets.

But the configuration backup does not include the File service files, except for the Rulesets.

The configuration backup is an XML file and can, if necessary, be encrypted.

Please note that you can use a backup file on a unit with a newer or same firmware version than what is was taken from. A backup file can not be restored on an older firmware version than the one it was taken from.

Backup made on firmware version vX Unit firmware version Possible
Backup.v3 Firmware version 3 YES
Backup.v1 Firmware version 3 YES
Backup.v1 Firmware version 1 YES
Backup.v3 Firmware version 1 NO

The Configuration Back and Restore performed on Dgw v2.0.31 includes all Rulesets. However, starting on Dgw v.2.0.32 only the Rulesets modified by the user will be included in the configuration backup and restore. If a configuration backup is performed on Dgw v2.0.31 and restored on a newer version of DGW, all Rulesets existing in v2.0.31 will be copied as custom Rulesets i.e the system will not use the factory Rulesets of the newer version even if they were not modified.


2 File Servers


2.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.

Next Step

3.1 Performing a Configuration Backup to a File Server 4.1 Restoring a Configuration From a File Server

2.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.

Next Step

3.1 Performing a Configuration Backup to a File Server 4.2 Restoring a Configuration from the Unit File Management System 4.1 Restoring a Configuration From a File Server 3.2 Performing a Configuration Backup to the Unit File Management System

2.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.

Next Step

3.1 Performing a Configuration Backup to a File Server 4.2 Restoring a Configuration from the Unit File Management System 4.1 Restoring a Configuration From a File Server

2.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.

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.

Next Step

2.5 Configuring the Mediatrix Unit to Use an SNTP Server

2.5 Configuring the Mediatrix Unit to Use an SNTP Server

Before You Start

Make sure there is an SNTP server available.

Context

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.

Steps

  1. Go to Network/Host.
  2. In the SNTP Configuration table, from the Configuration Source selection list, select the connection type from which you wish to obtain the SNTP parameters.

    Note

    Complete Step 3 only if you are using static SNTP server(s), otherwise go to Step 4.

  3. Provide an IP address or domain name and port numbers for each SNTP server you are using.
  4. If necessary, change the displayed default value of the Synchronisation Period.
  5. If necessary, change the displayed default value of the Synchronisation Period on Error.
  6. Click Apply.

Result

The SNTP host name and port will be displayed in the Host Status table under Network/Status.

Next Step

3.1 Performing a Configuration Backup to a File Server 4.3 Restoring a Configuration from Your PC 4.2 Restoring a Configuration from the Unit File Management System 4.1 Restoring a Configuration From a File Server 3.2 Performing a Configuration Backup to the Unit File Management System

2.6 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 instance, if you are using HTTPS or for the caller ID feature. In these cases, an SNTP client with an available SNTP server will need to be configured to allow the system to update and synchronise its time to the local clock.

SNTP is used to synchronise an SNTP client with an SNTP or NTP server by using UDP as transport. The Mediatrix unit implements an SNTP version 3 client.


3 Backup


3.1 Performing a Configuration Backup to a File Server

Before You Start

Depending on the type of transport protocol used, one of the following procedures must be completed:

Context

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.

Steps

  1. Go to Management/Backup and Restore.
  2. In the Image Configuration table, in the File Name field, indicate the name of your backup.

    Note

    The file name is case sensitive. As a best practice, add the *.xml extension. Make sure to indicate the firmware version the backup was made from because a backup file can not be restored on an older firmware version than the one it was taken from.

    Note

    Remember, if you have several units with several configurations and plan to reuse the configuration on another unit, the name must be explicit. Indicate the date of your backup, the interfaces used, the device model, etc.

  3. From the Transfer Protocol selection list, select the type of protocol you wish to use to transfer your backup.

    Note

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

  4. In the Host Name field, enter the file server IP address or FQDN.
  5. In the Location field, enter the path relative to the root of the file server where the backup will be saved.
  6. If your server requires authentication, enter your username and password.
  7. From the Content selection list, choose the elements you wish to include to the backup.
  8. If you wish to use encryption for backup operations, complete the Privacy Parameters.

    Note

    Media5 corp strongly recommends to use a privacy algorithm (encryption) to protect certificates and passwords.

  9. Make sure the file server is started.
  10. Click Apply and Backup Now.

Result

The configuration will be saved on the selected file server.

3.2 Performing a Configuration Backup to the Unit File Management System

Context

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.

Steps

  1. Go to Management/Backup and Restore.
  2. In the File Name field, indicate the name of your backup.

    Note

    The file name is case sensitive. As a best practice, add the *.xml extension. Make sure to indicate the firmware version the backup was made from because a backup file can not be restored on an older firmware version than the one it was taken from.

    Note

    Remember, if you have several units with several configurations and plan to reuse the configuration on another unit, the name must be explicit. Indicate the date of your backup, the interfaces used, the device model, etc.

  3. From the Transfer Protocol selection list, select File.
  4. From the Content selection list, choose the elements you wish to include to the backup.
  5. If you wish to use encryption for backup operations, complete the Privacy Parameters.

    Note

    Media5 corp strongly recommends to use a privacy algorithm (encryption) to protect certificates and passwords.

  6. Click Apply and Backup Now.

Result

The configuration will be saved in the unit's file management system. The backup file will appear at the end of the list of the File page, under Management/File.

4 Restore


4.1 Restoring a Configuration From a File Server

Before You Start

Depending on the type of transport protocol used, one of the following procedures must be completed:

Context

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.

Steps

  1. Go to Management/Backup and Restore.
  2. In the File Name field, indicate the name of your backup or use the Suggestion selection list.

    Note

    The file name is case sensitive. Remember that a backup file can not be restored on an older firmware version than the one it was taken from.

  3. From the Transfer Protocol selection list, select the type of protocol you wish to use to transfer your backup.

    Note

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

  4. In the Host Name field, enter the file server IP address or FQDN.
  5. In the Location field, enter the path relative to the root of the file server where the backup will be saved.
  6. If your server requires authentication, enter your username and password.
  7. Make sure the file server is started.
  8. If the backup file is encrypted, complete the Privacy Parameters.

    Note

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

  9. Click Apply and Restore Now.

    Note

    A pop-up message will be displayed indicating that the unit will be automatically restarted once the restore procedure is completed.

Result

The unit will be restarted. The configuration will be restored from the configured file server, and used as the running configuration.

4.2 Restoring a Configuration from the Unit File Management System

Context

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.

Steps

  1. Go to Management/Backup and Restore.
  2. In the File Name field, indicate the name of your backup or use the Suggestion selection list.

    Note

    The file name is case sensitive. Remember that a backup file can not be restored on an older firmware version than the one it was taken from.

  3. From the Transfer Protocol selection list, select File.
  4. If the backup file is encrypted, complete the Privacy Parameters.

    Note

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

  5. Click Apply and Restore Now.

    Note

    A pop-up message will be displayed indicating that the unit will be automatically restarted once the restore procedure is completed.

Result

The unit will be restarted. The configuration will be restored from the system's file management system, and used as the running configuration.

4.3 Restoring a Configuration from Your PC

Context

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.

Steps

  1. Go to Management/Backup and Restore.
  2. If the Web pages are not encrypted (HTTPS), click Activate unsecure file transfer through web browser, located at the top of the tables.
  3. In the Transfer Scripts Through Web Browser table, browse to the location of the file you wish to restore.

    Note

    The file name is case sensitive. Remember that a backup file can not be restored on an older firmware version than the one it was taken from.

  4. Click Upload and amp; Restore.

    Note

    A pop-up message will be displayed indicating that the unit will be automatically restarted once the restore procedure is completed.

Result

The unit will be restarted. The configuration will be restored from your PC, and used as the running configuration.

5 Parameters

Although the services can be configured in great part in the web browser, some aspects of the configuration can only be completed with the MIB parameters by:

  • using a MIB browser, such as the Mediatrix Unit Manager Network (UMN);
  • using the CLI;
  • creating a configuration script containing the configuration parameters.


5.1 Conf > Configuration Parameters

Image Transfer Cipher Suite

Refer to Conf.ImageTransferCipherSuite in the Configuration Reference Guide .

Image Transfer Tls Version

Refer to Conf.ImageTransferTlsVersion in the Configuration Reference Guide .

6 Copyright Notice

Copyright © 2018 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.