Page tree

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.


Excerpt

This page contains instructions on how to add and set up configuration templates for equipment provisioning.

Table of Contents
maxLevel2

...

You can add new device models by importing their corresponding configuration templates. Other than the configuration options, such templates contain all the other parameters required to provision the equipment. 

Also, you may use the import tools to update the configuration templates of the existing devices with your own customized versions. To do so, download an existing template, modify it to meet your requirements, and upload it again from the VoipNow web interface.

...

Templates can only be imported if they follow the default format as detailed in the Configuration Template Format section. If the upload is unsuccessful, VoipNow displays an error message that points to the exact problem, helping you address it efficiently.

To add a new configuration template, click the the Import Template icon icon under the the Tools area area. In the the Import Equipment Template pop pop-up panel, enter the path to the file and upload it to the system.

...

Expand
titleClick here to read tag descriptions.


TagDescription
<timezone_option>1/0</timezone_option>This option controls the availability of the time zone selector in the interface. If set to 0, the time zone selector will not be displayed in the interface.
<phone_timezones> </phone_timezones>These are all the valid timezones available on this phone device, that can be selected in the interface. The parameters for each time zone are included between the <phone_timezone> </phone_timezone> tags:

<phone_tag> </phone_tag> - The time zone's identification detail. A time zone description can be also added in order to be displayed in the interface. The following details are available:

<template_var name="TIMEZONE">time_zone_code</template_var> - The name of the template variable that will be replaced, usually the three letters time zone code (e.g. CET).

The <template_var> parameter is different based on the template you want to generate, for example, for Aastra devices, you can have:

<template_var name="AASTRA_TZ_NAME">NL-Amsterdam</template_var>

<template_var name="AASTRA_TZ_CODE">NLX</template_var>

<template_var name="AASTRA_TZ_MINUTES">60</template_var>

<vn_mappings> </vn_mappings>- The standard timezone key. If it is missing, the interface cannot provide any hints:

<vn_map>region</vn_map> - It is possible that a phone tag to be valid for multiple standard time zones and therefore you must specify all of them within these tags.

Below you can find a schematic example illustrating the the <file></file> tags tags for a Cisco SPA-508G phone phone device:

Code Block
xml
xml
<file>
  <name>spa508g.xml</name>
  <default>1</default>

   <body>
     <![CDATA[
     <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
     <flat-profile>

     <!-- Cisco SPA-508G Configuration Parameters -->
      .
      .
      .
     </flat-profile>
      ]]>
   </body>
</file>

Below you can find an example illustrating the the <equipment></equipment> and the  and the <firmware></firmware> firmware> tags for the same same Cisco SPA-508G phone phone device:

Code Block
xml
xml
<equipment id="cddb32b1f7f86472ac200d10106f1094">
<brand>Cisco</brand>
<name>Cisco</name>
<model>SPA-508G</model>
<type>phone</type>
<vendor>cis</vendor>
<oui>002699</oui>
<lines>8</lines>
<web_access>1</web_access>
<vn_timezone>
  <timezone_option>1</timezone_option>
  <phone_timezones>
    .
    .
    <phone_timezone>
      <phone_tag description=""GMT+02:00 Athens, Rome EET (Eastern European Time), MEST (Middle European Summer Time), ">
		<template_var name="TIMEZONE">EET</template_var>
      <vn_mappings>
      <vn_map>Europe/Berlin</vn_map>
      <vn_map>Europe/Zürich</vn_map>
      <vn_map>Europe/Gibraltar</vn_map>
      <vn_map>Europe/Rome</vn_map>
      .
      .
      .
      </vn_mappings>
    </phone_tag>
  </phone_timezone>
  .
  .
  .
  </phone_timezones>
</vn_timezone>
<firmware id="51731d509ffc7ece8ccd5a03576a84b7">
<name>7.4.4</name>
<interface>tftp,http</interface>
</firmware>
</equipment>


Configuration files differences

Screenshot: Example of a pop-up window showing the differences between two configuration files

...

  • The lines that were modified, @@ - line_no + line_no @@, where - line_no represents the location of the line(s) that were edited or removed and + line_no of those that were edited or added. 
  • Both values can be identical if the changes were made inside a line. In the pictured example, line line @@ -13,9 +13,9 @@ was was edited and no other line was removed or added.
  • The original content of the modified or removed line is displayed with a - sign in front and on red background. In this case, the original syntax was was -line2_name: "" ; Line 2 Extension\User ID ID.
  • The new customized content is displayed with a + sign in front and on white background. In this case, the new syntax is is +line2_name: "TEST DEVICE" ; Line 2 Extension\User ID ID.


4psarelated
NameRelated

...

topics

Customize

...

template files



Hiddenlabel
voipnow300_pbx/options/provision/edit_prov_tpl_file

...

Except where otherwise noted, content in this space is licensed under a Creative Commons Attribution 4.0 International.