<!DOCTYPE html
SYSTEM "about:legacy-compat">
<html lang="en"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><meta charset="UTF-8"><meta name="copyright" content="(C) Copyright 2023"><meta name="DC.rights.owner" content="(C) Copyright 2023"><meta name="DC.type" content="reference"><meta name="prodname" content="Virtuo EMS - Element Management System"><meta name="version" content="Virtuo 4.8.0"><meta name="platform" content=""><meta name="DC.date.modified" content="2023-03-28"><meta name="DC.date.issued" content="2023-03-28"><meta name="DC.date.available" content="2023-03-28"><meta name="ChapterNumbering" content="no"><meta name="DC.format" content="HTML5"><meta name="DC.identifier" content="reference_j4q_1rc_f3b"><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/75010953/commonltr.css"><link rel="stylesheet" type="text/css" href="https://documentation.media5corp.com/download/attachments/75010953/custom.css"><title>Configuring Virtuo for Zero-touch Provisioning</title></head><body><header role="banner"><div class="topicmeta title">Configuring Virtuo for Zero-touch Provisioning</div><div class="topicmeta date">2023-03-28</div><div class="topicmeta product">Virtuo EMS - Element Management System</div><div class="topicmeta version">Virtuo 4.8.0</div><div class="topicmeta pdf"><a href="https://documentation.media5corp.com/download/attachments/75010953/Configuring%20Virtuo%20for%20Zero-touch%20Provisioning.pdf" rel="nofollow">Download PDF Document</a></div><hr><span style="float: inline-end;"></span></header><nav role="toc"><ul><li><a href="#reference_j4q_1rc_f3b">Information to Know Before you Start</a></li><li><a href="#topic_title_Basic_Concepts_d1e15">Basic Concepts</a><ul><li><a href="#concept_cw1_fhg_1r">Configuration Scripts Used by Virtuo</a></li><li><a href="#concept_atg_ybf_f3b">Mediatrix Unit Custom Fields</a><ul><li><a href="#reference_twd_dfr_1jb">Example of Custom Fields </a></li></ul></li></ul></li><li><a href="#topic_title_Basic_Tasks_d1e19">Basic Tasks</a><ul><li><a href="#task_trv_qqw_23b">Logging On To Virtuo EMS</a></li><li><a href="#task_hy3_c2w_g3b">Adding a Configuration File to the Virtuo EMS</a></li><li><a href="#task_exf_j52_f3b">Associating a Virtuo Configuration File with a Group</a></li><li><a href="#unique_4276428">Associating a Mediatrix Unit to a Virtuo Group</a></li></ul></li><li><a href="#topic_title_Virtuo_Configuration_Scripts_d1e24">Virtuo Configuration Scripts</a><ul><li><a href="#unique_1598710105">Creating a Mediatrix Unit Custom Field</a></li><li><a href="#task_jx3_crs_1jb">Configuring the Custom Fields of a Mediatrix Unit </a></li></ul></li><li><a href="#concept_fqm_rv4_k4">Copyright Notice</a></li></ul></nav><main role="main"><article role="article" aria-labelledby="ariaid-title1"><hr><span style="float: inline-end;"><a href="#">Top</a></span><article class="nested0" aria-labelledby="ariaid-title1" id="reference_j4q_1rc_f3b">
<h1 class="title topictitle1" id="ariaid-title1">Information to Know Before you Start</h1>
<div class="body refbody">
<section class="section">
<ul class="ul" id="reference_j4q_1rc_f3b__ul_ekz_1sc_f3b">
<li class="li">The user must have as MSA that allows the use of Virtuo.</li>
<li class="li">The Mediatrix unit must have access to: <ul class="ul" id="reference_j4q_1rc_f3b__ul_mbv_gdw_g3b">
<li class="li">a valid DNS</li>
<li class="li">an NTP server, otherwise it will be impossible to validate the certificate date and
therefore it will be rejected.</li>
<li class="li">public internet</li>
</ul>
</li>
</ul>
</section>
</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_Basic_Concepts_d1e15">
<h1 class="title topictitle1" id="ariaid-title2">Basic Concepts</h1>
<article class="topic concept nested1" aria-labelledby="ariaid-title3" id="concept_cw1_fhg_1r">
<h2 class="title topictitle2" id="ariaid-title3">Configuration Scripts Used by Virtuo</h2>
<div class="body conbody"><p class="shortdesc">Carriers and service providers usually define a configuration that will apply to a large
number of units in compliance with the network architecture. It is the command and the parameter
values grouped in a text file that produce the configuration scripts. </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. The configuration scripts used by Virtuo are the
same as the ones used in DGW, i.e. the parameters, the structure, and the syntax are the same.
For more details, refer to the <a class="xref" href="https://documentation.media5corp.com/display/DGWLATEST/Configuration+Scripting+Language+Syntax" target="_blank">Configuration Scripting Language Syntax</a> published in the
DGW Configurations Guides section of on the <a class="xref" href="https://documentation.media5corp.com/" target="_blank">Media5 Documentation Portal</a>.</p>
<p class="p">Configuration Scripts used by Virtuo can also use custom fields created within the Virtuo EMS
Web interface. For more details refer to the <a class="xref" href="#concept_atg_ybf_f3b" title="Mediatrix unit custom fields created in Virtuo are tags/macros that provide an easy way to customise the configuration file of a unit. Custom fields are also used as keywords in the REST API.">Mediatrix Unit Custom Fields</a> section.</p>
</div>
</article><hr><span style="float: inline-end;"><a href="#">Top</a></span><article class="topic concept nested1" aria-labelledby="ariaid-title4" id="concept_atg_ybf_f3b">
<h2 class="title topictitle2" id="ariaid-title4">Mediatrix Unit Custom Fields</h2>
<div class="body conbody"><p class="shortdesc">Mediatrix unit custom fields created in Virtuo are tags/macros that provide an easy way
to customise the configuration file of a unit. Custom fields are also used as keywords in the REST
API.</p>
<p class="p">Custom fields are automatically populated by Virtuo when the configuration file is generated.
For example, the end-user can enter the specific SIP authentication credential and define the SIP
trunk CallerName here and Virtuo will automatically populate the values in the configuration
script file of the unit.</p>
<p class="p">The Custom fields are also used as keywords in the REST API to allow a third party application
to pass information to Virtuo which will populate the information to the configuration file of
the unit.</p>
<div class="p"> In the Virtuo configuration file template, tags are quoted in the following format:
<pre class="pre codeblock"><code>${unit.custom_field.field_ID}
</code></pre></div>
</div>
<hr><span style="float: inline-end;"><a href="#">Top</a></span><article class="topic reference nested2" aria-labelledby="ariaid-title5" id="reference_twd_dfr_1jb">
<h3 class="title topictitle3" id="ariaid-title5">Example of Custom Fields </h3>
<div class="body refbody">
<section class="section">If provisioning a new Mediatrix unit in Virtuo, custom fields for the SIP username and
password can be created in Virtuo (<a class="xref" href="#unique_1598710105">Creating a Mediatrix Unit Custom Field</a>). Once the custom fields
created, a specific value can be entered for each unit that needs to be provisioned by Virtuo
( <a class="xref" href="#task_jx3_crs_1jb">Configuring the Custom Fields of a Mediatrix Unit</a> ). Virtuo
will automatically take the value of the custom fields and place them in the template to build
the configuration file of the unit with these new values.</section>
<section class="section">Here are a few custom fields: <ul class="ul" id="reference_twd_dfr_1jb__ul_mbq_ffr_1jb">
<li class="li">SipEp.UserAgent[EpId=PRI1].Username = "${unit.custom_field.sip_unit_auth_username}"</li>
<li class="li">SipEp.UserAgent[EpId=PRI1].FriendlyName = ""</li>
<li class="li">SipEp.UserAgent[EpId=PRI1].Register = "Enable"</li>
<li class="li"># SipEp.Authentication.DeleteAllRows</li>
<li class="li">SipEp.Authentication[Index=1].CriteriaSelection = "Unit"</li>
<li class="li">SipEp.Authentication[Index=1].ValidateRealm = "Disable"</li>
<li class="li">SipEp.Authentication[Index=1].Username =
"${unit.custom_field.sip_unit_auth_username}"</li>
<li class="li">SipEp.Authentication[Index=1].Password =
"${unit.custom_field.sip_unit_auth_password}"</li>
<li class="li">sipEp.RegistrationRefresh</li>
</ul></section>
</div>
</article></article></article><hr><span style="float: inline-end;"><a href="#">Top</a></span><article class="topic nested0 nobody" aria-labelledby="ariaid-title6" id="topic_title_Basic_Tasks_d1e19">
<h1 class="title topictitle1" id="ariaid-title6">Basic Tasks</h1>
<article class="topic task nested1" aria-labelledby="ariaid-title7" id="task_trv_qqw_23b">
<h2 class="title topictitle2" id="ariaid-title7">Logging On To Virtuo EMS</h2>
<div class="body taskbody">
<section class="section prereq"><div class="tasklabel"><strong class="sectiontitle tasklabel">Before you begin</strong></div>A username and a password is required to connect to the Virtuo EMS. </section>
<section id="task_trv_qqw_23b__steps_l4j_nrw_23b"><div class="tasklabel"><strong class="sectiontitle tasklabel">Steps</strong></div><ol class="ol steps" id="task_trv_qqw_23b__steps_l4j_nrw_23b"><li class="li step">
<span class="ph cmd">Go to <a class="xref" href="https://virtuo.media5corp.com/" target="_blank">https://virtuo.media5corp.com</a></span>
</li><li class="li step">
<span class="ph cmd">Log on to the Virtuo EMS with your username and password.</span>
</li></ol></section>
<section class="section result"><div class="tasklabel"><strong class="sectiontitle tasklabel">Result</strong></div>The <span class="keyword wintitle">Virtuo EMS</span> home
page will be displayed.</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_hy3_c2w_g3b" title="Use this procedure if the configuration script you wish to use is not in the Configuration table (Configuration in the Settings section on the left hand side of screen),">Adding a Configuration File to the Virtuo EMS</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-title8" id="task_hy3_c2w_g3b">
<h2 class="title topictitle2" id="ariaid-title8">Adding a Configuration File to the Virtuo EMS</h2>
<div class="body taskbody"><p class="shortdesc">Use this procedure if the configuration script you wish to use is not in the
<span class="keyword wintitle">Configuration</span> table
(<span class="keyword wintitle">Configuration</span> in the
<span class="keyword wintitle">Settings</span> section on the
left hand side of screen),</p>
<section id="task_hy3_c2w_g3b__steps_ff5_g2w_g3b"><div class="tasklabel"><strong class="sectiontitle tasklabel">Steps</strong></div><ol class="ol steps" id="task_hy3_c2w_g3b__steps_ff5_g2w_g3b"><li class="li step">
<span class="ph cmd">In the Virtuo EMS Web interface, from the <span class="keyword wintitle">Settings</span> section
located on the left hand side of the screen, click <span class="keyword wintitle">Configuration</span>.</span>
</li><li class="li step">
<span class="ph cmd">In the <span class="keyword wintitle">Specific Configurations</span>
section, click <span class="keyword wintitle">Import Configuration</span>.</span>
</li><li class="li step">
<span class="ph cmd">Browse to the location of the configuration file.</span>
</li><li class="li step">
<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 uploaded configuration will appear in the section <span class="keyword wintitle">Specific Configurations</span> of the
<span class="keyword wintitle">Configuration</span>page.
The configuration can now be associated with a group. The configuration can also be
associated with a single unit as a specific configuration.<br><img class="image" id="task_hy3_c2w_g3b__image_lkv_rks_1jb" src="https://documentation.media5corp.com/download/attachments/75010953/UploadScript.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_exf_j52_f3b">Associating a Virtuo Configuration File with a Group</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-title9" id="task_exf_j52_f3b">
<h2 class="title topictitle2" id="ariaid-title9">Associating a Virtuo Configuration File with a Group</h2>
<div class="body taskbody">
<section id="task_exf_j52_f3b__steps_pqy_q52_f3b"><div class="tasklabel"><strong class="sectiontitle tasklabel">Steps</strong></div><ol class="ol steps" id="task_exf_j52_f3b__steps_pqy_q52_f3b"><li class="li step">
<span class="ph cmd">In the Virtuo EMS Web interface, from the <span class="keyword wintitle">Settings</span> section
located on the left hand side of the screen, click <span class="keyword wintitle">Configuration</span>.</span>
</li><li class="li step">
<span class="ph cmd">Click <img class="image" id="task_exf_j52_f3b__image_ytm_jwj_h3b" src="https://documentation.media5corp.com/download/attachments/75010953/pencilgris.png" width="25"> located on the same line as the provisioning group
to which you wish to associate the configuration script. </span>
</li><li class="li step">
<span class="ph cmd">In the <span class="keyword wintitle">Group Details</span> page,
from the <span class="keyword wintitle">Configuration</span> selection list, choose the appropriate Configuration file.</span>
</li><li class="li step">
<span class="ph cmd">Click <span class="keyword wintitle">Save Group</span>.</span>
</li></ol></section>
<section class="section result"><div class="tasklabel"><strong class="sectiontitle tasklabel">Result</strong></div>When a Mediatrix unit is associated with the group, the selected configuration
script will be applied for provisioning.<br><img class="image" id="task_exf_j52_f3b__image_lrw_4ls_1jb" src="https://documentation.media5corp.com/download/attachments/75010953/group.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="#unique_4276428">Associating a Mediatrix Unit to a Virtuo Group</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-title10" id="unique_4276428">
<h2 class="title topictitle2" id="ariaid-title10">Associating a Mediatrix Unit to a Virtuo Group</h2>
<div class="body taskbody">
<section id="unique_4276428__steps_pqy_q52_f3b"><div class="tasklabel"><strong class="sectiontitle tasklabel">Steps</strong></div><ol class="ol steps" id="unique_4276428__steps_pqy_q52_f3b"><li class="li step stepexpand">
<span class="ph cmd">From the left hand side menu, under the <span class="keyword wintitle">Units</span> section, click
<span class="keyword wintitle">List</span>.</span>
</li><li class="li step stepexpand">
<span class="ph cmd">From the <span class="keyword wintitle">Find</span>
selection list located at the bottom of the <span class="keyword wintitle">Units</span> table, select
<span class="keyword wintitle">Serial Number</span>.</span>
</li><li class="li step stepexpand">
<span class="ph cmd">In the <span class="keyword wintitle">Find</span>
field, enter the serial number of the unit for which the group must be
changed.</span>
<div class="itemgroup info">
<div class="note note note_note"><span class="note__title">Note:</span> If the unit for which you wish to change the group does not appear in the
<span class="keyword wintitle">Units</span>
list, then, if you purchased your unit directly from Media5, please contact
technical support at tac@media5corp.com, otherwise contact your
reseller.</div>
</div>
</li><li class="li step stepexpand">
<span class="ph cmd">Select the <span class="keyword wintitle">Unit Provisioning</span>
tab.</span>
</li><li class="li step stepexpand">
<span class="ph cmd">In the <span class="keyword wintitle">Unit Provisioning</span>
section, from the <span class="keyword wintitle">Provisioning Group</span>
selection list, select a group. </span>
</li><li class="li step stepexpand">
<span class="ph cmd">Select the <span class="keyword wintitle">Active</span> box. </span>
</li><li class="li step stepexpand">
<span class="ph cmd">Click <span class="keyword wintitle">Save</span>.</span>
</li></ol></section>
<section class="section result"><div class="tasklabel"><strong class="sectiontitle tasklabel">Result</strong></div>
<br><img class="image" id="unique_4276428__image_hlp_n4s_1jb" src="https://documentation.media5corp.com/download/attachments/75010953/unitconfigurationgroup.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-title11" id="topic_title_Virtuo_Configuration_Scripts_d1e24">
<h1 class="title topictitle1" id="ariaid-title11">Virtuo Configuration Scripts</h1>
<article class="topic task nested1" aria-labelledby="ariaid-title12" id="unique_1598710105">
<h2 class="title topictitle2" id="ariaid-title12">Creating a Mediatrix Unit Custom Field</h2>
<div class="body taskbody">
<section class="section prereq"><div class="tasklabel"><strong class="sectiontitle tasklabel">Before you begin</strong></div>You must have an access right with <span class="keyword wintitle">admin</span> privileges.</section>
<section id="unique_1598710105__steps_pqy_q52_f3b"><div class="tasklabel"><strong class="sectiontitle tasklabel">Steps</strong></div><ol class="ol steps" id="unique_1598710105__steps_pqy_q52_f3b"><li class="li step stepexpand">
<span class="ph cmd">In the Virtuo EMS Web interface, click <span class="keyword wintitle">Customs Fields</span>, located
in the <span class="keyword wintitle">Units</span>
section located on the left hand side of the screen.</span>
</li><li class="li step stepexpand">
<span class="ph cmd"> In the <span class="keyword wintitle">Unit Custom Fields</span>
page, click <span class="keyword wintitle">Add</span>. </span>
</li><li class="li step stepexpand">
<span class="ph cmd">In the <span class="keyword wintitle">New Unit Custom Field</span>
page, complete the fields as required.</span>
<div class="itemgroup info">
<div class="note note note_note"><span class="note__title">Note:</span> The <span class="keyword wintitle">Field ID</span> provided here is the field ID to be used in the
${unit.custom_field.field_ID} syntax.</div>
</div>
</li><li class="li step stepexpand">
<span class="ph cmd">Click <span class="keyword wintitle">Save</span>.</span>
</li></ol></section>
<section class="section result"><div class="tasklabel"><strong class="sectiontitle tasklabel">Result</strong></div>The custom field will be available for the units.</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_jx3_crs_1jb">Configuring the Custom Fields of a Mediatrix Unit</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-title13" id="task_jx3_crs_1jb">
<h2 class="title topictitle2" id="ariaid-title13">Configuring the Custom Fields of a Mediatrix Unit </h2>
<div class="body taskbody">
<section class="section prereq"><div class="tasklabel"><strong class="sectiontitle tasklabel">Before you begin</strong></div>Custom fields must have been created first. Refer to <a class="xref" href="#unique_1598710105">Creating a Mediatrix Unit Custom Field</a>.</section>
<section id="task_jx3_crs_1jb__steps_nxg_frs_1jb"><div class="tasklabel"><strong class="sectiontitle tasklabel">Steps</strong></div><ol class="ol steps" id="task_jx3_crs_1jb__steps_nxg_frs_1jb"><li class="li step stepexpand">
<span class="ph cmd">From the left hand side menu, under the <span class="keyword wintitle">Units</span> section, click
<span class="keyword wintitle">List</span>.</span>
</li><li class="li step stepexpand">
<span class="ph cmd">From the <span class="keyword wintitle">Find</span>
selection list located at the bottom of the <span class="keyword wintitle">Units</span> table, select
<span class="keyword wintitle">Serial Number</span>.</span>
</li><li class="li step stepexpand">
<span class="ph cmd">In the <span class="keyword wintitle">Find</span>
field, enter the serial number of the unit for which the custom fields need to
be configured.</span>
<div class="itemgroup info">
<div class="note note note_note"><span class="note__title">Note:</span> If the unit for which you wish to configure the custom fields does not
appear in the <span class="keyword wintitle">Units</span> list, then,
if you purchased your unit directly from Media5, please contact technical
support at tac@media5corp.com, otherwise contact your reseller.</div>
</div>
</li><li class="li step stepexpand">
<span class="ph cmd">Under the <span class="keyword wintitle">Unit Details</span> tb, under
the <span class="keyword wintitle">Unit Custom Fields</span>
section, enter the value of the custom fields to be configured.</span>
</li><li class="li step stepexpand">
<span class="ph cmd">Click <span class="keyword wintitle">Save</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_jx3_crs_1jb__image_nhm_kss_1jb" src="https://documentation.media5corp.com/download/attachments/75010953/UnitCustomFields.png" width="800"><br>
</section>
</div>
</article></article><hr><span style="float: inline-end;"><a href="#">Top</a></span><article class="topic concept nested0" aria-labelledby="ariaid-title14" id="concept_fqm_rv4_k4">
<h1 class="title topictitle1" id="ariaid-title14">Copyright Notice</h1>
<div class="body conbody"><p class="shortdesc">Copyright © 2022 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> |