Command Line Interface (CLI)

The Command Line Interface (CLI) provides an access to interactively configure all the Mediatrix unit parameters.

IMPORTANT: Although it is possible to configure existing ruleset parameters via the CLI, it is not possible to create or edit a ruleset from the CLI: it must be either imported or directly created or edited in the DGW Web interface.
The CLI is accessed through either a secure SSH session (default) or an unsecure TELNET session. When using a secure SSH session, all communications between Client and server are encrypted before being sent over the network, thus packet sniffers are unable to extract user names, passwords, and other potentially sensitive data. This is the default and recommended way to access the Command Line Interface.

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.


Creating the Telnet Session Activation Configuration Script

  1. Open a text editor.
  2. Copy and paste the text included in the following Result section.
    Note: If necessary, you can customise the value of the Cli.InactivityTimeOut and Cli.TelnetPort parameters.
  3. Save the file as telnet.cfg
The configuration script to enable Telnet sessions is created but needs to be imported to the unit.


Importing a Configuration Script from Your PC

  1. Go to Management/Configuration Scripts/Execute.
  2. If you are not using HTTPS, click Activate unsecure file importation from the Web browser.
  3. In the Upload Script Through Web Browser table, browse to the location of the file you wish to import.
  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. Click Upload and Execute.
  6. Located at the top of the page, click Refresh.
The configuration script will be imported from your PC and any changes to the script will be applied to the running configuration.


Accessing the CLI via a Telnet Session

IMPORTANT: Remember that when using a Telnet session to access the CLI, communications between Client and server are not secured, thus packet sniffers are able to extract user names, passwords, and other potentially sensitive data. Therefore, Media5 Corporation strongly recommends using an SSH session.
Before you begin
Your unit must be properly connected. Refer to the Hardware Installation Guide of your unit published on the Media5 Documentation Portal.
  1. Start your Telnet Client.
  2. Enter the IP address of your unit.
  3. Enter the port number 23.
  4. Select Telnet as the connection type.
  5. When prompted for login, enter your login userrname (Default usernames are public or admin).
  6. Enter your login password (for the default admin usrname, the password is administrator, for the public username, no password is required).
    Note: If you are accessing the unit through the CLI for the first time or after a factory reset, you may be presented with a warning message regarding the unit’s identification. You can accept the message and continue.
After you have successfully connected to the Mediatrix unit by using a Telnet session, you can start using the CLI to configure the Mediatrix unit. For more details on the scripting language, refer to the DGW Configuation guide - Configuration Scripting Language Syntax published on the Media5 Documentation Portal.


DGW Documentation

Mediatrix devices are supplied with an exhaustive set of documentation.

Mediatrix user documentation is available on the Media5 Documentation Portal.

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.


Copyright Notice

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