<!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="concept"><meta name="prodname" content=""><meta name="version" content="DGW 49.12.28842941"><meta name="platform" content="All Mediatrix Units"><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="concept_plb_grn_rs"><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>Auto-Provisioning Mediatrix Units Using DGW Configuration Scripts</title></head><body><header role="banner"><div class="topicmeta title">Auto-Provisioning Mediatrix Units Using DGW Configuration Scripts</div><div class="topicmeta date">2023-0308-28<09</div><div class="topicmeta product"></div><div class="topicmeta version">DGW 49.12.2884<2941</div><div class="topicmeta pdf"><a href="https://documentation.media5corp.com/download/attachments/45482024/Auto-Provisioning%20Mediatrix%20Units%20with%20DGW%20Configuration%20Scripts.pdf" rel="nofollow">Download PDF Document</a></div><hr><span style="float: inline-end;"></span></header><nav role="toc"><ul><li><a href="#concept_plb_grn_rs">Auto-Provisioning Mediatrix Units with Configuration Scripts</a></li><li><a href="#topic_title_Overview_of_the_Server_Configuration_d1e15">Overview of the Server Configuration</a><ul><li><a href="#task_jv3_dc4_rs">Preparing Windows Server IIS</a></li><li><a href="#task_owx_nf4_rs">Preparing the Pumpkin TFTP Server</a></li></ul></li><li><a href="#topic_title_Configuration_Scripts_d1e18">Configuration Scripts</a><ul><li><a href="#concept_cw1_fhg_1r">Configuration Scripts</a></li><li><a href="#task_syk_fkb_wr">Configuring the FTP Server </a></li><li><a href="#task_dpx_4dq_5q">Configuring the TFTP Server</a></li><li><a href="#task_ebc_zwg_wq">Configuring the HTTP Server</a></li><li><a href="#task_qhf_hyg_wq">Configuring the HTTPS Server</a><ul><li><a href="#concept_vtd_gkg_yr">Parameters</a></li></ul></li><li><a href="#task_u1j_3f1_yr">Exporting a Configuration Script Using a File Server</a></li></ul></li><li><a href="#topic_title_Encryption_d1e26">Encryption</a><ul><li><a href="#concept_ztd_4m4_rs">Securing Configuration Scripts</a></li><li><a href="#task_zyc_vrn_12v">Securing the configuration scripts using AES-256 GCM</a></li><li><a href="#task_zyc_vrn_13v">Securing the configuration scripts using Blowfish</a></li></ul></li><li><a href="#topic_title_Preparation_of_the_Configuration_Files_and_Firmware_d1e30">Preparation of the Configuration Files and Firmware</a><ul><li><a href="#task_cwv_slh_yr">Executing Configuration Scripts from a File Server Periodically</a></li><li><a href="#task_rht_dht_1s">Executing Configuration Scripts from the Unit File Management System Periodically</a></li><li><a href="#task_azs_hhp_yr">Executing Configuration Scripts from a File Server Each Time the Unit is Started </a></li><li><a href="#task_mgx_dlt_1s">Executing Configuration Scripts from the Unit File Management System Each Time the Unit is Started</a></li><li><a href="#task_ofy_g2q_5q">Configuring the Mediatrix Unit to Use an SNTP Server</a></li></ul></li><li><a href="#topic_title_Configuration_of_the_Mediatrix_Unit_d1e36">Configuration of the Mediatrix Unit</a><ul><li><a href="#task_z5d_4sy_xr">Importing a Configuration Script Using a File Server</a></li><li><a href="#task_w4f_tv5_1s">Importing a Configuration Script to the Unit File Management System</a></li><li><a href="#task_aqz_l45_yr">Configuring the DHCP to Trigger Configuration Script Execution</a></li><li><a href="#concept_zk3_lr5_yr">DHCPv4 Auto-Provisioning</a></li></ul></li><li><a href="#reference_dsd_hs4_yr">Unit Macros</a></li><li><a href="#reference_j4g_nbv_gfb">Online Help</a></li><li><a href="#reference_ur5_yx3_ps">Available 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="concept_plb_grn_rs">
<h1 class="title topictitle1" id="ariaid-title1">Auto-Provisioning Mediatrix Units with Configuration Scripts</h1>
<div class="body conbody">
<div class="p">This configuration describes how to use the Mediatrix unit's functionality that allows it to
fetch the firmware and configuration files automatically from a provisioning server by using
FTP, TFTP, HTTP or HTTPS.<br><img class="image" id="concept_plb_grn_rs__image_ljl_5tn_rs" src="https://documentation.media5corp.com/download/attachments/45482024/AutoProvisioningMediatrixUnits.png" width="800"><br></div>
<div class="note note note_note"><span class="note__title">Note:</span> Mediatrix units can also be provisioned with the Virtuo Element Management System (EMS).
For more details on using the Virtuo EMS, refer to the Virtuo documentation published on
the Media5 documentation portal at <a class="xref" href="https://documentation.media5corp.com/" target="_blank">https://documentation.media5corp.com/</a>.</div>
</div>
</article><hr><span style="float: inline-end;"><a href="#">Top</a></span><article class="topic nested0 nobody" aria-labelledby="ariaid-title2" id="topic_title_Overview_of_the_Server_Configuration_d1e15">
<h1 class="title topictitle1" id="ariaid-title2">Overview of the Server Configuration</h1>
<article class="topic task nested1" aria-labelledby="ariaid-title3" id="task_jv3_dc4_rs">
<h2 class="title topictitle2" id="ariaid-title3">Preparing Windows Server IIS</h2>
<div class="body taskbody">
<section class="section prereq"><div class="tasklabel"><strong class="sectiontitle tasklabel">Before you begin</strong></div>If using Windows, ensure that the HTTP Server functionality is activated and that
the configuration files and binaries are located under (default location):
C:\lnetpub\wwwroot</section>
<section class="section context"><div class="tasklabel"><strong class="sectiontitle tasklabel">Context</strong></div>Media5 recommends that the administrator creates a subdirectory for the firmware
and another subdirectory for the configuration files under the Web Server root
directory.</section>
<section><div class="tasklabel"><strong class="sectiontitle tasklabel">Steps</strong></div><ol class="ol steps"><li class="li step">
<span class="ph cmd">Create a subdirectory for the firmware under the Web Server root
directory.</span>
</li><li class="li step">
<span class="ph cmd">Create a subdirectory for the configuration files under the Web Server root
directory.</span>
</li></ol></section>
<section class="section result"><div class="tasklabel"><strong class="sectiontitle tasklabel">Result</strong></div>
<br><img class="image" id="task_jv3_dc4_rs__image_m5r_s24_rs" src="https://documentation.media5corp.com/download/attachments/45482024/WindowsWebServer%28IIS%29.png" width="700"><br>
</section>
</div>
<nav role="navigation" class="related-links"><div class="linklist relinfo reltasks"><div class="linklistlabel"><strong class="sectiontitle linklistlabel">Next Step</strong></div><ul class="linklist"><li class="linklist"><a class="link" href="#task_u1j_3f1_yr">Exporting a Configuration Script Using a File Server</a></li></ul></div></nav></article><hr><span style="float: inline-end;"><a href="#">Top</a></span><article class="topic task nested1" aria-labelledby="ariaid-title4" id="task_owx_nf4_rs">
<h2 class="title topictitle2" id="ariaid-title4">Preparing the Pumpkin TFTP Server</h2>
<div class="body taskbody">
<section class="section prereq"><div class="tasklabel"><strong class="sectiontitle tasklabel">Before you begin</strong></div>If you are using the Pumpkin TFTP server, ensure that it allows proper permission.
For the PumpKIN TFTP server, please make sure that the options are selected as shown in
the figure below.</section>
<section class="section context"><div class="tasklabel"><strong class="sectiontitle tasklabel">Context</strong></div>Media5 recommends that the administrator creates a subdirectory for the firmware
and another subdirectory for the configuration files under TFTP root.</section>
<section><div class="tasklabel"><strong class="sectiontitle tasklabel">Steps</strong></div><ol class="ol steps"><li class="li step">
<span class="ph cmd">Create a subdirectory for the firmware under C:\PumpKIN\</span>
</li><li class="li step">
<span class="ph cmd">Create a subdirectory for configuration files under C:\PumpKIN\</span>
</li></ol></section>
<section class="section result"><div class="tasklabel"><strong class="sectiontitle tasklabel">Result</strong></div>
<br><img class="image" id="task_owx_nf4_rs__image_vvj_kht_jv" src="https://documentation.media5corp.com/download/attachments/45482024/PumpKINTFTP.png" width="500"><br>
</section>
</div>
<nav role="navigation" class="related-links"><div class="linklist relinfo reltasks"><div class="linklistlabel"><strong class="sectiontitle linklistlabel">Next Step</strong></div><ul class="linklist"><li class="linklist"><a class="link" href="#task_u1j_3f1_yr">Exporting a Configuration Script Using a File Server</a></li></ul></div></nav></article></article><hr><span style="float: inline-end;"><a href="#">Top</a></span><article class="topic nested0 nobody" aria-labelledby="ariaid-title5" id="topic_title_Configuration_Scripts_d1e18">
<h1 class="title topictitle1" id="ariaid-title5">Configuration Scripts</h1>
<article class="topic concept nested1" aria-labelledby="ariaid-title6" id="concept_cw1_fhg_1r">
<h2 class="title topictitle2" id="ariaid-title6">Configuration Scripts</h2>
<div class="body conbody"><p class="shortdesc">Configuration scripts are files containing textual commands that are sent from the ACS
over the network to a Mediatrix unit. </p>
<p class="p">Configuration scripts support all configuration parameters and can be created for a group of
units or for a specific unit of the Network. </p>
<p class="p">The automated importation of configuration scripts can be performed with the use of a Customer
Profile or using a DHCP server indicating the location of the file server with options 66 or 67.
The automated importation to a unit is what is referred to as zero-touch, as the unit is
automatically updated with the latest configuration without manual intervention.</p>
<p class="p">When the configuration scripts are received, the unit executes each command line in sequence.
Script commands can assign values to configuration parameters, or execute configuration commands.
Scripts are written by the system administrator and can be used to accomplish various tasks, such
as automating recurrent configuration tasks or batch-applying configuration settings to multiple
devices. They can also be scheduled to be executed when the Mediatrix unit restarts.</p>
<div class="p">They can, for example, update the value of parameters, initiate a firmware upgrade, service
restart, or unit reboot. The scripts can be imported by the unit in different situations: <ul class="ul" id="concept_cw1_fhg_1r__ul_ugx_ypm_1r">
<li class="li">When the unit is restarted</li>
<li class="li">According to a pre-determined schedule</li>
<li class="li">Initiated by a DHCP server indicating where the script files are located using options 66
and 67</li>
</ul></div>
<div class="p">Scripts can be sent using the following protocols:<ul class="ul" id="concept_cw1_fhg_1r__ul_md1_npm_1r">
<li class="li">FTP</li>
<li class="li">TFTP</li>
<li class="li">HTTP</li>
<li class="li">HTTPS</li>
</ul></div>
<p class="p">The configuration script download feature allows updating the Mediatrix unit configuration by
transferring a configuration script from a remote server or from the local file system. The
Mediatrix unit is the session initiator, which allows NAT traversal. You can also configure the
Mediatrix unit to automatically update its configuration or you can generate a configuration
script from the running configuration of the Mediatrix unit. </p>
</div>
</article><hr><span style="float: inline-end;"><a href="#">Top</a></span><article class="topic task nested1" aria-labelledby="ariaid-title7" id="task_syk_fkb_wr">
<h2 class="title topictitle2" id="ariaid-title7">Configuring the FTP Server </h2>
<div class="body taskbody">
<section class="section prereq"><div class="tasklabel"><strong class="sectiontitle tasklabel">Before you begin</strong></div>If you are not familiar with the procedure on how to set the FTP root path, please
refer to your FTP server's documentation.</section>
<section class="section context"><div class="tasklabel"><strong class="sectiontitle tasklabel">Context</strong></div>
<p class="p">Perform this procedure if you plan to use the FTP transport protocol.</p>
</section>
<section id="task_syk_fkb_wr__steps_ukh_gkb_wr"><div class="tasklabel"><strong class="sectiontitle tasklabel">Steps</strong></div><ol class="ol steps" id="task_syk_fkb_wr__steps_ukh_gkb_wr"><li class="li step stepexpand">
<span class="ph cmd">Set an FTP service on the assigned server.</span>
</li><li class="li step stepexpand">
<span class="ph cmd">Make sure the FTP server can be reached by the Mediatrix unit.</span>
<div class="itemgroup info">
<div class="note note note_note"><span class="note__title">Note:</span> If the file server is located behind a firewall, make sure that TCP port
21 is open.</div>
</div>
</li></ol></section>
</div>
</article><hr><span style="float: inline-end;"><a href="#">Top</a></span><article class="topic task nested1" aria-labelledby="ariaid-title8" id="task_dpx_4dq_5q">
<h2 class="title topictitle2" id="ariaid-title8">Configuring the TFTP Server</h2>
<div class="body taskbody">
<section class="section prereq"><div class="tasklabel"><strong class="sectiontitle tasklabel">Before you begin</strong></div>If you are not familiar with the procedure on how to set the TFTP root path, please
refer to your TFTP server's documentation.</section>
<section class="section context"><div class="tasklabel"><strong class="sectiontitle tasklabel">Context</strong></div>Perform this procedure if you plan to use the TFTP transport protocol.</section>
<section><div class="tasklabel"><strong class="sectiontitle tasklabel">Steps</strong></div><ol class="ol steps"><li class="li step stepexpand">
<span class="ph cmd">Set a TFTP service on the assigned server.</span>
</li><li class="li step stepexpand">
<span class="ph cmd">Make sure the TFTP server can be reached by the Mediatrix unit.</span>
<div class="itemgroup info">
<div class="note note note_note"><span class="note__title">Note:</span> If the file server is located behind a firewall, make sure the UDP port 69
is open.</div>
</div>
</li></ol></section>
</div>
</article><hr><span style="float: inline-end;"><a href="#">Top</a></span><article class="topic task nested1" aria-labelledby="ariaid-title9" id="task_ebc_zwg_wq">
<h2 class="title topictitle2" id="ariaid-title9">Configuring the HTTP Server</h2>
<div class="body taskbody">
<section class="section prereq"><div class="tasklabel"><strong class="sectiontitle tasklabel">Before you begin</strong></div>If you are not familiar with the procedure on how to set the HTTP root path, refer
to your HTTP server's documentation. </section>
<section class="section context"><div class="tasklabel"><strong class="sectiontitle tasklabel">Context</strong></div>Perform this procedure if you plan to use the HTTP transport protocol.</section>
<section><div class="tasklabel"><strong class="sectiontitle tasklabel">Steps</strong></div><ol class="ol steps"><li class="li step stepexpand">
<span class="ph cmd">Set an HTTP service on the assigned server.</span>
</li><li class="li step stepexpand">
<span class="ph cmd">Make sure the HTTP server can be reached by the Mediatrix unit.</span>
<div class="itemgroup info">
<div class="note note note_note"><span class="note__title">Note:</span> If the file server is located behind a firewall, make sure the TCP port 80
is open.</div>
</div>
</li></ol></section>
</div>
</article><hr><span style="float: inline-end;"><a href="#">Top</a></span><article class="topic task nested1" aria-labelledby="ariaid-title10" id="task_qhf_hyg_wq">
<h2 class="title topictitle2" id="ariaid-title10">Configuring the HTTPS Server</h2>
<div class="body taskbody">
<section class="section prereq"><div class="tasklabel"><strong class="sectiontitle tasklabel">Before you begin</strong></div> If you are not familiar with the procedure on how to set the HTTPS root path,
please refer to your HTTPS documentation. <p class="p">Make sure the unit is set to the proper
date (refer to <a class="xref" href="#task_ofy_g2q_5q">Configuring the Mediatrix Unit to Use an SNTP Server</a>.</p></section>
<section class="section context"><div class="tasklabel"><strong class="sectiontitle tasklabel">Context</strong></div>Perform this procedure if you plan to use the HTTPS transport protocol.</section>
<section><div class="tasklabel"><strong class="sectiontitle tasklabel">Steps</strong></div><ol class="ol steps"><li class="li step stepexpand">
<span class="ph cmd">Set an HTTPS service on the assigned server.</span>
</li><li class="li step stepexpand">
<span class="ph cmd">Make sure the HTTPS server can be reached by the Mediatrix unit.</span>
<div class="itemgroup info">
<div class="note note note_note"><span class="note__title">Note:</span> If the file server is located behind a firewall, make sure the TCP port
443 is open.</div>
</div>
</li><li class="li step stepexpand">
<span class="ph cmd">Make sure that in the <span class="keyword wintitle">Management</span>/<span class="keyword wintitle">Certificates</span> tab, in the
<span class="keyword wintitle">Certificate Import Through Web
Browser</span> table, there is a certificate that authenticates the HTTPS server selected in
the <span class="keyword wintitle">Path</span> field, and
that <span class="keyword wintitle">Other</span> is selected
in the <span class="keyword wintitle">Type</span>
field.</span>
</li><li class="li step stepexpand">
<span class="ph cmd">Set the configuration parameters.</span>
</li></ol></section>
</div>
<hr><span style="float: inline-end;"><a href="#">Top</a></span><article class="topic concept nested2" aria-labelledby="ariaid-title11" id="concept_vtd_gkg_yr">
<h3 class="title topictitle3" id="ariaid-title11">Parameters</h3>
<div class="body conbody">
<div class="p">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:<ul class="ul" id="concept_vtd_gkg_yr__ul_gfn_14v_wr">
<li class="li">using a MIB browser, such as the Mediatrix Unit Manager Network (UMN);</li>
<li class="li">using the CLI;</li>
<li class="li">creating a configuration script containing the configuration parameters.</li>
</ul></div>
</div>
</article></article><hr><span style="float: inline-end;"><a href="#">Top</a></span><article class="topic task nested1" aria-labelledby="ariaid-title12" id="task_u1j_3f1_yr">
<h2 class="title topictitle2" id="ariaid-title12">Exporting a Configuration Script Using a File Server</h2>
<div class="body taskbody">
<section class="section prereq"><div class="tasklabel"><strong class="sectiontitle tasklabel">Before you begin</strong></div>Depending on the type of transport protocol used, one of the following procedures
must be completed: <ul class="ul" id="task_u1j_3f1_yr__ul_lpt_1qz_xv">
<li class="li"><a class="xref" href="#task_syk_fkb_wr">Configuring the FTP Server</a></li>
<li class="li"><a class="xref" href="#task_dpx_4dq_5q">Configuring the TFTP Server</a></li>
<li class="li"><a class="xref" href="#task_ebc_zwg_wq">Configuring the HTTP Server</a></li>
<li class="li"><a class="xref" href="#task_qhf_hyg_wq">Configuring the HTTPS Server</a></li>
</ul></section>
<section id="task_u1j_3f1_yr__steps_n14_vvy_xr"><div class="tasklabel"><strong class="sectiontitle tasklabel">Steps</strong></div><ol class="ol steps" id="task_u1j_3f1_yr__steps_n14_vvy_xr"><li class="li step stepexpand">
<span class="ph cmd">Go to <span class="keyword wintitle">Management</span>/<span class="keyword wintitle">Configuration Scripts</span>/<span class="keyword wintitle">Export</span>.</span>
</li><li class="li step stepexpand">
<span class="ph cmd">In the <span class="keyword wintitle">Export Script</span>
table, from the <span class="keyword wintitle">Content</span> selection list, choose if you wish to export only what is different from the
factory configuration script or the complete configuration. </span>
</li><li class="li step stepexpand">
<span class="ph cmd">From the <span class="keyword wintitle">Service Name</span>
selection list, choose if you wish to export the configuration script of a
specific service or of all services.</span>
</li><li class="li step stepexpand">
<span class="ph cmd">In the <span class="keyword wintitle">Send To URL</span>
field, enter the
<code class="ph codeph">protocol://[user[:password]@]hostname[:port]/[path/]filename</code>
where to export the configuration file.</span>
<div class="itemgroup info">
<div class="note note note_note"><span class="note__title">Note:</span> This must be consistent with the file server you have configured. The file
name may be replaced by a macro. For more details, refer to the <a class="xref" href="#reference_dsd_hs4_yr">Unit Macros</a> section. As a
best practice, add the *.cfg extension to the file name.</div>
</div>
<div class="itemgroup info">
<div class="note note note_note"><span class="note__title">Note:</span> 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 script, the interfaces used, the device model,
etc.</div>
</div>
</li><li class="li step stepexpand">
<span class="ph cmd">If you wish to use encryption for transfer operations, enter a encryption key
in the <span class="keyword wintitle">Privacy Key</span>
field. </span>
<div class="itemgroup info">
<div class="note note note_note"><span class="note__title">Note:</span> Media5 corp strongly recommends to use encryption to protect certificates
and passwords.</div>
</div>
</li><li class="li step stepexpand">
<span class="ph cmd">Make sure the file server is started.</span>
</li><li class="li step stepexpand">
<span class="ph cmd">Click <span class="keyword wintitle">Export and Download</span>.</span>
</li></ol></section>
<section class="section result"><div class="tasklabel"><strong class="sectiontitle tasklabel">Result</strong></div>The configuration script will be exported to the specified file server.<br><img class="image" id="task_u1j_3f1_yr__image_nzy_dpt_1s" src="https://documentation.media5corp.com/download/attachments/45482024/ExportScript.png" width="800"><br></section>
</div>
<nav role="navigation" class="related-links"><div class="linklist relinfo reltasks"><div class="linklistlabel"><strong class="sectiontitle linklistlabel">Next Step</strong></div><ul class="linklist"><li class="linklist"><a class="link" href="#task_cwv_slh_yr">Executing Configuration Scripts from a File Server Periodically</a></li><li class="linklist"><a class="link" href="#task_rht_dht_1s">Executing Configuration Scripts from the Unit File Management System Periodically</a></li><li class="linklist"><a class="link" href="#task_azs_hhp_yr">Executing Configuration Scripts from a File Server Each Time the Unit is Started</a></li><li class="linklist"><a class="link" href="#task_mgx_dlt_1s">Executing Configuration Scripts from the Unit File Management System Each Time the Unit is Started</a></li></ul></div></nav></article></article><hr><span style="float: inline-end;"><a href="#">Top</a></span><article class="topic nested0 nobody" aria-labelledby="ariaid-title13" id="topic_title_Encryption_d1e26">
<h1 class="title topictitle1" id="ariaid-title13">Encryption</h1>
<article class="topic concept nested1" aria-labelledby="ariaid-title14" id="concept_ztd_4m4_rs">
<h2 class="title topictitle2" id="ariaid-title14">Securing Configuration Scripts</h2>
<div class="body conbody"><p class="shortdesc">Media5 provides an encryption tool (MxCryptFile) to secure the configuration scripts on
the server.</p>
<section class="section">
<p class="p">There are two encryption algorithms available: </p>
<ul class="ul">
<li class="li"><var class="keyword varname">AES-256 GCM</var> (recommended, available since DGW 47.0)</li>
<li class="li"><var class="keyword varname">Blowfish ECB</var> (legacy).</li>
</ul>
<p class="p">Once the file is encrypted, the transfer of the information over the network is secure. The
encryption key must be configured on the Mediatrix units in order to decipher the
information. The unit detects automatically the encryption algorithm from the file.</p>
<p class="p">Ensure that the Mediatrix unit is configured with the correct Privacy key in order to
decipher the information. Without the proper key, the parameters in the encrypted script
would not be applied to the Mediatrix unit.</p>
<p class="p">In any case, the same key is used to decrypt both the generic and specific configuration
scripts. When a key is defined, unencrypted configuration scripts are not allowed to be
executed.</p>
</section>
</div>
</article><hr><span style="float: inline-end;"><a href="#">Top</a></span><article class="topic task nested1" aria-labelledby="ariaid-title15" id="task_zyc_vrn_12v">
<h2 class="title topictitle2" id="ariaid-title15">Securing the configuration scripts using AES-256 GCM</h2>
<div class="body taskbody">
<section class="section prereq"><div class="tasklabel"><strong class="sectiontitle tasklabel">Before you begin</strong></div>
<div class="note note note_note"><span class="note__title">Note:</span> You may need to install python and the cryptography module for python: <ul class="ul" id="task_zyc_vrn_12v__ul_rtx_14z_t4b">
<li class="li">For MacOS, python3 is already pre-installed on recent MacOS versions.</li>
<li class="li">For Linux, some distribution already pre-install python3. Otherwise use the
appropriate package manager to install python3 and pip3.</li>
<li class="li">For Windows, use an installation package from
https://www.python.org/downloads/windows/ or install from the Windows Store on a clean
install of Windows 10. Make sure to add application to PATH to facilitate usage.</li>
</ul>Once python is installed use the pip package manager to install the cryptography
module. Execute the following in a command prompt/terminal: <code class="ph codeph">pip3 install
cryptography</code>
</div>
</section>
<section class="section context"><div class="tasklabel"><strong class="sectiontitle tasklabel">Context</strong></div>
<p class="p">To secure the configuration scripts using <var class="keyword varname">AES-256</var>, the python script
<code class="ph codeph">MxCryptFileAes.py</code> is available. The key is a password of variable-length
ASCII characters. For optimal security, it is recommended to use a password of at least 42
characters. The maximum length is 256 characters.</p>
<p class="p">This is an example of the python script:</p>
<div class="p"><pre class="pre codeblock"><code>Usage:
MxCryptFileAes.py -in <input file> -out <output file> -k <key> [-enc|-dec]
where:
-in <input file>
Specifies the file to read from
-out <output file>
Specifies the file to write to
-k <key>
The key in variable size.
-enc
Perform encryption (default).
-dec
Perform decryption.</code></pre></div>
<div class="p">The following are some examples of MxCryptFileAes.py commands:<ul class="ul" id="task_zyc_vrn_12v__ul_kc4_m44_rs2">
<li class="li"><code class="ph codeph">MxCryptFileAes.py -in mediatrix.cfg -out mediatrix_encrypted.cfg.bin -k MyPassword -enc</code></li>
<li class="li"><code class="ph codeph">MxCryptFileAes.py -in mediatrix_encrypted.cfg.bin -out mediatrix.cfg -k MyPassword -dec</code></li>
</ul></div>
<div class="note note note_note"><span class="note__title">Note:</span> This python script also support decrypting backup image files. </div>
</section>
</div>
</article><hr><span style="float: inline-end;"><a href="#">Top</a></span><article class="topic task nested1" aria-labelledby="ariaid-title16" id="task_zyc_vrn_13v">
<h2 class="title topictitle2" id="ariaid-title16">Securing the configuration scripts using Blowfish</h2>
<div class="body taskbody">
<section class="section context"><div class="tasklabel"><strong class="sectiontitle tasklabel">Context</strong></div>
<p class="p">To secure the configuration scripts using <var class="keyword varname">Blowfish</var>, the perl and exe scripts
(<code class="ph codeph">MxCryptFile.pl</code> and <code class="ph codeph">MxCryptFile.exe</code>) are available. The key is encoded in
hexadecimal notation, meaning only characters in the range 0-9 and A-F can be used. The
maximum key length is 64 hex characters, which gives a binary key of 256 bits. It is the
maximum key size accepted by the MxCryptFile external tool. For example, a 32-bit key could
look like: A36CB299.</p>
<p class="p">This is an example of the tool running on Windows:</p>
<pre class="pre codeblock"><code>MxCryptFile version 1.0.3.5
Copyright(c) 2009 Media5 Corporation
Usage:
MxCryptFile -h Display online help
or
MxCryptFile -in <input file name>
-out <output file name>
-k <key string>
[-s]
[-enc|-dec]
where:
<input file name>: name of the file to read
<output file name>: name of the file to write
<key string>: key string (allowed characters are 0-9, a-f, A-F)
-s: run in silent mode (no display)
-enc: encrypt (default)
-dec: decrypt</code></pre>
<div class="p">The following are some examples of MxCryptFile.exe commands:<ul class="ul" id="task_zyc_vrn_13v__ul_kc4_m44_rs">
<li class="li"><code class="ph codeph">MxCryptFile.exe -in Mediatrix_4102_unencrypted.cfg –out Mediatrix4102.cfg.bin –k 12345678</code></li>
<li class="li"><code class="ph codeph">MxCryptFile.exe –in 0090F8XXXXXX_unencrypted.cfg –out 0090F8XXXXXX.cfg.bin –k 89bb6758ac895f56</code></li>
</ul></div>
</section>
</div>
</article></article><hr><span style="float: inline-end;"><a href="#">Top</a></span><article class="topic nested0 nobody" aria-labelledby="ariaid-title17" id="topic_title_Preparation_of_the_Configuration_Files_and_Firmware_d1e30">
<h1 class="title topictitle1" id="ariaid-title17">Preparation of the Configuration Files and Firmware</h1>
<article class="topic task nested1" aria-labelledby="ariaid-title18" id="task_cwv_slh_yr">
<h2 class="title topictitle2" id="ariaid-title18">Executing Configuration Scripts from a File Server Periodically</h2>
<div class="body taskbody">
<section class="section prereq"><div class="tasklabel"><strong class="sectiontitle tasklabel">Before you begin</strong></div>Depending on the type of transport protocol used, one of the following procedures
must be completed: <ul class="ul" id="task_cwv_slh_yr__ul_ftj_5dp_wr">
<li class="li"><a class="xref" href="#task_syk_fkb_wr">Configuring the FTP Server</a></li>
<li class="li"><a class="xref" href="#task_dpx_4dq_5q">Configuring the TFTP Server</a></li>
<li class="li"><a class="xref" href="#task_ebc_zwg_wq">Configuring the HTTP Server</a></li>
<li class="li"><a class="xref" href="#task_qhf_hyg_wq">Configuring the HTTPS Server</a></li>
</ul><p class="p">Mediatrix units do not all include a real time clock allowing them to maintain
accurate time when they are shutdown. You must have a time server SNTP that is
accessible and properly configured or the automatic configuration update feature may
not work properly. Refer to <a class="xref" href="#task_ofy_g2q_5q">Configuring the Mediatrix Unit to Use an SNTP Server</a>.</p></section>
<section id="task_cwv_slh_yr__steps_n14_vvy_xr"><div class="tasklabel"><strong class="sectiontitle tasklabel">Steps</strong></div><ol class="ol steps" id="task_cwv_slh_yr__steps_n14_vvy_xr"><li class="li step stepexpand">
<span class="ph cmd">Go to <span class="keyword wintitle">Management</span>/<span class="keyword wintitle">Configuration Scripts</span>/<span class="keyword wintitle">Execute</span>.</span>
</li><li class="li step stepexpand">
<span class="ph cmd">In the <span class="keyword wintitle">Execute Scripts</span>
table, in the <span class="keyword wintitle">Generic File Name</span> and/or
<span class="keyword wintitle">Specific File Name</span>
field, indicate the name of the files you wish to import.</span>
<div class="itemgroup info">
<div class="note note note_note"><span class="note__title">Note:</span> The file name is case sensitive, and may be replaced by a macro. For more
details, refer to the <a class="xref" href="#reference_dsd_hs4_yr">Unit Macros</a> section. Make
sure to add the *.cfg. file extension.</div>
</div>
</li><li class="li step stepexpand">
<span class="ph cmd">From the <span class="keyword wintitle">Transfer Protocol</span> selection
list, select the type of protocol you wish to use to transfer your script. </span>
<div class="itemgroup info">
<div class="note note note_note"><span class="note__title">Note:</span> This must be consistent with the file server you have configured.</div>
</div>
</li><li class="li step stepexpand">
<span class="ph cmd">In the <span class="keyword wintitle">Host Name</span>
field, enter the file server IP address or FQDN.</span>
</li><li class="li step stepexpand">
<span class="ph cmd">In the <span class="keyword wintitle">Location</span>
field, enter the path relative to the root of the file server where the script
is saved. </span>
</li><li class="li step stepexpand">
<span class="ph cmd">If your server requires authentication, enter your username and password.
</span>
</li><li class="li step stepexpand">
<span class="ph cmd">If the files are encrypted, provide the privacy key in the <span class="keyword wintitle">Privacy Parameters</span>
section.</span>
<div class="itemgroup info">
<div class="note note note_note"><span class="note__title">Note:</span> The privacy key must match the privacy key used to encrypt the
file.</div>
</div>
</li><li class="li step stepexpand">
<span class="ph cmd">Make sure the file server is started.</span>
</li><li class="li step stepexpand">
<span class="ph cmd">In the <span class="keyword wintitle">Automatic Script
Execution</span>
section, from the <span class="keyword wintitle">Execute Periodically</span>
selection list, choose <span class="keyword wintitle">Enable</span>. </span>
</li><li class="li step stepexpand">
<span class="ph cmd">Complete the <span class="keyword wintitle">Time Unit</span>, <span class="keyword wintitle">Period</span> and
<span class="keyword wintitle">Time Range</span> fields
according to your needs.</span>
<div class="itemgroup info">
<div class="note note note_note"><span class="note__title">Note:</span> The time range ( hh[:mm[:ss]] or hh[:mm[:ss]] - hh[:mm[:ss]]) is based on
the <span class="keyword wintitle">Static Time Zone</span>
field, under the <span class="keyword wintitle">Network</span> > <span class="keyword wintitle">Host</span> page.</div>
</div>
</li><li class="li step stepexpand">
<span class="ph cmd">As a best practice, enable the <span class="keyword wintitle">Allow Repeated Execution</span>
field.</span>
</li><li class="li step stepexpand">
<span class="ph cmd">Click <span class="keyword wintitle">Apply</span>.</span>
</li></ol></section>
<section class="section result"><div class="tasklabel"><strong class="sectiontitle tasklabel">Result</strong></div>The configuration script will be imported from the file server at the specified time
or at a random time within the specified interval and thereafter at the period defined
by the <span class="keyword wintitle">Period</span> field. Any
change to the script will be applied to the running configuration. The unit
configuration is only updated if at least one parameter value defined in the imported
configuration scripts is different from the actual unit configuration. Keep in mind that
if you import a generic and a specific file, the commands of the specific file will
override the commands of the generic file.<br><img class="image" id="task_cwv_slh_yr__image_g1x_s2n_dhb" src="https://documentation.media5corp.com/download/attachments/45482024/ExecuteScripts.png" width="800"><br></section>
</div>
<nav role="navigation" class="related-links"><div class="linklist relinfo reltasks"><div class="linklistlabel"><strong class="sectiontitle linklistlabel">Next Step</strong></div><ul class="linklist"><li class="linklist"><a class="link" href="#task_z5d_4sy_xr">Importing a Configuration Script Using a File Server</a></li><li class="linklist"><a class="link" href="#task_aqz_l45_yr" title="The Mediatrix unit can be configured to automatically import new configuration scripts upon receiving options 66 (tftp-server) or 67 (bootfile), or vendor-specific option 43 using sub-options 66 and 67 in a DHCPv4 answer. A DHCP answer includes both Bound and Renew.">Configuring the DHCP to Trigger Configuration Script Execution</a></li></ul></div></nav></article><hr><span style="float: inline-end;"><a href="#">Top</a></span><article class="topic task nested1" aria-labelledby="ariaid-title19" id="task_rht_dht_1s">
<h2 class="title topictitle2" id="ariaid-title19">Executing Configuration Scripts from the Unit File Management System Periodically</h2>
<div class="body taskbody">
<section class="section prereq"><div class="tasklabel"><strong class="sectiontitle tasklabel">Before you begin</strong></div><p class="p">You must have a time server SNTP that is accessible and properly configured or
the automatic configuration update feature may not work properly. Refer to <a class="xref" href="#task_ofy_g2q_5q">Configuring the Mediatrix Unit to Use an SNTP Server</a>. Configuration scripts files must be available in the unit's file management
system. Refer to <a class="xref" href="#task_w4f_tv5_1s">Importing a Configuration Script to the Unit File Management System</a>.</p>A configuration script must have been imported to the unit's file management
system. Refer to <a class="xref" href="#task_w4f_tv5_1s">Importing a Configuration Script to the Unit File Management System</a>.</section>
<section id="task_rht_dht_1s__steps_n14_vvy_xr"><div class="tasklabel"><strong class="sectiontitle tasklabel">Steps</strong></div><ol class="ol steps" id="task_rht_dht_1s__steps_n14_vvy_xr"><li class="li step stepexpand">
<span class="ph cmd">Go to <span class="keyword wintitle">Management</span>/<span class="keyword wintitle">Configuration Scripts</span>/<span class="keyword wintitle">Execute</span>.</span>
</li><li class="li step stepexpand">
<span class="ph cmd">In the <span class="keyword wintitle">Execute Scripts</span>
table, in the <span class="keyword wintitle">Generic File Name</span> and/or
<span class="keyword wintitle">Specific File Name</span>
field, indicate the name of the files you wish to import or use the <span class="keyword wintitle">Suggestion</span> selection
list.</span>
<div class="itemgroup info">
<div class="note note note_note"><span class="note__title">Note:</span> The file name is case sensitive, and may be replaced by a macro. For more
details, refer to the <a class="xref" href="#reference_dsd_hs4_yr">Unit Macros</a> section. Make
sure to add the *.cfg. file extension.</div>
</div>
</li><li class="li step stepexpand">
<span class="ph cmd">From the <span class="keyword wintitle">Transfer Protocol</span> selection
list, select <span class="keyword wintitle">File</span>.
</span>
</li><li class="li step stepexpand">
<span class="ph cmd">If the files are encrypted, provide the privacy key in the <span class="keyword wintitle">Privacy Key</span> field.</span>
<div class="itemgroup info">
<div class="note note note_note"><span class="note__title">Note:</span> The privacy key must match the privacy key used to encrypt the
files.</div>
</div>
</li><li class="li step stepexpand">
<span class="ph cmd">In the <span class="keyword wintitle">Automatic Script
Execution</span>
section, from the <span class="keyword wintitle">Execute Periodically</span>
selection list, choose <span class="keyword wintitle">Enable</span>. </span>
</li><li class="li step stepexpand">
<span class="ph cmd">Complete the <span class="keyword wintitle">Time Unit</span>, <span class="keyword wintitle">Period</span> and
<span class="keyword wintitle">Time Range</span> fields
according to your needs.</span>
<div class="itemgroup info">
<div class="note note note_note"><span class="note__title">Note:</span> The time range ( hh[:mm[:ss]] or hh[:mm[:ss]] - hh[:mm[:ss]]) is based on
the <span class="keyword wintitle">Static Time Zone</span>
field, under the <span class="keyword wintitle">Network</span> > <span class="keyword wintitle">Host</span> page.</div>
</div>
</li><li class="li step stepexpand">
<span class="ph cmd">As a best practice, enable the <span class="keyword wintitle">Allow Repeated Execution</span>
field.</span>
</li><li class="li step stepexpand">
<span class="ph cmd">Click <span class="keyword wintitle">Apply</span>.</span>
</li></ol></section>
<section class="section result"><div class="tasklabel"><strong class="sectiontitle tasklabel">Result</strong></div>The configuration script will be imported from the system's file management system
at the specified time or at a random time within the specified interval and thereafter
at the period defined by the <span class="keyword wintitle">Period</span> field. Any change to the
script will be applied to the running configuration. The unit configuration is only
updated if at least one parameter value defined in the imported configuration scripts is
different from the actual unit 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.<br><img class="image" id="task_rht_dht_1s__image_iyd_jyn_gkb" src="https://documentation.media5corp.com/download/attachments/45482024/AutomaticScriptExecution_File.png" width="800"><br></section>
</div>
<nav role="navigation" class="related-links"><div class="linklist relinfo reltasks"><div class="linklistlabel"><strong class="sectiontitle linklistlabel">Next Step</strong></div><ul class="linklist"><li class="linklist"><a class="link" href="#task_z5d_4sy_xr">Importing a Configuration Script Using a File Server</a></li><li class="linklist"><a class="link" href="#task_aqz_l45_yr" title="The Mediatrix unit can be configured to automatically import new configuration scripts upon receiving options 66 (tftp-server) or 67 (bootfile), or vendor-specific option 43 using sub-options 66 and 67 in a DHCPv4 answer. A DHCP answer includes both Bound and Renew.">Configuring the DHCP to Trigger Configuration Script Execution</a></li></ul></div></nav></article><hr><span style="float: inline-end;"><a href="#">Top</a></span><article class="topic task nested1" aria-labelledby="ariaid-title20" id="task_azs_hhp_yr">
<h2 class="title topictitle2" id="ariaid-title20">Executing Configuration Scripts from a File Server Each Time the Unit is Started </h2>
<div class="body taskbody">
<section class="section prereq"><div class="tasklabel"><strong class="sectiontitle tasklabel">Before you begin</strong></div>Depending on the type of transport protocol used, one of the following procedures
must be completed: <ul class="ul" id="task_azs_hhp_yr__ul_ftj_5dp_wr">
<li class="li"><a class="xref" href="#task_syk_fkb_wr">Configuring the FTP Server</a></li>
<li class="li"><a class="xref" href="#task_dpx_4dq_5q">Configuring the TFTP Server</a></li>
<li class="li"><a class="xref" href="#task_ebc_zwg_wq">Configuring the HTTP Server</a></li>
<li class="li"><a class="xref" href="#task_qhf_hyg_wq">Configuring the HTTPS Server</a></li>
</ul></section>
<section id="task_azs_hhp_yr__steps_n14_vvy_xr"><div class="tasklabel"><strong class="sectiontitle tasklabel">Steps</strong></div><ol class="ol steps" id="task_azs_hhp_yr__steps_n14_vvy_xr"><li class="li step stepexpand">
<span class="ph cmd">Go to <span class="keyword wintitle">Management</span>/<span class="keyword wintitle">Configuration Scripts</span>/<span class="keyword wintitle">Execute</span>.</span>
</li><li class="li step stepexpand">
<span class="ph cmd">From the <span class="keyword wintitle">Execute Scripts</span> table, in the <span class="keyword wintitle">Generic File Name</span> and/or
<span class="keyword wintitle">Specific File Name</span>
field, indicate the name of the files you wish to import.</span>
<div class="itemgroup info">
<div class="note note note_note"><span class="note__title">Note:</span> The file name is case sensitive, and may be replaced by a macro. For more
details, refer to the <a class="xref" href="#reference_dsd_hs4_yr">Unit Macros</a> section. Make
sure to add the *.cfg. file extension.</div>
</div>
</li><li class="li step stepexpand">
<span class="ph cmd">From the <span class="keyword wintitle">Transfer Protocol</span> selection
list, select the type of protocol you wish to use to transfer your script. </span>
<div class="itemgroup info">
<div class="note note note_note"><span class="note__title">Note:</span> This must be consistent with the file server you have configured.</div>
</div>
</li><li class="li step stepexpand">
<span class="ph cmd">In the <span class="keyword wintitle">Host Name</span>
field, enter the file server IP address or FQDN.</span>
</li><li class="li step stepexpand">
<span class="ph cmd">In the <span class="keyword wintitle">Location</span>
field, enter the path relative to the root of the file server where the script
is saved. </span>
</li><li class="li step stepexpand">
<span class="ph cmd">If your server requires authentication, enter your username and password.
</span>
</li><li class="li step stepexpand">
<span class="ph cmd">If the files are encrypted, provide the privacy key in the <span class="keyword wintitle">Privacy Parameters</span>
section.</span>
<div class="itemgroup info">
<div class="note note note_note"><span class="note__title">Note:</span> The privacy key must match the privacy key used to encrypt the
files.</div>
</div>
</li><li class="li step stepexpand">
<span class="ph cmd">Make sure the file server is started.</span>
</li><li class="li step stepexpand">
<span class="ph cmd">In the <span class="keyword wintitle">Automatic Script
Execution</span>
section, from the <span class="keyword wintitle">Execute on Startup</span> selection
list, choose <span class="keyword wintitle">Enable</span>.
</span>
</li><li class="li step stepexpand">
<span class="ph cmd">As a best practice, enable the <span class="keyword wintitle">Allow Repeated Execution</span>
field.</span>
</li><li class="li step stepexpand">
<span class="ph cmd">Click <span class="keyword wintitle">Apply</span>.</span>
</li></ol></section>
<section class="section result"><div class="tasklabel"><strong class="sectiontitle tasklabel">Result</strong></div>When the unit is restarted, the configuration script will be imported from the file
server, and any changes to the script will be applied to the running configuration. Keep
in mind that if you import a generic and a specific file, the commands of the specific
file will override the commands of the generic file.<br><img class="image" id="task_azs_hhp_yr__image_nyb_bzn_gkb" src="https://documentation.media5corp.com/download/attachments/45482024/AutomaticScriptExecution_File_eachUnitStart.png" width="800"><br></section>
</div>
<nav role="navigation" class="related-links"><div class="linklist relinfo reltasks"><div class="linklistlabel"><strong class="sectiontitle linklistlabel">Next Step</strong></div><ul class="linklist"><li class="linklist"><a class="link" href="#task_z5d_4sy_xr">Importing a Configuration Script Using a File Server</a></li><li class="linklist"><a class="link" href="#task_aqz_l45_yr" title="The Mediatrix unit can be configured to automatically import new configuration scripts upon receiving options 66 (tftp-server) or 67 (bootfile), or vendor-specific option 43 using sub-options 66 and 67 in a DHCPv4 answer. A DHCP answer includes both Bound and Renew.">Configuring the DHCP to Trigger Configuration Script Execution</a></li></ul></div></nav></article><hr><span style="float: inline-end;"><a href="#">Top</a></span><article class="topic task nested1" aria-labelledby="ariaid-title21" id="task_mgx_dlt_1s">
<h2 class="title topictitle2" id="ariaid-title21">Executing Configuration Scripts from the Unit File Management System Each Time the Unit
is Started</h2>
<div class="body taskbody">
<section class="section prereq"><div class="tasklabel"><strong class="sectiontitle tasklabel">Before you begin</strong></div>A configuration script must have been imported to the unit's file management system.
Refer to <a class="xref" href="#task_w4f_tv5_1s">Importing a Configuration Script to the Unit File Management System</a>.</section>
<section id="task_mgx_dlt_1s__steps_n14_vvy_xr"><div class="tasklabel"><strong class="sectiontitle tasklabel">Steps</strong></div><ol class="ol steps" id="task_mgx_dlt_1s__steps_n14_vvy_xr"><li class="li step stepexpand">
<span class="ph cmd">Go to <span class="keyword wintitle">Management</span>/<span class="keyword wintitle">Configuration Scripts</span>/<span class="keyword wintitle">Execute</span>.</span>
</li><li class="li step stepexpand">
<span class="ph cmd">From the <span class="keyword wintitle">Execute Scripts</span> table, in the <span class="keyword wintitle">Generic File Name</span> and/or
<span class="keyword wintitle">Specific File Name</span>
field, indicate the name of the files you wish to import or use the <span class="keyword wintitle">Suggestion</span> selection
list.</span>
<div class="itemgroup info">
<div class="note note note_note"><span class="note__title">Note:</span> The file name is case sensitive, and may be replaced by a macro. For more
details, refer to the <a class="xref" href="#reference_dsd_hs4_yr">Unit Macros</a> section. Make
sure to add the *.cfg. file extension.</div>
</div>
</li><li class="li step stepexpand">
<span class="ph cmd">From the <span class="keyword wintitle">Transfer Protocol</span> selection
list, select <span class="keyword wintitle">File</span>.
</span>
</li><li class="li step stepexpand">
<span class="ph cmd">If the files are encrypted, provide the privacy key in the <span class="keyword wintitle">Privacy Parameters</span>
section.</span>
</li><li class="li step stepexpand">
<span class="ph cmd">In the <span class="keyword wintitle">Automatic Script
Execution</span>
section, from the <span class="keyword wintitle">Execute on Startup</span> selection
list, choose <span class="keyword wintitle">Enable</span>.
</span>
</li><li class="li step stepexpand">
<span class="ph cmd">As a best practice, enable the <span class="keyword wintitle">Allow Repeated Execution</span>
field.</span>
</li><li class="li step stepexpand">
<span class="ph cmd">Click <span class="keyword wintitle">Apply</span>.</span>
</li></ol></section>
<section class="section result"><div class="tasklabel"><strong class="sectiontitle tasklabel">Result</strong></div>When the unit is restarted, the configuration script will be imported from the
system'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. <br><img class="image" id="task_mgx_dlt_1s__image_qbp_rzn_gkb" src="https://documentation.media5corp.com/download/attachments/45482024/ExecuteScripts_FileManagementSystem_EachUnitStartup.PNG" width="800"><br></section>
</div>
<nav role="navigation" class="related-links"><div class="linklist relinfo reltasks"><div class="linklistlabel"><strong class="sectiontitle linklistlabel">Next Step</strong></div><ul class="linklist"><li class="linklist"><a class="link" href="#task_z5d_4sy_xr">Importing a Configuration Script Using a File Server</a></li><li class="linklist"><a class="link" href="#task_aqz_l45_yr" title="The Mediatrix unit can be configured to automatically import new configuration scripts upon receiving options 66 (tftp-server) or 67 (bootfile), or vendor-specific option 43 using sub-options 66 and 67 in a DHCPv4 answer. A DHCP answer includes both Bound and Renew.">Configuring the DHCP to Trigger Configuration Script Execution</a></li></ul></div></nav></article><hr><span style="float: inline-end;"><a href="#">Top</a></span><article class="topic task nested1" aria-labelledby="ariaid-title22" id="task_ofy_g2q_5q">
<h2 class="title topictitle2" id="ariaid-title22">Configuring the Mediatrix Unit to Use an SNTP Server</h2>
<div class="body taskbody">
<section class="section prereq"><div class="tasklabel"><strong class="sectiontitle tasklabel">Before you begin</strong></div>Make sure there is an SNTP server available.</section>
<section class="section context"><div class="tasklabel"><strong class="sectiontitle tasklabel">Context</strong></div>
</section>
<section><div class="tasklabel"><strong class="sectiontitle tasklabel">Steps</strong></div><ol class="ol steps"><li class="li step stepexpand">
<span class="ph cmd">Go to <span class="keyword wintitle">Network</span>/<span class="keyword wintitle">Host</span>.</span>
</li><li class="li step stepexpand">
<span class="ph cmd">In the <span class="keyword wintitle">SNTP Configuration</span> table,
from the <span class="keyword wintitle">Configuration Source</span>
selection list, select the connection type from which you wish to obtain the
SNTP parameters. </span>
<div class="itemgroup info">
<div class="note note note_note"><span class="note__title">Note:</span> Complete <a class="xref" href="#task_ofy_g2q_5q__Step3">Step 3</a>
only if you are using static SNTP server(s), otherwise go to <a class="xref" href="#task_ofy_g2q_5q__Step4">Step 4</a>.</div>
</div>
</li><li class="li step stepexpand">
<span class="ph cmd" id="task_ofy_g2q_5q__Step3">Provide an IP address or domain name and port numbers for each SNTP
server you are using.</span>
</li><li class="li step stepexpand" id="task_ofy_g2q_5q__Step4">
<span class="ph cmd">If necessary, change the displayed default value of the <span class="keyword wintitle">Synchronisation Period</span>.</span>
</li><li class="li step stepexpand">
<span class="ph cmd">If necessary, change the displayed default value of the <span class="keyword wintitle">Synchronisation Period on Error</span>.</span>
</li><li class="li step stepexpand">
<span class="ph cmd">Click <span class="keyword wintitle">Apply</span>.</span>
</li></ol></section>
<section class="section result"><div class="tasklabel"><strong class="sectiontitle tasklabel">Result</strong></div>The SNTP host name and port will be displayed in the <span class="keyword wintitle">Host Status</span> table under <span class="keyword wintitle">Network</span>/<span class="keyword wintitle">Status</span>.<br><img class="image" id="task_ofy_g2q_5q__image_ixb_rl4_1s" src="https://documentation.media5corp.com/download/attachments/45482024/SNTPConfiguration.png" width="800"><br></section>
</div>
</article></article><hr><span style="float: inline-end;"><a href="#">Top</a></span><article class="topic nested0 nobody" aria-labelledby="ariaid-title23" id="topic_title_Configuration_of_the_Mediatrix_Unit_d1e36">
<h1 class="title topictitle1" id="ariaid-title23">Configuration of the Mediatrix Unit</h1>
<article class="topic task nested1" aria-labelledby="ariaid-title24" id="task_z5d_4sy_xr">
<h2 class="title topictitle2" id="ariaid-title24">Importing a Configuration Script Using a File Server</h2>
<div class="body taskbody">
<section class="section prereq"><div class="tasklabel"><strong class="sectiontitle tasklabel">Before you begin</strong></div>Depending on the type of transport protocol used, one of the following procedures
must be completed: <ul class="ul" id="task_z5d_4sy_xr__ul_ftj_5dp_wr">
<li class="li"><a class="xref" href="#task_syk_fkb_wr">Configuring the FTP Server</a></li>
<li class="li"><a class="xref" href="#task_dpx_4dq_5q">Configuring the TFTP Server</a></li>
<li class="li"><a class="xref" href="#task_ebc_zwg_wq">Configuring the HTTP Server</a></li>
<li class="li"><a class="xref" href="#task_qhf_hyg_wq">Configuring the HTTPS Server</a></li>
</ul></section>
<section id="task_z5d_4sy_xr__steps_n14_vvy_xr"><div class="tasklabel"><strong class="sectiontitle tasklabel">Steps</strong></div><ol class="ol steps" id="task_z5d_4sy_xr__steps_n14_vvy_xr"><li class="li step stepexpand">
<span class="ph cmd">Go to <span class="keyword wintitle">Management</span>/<span class="keyword wintitle">Configuration Scripts</span>/<span class="keyword wintitle">Execute</span>.</span>
</li><li class="li step stepexpand">
<span class="ph cmd">In the <span class="keyword wintitle">Execute Scripts</span>
table, in the <span class="keyword wintitle">Generic File Name</span> and/or
<span class="keyword wintitle">Specific File Name</span>
field, indicate the name of the files you wish to import.</span>
<div class="itemgroup info">
<div class="note note note_note"><span class="note__title">Note:</span> The file name is case sensitive and may be replaced by a macro. For more
details on macros, refer to the <a class="xref" href="#reference_dsd_hs4_yr">Unit Macros</a> section. Make
sure to add the *.cfg. file extension.</div>
</div>
</li><li class="li step stepexpand">
<span class="ph cmd">From the <span class="keyword wintitle">Transfer Protocol</span> selection
list, select the type of protocol you wish to use to transfer your configuration
script. </span>
<div class="itemgroup info">
<div class="note note note_note"><span class="note__title">Note:</span> This must be consistent with the file server you have configured.</div>
</div>
</li><li class="li step stepexpand">
<span class="ph cmd">In the <span class="keyword wintitle">Host Name</span>
field, enter the file server IP address or FQDN.</span>
</li><li class="li step stepexpand">
<span class="ph cmd">In the <span class="keyword wintitle">Location</span>
field, enter the path relative to the root of the file server where the
configuration script is saved.</span>
</li><li class="li step stepexpand">
<span class="ph cmd">If your server requires authentication, enter your username and password.</span>
</li><li class="li step stepexpand">
<span class="ph cmd">If the files are encrypted, provide the privacy key in the <span class="keyword wintitle">Privacy Key</span> field.</span>
<div class="itemgroup info">
<div class="note note note_note"><span class="note__title">Note:</span> The privacy key must match the privacy key used to encrypt the
file.</div>
</div>
</li><li class="li step stepexpand">
<span class="ph cmd">Make sure the file server is started.</span>
</li><li class="li step stepexpand">
<span class="ph cmd">Depending on your use case, set the <span class="keyword wintitle">Allow Repeated Execution</span>
field to <span class="keyword wintitle">Enable</span> or
<span class="keyword wintitle">Disable</span>. This
parameter defines if the Mediatrix unit will execute a script or not, when it is
the same as the last executed script.",</span>
</li><li class="li step stepexpand">
<span class="ph cmd">Click <span class="keyword wintitle">Apply & Execute</span>.</span>
</li></ol></section>
<section class="section result"><div class="tasklabel"><strong class="sectiontitle tasklabel">Result</strong></div>The configuration script will be imported from the file server, and any changes to
the script will be applied to the running configuration. Keep in mind that if you import
a generic and a specific file, the commands of the specific file will override the
commands of the generic file.<br><img class="image" id="task_z5d_4sy_xr__image_g1x_s2n_dhb" src="https://documentation.media5corp.com/download/attachments/45482024/ExecuteScripts.png" width="800"><br></section>
</div>
</article><hr><span style="float: inline-end;"><a href="#">Top</a></span><article class="topic task nested1" aria-labelledby="ariaid-title25" id="task_w4f_tv5_1s">
<h2 class="title topictitle2" id="ariaid-title25">Importing a Configuration Script to the Unit File Management System</h2>
<div class="body taskbody">
<section class="section prereq"><div class="tasklabel"><strong class="sectiontitle tasklabel">Before you begin</strong></div>This option is not available on the Mediatrix 4102S running a firmware version more
recent than DGW 2.0.26.451</section>
<section><div class="tasklabel"><strong class="sectiontitle tasklabel">Steps</strong></div><ol class="ol steps"><li class="li step stepexpand">
<span class="ph cmd">Go to <span class="keyword wintitle">Management</span>/<span class="keyword wintitle">File</span>.</span>
</li><li class="li step stepexpand">
<span class="ph cmd">If you are not using HTTPS, click <span class="keyword wintitle">Activate unsecure
file importation from the Web browser</span> located at the top of the page. </span>
</li><li class="li step stepexpand">
<span class="ph cmd">In the <span class="keyword wintitle">Import File Through Web Browser</span>
table, from the <span class="keyword wintitle">Path</span>
selection list, select <span class="keyword wintitle">Conf/</span>.</span>
</li><li class="li step stepexpand">
<span class="ph cmd">Browse to the location of the configuration file.</span>
</li><li class="li step stepexpand">
<span class="ph cmd">Click <span class="keyword wintitle">Import</span>. </span>
<div class="itemgroup info">
<div class="note note note_note"><span class="note__title">Note:</span> A factory reset will remove the file from the Internal file.</div>
</div>
</li></ol></section>
<section class="section result"><div class="tasklabel"><strong class="sectiontitle tasklabel">Result</strong></div>The imported configuration file will appear in the <span class="keyword wintitle">Internal files</span> table, under <span class="keyword wintitle">Management</span>/<span class="keyword wintitle">File</span> . <br><img class="image" id="task_w4f_tv5_1s__image_mjd_mz5_1s" src="https://documentation.media5corp.com/download/attachments/45482024/ImportFileThroughWebBrowser_Configuration.png" width="800"><br></section>
</div>
</article><hr><span style="float: inline-end;"><a href="#">Top</a></span><article class="topic task nested1" aria-labelledby="ariaid-title26" id="task_aqz_l45_yr">
<h2 class="title topictitle2" id="ariaid-title26">Configuring the DHCP to Trigger Configuration Script Execution</h2>
<div class="body taskbody"><p class="shortdesc">The Mediatrix unit can be configured to automatically import new configuration
scripts upon receiving options 66 (tftp-server) or 67 (bootfile), or vendor-specific option
43 using sub-options 66 and 67 in a DHCPv4 answer. A DHCP answer includes both Bound and
Renew. </p>
<section class="section prereq"><div class="tasklabel"><strong class="sectiontitle tasklabel">Before you begin</strong></div>Depending on the type of transport protocol used, one of the following procedures
must be completed: <ul class="ul" id="task_aqz_l45_yr__ul_ftj_5dp_wr">
<li class="li"><a class="xref" href="#task_syk_fkb_wr">Configuring the FTP Server</a></li>
<li class="li"><a class="xref" href="#task_dpx_4dq_5q">Configuring the TFTP Server</a></li>
<li class="li"><a class="xref" href="#task_ebc_zwg_wq">Configuring the HTTP Server</a></li>
<li class="li"><a class="xref" href="#task_qhf_hyg_wq">Configuring the HTTPS Server</a></li>
</ul><p class="p">Mediatrix units do not all include a real time clock allowing them to maintain
accurate time when they are shutdown. If you are using HTTPS, you must have an SNTP
server that is accessible and properly configured or the automatic configuration
update feature may not work properly. Refer to <a class="xref" href="#task_ofy_g2q_5q">Configuring the Mediatrix Unit to Use an SNTP Server</a>.</p></section>
<section class="section context"><div class="tasklabel"><strong class="sectiontitle tasklabel">Context</strong></div>
<p class="p"> For more details on
DHCPv4 Auto-Provisionning, refer to <a class="xref" href="#concept_zk3_lr5_yr" title="The Mediatrix unit can be configured to automatically download new configuration scripts upon receiving options 66 (tftp-server) or 67 (bootfile), or vendor-specific option 43 using sub-options 66 and 67 in a DHCPv4 answer">DHCPv4 Auto-Provisioning</a></p>
</section>
<section id="task_aqz_l45_yr__steps_n14_vvy_xr"><div class="tasklabel"><strong class="sectiontitle tasklabel">Steps</strong></div><ol class="ol steps" id="task_aqz_l45_yr__steps_n14_vvy_xr"><li class="li step">
<span class="ph cmd">Go to <span class="keyword wintitle">Management</span>/<span class="keyword wintitle">Configuration Scripts</span>/<span class="keyword wintitle">Execute</span>.</span>
</li><li class="li step">
<span class="ph cmd">In the <span class="keyword wintitle">Automatic Script
Execution</span>
section, from the <span class="keyword wintitle">Allow DHCP to Trigger Scripts
Execution</span> selection list, choose <span class="keyword wintitle">Enable</span>. </span>
</li><li class="li step">
<span class="ph cmd">Click <span class="keyword wintitle">Apply</span>.</span>
</li></ol></section>
<section class="section result"><div class="tasklabel"><strong class="sectiontitle tasklabel">Result</strong></div>
<p class="p">The instructions sent FROM the DHCP server can be in different formats and will be
understood by the Mediatrix unit according to what was chosen for the
<span class="keyword parmname">ScriptsDhcpOptionsFormat</span> MIB parameter (not accessible via
Web page). Possible values with their respective formats are: </p>
<ul class="ul" id="task_aqz_l45_yr__ul_ufq_xmn_j1b">
<li class="li">Fully Qualified: Script=[protocol]://[username]
:[password]@[server]/[path]/[file].</li>
<li class="li">Url: [protocol]:// [username] :[password]@[server]/[path]/[file]</li>
<li class="li">ServerHost: Allow one DHCP option to specify the IP address or FQDN of a file
server. Uses the path and filename specified in the ScriptLocation and
ScriptGenericFileName parameters, use the transfer protocol, username and
password specified in ScriptTransferProtocol, ScriptTransferUsername and
ScriptTransferPassword parameters.</li>
<li class="li">AutoDetect: A value beginning with "Script=" is considered as "FullyQualified",
A value beginning with "[protocol]://" is considered as a URL. A value that
looks like an IPv4/IPv6 address or domain name is considered as a "ServerHost".
(default value)</li>
</ul>
<p class="p">When the unit starts, it will receive the location of the config script from the DHCP
response, as per the format defined by the
<span class="keyword parmname">ScriptsDhcpOptionsFormat</span> parameter. The unit will then
import and execute the configuration scripts from the specified location. Any
changes to the script will be applied to the running configuration. The unit
configuration is only updated if at least one parameter value defined in the
imported configuration scripts is different from the actual unit configuration. </p>
<br><img class="image" id="task_aqz_l45_yr__image_g3p_1hn_dhb" src="https://documentation.media5corp.com/download/attachments/45482024/ExecuteScripts_startup.png" width="800"><br>
</section>
</div>
</article><hr><span style="float: inline-end;"><a href="#">Top</a></span><article class="topic concept nested1" aria-labelledby="ariaid-title27" id="concept_zk3_lr5_yr">
<h2 class="title topictitle2" id="ariaid-title27">DHCPv4 Auto-Provisioning</h2>
<div class="body conbody"><p class="shortdesc">The Mediatrix unit can be configured to automatically download new configuration scripts
upon receiving options 66 (tftp-server) or 67 (bootfile), or vendor-specific option 43 using
sub-options 66 and 67 in a DHCPv4 answer</p>
<p class="p"> A DHCP server answer includes both Bound and Renew. The contents of option 66, 67 or 43
defines which script to download. The unit's configuration is not used to download the script.
This allows the unit, for instance, to download a script from a server after a factory reset and
to reconfigure itself without a specific profile. If the imported configuration script is
identical to the last executed script, it will not be run again. The script retry mechanism is
not enabled for the DHCPv4 triggered scripts. If options 66, 67 and 43 are received, all scripts
are executed independently. The script defined by the tftp-server (option 66) option is executed
first. If you are using HTTPS to transfer scripts, you must have a time server SNTP that is
accessible and properly configured.</p>
</div>
</article></article><hr><span style="float: inline-end;"><a href="#">Top</a></span><article class="topic reference nested0" aria-labelledby="ariaid-title28" id="reference_dsd_hs4_yr">
<h1 class="title topictitle1" id="ariaid-title28">Unit Macros</h1>
<div class="body refbody">
<table class="table frame-all" id="reference_dsd_hs4_yr__table_p3v_hs4_yr"><caption></caption><colgroup><col style="width:50%"><col style="width:50%"></colgroup><thead class="thead">
<tr class="row">
<th class="entry colsep-1 rowsep-1" id="reference_dsd_hs4_yr__table_p3v_hs4_yr__entry__1">Macro</th>
<th class="entry colsep-1 rowsep-1" id="reference_dsd_hs4_yr__table_p3v_hs4_yr__entry__2">Description</th>
</tr>
</thead><tbody class="tbody">
<tr class="row">
<td class="entry colsep-1 rowsep-1" headers="reference_dsd_hs4_yr__table_p3v_hs4_yr__entry__1">%mac% </td>
<td class="entry colsep-1 rowsep-1" headers="reference_dsd_hs4_yr__table_p3v_hs4_yr__entry__2">the MAC address of the unit </td>
</tr>
<tr class="row">
<td class="entry colsep-1 rowsep-1" headers="reference_dsd_hs4_yr__table_p3v_hs4_yr__entry__1">%version%</td>
<td class="entry colsep-1 rowsep-1" headers="reference_dsd_hs4_yr__table_p3v_hs4_yr__entry__2"> the MFP version of the unit (firmware version)</td>
</tr>
<tr class="row">
<td class="entry colsep-1 rowsep-1" headers="reference_dsd_hs4_yr__table_p3v_hs4_yr__entry__1">%product% </td>
<td class="entry colsep-1 rowsep-1" headers="reference_dsd_hs4_yr__table_p3v_hs4_yr__entry__2">the Product name of the unit</td>
</tr>
<tr class="row">
<td class="entry colsep-1 rowsep-1" headers="reference_dsd_hs4_yr__table_p3v_hs4_yr__entry__1">%productseries%</td>
<td class="entry colsep-1 rowsep-1" headers="reference_dsd_hs4_yr__table_p3v_hs4_yr__entry__2">the Product series name of the unit.</td>
</tr>
</tbody></table>
</div>
</article><hr><span style="float: inline-end;"><a href="#">Top</a></span><article class="topic reference nested0" aria-labelledby="ariaid-title29" id="reference_j4g_nbv_gfb">
<h1 class="title topictitle1" id="ariaid-title29">Online Help</h1>
<p class="shortdesc"><span class="ph">If you are not familiar with the meaning of the fields and
buttons, click <span class="keyword wintitle">Show Help</span>, 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 bedisplayed.</span></p>
</article><hr><span style="float: inline-end;"><a href="#">Top</a></span><article class="topic reference nested0" aria-labelledby="ariaid-title30" id="reference_ur5_yx3_ps">
<h1 class="title topictitle1" id="ariaid-title30">Available Documentation</h1>
<div class="body refbody">
<section class="section">For more details, refer to the <a class="xref" href="https://documentation.media5corp.com/display/DGWLATEST/Latest+DGW" target="_blank">Mediatrix Documentation</a> published on the <a class="xref" href="https://documentation.media5corp.com/" target="_blank">Media5 Documentation Portal</a>.</section>
</div>
</article><hr><span style="float: inline-end;"><a href="#">Top</a></span><article class="topic concept nested0" aria-labelledby="ariaid-title31" id="concept_fqm_rv4_k4">
<h1 class="title topictitle1" id="ariaid-title31">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> |
