<!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="topic"><meta name="prodname" content="For Sentinel units"><meta name="version" content="DGW 49.12.28842941"><meta name="platform" content="Sentinel"><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="topic_title_Virtual_Machine_Basic_Concepts_d1e15"><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/62825785/commonltr.css"><link rel="stylesheet" type="text/css" href="https://documentation.media5corp.com/download/attachments/62825785/custom.css"><title>Virtual Machine Service User Guide</title></head><body class="nobody"><header role="banner"><div class="topicmeta title">Virtual Machine Service User Guide</div><div class="topicmeta date">2023-0308-28<09</div><div class="topicmeta product"> For Sentinel units</div><div class="topicmeta version">DGW 49.12.2884<2941</div><div class="topicmeta pdf"><a href="https://documentation.media5corp.com/download/attachments/62825785/VM%20Service%20User%20Guide.pdf" rel="nofollow">Download PDF Document</a></div><hr><span style="float: inline-end;"></span></header><nav role="toc"><ul><li><a href="#topic_title_Virtual_Machine_Basic_Concepts_d1e15">Virtual Machine Basic Concepts</a><ul><li><a href="#reference_pmg_jg4_3mb">Important Information on Virtual Machines</a></li><li><a href="#reference_krw_ghw_3mb">RAM and SSD Sizes</a><ul><li><a href="#reference_mng_hwg_fw">RAM Allocation to Virtual Machines</a></li></ul></li><li><a href="#concept_nrb_z34_kr">VM name</a></li><li><a href="#unique_1729001085615228476">VM Memory</a></li><li><a href="#unique_76361947743903359">USB Usage</a></li><li><a href="#unique_2167295121433619556">Virtual Switch</a></li><li><a href="#concept_k1z_g675j_mdb">Behaviour on Factory Reset</a></li><li><a href="#concept_bxn_z5m_5cb">How to Protect my VM against Spectre</a></li><li><a href="#concept_xrt_p5m_5cb">How to Protect my VM against Meltdown</a></li></ul></li><li><a href="#topic_title_Basic_Virtual_Machine_Tasks_d1e26">Basic Virtual Machine Tasks</a><ul><li><a href="#task_ons_lwb_ss">Stopping the Virtual Machine </a></li><li><a href="#task_inr_lqv_pkb">Stopping the Virtual Machine - Graceful Stop</a></li><li><a href="#task_opf_vtv_rs">Rebooting a VM </a></li><li><a href="#task_ekb_dzb_ss">Rebooting a VM - Graceful Reboot</a></li><li><a href="#task_bpv_jkh_ps">Deleting a VM</a></li><li><a href="#task_nkm_bkh_ps">Setting the Virtual Machine to Automatic Start </a></li><li><a href="#task_zhx_vmh_ps">Setting the Virtual Machine to Manual Start </a></li><li><a href="#unique_20561575101708904088">Deleting a VM</a></li></ul></li><li><a href="#topic_title_Virtual_Machine_Installation_d1e35">Virtual Machine Installation</a><ul><li><a href="#task_ptr_dnk_ls">Adding a Virtual Machine</a></li><li><a href="#task_cq1_bd4_ts">Configuring a Link as a Virtual Switch</a></li><li><a href="#task_h5g_n4v_rs">Importing an ISO Image Larger than 10mb to the Unit File Management System</a></li><li><a href="#task_f2k_czk_ls">Importing an ISO image to the Unit File Management System</a></li><li><a href="#task_grf_5dl_ls">Configuring the VM Network Adapter (VirtIO)</a></li><li><a href="#task_d2r_2yk_ls">Installing the OS on the Virtual Machine Using an ISO image</a></li><li><a href="#unique_615603197872886331">Installing the Virtual Machine OS using a USB External Device</a></li><li><a href="#unique_1250482714615966480">Importing an ISO image to the Unit File Management System</a></li><li><a href="#task_z5n_dnz_lv">Disabling Swap on Linux</a></li></ul></li><li><a href="#topic_title_Virtual_Machine_Modification_d1e45">Virtual Machine Modification</a><ul><li><a href="#task_dcv_xhv_rs">Modifying the Virtual Machine Configuration</a></li></ul></li><li><a href="#concept_vtd_gkg_yr">Parameters</a><ul><li><a href="#reference_lxl_ljw_bq"> System/VM Parameters</a></li></ul></li><li><a href="#reference_yv3_w5d_lr">Configuration notes</a><ul><li><a href="#reference_apw_54c_ss">Virtual Machine Configuration Notes</a></li></ul></li><li><a href="#reference_j4g_nbv_gfb">Online Help</a></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="topic_title_Virtual_Machine_Basic_Concepts_d1e15">
<h1 class="title topictitle1" id="ariaid-title1">Virtual Machine Basic Concepts</h1>
<article class="topic reference nested1" aria-labelledby="ariaid-title2" id="reference_pmg_jg4_3mb">
<h2 class="title topictitle2" id="ariaid-title2">Important Information on Virtual Machines</h2>
<div class="body refbody"><p class="shortdesc"></p>
<section class="section">
<div class="note note note_note"><span class="note__title">Note:</span> It is not possible to modify the settings (RAM, name, etc.) once the virtual machine has
been created. The only way to change the settings, is to delete the virtual machine and to
create it once again.</div>
<div class="note note note_note"><span class="note__title">Note:</span> A maximum of 2 virtual machines can be added.</div>
</section>
</div>
</article><hr><span style="float: inline-end;"><a href="#">Top</a></span><article class="topic reference nested1" aria-labelledby="ariaid-title3" id="reference_krw_ghw_3mb">
<h2 class="title topictitle2" id="ariaid-title3">RAM and SSD Sizes</h2>
<div class="body refbody"><p class="shortdesc"></p>
<section class="section">
<table class="table frame-all" id="reference_krw_ghw_3mb__table_p2d_khw_3mb"><caption><span class="table--title-label">Table 1. </span><span class="title"></span></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_krw_ghw_3mb__table_p2d_khw_3mb__entry__1">Description</th>
<th class="entry colsep-1 rowsep-1" id="reference_krw_ghw_3mb__table_p2d_khw_3mb__entry__2">Possible Values</th>
</tr>
</thead><tbody class="tbody">
<tr class="row">
<td class="entry colsep-1 rowsep-1" headers="reference_krw_ghw_3mb__table_p2d_khw_3mb__entry__1">RAM size <a name="fnsrc_1" href="#fntarg_1"><sup>1</sup></a></td>
<td class="entry colsep-1 rowsep-1" headers="reference_krw_ghw_3mb__table_p2d_khw_3mb__entry__2">
<ul class="ul" id="reference_krw_ghw_3mb__d11e118">
<li class="li">0 - No DDR (slave device) (contact Media5 sales)</li>
<li class="li">1 - 2 GB DDR</li>
<li class="li">2 - 4 GB DDR</li>
<li class="li">3 - 8 GB DDR</li>
<li class="li">4 - 16 GB DDR (contact Media5 sales)</li>
</ul>
</td>
</tr>
<tr class="row">
<td class="entry colsep-1 rowsep-1" headers="reference_krw_ghw_3mb__table_p2d_khw_3mb__entry__1">SSD size <a name="fnsrc_2" href="#fntarg_2"><sup>2</sup></a></td>
<td class="entry colsep-1 rowsep-1" headers="reference_krw_ghw_3mb__table_p2d_khw_3mb__entry__2">
<ul class="ul" id="reference_krw_ghw_3mb__d11e150">
<li class="li">0 - No SSD (slave device) (contact Media5 sales)</li>
<li class="li">1 - 16 GB SSD</li>
<li class="li">B - 32 GB SSD (20k erase cycle)</li>
<li class="li">C - 64 GB SSD (20k erase cycle)</li>
<li class="li">D - 128 GB SSD (20k erase cycle)</li>
<li class="li">E - 256 GB SSD (20k erase cycle)</li>
</ul>
</td>
</tr>
</tbody></table>
</section>
</div>
<hr><span style="float: inline-end;"><a href="#">Top</a></span><article class="topic reference nested2" aria-labelledby="ariaid-title4" id="reference_mng_hwg_fw">
<h3 class="title topictitle3" id="ariaid-title4">RAM Allocation to Virtual Machines</h3>
<div class="body refbody"><p class="shortdesc">To reduce the wear-and-tear of the Solid State Drive, make sure to allocate the maximum
amount of RAM possible to the virtual machine. </p>
<table class="table frame-all" id="reference_mng_hwg_fw__table_pgk_jwg_fw"><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_mng_hwg_fw__table_pgk_jwg_fw__entry__1">Installed RAM on Mediatrix Units</th>
<th class="entry colsep-1 rowsep-1" id="reference_mng_hwg_fw__table_pgk_jwg_fw__entry__2">Available RAM for Virtual Machine</th>
</tr>
</thead><tbody class="tbody">
<tr class="row">
<td class="entry colsep-1 rowsep-1" headers="reference_mng_hwg_fw__table_pgk_jwg_fw__entry__1">2 Gb</td>
<td class="entry colsep-1 rowsep-1" headers="reference_mng_hwg_fw__table_pgk_jwg_fw__entry__2">1.5 Gb</td>
</tr>
<tr class="row">
<td class="entry colsep-1 rowsep-1" headers="reference_mng_hwg_fw__table_pgk_jwg_fw__entry__1">4 Gb</td>
<td class="entry colsep-1 rowsep-1" headers="reference_mng_hwg_fw__table_pgk_jwg_fw__entry__2">3.5 Gb</td>
</tr>
<tr class="row">
<td class="entry colsep-1 rowsep-1" headers="reference_mng_hwg_fw__table_pgk_jwg_fw__entry__1">8 Gb</td>
<td class="entry colsep-1 rowsep-1" headers="reference_mng_hwg_fw__table_pgk_jwg_fw__entry__2">7 Gb ( 87.5% of available RAM)</td>
</tr>
<tr class="row">
<td class="entry colsep-1 rowsep-1" headers="reference_mng_hwg_fw__table_pgk_jwg_fw__entry__1">16 Gb</td>
<td class="entry colsep-1 rowsep-1" headers="reference_mng_hwg_fw__table_pgk_jwg_fw__entry__2">10 Gb</td>
</tr>
</tbody></table>
</div>
</article></article><hr><span style="float: inline-end;"><a href="#">Top</a></span><article class="topic concept nested1" aria-labelledby="ariaid-title5" id="concept_nrb_z34_kr">
<h2 class="title topictitle2" id="ariaid-title5">VM name</h2>
<div class="body conbody">
<p class="p">The name is set when adding a new virtual machine with the <span class="keyword cmdname">CreateVm</span> command. The user cannot modify the name after.</p>
<p class="p">When the <span class="keyword cmdname">CreateVm</span> command is called without a name, the index is used to
generate a unique name such as VM_Index.</p>
</div>
</article><hr><span style="float: inline-end;"><a href="#">Top</a></span><article class="topic concept nested1" aria-labelledby="ariaid-title6" id="unique_1729001085615228476">
<h2 class="title topictitle2" id="ariaid-title6">VM Memory</h2>
<div class="body conbody">
<p class="p">When adding a VM with the <span class="keyword cmdname">CreateVm</span> command, the amount of allocated memory is set; this amount cannot be modified after adding the VM. </p>
<p class="p">When the <span class="keyword cmdname">CreateVm</span> command is called without an amount of allocated memory, a minimal
value of 128 MB is set.</p>
<div class="p">Depending on the total amount of volatile memory in the system, the amount of memory reserved
for DGW is <ul class="ul">
<li class="li">a minimum of 512 MB, or </li>
<li class="li">12.5% of the total volatile memory capacity if more than 512 MB is available </li>
</ul></div>
</div>
</article><hr><span style="float: inline-end;"><a href="#">Top</a></span><article class="topic concept nested1" aria-labelledby="ariaid-title7" id="unique_76361947743903359">
<h2 class="title topictitle2" id="ariaid-title7">USB Usage</h2>
<div class="body conbody">
<p class="p">The VM config allows the user to associate none or all USB Ports to a virtual machine.</p>
<p class="p">A USB port can be associated with one VM. The first VM that is configured with USB can use all available USB ports. </p>
<p class="p">If an another VM tries to use a USB port already in use, the Vm service ignores this config and starts the VM as if it was configured with <em class="ph i">NONE</em>, and sets its configuration status (<span class="keyword parmname">ConfigStatus</span>) to <em class="ph i">USBNotAvailable</em>.</p>
</div>
</article><hr><span style="float: inline-end;"><a href="#">Top</a></span><article class="topic concept nested1" aria-labelledby="ariaid-title8" id="unique_2167295121433619556">
<h2 class="title topictitle2" id="ariaid-title8">Virtual Switch</h2>
<div class="body conbody">
<p class="p">Enabling the Virtual Switch with the <span class="keyword parmname">Eth.Links.VirtualSwitch</span> parameter
grants network access to the VM. Once enabled, the virtual switch creates a bridge between the
VM and the associated Ethernet link.</p>
<p class="p">When the Virtual Switch is enabled, the <span class="keyword parmname">Vm.Vm.NetworkAdapter</span> parameter
configures its virtualised network adapter.</p>
</div>
</article><hr><span style="float: inline-end;"><a href="#">Top</a></span><article class="topic concept nested1" aria-labelledby="ariaid-title9" id="concept_k1z_g675j_mdb">
<h2 class="title topictitle2" id="ariaid-title9">Behaviour on Factory Reset</h2>
<div class="body conbody">
<p class="p">The unit can be preinstalled with a factory-installed VM stored in the <em class="ph i">vm/images/factory</em> folder.
This folder can only be created in factory and must have the factory-installed VM files.
</p>
<div class="p">Two behaviors are possible for the VMs on a factory reset.
<ul class="ul">
<li class="li">When one or more factory-installed VM is present, VM images and configurations are returned to their original factory state.</li>
<li class="li">When no factory-installed VM is present, the VM images and configurations stay unchanged, i.e. the files present in <em class="ph i">vm/images/</em> are not erased.</li>
</ul>
</div>
<div class="p">When a factory-installed VM is present, the factory reset is performed as follows:
<ul class="ul">
<li class="li">The files in the <em class="ph i">vm/images/</em> folder are erased, which removes the VM snapshots and all VMs created, modified, or installed by users.
<ul class="ul">
<li class="li">Note: this is done even if the <em class="ph i">vm/images/factory</em> folder exists and is empty.</li>
</ul>
</li>
<li class="li">For each factory-installed VM (visible in the <em class="ph i">vm/images/factory</em> folder), the configuration file (.cfg) is copied in the <em class="ph i">vm/images</em> folder
and a snapshot of the VM image is also created in the <em class="ph i">vm/images</em> folder. The snapshot file is given the <em class="ph i">.snapshot extension</em>
and is always in a QCOW2 format.
When this VM is used, the snapshot file changes over time but the base image (located in <em class="ph i">vm/images/factory</em>)
is never modified, allowing the next factory reset to restore the factory VMs to their original state again.</li>
<li class="li">The admin can use, configure, convert, and delete a VM with a snapshot image like any other VM, but after a
factory reset, the snapshot image is deleted and a new one is created.</li>
<li class="li">When a snapshot file is converted into a VM image file, the resulting file is a new image file combining the base
VM plus the history contained in the snapshot file.</li>
<li class="li">Users cannot add or delete files on the <em class="ph i">vm/images/factory</em> folder. This can only be done in factory.</li>
<li class="li">The VM images under <em class="ph i">vm/images/factory</em> can have either the RAW or QCOW2 format.</li>
<li class="li">The <em class="ph i">RestoreAfterFactory</em> parameter in the VM configuration file is ignored. The factory-installed VMs are always restored.</li>
</ul>
</div>
<p class="p">In all cases, the content of <em class="ph i">/vm/drives</em> is erased.</p>
</div>
</article><hr><span style="float: inline-end;"><a href="#">Top</a></span><article class="topic concept nested1" aria-labelledby="ariaid-title10" id="concept_bxn_z5m_5cb">
<h2 class="title topictitle2" id="ariaid-title10">How to Protect my VM against Spectre</h2>
<div class="body conbody"><p class="shortdesc">There are different mitigation techniques against Spectre:</p>
<ul class="ul" id="concept_bxn_z5m_5cb__ul_ik2_dvm_5cb">
<li class="li">Mitigation #1: A microcode update from the CPU vendor for better control over the branch
speculation. Also need an updated kernel to enable these new features (IBRS and IBPB).</li>
<li class="li">Mitigation #2: Different techniques (like "retpoline" and "LFENCE") that require recompiling
the kernel, packages and applications.</li>
</ul>
<p class="p">As the time this document was written, Mitigation #1 could not be applied, as Intel had not yet
released a microcode update for the CPU of the Sentinel 400.</p>
<div class="p">If your Virtual Machine is vulnerable, Media5 recommends applying Mitigation #2. See <a class="xref" href="https://en.wikipedia.org/wiki/Spectre_(security_vulnerability)#Mitigation" target="_blank">https://en.wikipedia.org/wiki/Spectre_(security_vulnerability)#Mitigation</a> for more
details.<div class="note important note_important"><span class="note__title">IMPORTANT:</span> Mitigation techniques against Spectre may impact the performance
of your Virtual Machine.</div></div>
</div>
</article><hr><span style="float: inline-end;"><a href="#">Top</a></span><article class="topic concept nested1" aria-labelledby="ariaid-title11" id="concept_xrt_p5m_5cb">
<h2 class="title topictitle2" id="ariaid-title11">How to Protect my VM against Meltdown</h2>
<div class="body conbody"><p class="shortdesc">Linux kernels have a new feature called KPTI (previously known as KAISER) that protects
against Meltdown.</p>
<p class="p">If your Virtual Machine is vulnerable, Media5 recommends that you upgrade your kernel to a
version that supports KPTI, and enable it.</p>
<div class="p">For more information on KPTI: <a class="xref" href="https://en.wikipedia.org/wiki/Kernel_page-table_isolation" target="_blank">https://en.wikipedia.org/wiki/Kernel_page-table_isolation</a><div class="note important note_important"><span class="note__title">IMPORTANT:</span> Enabling
KPTI may impact the performance of your Virtual Machine.</div></div>
</div>
</article></article><hr><span style="float: inline-end;"><a href="#">Top</a></span><article class="topic nested0 nobody" aria-labelledby="ariaid-title12" id="topic_title_Basic_Virtual_Machine_Tasks_d1e26">
<h1 class="title topictitle1" id="ariaid-title12">Basic Virtual Machine Tasks</h1>
<article class="topic task nested1" aria-labelledby="ariaid-title13" id="task_ons_lwb_ss">
<h2 class="title topictitle2" id="ariaid-title13">Stopping the Virtual Machine </h2>
<div class="body taskbody">
<section><div class="tasklabel"><strong class="sectiontitle tasklabel">Steps</strong></div><ol class="ol steps"><li class="li step">
<span class="ph cmd">Go to <span class="keyword wintitle">System</span>/<span class="keyword wintitle">VM</span>.</span>
</li><li class="li step">
<span class="ph cmd">In the <span class="keyword wintitle">Virtual Machine Configuration</span>
table, click <img class="image" id="task_ons_lwb_ss__image_fxz_ywb_ss" src="https://documentation.media5corp.com/download/attachments/62825785/StopService.jpg" width="14"> located on the same row as the <span class="keyword wintitle">VM</span> you wish
to stop.</span>
</li></ol></section>
<section class="section result"><div class="tasklabel"><strong class="sectiontitle tasklabel">Result</strong></div>The virtual machine stops. In the <span class="keyword wintitle">Virtual Machine Status</span> table,
<span class="keyword wintitle">Stopped</span> will be displayed
under the <span class="keyword wintitle">State</span>
column.</section>
</div>
</article><hr><span style="float: inline-end;"><a href="#">Top</a></span><article class="topic task nested1" aria-labelledby="ariaid-title14" id="task_inr_lqv_pkb">
<h2 class="title topictitle2" id="ariaid-title14">Stopping the Virtual Machine - Graceful Stop</h2>
<div class="body taskbody">
<section id="task_inr_lqv_pkb__steps_jtd_vqv_pkb"><div class="tasklabel"><strong class="sectiontitle tasklabel">Steps</strong></div><ol class="ol steps" id="task_inr_lqv_pkb__steps_jtd_vqv_pkb"><li class="li step stepexpand">
<span class="ph cmd">Open the VNC Client located on a computer located on the network connected to
the unit.</span>
<div class="itemgroup info">
<div class="note note note_note"><span class="note__title">Note:</span>
<p class="p">UltraVNC Viewer, TightVNC Viewer and VNC Viewer are presently
supported.</p>
</div>
</div>
</li><li class="li step stepexpand">
<span class="ph cmd">Enter the <span class="keyword wintitle">Unit.IP.Address: VNCid</span> .</span>
</li><li class="li step stepexpand">
<span class="ph cmd">In the <span class="keyword wintitle">VNC</span> console, shutdown the OS using the recommended
OS method.</span>
</li></ol></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_opf_vtv_rs">
<h2 class="title topictitle2" id="ariaid-title15">Rebooting a VM </h2>
<div class="body taskbody">
<section class="section context"><div class="tasklabel"><strong class="sectiontitle tasklabel">Context</strong></div>If the virtual machine you wish to start requires resources equivalent to the
available resources on the unit, then it will not be possible to start another virtual
machine. It is only possible to start a virtual machine if there are enough resources on
the unit.<div class="note note note_note"><span class="note__title">Note:</span> Rebooting a virtual machine does not have the same effect as Restarting
the virtual machine.</div></section>
<section id="task_opf_vtv_rs__steps_qbt_jsh_rs"><div class="tasklabel"><strong class="sectiontitle tasklabel">Steps</strong></div><ol class="ol steps" id="task_opf_vtv_rs__steps_qbt_jsh_rs"><li class="li step">
<span class="ph cmd">Go to <span class="keyword wintitle">System</span>/<span class="keyword wintitle">VM</span>.</span>
</li><li class="li step">
<span class="ph cmd">Click <img class="image" id="task_opf_vtv_rs__image_sf4_53v_rs" src="https://documentation.media5corp.com/download/attachments/62825785/Restart.png" width="14">.</span>
</li></ol></section>
<section class="section result"><div class="tasklabel"><strong class="sectiontitle tasklabel">Result</strong></div>The virtual machine is restarted. In the <span class="keyword wintitle">Virtual Machine Status</span>, <span class="keyword wintitle">Started</span> will be displayed under the
<span class="keyword wintitle">State</span> column.</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_ekb_dzb_ss">
<h2 class="title topictitle2" id="ariaid-title16">Rebooting a VM - Graceful Reboot</h2>
<div class="body taskbody">
<section class="section context"><div class="tasklabel"><strong class="sectiontitle tasklabel">Context</strong></div>
<p class="p">Although the virtual machine can be rebooted via the Web page, rebooting the virtual
machine using a VNC Client is the preferred way to reboot the virtual machine.</p>
<div class="note note note_note"><span class="note__title">Note:</span> Rebooting the virtual machine does not have the same effect as restarting the
virtual machine.</div>
</section>
<section id="task_ekb_dzb_ss__steps_iww_pxb_ss"><div class="tasklabel"><strong class="sectiontitle tasklabel">Steps</strong></div><ol class="ol steps" id="task_ekb_dzb_ss__steps_iww_pxb_ss"><li class="li step stepexpand">
<span class="ph cmd">Open the VNC Client located on a computer located on the network connected to
the unit.</span>
<div class="itemgroup info">
<div class="note note note_note"><span class="note__title">Note:</span>
<p class="p">UltraVNC Viewer, TightVNC Viewer and VNC Viewer are presently
supported.</p>
</div>
</div>
</li><li class="li step stepexpand">
<span class="ph cmd">Enter the <strong class="ph b">Unit.IP.Address: 5900+VNCid </strong>.</span>
</li><li class="li step stepexpand">
<span class="ph cmd">In the VNC console, shutdown the OS using the recommended OS method.</span>
</li></ol></section>
<section class="section result"><div class="tasklabel"><strong class="sectiontitle tasklabel">Result</strong></div>The virtual machine is restarted. In the <span class="keyword wintitle">Virtual Machine Status</span>, <span class="keyword wintitle">Started</span> will be displayed under the
<span class="keyword wintitle">State</span> column.</section>
</div>
</article><hr><span style="float: inline-end;"><a href="#">Top</a></span><article class="topic task nested1" aria-labelledby="ariaid-title17" id="task_bpv_jkh_ps">
<h2 class="title topictitle2" id="ariaid-title17">Deleting a VM</h2>
<div class="body taskbody">
<section><div class="tasklabel"><strong class="sectiontitle tasklabel">Steps</strong></div><ol class="ol steps"><li class="li step">
<span class="ph cmd">Go to <span class="keyword wintitle">System</span>/<span class="keyword wintitle">VM</span>.</span>
</li><li class="li step">
<span class="ph cmd">In the <span class="keyword wintitle">Virtual Machine Configuration</span>
table, click <img class="image" id="task_bpv_jkh_ps__image_xpm_32h_rs" src="https://documentation.media5corp.com/download/attachments/62825785/minus.jpg" width="14"> located on the same row as the virtual
machine you wish to delete. </span>
</li></ol></section>
<section class="section result"><div class="tasklabel"><strong class="sectiontitle tasklabel">Result</strong></div> The virtual machine and its configuration are deleted. </section>
</div>
</article><hr><span style="float: inline-end;"><a href="#">Top</a></span><article class="topic task nested1" aria-labelledby="ariaid-title18" id="task_nkm_bkh_ps">
<h2 class="title topictitle2" id="ariaid-title18">Setting the Virtual Machine to Automatic Start </h2>
<div class="body taskbody">
<section class="section context"><div class="tasklabel"><strong class="sectiontitle tasklabel">Context</strong></div>
<p class="p">If the virtual machine you wish to start requires resources equivalent to the
available resources on the unit, then it will not be possible to start another
virtual machine. It is only possible to start a virtual if there are enough
resources on the unit.</p>
</section>
<section><div class="tasklabel"><strong class="sectiontitle tasklabel">Steps</strong></div><ol class="ol steps"><li class="li step">
<span class="ph cmd">Go to <span class="keyword wintitle">System</span>/<span class="keyword wintitle">VM</span>.</span>
</li><li class="li step">
<span class="ph cmd">In the <span class="keyword wintitle">Virtual Machine Configuration</span>
table, from the <span class="keyword wintitle">Startup</span> dropdown list, select <span class="keyword wintitle">Auto</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>When the Vm Service is started, the virtual machine will also be started. <br><img class="image" id="task_nkm_bkh_ps__image_hf5_xjc_ss" src="https://documentation.media5corp.com/download/attachments/62825785/VirtualMachineConfiguration_auto.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-title19" id="task_zhx_vmh_ps">
<h2 class="title topictitle2" id="ariaid-title19">Setting the Virtual Machine to Manual Start </h2>
<div class="body taskbody">
<section class="section context"><div class="tasklabel"><strong class="sectiontitle tasklabel">Context</strong></div>Manually starting the virtual machine can be useful when installing the virtual
machine to check if the installation was done properly. However, on a day to day usage,
the virtual machine should be set to start automatically. Refer to <a class="xref" href="#task_nkm_bkh_ps">Setting the Virtual Machine to Automatic Start</a>.<div class="note note note_note"><span class="note__title">Note:</span> If
the virtual machine you wish to start requires resources equivalent to the available
resources on the unit, then it will not be possible to start another virtual
machine. It is only possible to start a virtual machine if there are enough
resources available on the unit.</div></section>
<section><div class="tasklabel"><strong class="sectiontitle tasklabel">Steps</strong></div><ol class="ol steps"><li class="li step">
<span class="ph cmd">Go to <span class="keyword wintitle">System</span>/<span class="keyword wintitle">VM</span>.</span>
</li><li class="li step">
<span class="ph cmd">In the <span class="keyword wintitle">Virtual Machine Configuration</span>
table, from the <span class="keyword wintitle">Startup</span> dropdown list, select <span class="keyword wintitle">Manual</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>The virtual machine will be started only if it is started manually. In the <span class="keyword wintitle">Virtual Machine Status</span>, <span class="keyword wintitle">Started</span> will be displayed under the
<span class="keyword wintitle">State</span> column.<br><img class="image" id="task_zhx_vmh_ps__image_pvr_wjc_ss" src="https://documentation.media5corp.com/download/attachments/62825785/VirtualMachineConfiguration_manual.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-title20" id="unique_20561575101708904088">
<h2 class="title topictitle2" id="ariaid-title20">Deleting a VM</h2>
<div class="body taskbody">
<section><div class="tasklabel"><strong class="sectiontitle tasklabel">Steps</strong></div><ol class="ol steps"><li class="li step">
<span class="ph cmd">Go to <span class="keyword wintitle">System</span>/<span class="keyword wintitle">VM</span>.</span>
</li><li class="li step">
<span class="ph cmd">In the <span class="keyword wintitle">Virtual Machine Configuration</span>
table, click <img class="image" id="unique_20561575101708904088__image_xpm_32h_rs" src="https://documentation.media5corp.com/download/attachments/62825785/minus.jpg" width="14"> located on the same row as the virtual
machine you wish to delete. </span>
</li></ol></section>
<section class="section result"><div class="tasklabel"><strong class="sectiontitle tasklabel">Result</strong></div> The virtual machine and its configuration are deleted. </section>
</div>
</article></article><hr><span style="float: inline-end;"><a href="#">Top</a></span><article class="topic nested0 nobody" aria-labelledby="ariaid-title21" id="topic_title_Virtual_Machine_Installation_d1e35">
<h1 class="title topictitle1" id="ariaid-title21">Virtual Machine Installation</h1>
<article class="topic task nested1" aria-labelledby="ariaid-title22" id="task_ptr_dnk_ls">
<h2 class="title topictitle2" id="ariaid-title22">Adding a Virtual Machine</h2>
<div class="body taskbody">
<section class="section prereq"><div class="tasklabel"><strong class="sectiontitle tasklabel">Before you begin</strong></div>The <span class="keyword parmname">VirtualSwitch</span> parameter must be configured to enable the
link you wish to use to contact the virtual machine. Refer to <a class="xref" href="#task_cq1_bd4_ts">Configuring a Link as a Virtual Switch</a> . <p class="p">You
must have a virtual machine licence and the VM service must be started. </p><div class="note caution note_caution"><span class="note__title">Caution:</span> It is a best practice to create the Virtual Machine in a test
environment. If not enough memory is allocated and swap is disabled, the Virtual
Machine will stop, and the installation will need to be restarted from the
beginning.</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">System</span>/<span class="keyword wintitle">VM</span>.</span>
</li><li class="li step stepexpand">
<span class="ph cmd">In the <span class="keyword wintitle">Virtual Machine Creation</span>
table, complete the <span class="keyword wintitle">Vm Name</span> field.</span>
<div class="itemgroup info">
<div class="note note note_note"><span class="note__title">Note:</span> Vm names must be unique.</div>
</div>
</li><li class="li step stepexpand">
<span class="ph cmd">In the <span class="keyword wintitle">Ram(Mb)</span> field,
enter the amount of RAM required to run the virtual machine.</span>
<div class="itemgroup info">
<div class="note caution note_caution"><span class="note__title">Caution:</span> To reduce the wear-and-tear of the Solid State Drive, make
sure to allocate the maximum amount of RAM possible to the virtual machine.
</div>
</div>
<div class="itemgroup info">
<div class="note note note_note"><span class="note__title">Note:</span> For instance, 87.5% of the actual available RAM, or 1.5 Gb for units with
2 Gb of RAM, 3.5 Gb with 4 Gb of RAM and for 7 Gb with 8 Gb of RAM.</div>
</div>
</li><li class="li step stepexpand">
<span class="ph cmd">Complete the <span class="keyword wintitle">Storage(Gb)</span> field.</span>
<div class="itemgroup info">
<div class="note note note_note"><span class="note__title">Note:</span> 10 Gb is the maximum value one can allocate in a typical Sentinel equipped
with a 16 Gb Solid State Drive.</div>
</div>
</li><li class="li step stepexpand">
<span class="ph cmd">From the <span class="keyword wintitle">Image Format</span>
selection list, choose the format of the image. </span>
<div class="itemgroup info">
<div class="note note note_note"><span class="note__title">Note:</span>
<ul class="ul" id="task_ptr_dnk_ls__ul_myr_yhx_vdb">
<li class="li">Use QCOW2 for space efficiency and flexibility. </li>
<li class="li">Use RAW for improved performance</li>
</ul>
</div>
</div>
</li><li class="li step stepexpand">
<span class="ph cmd">From the <span class="keyword wintitle">Nb Cores</span>
selection list, select the number of cores the virtual machine will be using. </span>
<div class="itemgroup info">
<div class="note important note_important"><span class="note__title">IMPORTANT:</span> It is not possible to modify the settings (RAM, name,
etc.) once the virtual machine has been created. The only way to change the
settings, is to delete the virtual machine and to create it once
again.</div>
</div>
</li><li class="li step stepexpand">
<span class="ph cmd">Click <img class="image" id="task_ptr_dnk_ls__image_dvw_z4g_rs" src="https://documentation.media5corp.com/download/attachments/62825785/Plusbleu.jpg" width="14">.</span>
<div class="itemgroup info">
<div class="note note note_note"><span class="note__title">Note:</span> A maximum of 2 virtual machines can be added.</div>
</div>
</li></ol></section>
<section class="section result"><div class="tasklabel"><strong class="sectiontitle tasklabel">Result</strong></div>The virtual machine will be displayed in both the <span class="keyword wintitle">Virtual Machine Configuration</span> and the
<span class="keyword wintitle">Virtual Machine Status</span> tables. <br><div class="imagecenter"><img class="image imagecenter" id="task_ptr_dnk_ls__image_ohf_1qg_rs" src="https://documentation.media5corp.com/download/attachments/62825785/VirtualMachineCreation.png" width="800"></div><br></section>
</div>
</article><hr><span style="float: inline-end;"><a href="#">Top</a></span><article class="topic task nested1" aria-labelledby="ariaid-title23" id="task_cq1_bd4_ts">
<h2 class="title topictitle2" id="ariaid-title23">Configuring a Link as a Virtual Switch</h2>
<div class="body taskbody">
<section><div class="tasklabel"><strong class="sectiontitle tasklabel">Steps</strong></div><ol class="ol steps"><li class="li step">
<span class="ph cmd">Go to <span class="keyword wintitle">Network</span>/<span class="keyword wintitle">Interfaces</span>.
</span>
</li><li class="li step">
<span class="ph cmd">In the <span class="keyword wintitle">Ethernet Link
Configuration</span>
table, from the <span class="keyword wintitle">Virtual Switch</span> selection
list, select <span class="keyword wintitle">Enable</span>
located on the same row as the link you wish to enable for the virtual
switch.</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>
<br><img class="image" id="task_cq1_bd4_ts__image_rbc_l24_ts" src="https://documentation.media5corp.com/download/attachments/62825785/EthernetLinkConfiguration_VirtualSwitch.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-title24" id="task_h5g_n4v_rs">
<h2 class="title topictitle2" id="ariaid-title24">Importing an ISO Image Larger than 10mb 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>Only the http and https protocols are supported to import the large files.</section>
<section id="task_h5g_n4v_rs__steps_cmr_bqh_rs"><div class="tasklabel"><strong class="sectiontitle tasklabel">Steps</strong></div><ol class="ol steps" id="task_h5g_n4v_rs__steps_cmr_bqh_rs"><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">In the <span class="keyword wintitle">Import File Through URL</span> table,
from the <span class="keyword wintitle">Destination</span>
selection list, select the destination directory on the unit where to save the
file.</span>
</li><li class="li step stepexpand">
<span class="ph cmd">In the <span class="keyword wintitle">URL</span> field,
indicate the file server's URL where the iso image to import is located.</span>
<div class="itemgroup info">
<div class="note note note_note"><span class="note__title">Note:</span> For larger files you must use the http or https protocols. For example
http://www.myserver.com/myfile</div>
</div>
</li><li class="li step stepexpand">
<span class="ph cmd">Complete the <span class="keyword wintitle">User Name</span>
and <span class="keyword wintitle">Password</span> fields if
the file server requires authentication. </span>
</li><li class="li step stepexpand">
<span class="ph cmd">Click <span class="keyword wintitle">Import</span>.</span>
</li></ol></section>
<section class="section result"><div class="tasklabel"><strong class="sectiontitle tasklabel">Result</strong></div>The ISO image file will be displayed in the <span class="keyword wintitle">VM Files</span> table, under <span class="keyword wintitle">Management</span>/<span class="keyword wintitle">File</span>. <br><img class="image" id="task_h5g_n4v_rs__image_nrx_dnv_tt" src="https://documentation.media5corp.com/download/attachments/62825785/ImportFileThroughURL.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_f2k_czk_ls">
<h2 class="title topictitle2" id="ariaid-title25">Importing an ISO image to the Unit File Management System</h2>
<div class="body taskbody">
<section class="section context"><div class="tasklabel"><strong class="sectiontitle tasklabel">Context</strong></div>
<p class="p">If the ISO Image is larger than 10mb, use the <a class="xref" href="#task_h5g_n4v_rs">Importing an ISO Image Larger than 10mb to the Unit File Management System</a>. </p>
</section>
<section id="task_f2k_czk_ls__steps_xxt_gzk_ls"><div class="tasklabel"><strong class="sectiontitle tasklabel">Steps</strong></div><ol class="ol steps" id="task_f2k_czk_ls__steps_xxt_gzk_ls"><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">vm/drives/</span>.</span>
</li><li class="li step stepexpand">
<span class="ph cmd">Browse to the location of the ISO file containing the operating system (OS) to
install on the virtual machine.</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 <span class="keyword wintitle">Internal files</span>table.</div>
</div>
</li></ol></section>
<section class="section result"><div class="tasklabel"><strong class="sectiontitle tasklabel">Result</strong></div>The imported ISO file will appear in the <span class="keyword wintitle">VM Files</span> table, under <span class="keyword wintitle">Management</span>/<span class="keyword wintitle">File</span>. <br><img class="image" id="task_f2k_czk_ls__image_fms_rd3_rs" src="https://documentation.media5corp.com/download/attachments/62825785/ImportFileThroughWebBrowser_Vm.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_grf_5dl_ls">
<h2 class="title topictitle2" id="ariaid-title26">Configuring the VM Network Adapter (VirtIO)</h2>
<div class="body taskbody">
<section class="section prereq"><div class="tasklabel"><strong class="sectiontitle tasklabel">Before you begin</strong></div>Configuring the Network Adapter is optional. By default, it is set to E 1000 (Intel
82545EM emulated network interface card). However, for enhanced network performance, the
network adapter can be set to VirtIO, provided it is supported by the guest OS as
paravirtualised drivers are required.</section>
<section id="task_grf_5dl_ls__steps_cmr_bqh_rs"><div class="tasklabel"><strong class="sectiontitle tasklabel">Steps</strong></div><ol class="ol steps" id="task_grf_5dl_ls__steps_cmr_bqh_rs"><li class="li step stepexpand">
<span class="ph cmd">Go to <span class="keyword wintitle">System</span>/<span class="keyword wintitle">VM</span>.</span>
</li><li class="li step stepexpand">
<span class="ph cmd">From the Network Adapter drop down list, select <span class="keyword wintitle">VirtIO</span>.</span>
<div class="itemgroup info">
<div class="note note note_note"><span class="note__title">Note:</span> Please refer to the OS documentation for specific information regarding
VirtIO.</div>
</div>
</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>
<p class="p">The virtual machine Network Adapter will be set to <span class="keyword wintitle">VirtIO</span>.</p>
<br><img class="image" id="task_grf_5dl_ls__image_sll_phc_ss" src="https://documentation.media5corp.com/download/attachments/62825785/VirtualMachineVirtIO.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-title27" id="task_d2r_2yk_ls">
<h2 class="title topictitle2" id="ariaid-title27">Installing the OS on the Virtual Machine Using an ISO image</h2>
<div class="body taskbody">
<section class="section prereq"><div class="tasklabel"><strong class="sectiontitle tasklabel">Before you begin</strong></div>The <a class="xref" href="#unique_1250482714615966480">Importing an ISO image to the Unit File Management System</a> procedure must be completed. When downloading an OS that provides architecture
choices you need to choose either AMD64 (64 bit OS) or i386/i686 (32 bit OS). Basically
you need to choose the architecture for an INTEL processor</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">System</span>/<span class="keyword wintitle">VM</span>.</span>
</li><li class="li step stepexpand">
<span class="ph cmd">In the <span class="keyword wintitle">Virtual Machine Configuration</span>,
in the <span class="keyword wintitle">Iso Name</span> field,
indicate the name of the ISO file containing the OS.</span>
</li><li class="li step stepexpand">
<span class="ph cmd">In the <span class="keyword wintitle">Vnc Id</span> field,
indicate the unique id used with the VNC Client to connect to the virtual
machine console.</span>
</li><li class="li step stepexpand">
<span class="ph cmd">From the <span class="keyword wintitle">Usb</span> field,
select <span class="keyword wintitle">None</span>.</span>
</li><li class="li step stepexpand">
<span class="ph cmd">Click <img class="image" id="task_d2r_2yk_ls__image_k4d_gxg_rs" src="https://documentation.media5corp.com/download/attachments/62825785/StartVirtualMachine.png" width="16">.</span>
</li><li class="li step stepexpand">
<span class="ph cmd">Open the VNC Client located on a computer of the network connected to the
unit.</span>
<div class="itemgroup info">
<div class="note note note_note"><span class="note__title">Note:</span>
<p class="p">UltraVNC Viewer, TightVNC Viewer and VNC Viewer are presently
supported.</p>
</div>
</div>
</li><li class="li step stepexpand">
<span class="ph cmd">Enter the IPAddressOftheUnit:VNCid.</span>
<div class="itemgroup info">
<div class="note note note_note"><span class="note__title">Note:</span> For example 192.168.0.12:1</div>
</div>
</li><li class="li step stepexpand">
<span class="ph cmd">Follow the on-screen instructions.</span>
<div class="itemgroup info">
<div class="note caution note_caution"><span class="note__title">Caution:</span>
<div class="p">To reduce the wear-and-tear of the Solid State Drive,<ul class="ul" id="task_d2r_2yk_ls__ul_hnx_qkn_cv">
<li class="li">On Linux OS, disable memory swapping or at least set swappiness
to 0.</li>
<li class="li">On Windows OS, disable the virtual memory.</li>
</ul></div>
</div>
</div>
<div class="itemgroup info">
<div class="note note note_note"><span class="note__title">Note:</span> If the Solid State Drive fails because it is inadequately used by a third
party software or the operating system, the warranty of the Mediatrix unit
will no longer be valid.</div>
</div>
<div class="itemgroup info">
<div class="note note note_note"><span class="note__title">Note:</span> The installation can take more than an hour depending on the image you are
installing.</div>
</div>
</li></ol></section>
<section class="section result"><div class="tasklabel"><strong class="sectiontitle tasklabel">Result</strong></div>The virtual machine will be started only if it is started manually.<br><img class="image" id="task_d2r_2yk_ls__image_u2t_ghc_ss" src="https://documentation.media5corp.com/download/attachments/62825785/VirtualMachineConfiguration_iso.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-title28" id="unique_615603197872886331">
<h2 class="title topictitle2" id="ariaid-title28">Installing the Virtual Machine OS using a USB External Device</h2>
<div class="body taskbody">
<section class="section prereq"><div class="tasklabel"><strong class="sectiontitle tasklabel">Before you begin</strong></div>Make sure your USB external device contains the Operating System installation media,
is bootable, and is connected. When downloading an OS that provides architecture choices
you need to choose either AMD64 (64 bit OS) or i386/i686 (32 bit OS). Basically you need
to choose the architecture for an INTEL processor.</section>
<section id="unique_615603197872886331__steps_cmr_bqh_rs"><div class="tasklabel"><strong class="sectiontitle tasklabel">Steps</strong></div><ol class="ol steps" id="unique_615603197872886331__steps_cmr_bqh_rs"><li class="li step stepexpand">
<span class="ph cmd">Go to <span class="keyword wintitle">System</span>/<span class="keyword wintitle">VM</span>.</span>
</li><li class="li step stepexpand">
<span class="ph cmd">In the <span class="keyword wintitle">Virtual Machine Configuration</span>
table, in the <span class="keyword wintitle">Vnc Id</span>
field, indicate the unique id of the virtual machine.</span>
</li><li class="li step stepexpand">
<span class="ph cmd">From the <span class="keyword wintitle">Usb</span> field,
select <span class="keyword wintitle">All</span>.</span>
</li><li class="li step stepexpand">
<span class="ph cmd">Click <img class="image" id="unique_615603197872886331__image_of4_bdv_rs" src="https://documentation.media5corp.com/download/attachments/62825785/fleche.jpg" width="14">. </span>
</li><li class="li step stepexpand">
<span class="ph cmd">Open the VNC Client located on a computer of the network connected to the
unit.</span>
<div class="itemgroup info">
<div class="note note note_note"><span class="note__title">Note:</span> UltraVNC Viewer, TightVNC Viewer and VNC Viewer are presently
supported.</div>
</div>
</li><li class="li step stepexpand">
<span class="ph cmd">Enter the<strong class="ph b"> IPAddressOftheUnit:VNCid</strong></span>
<div class="itemgroup info">
<div class="note note note_note"><span class="note__title">Note:</span> For example 192.168.0.12:1</div>
</div>
</li><li class="li step stepexpand">
<span class="ph cmd">From the VNC client, wait for the following message to display "Press F12 for
boot menu". If too late, restart the VM by clicking the <img class="image" id="unique_615603197872886331__image_kdd_dl3_tbb" src="https://documentation.media5corp.com/download/attachments/62825785/StartVirtualMachine.png" width="15">
button.</span>
</li><li class="li step stepexpand">
<span class="ph cmd">Press F12, then select the USB device.</span>
</li><li class="li step stepexpand">
<span class="ph cmd">Follow the on-screen instructions.</span>
<div class="itemgroup info">
<div class="note caution note_caution"><span class="note__title">Caution:</span>
<div class="p">To reduce the wear-and-tear of the Solid State Drive:<ul class="ul" id="unique_615603197872886331__ul_mx1_5kn_cv">
<li class="li">On Linux OS, disable memory swapping or at least set swappiness
to 0.</li>
<li class="li">On Windows OS, disable the virtual memory.</li>
</ul></div>
</div>
<div class="note note note_note"><span class="note__title">Note:</span> If the Solid State Drive fails because it is inadequately used by a third
party software or the operating system, the warranty of the Mediatrix unit
will no longer be valid.</div>
</div>
<div class="itemgroup info">
<div class="note note note_note"><span class="note__title">Note:</span> The installation can take more than an hour depending on the image you are
installing.</div>
</div>
</li></ol></section>
<section class="section result"><div class="tasklabel"><strong class="sectiontitle tasklabel">Result</strong></div>
<p class="p">The virtual machine will be started only if it is started manually</p>
<br><img class="image" id="unique_615603197872886331__image_sll_phc_ss" src="https://documentation.media5corp.com/download/attachments/62825785/VirtualMachineConfiguration_USB.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-title29" id="unique_1250482714615966480">
<h2 class="title topictitle2" id="ariaid-title29">Importing an ISO image to the Unit File Management System</h2>
<div class="body taskbody">
<section class="section context"><div class="tasklabel"><strong class="sectiontitle tasklabel">Context</strong></div>
<p class="p">If the ISO Image is larger than 10mb, use the <a class="xref" href="#task_h5g_n4v_rs">Importing an ISO Image Larger than 10mb to the Unit File Management System</a>. </p>
</section>
<section id="unique_1250482714615966480__steps_xxt_gzk_ls"><div class="tasklabel"><strong class="sectiontitle tasklabel">Steps</strong></div><ol class="ol steps" id="unique_1250482714615966480__steps_xxt_gzk_ls"><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">vm/drives/</span>.</span>
</li><li class="li step stepexpand">
<span class="ph cmd">Browse to the location of the ISO file containing the operating system (OS) to
install on the virtual machine.</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 <span class="keyword wintitle">Internal files</span>table.</div>
</div>
</li></ol></section>
<section class="section result"><div class="tasklabel"><strong class="sectiontitle tasklabel">Result</strong></div>The imported ISO file will appear in the <span class="keyword wintitle">VM Files</span> table, under <span class="keyword wintitle">Management</span>/<span class="keyword wintitle">File</span>. <br><img class="image" id="unique_1250482714615966480__image_fms_rd3_rs" src="https://documentation.media5corp.com/download/attachments/62825785/ImportFileThroughWebBrowser_Vm.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-title30" id="task_z5n_dnz_lv">
<h2 class="title topictitle2" id="ariaid-title30">Disabling Swap on Linux</h2>
<div class="body taskbody">
<section class="section context"><div class="tasklabel"><strong class="sectiontitle tasklabel">Context</strong></div>Disabling swapping in the Operating System will optimise the virtual machine in
such a way to reduce the wear-and-tear of the Solid State Drive.<div class="note note note_note"><span class="note__title">Note:</span> If the
Solid State Drive fails because it is inadequately used by a third-party software or
the operating system, the warranty of the Mediatrix unit will no longer be
valid.</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">Open the VNC Client located on a computer of the network connected to the
unit.</span>
<div class="itemgroup info">
<div class="note note note_note"><span class="note__title">Note:</span> UltraVNC Viewer, TightVNC Viewer and VNC Viewer are presently
supported.</div>
</div>
</li><li class="li step stepexpand">
<span class="ph cmd">Open .../etc/sysctl.conf file</span>
</li><li class="li step stepexpand">
<span class="ph cmd">Add vm.swappiness = 0 to the file.</span>
</li><li class="li step stepexpand">
<span class="ph cmd">Open ... /etc/fstab.</span>
</li><li class="li step stepexpand">
<span class="ph cmd">Add noatime to the following lines</span>
<ol type="a" class="ol substeps" id="task_z5n_dnz_lv__substeps_yh3_hnz_lv">
<li class="li substep">
<span class="ph cmd">§ UUID=32b414c0-This-is-an-example / ext4 defaults, noatime 1 1</span>
</li>
<li class="li substep">
<span class="ph cmd">§ UUID=b4598e44-This-is-an-example /boot ext4 defaults, noatime 1
2</span>
</li>
</ol>
</li><li class="li step stepexpand">
<span class="ph cmd">Comment out</span>
<ol type="a" class="ol substeps" id="task_z5n_dnz_lv__substeps_g5w_3nz_lv">
<li class="li substep">
<span class="ph cmd">§ # UUID=72355f7a-497d-This-is-an-example swap swap defaults 0 0</span>
</li>
</ol>
</li><li class="li step stepexpand">
<span class="ph cmd">Use the Shutdown command and then restart the Virtual Machine.</span>
<div class="itemgroup info">
<div class="note important note_important"><span class="note__title">IMPORTANT:</span> Do no use the Linux <span class="keyword cmdname">reboot</span> command as
the filesystem may not get mounted properly.</div>
</div>
</li></ol></section>
</div>
</article></article><hr><span style="float: inline-end;"><a href="#">Top</a></span><article class="topic nested0 nobody" aria-labelledby="ariaid-title31" id="topic_title_Virtual_Machine_Modification_d1e45">
<h1 class="title topictitle1" id="ariaid-title31">Virtual Machine Modification</h1>
<article class="topic task nested1" aria-labelledby="ariaid-title32" id="task_dcv_xhv_rs">
<h2 class="title topictitle2" id="ariaid-title32">Modifying the Virtual Machine Configuration</h2>
<div class="body taskbody">
<section><div class="tasklabel"><strong class="sectiontitle tasklabel">Steps</strong></div><ol class="ol steps"><li class="li step">
<span class="ph cmd">Go to <span class="keyword wintitle">System</span>/<span class="keyword wintitle">VM</span>.</span>
</li><li class="li step">
<span class="ph cmd">In the <span class="keyword wintitle">Virtual Machine Configuration</span>
table, modify the fields as required.</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>The next time the virtual machine will be used, the new parameter values will be
applied. </section>
</div>
</article></article><hr><span style="float: inline-end;"><a href="#">Top</a></span><article class="topic concept nested0" aria-labelledby="ariaid-title33" id="concept_vtd_gkg_yr">
<h1 class="title topictitle1" id="ariaid-title33">Parameters</h1>
<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>
<hr><span style="float: inline-end;"><a href="#">Top</a></span><article class="topic reference nested1" aria-labelledby="ariaid-title34" id="reference_lxl_ljw_bq">
<h2 class="title topictitle2" id="ariaid-title34"> System/VM Parameters</h2>
<div class="body refbody">
<section class="section"><h3 class="title sectiontitle">Min Severity</h3>For more details on the following parameters, refer to the <a class="xref" href="https://documentation.media5corp.com/display/DGWLATEST/Reference+Guide" target="_blank">DGW Configuration Guide - Reference Guide</a> published on the <a class="xref" href="https://documentation.media5corp.com/" target="_blank">Media5 Documentation Portal</a>
Refer to <span class="keyword parmname"> Vm.Min
Severity</span>.</section>
<section class="section"><h3 class="title sectiontitle">Need Restart Info</h3>Refer to <span class="keyword parmname">
Vm.NeedRestartInfo</span>.</section>
</div>
</article></article><hr><span style="float: inline-end;"><a href="#">Top</a></span><article class="topic reference nested0" aria-labelledby="ariaid-title35" id="reference_yv3_w5d_lr">
<h1 class="title topictitle1" id="ariaid-title35">Configuration notes</h1>
<div class="body refbody"><p class="shortdesc">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 <span class="keyword cmdname">created</span> to guide the user through an aspect of the
configuration. </p>
<section class="section">To access the configuration notes, go to <a class="xref" href="#reference_apw_54c_ss">Configuration
notes</a>.</section>
</div>
<hr><span style="float: inline-end;"><a href="#">Top</a></span><article class="topic reference nested1" aria-labelledby="ariaid-title36" id="reference_apw_54c_ss">
<h2 class="title topictitle2" id="ariaid-title36">Virtual Machine Configuration Notes</h2>
<div class="body refbody">
<section class="section">The following documents are published on the <a class="xref" href="https://documentation.media5corp.com/" target="_blank">Media5 Documentation Portal</a>:<ul class="ul" id="reference_apw_54c_ss__ul_evk_y4c_ss">
<li class="li"><a class="xref" href="https://documentation.media5corp.com/display/DGWLATEST/Installing+a+FreePBX+Virtual+Machine" target="_blank">Technical Bulletin - Installing a FreePBX Virtual
Machine</a></li>
<li class="li"><a class="xref" href="https://documentation.media5corp.com/display/DGWLATEST/Installing+a+Virtual+Machine+Using+an+ISO+Image" target="_blank">Technical Bulletin - Installing a VM using an iso
image</a>
</li>
<li class="li">
<a class="xref" href="https://documentation.media5corp.com/display/DGWLATEST/Installing+a+Virtual+Machine+Using+an+USB+External+Device" target="_blank">Technical Bulletin - Installing a VM using an USB
external device</a>
</li>
</ul></section>
</div>
</article></article><hr><span style="float: inline-end;"><a href="#">Top</a></span><article class="topic reference nested0" aria-labelledby="ariaid-title37" id="reference_j4g_nbv_gfb">
<h1 class="title topictitle1" id="ariaid-title37">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 concept nested0" aria-labelledby="ariaid-title38" id="concept_v4k_q3h_1r">
<h1 class="title topictitle1" id="ariaid-title38">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-title39" id="concept_fqm_rv4_k4">
<h1 class="title topictitle1" id="ariaid-title39">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><div class="fn"><a name="fntarg_1" href="#fnsrc_1"><sup>1</sup></a> a minimum of 4 GB is required to use a VM</div><div class="fn"><a name="fntarg_2" href="#fnsrc_2"><sup>2</sup></a> a minimum of 32 GB is required to use a VM</div></article></main></body></html> |