<!DOCTYPE html
SYSTEM "about:legacy-compat">
<html lang="en"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><meta charset="UTF-8"><meta name="copyright" content="(C) Copyright 2023"><meta name="DC.rights.owner" content="(C) Copyright 2023"><meta name="DC.type" content="reference"><meta name="prodname" content="For all Mediatrix Products"><meta name="version" content="DGW 49.12.28842941"><meta name="platform" content="All"><meta name="DC.date.modified" content="2023-0308-2809"><meta name="DC.date.issued" content="2023-0308-2809"><meta name="DC.date.available" content="2023-0308-2809"><meta name="ChapterNumbering" content="no"><meta name="DC.format" content="HTML5"><meta name="DC.identifier" content="reference_zyr_325_ts"><link href="https://fonts.googleapis.com/css?family=Open+Sans" rel="stylesheet"><link rel="stylesheet" type="text/css" href="https://documentation.media5corp.com/download/attachments/45482024/commonltr.css"><link rel="stylesheet" type="text/css" href="https://documentation.media5corp.com/download/attachments/45482024/custom.css"><title>Using the CLI via an SSH Session</title></head><body><header role="banner"><div class="topicmeta title">Using the CLI via an SSH Session</div><div class="topicmeta date">2023-0308-28<09</div><div class="topicmeta product">For all Mediatrix Products</div><div class="topicmeta version">DGW 49.12.2884<2941</div><div class="topicmeta pdf"><a href="https://documentation.media5corp.com/download/attachments/45482024/Using%20the%20Command%20Line%20Interface%20via%20an%20SSH%20Session.pdf" rel="nofollow">Download PDF Document</a></div><hr><span style="float: inline-end;"></span></header><nav role="toc"><ul><li><a href="#reference_zyr_325_ts">Requirements</a></li><li><a href="#concept_zqb_h14_1r">Command Line Interface (CLI)</a><ul><li><a href="#task_u1l_yxs_bz">Accessing the CLI via an SSH Session</a></li></ul></li><li><a href="#concept_v4k_q3h_1r">DGW Documentation</a></li><li><a href="#concept_fqm_rv4_k4">Copyright Notice</a></li></ul></nav><main role="main"><article role="article" aria-labelledby="ariaid-title1"><hr><span style="float: inline-end;"><a href="#">Top</a></span><article class="nested0" aria-labelledby="ariaid-title1" id="reference_zyr_325_ts">
<h1 class="title topictitle1" id="ariaid-title1">Requirements</h1>
<div class="body refbody">
<section class="section">
<ul class="ul" id="reference_zyr_325_ts__ul_v41_s25_ts">
<li class="li">Computer with an SSH or OpenSSH compatible remote shell Client running on a PC that acts
as an SSH host.</li>
<li class="li">You must know the IP address of your Mediatrix unit. Refer to the <a class="xref" href="https://documentation.media5corp.com/display/DGWLATEST/Hardware+Installation+Guides" target="_blank">Hardware Installation Guide</a> of your unit published on the <a class="xref" href="https://documentation.media5corp.com/" target="_blank">Media5 Documentation Portal</a>.</li>
</ul>
</section>
</div>
</article><hr><span style="float: inline-end;"><a href="#">Top</a></span><article class="topic concept nested0" aria-labelledby="ariaid-title2" id="concept_zqb_h14_1r">
<h1 class="title topictitle1" id="ariaid-title2">Command Line Interface (CLI)</h1>
<div class="body conbody"><p class="shortdesc">The Command Line Interface (CLI) provides an access to interactively configure all the
Mediatrix unit parameters.</p>
<div class="p"><div class="note important note_important"><span class="note__title">IMPORTANT:</span> 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.</div>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.</div>
<p class="p">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.</p>
</div>
<hr><span style="float: inline-end;"><a href="#">Top</a></span><article class="topic task nested1" aria-labelledby="ariaid-title3" id="task_u1l_yxs_bz">
<h2 class="title topictitle2" id="ariaid-title3">Accessing the CLI via an SSH Session</h2>
<div class="body taskbody">
<section class="section prereq"><div class="tasklabel"><strong class="sectiontitle tasklabel">Before you begin</strong></div>Your unit must be properly connected. Refer to the <a class="xref" href="https://documentation.media5corp.com/display/DGWLATEST/Firmware+Guides" target="_blank">Hardware Installation Guide</a> of your unit
published on the <a class="xref" href="https://documentation.media5corp.com/" target="_blank">Media5 Documentation Portal</a>.</section>
<section class="section context"><div class="tasklabel"><strong class="sectiontitle tasklabel">Context</strong></div>This is the recommended way to access the CLI. </section>
<section id="task_u1l_yxs_bz__steps_ukt_3zs_bz"><div class="tasklabel"><strong class="sectiontitle tasklabel">Steps</strong></div><ol class="ol steps" id="task_u1l_yxs_bz__steps_ukt_3zs_bz"><li class="li step stepexpand">
<span class="ph cmd">Start your SSH Client. </span>
</li><li class="li step stepexpand">
<span class="ph cmd">Enter the IP address of your unit.</span>
</li><li class="li step stepexpand">
<span class="ph cmd">Use the SSH default port number, i.e. <span class="keyword wintitle">22</span> unless, you have
previously changed it in the DGW Web interface under <span class="keyword wintitle">Management</span>/<span class="keyword wintitle">Misc</span>.</span>
</li><li class="li step stepexpand">
<span class="ph cmd">Select <span class="keyword wintitle">SSH</span> as the connection type.</span>
</li><li class="li step stepexpand">
<span class="ph cmd">When prompted for login, enter your login userrname (Default usernames are
<span class="keyword wintitle">public</span> or <span class="keyword wintitle">admin</span> ).</span>
</li><li class="li step stepexpand">
<span class="ph cmd">Enter your login password (for the default <span class="keyword wintitle">admin</span> username,
the password is <span class="keyword wintitle">administrator</span>, for the
<span class="keyword wintitle">public</span> username, no password is required).</span>
<div class="itemgroup info">
<div class="note note note_note"><span class="note__title">Note:</span> 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. </div>
</div>
</li></ol></section>
<section class="section result"><div class="tasklabel"><strong class="sectiontitle tasklabel">Result</strong></div>After you have successfully connected to the Mediatrix unit by using an SSH session,
you can start using the CLI to configure the Mediatrix unit. For more details on the
scripting language, refer to the <a class="xref" href="https://documentation.media5corp.com/display/DGWLATEST/Configuration+Scripting+Language+Syntax" target="_blank">DGW Configuation guide - Configuration Scripting
Language Syntax</a> published on the <a class="xref" href="https://documentation.media5corp.com/" target="_blank">Media5 Documentation Portal</a>.</section>
</div>
</article></article><hr><span style="float: inline-end;"><a href="#">Top</a></span><article class="topic concept nested0" aria-labelledby="ariaid-title4" id="concept_v4k_q3h_1r">
<h1 class="title topictitle1" id="ariaid-title4">DGW Documentation</h1>
<div class="body conbody"><p class="shortdesc">Mediatrix devices are supplied with an exhaustive set of documentation. </p>
<p class="p">Mediatrix user documentation is available on the <a class="xref" href="http://documentation.media5corp.com" target="_blank">Media5 Documentation
Portal</a>.</p>
<div class="p">Several types of documents were created to clearly present the information you are looking for.
Our documentation includes:<ul class="ul" id="concept_v4k_q3h_1r__ul_bqy_cjh_1r">
<li class="li"><strong class="ph b">Release notes</strong>: 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.</li>
<li class="li"><strong class="ph b">Configuration notes</strong>: 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. </li>
<li class="li"><strong class="ph b">Technical bulletins</strong>: These documents are created to facilitate the configuration of a
specific technical action, such as performing a firmware upgrade.</li>
<li class="li"><strong class="ph b">Hardware installation guide</strong>: 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.</li>
<li class="li"><strong class="ph b">User guide</strong>: 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.</li>
<li class="li"><strong class="ph b">Reference guide</strong>: 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. </li>
</ul></div>
</div>
</article><hr><span style="float: inline-end;"><a href="#">Top</a></span><article class="topic concept nested0" aria-labelledby="ariaid-title5" id="concept_fqm_rv4_k4">
<h1 class="title topictitle1" id="ariaid-title5">Copyright Notice</h1>
<div class="body conbody"><p class="shortdesc">Copyright © 2023 Media5 Corporation.</p>
<p class="p">This document contains information that is proprietary to Media5 Corporation.</p>
<p class="p">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.</p>
<p class="p">This publication cannot be reproduced, neither in whole nor in part, in any form whatsoever,
without written prior approval by Media5 Corporation.</p>
<p class="p">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.</p>
</div>
</article></article></main></body></html> | 