summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
-rw-r--r--doc/book-enea-nfv-access-getting-started/doc/images/wap_external_interface.pngbin0 -> 18534 bytes
-rw-r--r--doc/book-enea-nfv-access-getting-started/doc/images/wap_wireless_ap.pngbin0 -> 21250 bytes
-rw-r--r--doc/book-enea-nfv-access-getting-started/doc/net_config_options.xml176
3 files changed, 156 insertions, 20 deletions
diff --git a/doc/book-enea-nfv-access-getting-started/doc/images/wap_external_interface.png b/doc/book-enea-nfv-access-getting-started/doc/images/wap_external_interface.png
new file mode 100644
index 0000000..ee49fc1
--- /dev/null
+++ b/doc/book-enea-nfv-access-getting-started/doc/images/wap_external_interface.png
Binary files differ
diff --git a/doc/book-enea-nfv-access-getting-started/doc/images/wap_wireless_ap.png b/doc/book-enea-nfv-access-getting-started/doc/images/wap_wireless_ap.png
new file mode 100644
index 0000000..b7c77bf
--- /dev/null
+++ b/doc/book-enea-nfv-access-getting-started/doc/images/wap_wireless_ap.png
Binary files differ
diff --git a/doc/book-enea-nfv-access-getting-started/doc/net_config_options.xml b/doc/book-enea-nfv-access-getting-started/doc/net_config_options.xml
index 034908a..53f45c9 100644
--- a/doc/book-enea-nfv-access-getting-started/doc/net_config_options.xml
+++ b/doc/book-enea-nfv-access-getting-started/doc/net_config_options.xml
@@ -204,7 +204,7 @@ and click the <emphasis role="bold">Add</emphasis> button. The available Interfa
204 Manager, select the uCPE device, then from the top toolbar select 204 Manager, select the uCPE device, then from the top toolbar select
205 the <emphasis role="bold">Configuration</emphasis> menu, then <emphasis role="bold">External 205 the <emphasis role="bold">Configuration</emphasis> menu, then <emphasis role="bold">External
206 Interfaces</emphasis> and <emphasis role="bold">Configuration</emphasis>. 206 Interfaces</emphasis> and <emphasis role="bold">Configuration</emphasis>.
207 The already configured interfaces are displayed here, as seen in the figure above.</para> 207 The already configured interfaces are displayed here, as seen in the figure above.</para>
208 </listitem> 208 </listitem>
209 209
210 <listitem> 210 <listitem>
@@ -238,17 +238,77 @@ and click the <emphasis role="bold">Add</emphasis> button. The available Interfa
238 </note> 238 </note>
239 </section> 239 </section>
240 240
241 <section id="wap_interface_type">
242 <title>Wap Interface Type</title>
243
244 <para>Wireless Access Point (Wap) interfaces are used to create Wireless
245 Access Points. Only interfaces with <literal>wap-capable</literal>
246 capabilities can be added as WAP interfaces.</para>
247
248 <para><emphasis role="bold">How to edit the Configuration of a Wap
249 Interface</emphasis></para>
250
251 <orderedlist>
252 <listitem>
253 <para>To edit an interface configuration from the Enea uCPE
254 Manager, select the uCPE device, then from the top toolbar select
255 the <emphasis role="bold">Configuration</emphasis> menu then
256 <emphasis role="bold">External Interfaces</emphasis> and select
257 <emphasis role="bold">Configuration</emphasis>. The already configured
258 interfaces will be displayed here.</para>
259 </listitem>
260
261 <listitem>
262 <para>In order to edit an already configured interface, (as in the
263 example popup shown below, a WAP interface) double click on the
264 desired one and a pop-up will appear. A different pop-up appears for
265 each type of interface. From the <literal>Host Interface</literal>
266 window, the following parameters are configurable:</para>
267
268 <itemizedlist>
269 <listitem>
270 <para>Country Code: the country code, a 2 letter identifier.</para>
271 </listitem>
272
273 <listitem>
274 <para>Wireless Band: 2.4 GHz or 5 GHz. Depending on the band
275 selection, the correct <literal>Wireless Mode</literal> and
276 <literal>Radio Channel</literal> must be provided.</para>
277 </listitem>
278 </itemizedlist>
279
280 <figure>
281 <title>Editing an Interface</title>
282
283 <mediaobject>
284 <imageobject>
285 <imagedata align="center" contentwidth="475"
286 fileref="images/wap_external_interface.png" />
287 </imageobject>
288 </mediaobject>
289 </figure>
290 </listitem>
291 </orderedlist>
292
293 <note>
294 <para>Correct <emphasis role="bold">Country Code</emphasis> selection is mandatory.
295 All configuration options are available in the Enea uCPE Manager GUI but only the
296 Radio Settings that conform with the selected country's official regulatory laws
297 will be applied when the Wireless AP is started on the uCPE Device.</para>
298 </note>
299 </section>
300
241 <section id="man_configuration"> 301 <section id="man_configuration">
242 <title>Manual Configuration</title> 302 <title>Manual Configuration</title>
243 303
244 <para>For Manual Configuration of uCPE networking, select the uCPE 304 <para>For Manual Configuration of uCPE networking, select the uCPE device first, then
245 device first, then access the <emphasis role="bold">Configuration</emphasis> menu, 305 access the <emphasis role="bold">Configuration</emphasis> menu, and choose
246 and choose <emphasis role="bold">External Interfaces</emphasis>, where a list of 306 <emphasis role="bold">External Interfaces</emphasis>, where a list of
247 available network interfaces and their capabilities can be found.</para> 307 available network interfaces and their capabilities can be found.</para>
248 308
249 <para>After networking interfaces have been added to the Enea uCPE 309 <para>After networking interfaces have been added to the Enea uCPE
250 Manager, the user can change the interface type (DPDK, SR-IOV, 310 Manager, the user can change the interface type (DPDK, SR-IOV,
251 Standard, WAN).</para> 311 Standard, WAN, WAP).</para>
252 312
253 <figure> 313 <figure>
254 <title>Configuration of External Interfaces</title> 314 <title>Configuration of External Interfaces</title>
@@ -303,9 +363,9 @@ and click the <emphasis role="bold">Add</emphasis> button. The available Interfa
303 </orderedlist> 363 </orderedlist>
304 364
305 <note> 365 <note>
306 <para>Depending on the settings found when accessing <emphasis role="bold">Configuration</emphasis>, 366 <para>Depending on the settings found when accessing
307 <emphasis role="bold">OpenVSwitch</emphasis> and selecting 367 <emphasis role="bold">Configuration</emphasis>, <emphasis role="bold">OpenVSwitch</emphasis>
308 <emphasis role="bold">DPDK</emphasis>, OVS bridges with or without DPDK 368 and selecting <emphasis role="bold">DPDK</emphasis>, OVS bridges with or without DPDK
309 support will be used on the uCPE device.</para> 369 support will be used on the uCPE device.</para>
310 </note> 370 </note>
311 371
@@ -405,9 +465,19 @@ and click the <emphasis role="bold">Add</emphasis> button. The available Interfa
405 465
406 <itemizedlist> 466 <itemizedlist>
407 <listitem> 467 <listitem>
408 <para><emphasis role="bold">communication</emphasis>: allows for 468 <para><emphasis role="bold">communication</emphasis>:
409 VNF communication towards LAN/WAN networks. This bridge type has 469 <itemizedlist>
410 at least one physical port attached to it.</para> 470 <listitem>
471 <para>Allows for VNF communication towards LAN/WAN networks.
472 This bridge type has at least one physical port attached to
473 it.</para>
474 </listitem>
475
476 <listitem>
477 <para>Allows for creation of <literal>Wireless Access Points</literal>.
478 This bridge type does not need a physical port attached to it.</para>
479 </listitem>
480 </itemizedlist></para>
411 </listitem> 481 </listitem>
412 482
413 <listitem> 483 <listitem>
@@ -422,14 +492,14 @@ and click the <emphasis role="bold">Add</emphasis> button. The available Interfa
422 492
423 <itemizedlist> 493 <itemizedlist>
424 <listitem> 494 <listitem>
425 <para>name: name of the bridge.</para> 495 <para><emphasis role="bold">name</emphasis>: name of the bridge.</para>
426 </listitem> 496 </listitem>
427 497
428 <listitem> 498 <listitem>
429 <para>ovs-bridge-type: select <literal>communication</literal> or 499 <para><emphasis role="bold">ovs-bridge-type</emphasis>: select
430 <literal>integration</literal>, depending on intended usage. For 500 <literal>communication</literal> or <literal>integration</literal>,
431 communication bridges, physical interfaces can be added to the 501 depending on intended usage. For communication bridges, physical
432 bridge.</para> 502 interfaces can be added to the bridge.</para>
433 </listitem> 503 </listitem>
434 </itemizedlist> 504 </itemizedlist>
435 </section> 505 </section>
@@ -474,7 +544,7 @@ and click the <emphasis role="bold">Add</emphasis> button. The available Interfa
474 informing that the ZTP setup failed for the specific uCPE device.</para> 544 informing that the ZTP setup failed for the specific uCPE device.</para>
475 545
476 <para>To create an offline configuration, select from the top toolbar 546 <para>To create an offline configuration, select from the top toolbar
477 the <emphasis role="bold">Applications</emphasis> menu, then <emphasis role="bold">Offline 547 the <emphasis role="bold">Applications</emphasis> menu, then <emphasis role="bold">Offline
478 Config</emphasis> and choose <emphasis role="bold">Add</emphasis>. The following fields 548 Config</emphasis> and choose <emphasis role="bold">Add</emphasis>. The following fields
479 should be filled:</para> 549 should be filled:</para>
480 550
@@ -537,7 +607,7 @@ and click the <emphasis role="bold">Add</emphasis> button. The available Interfa
537 device as part of Zero-Touch-Provisioning.</para> 607 device as part of Zero-Touch-Provisioning.</para>
538 608
539 <para>After creating the Offline Config Store, access the device by selecting 609 <para>After creating the Offline Config Store, access the device by selecting
540 <emphasis role="bold">Applications</emphasis>, then <emphasis role="bold">offline config</emphasis> 610 <emphasis role="bold">Applications</emphasis>, then <emphasis role="bold">offline config</emphasis>
541 and clicking <emphasis role="bold">Config App</emphasis>, to provision it with the required 611 and clicking <emphasis role="bold">Config App</emphasis>, to provision it with the required
542 initial configuration. This operation mirrors what happens during manual 612 initial configuration. This operation mirrors what happens during manual
543 configuration described previously.</para> 613 configuration described previously.</para>
@@ -650,7 +720,7 @@ and select <emphasis role="bold">factory reset</emphasis>.</para>
650 </listitem> 720 </listitem>
651 721
652 <listitem> 722 <listitem>
653 <para>Select the <emphasis role="bold">Configuration</emphasis> tab and specify a 723 <para>Select the <emphasis role="bold">Configuration</emphasis> tab and specify a
654 new loacation to store the scripts.</para> 724 new loacation to store the scripts.</para>
655 725
656 <note> 726 <note>
@@ -708,4 +778,70 @@ and select <emphasis role="bold">factory reset</emphasis>.</para>
708 </orderedlist> 778 </orderedlist>
709 </section> 779 </section>
710 </section> 780 </section>
781
782 <section>
783 <title>Wireless Access Point</title>
784
785 <para>The Wireless AP Screen from the Enea uCPE Manager
786 Configuration menu allows users to configure a <literal>Wireless Access
787 Point</literal>. A <literal>wap-capable</literal> interface and a LAN
788 bridge must be added before doing the Wireless AP configuration. For more details
789 see sections <link linkend="wap_interface_type">Wap interface Type</link>
790 and <link linkend="dataplane_bridge">Data-plane bridge</link>.</para>
791
792 <para>The following parameters are configurable:</para>
793
794 <itemizedlist>
795 <listitem>
796 <para>SSID: the Wireless network name - any string with a max. length of 32
797 octets.</para>
798 </listitem>
799
800 <listitem>
801 <para>Interface Name: the <literal>wap-capable</literal> external
802 interface.</para>
803 </listitem>
804
805 <listitem>
806 <para>Lan Bridge: the LAN bridge where wireless clients will be
807 hosted.</para>
808 </listitem>
809
810 <listitem>
811 <para>WAP Security Mode: <literal>open</literal> or
812 <literal>wpa2Psk</literal>. When choosing <literal>wpa2Psk</literal>,
813 a <literal>password</literal> and an <literal>encryption</literal>
814 must be provided. The <literal>password</literal> can be any string
815 with a minimum length of 8 and a maximum length of 63 characters.</para>
816 </listitem>
817
818 <listitem>
819 <para>DHCP Server: <literal>disabled</literal> or
820 <literal>enabled</literal>. When <literal>enabled</literal> is selected,
821 the range of IPs (<literal>IP Address Start</literal> - <literal>IP
822 Address End</literal>), <literal>Netmask</literal> and
823 <literal>Gateway</literal> values must be provided.</para>
824 </listitem>
825 </itemizedlist>
826
827 <figure>
828 <title>Wireless AP</title>
829
830 <mediaobject>
831 <imageobject>
832 <imagedata align="center" contentwidth="600"
833 fileref="images/wap_wireless_ap.png" />
834 </imageobject>
835 </mediaobject>
836 </figure>
837
838 <note>
839 <para>Only a single Wireless AP is allowed on a physical interface. The
840 validation of the <literal>wap-capable</literal> interface is done when
841 adding the Wireless AP, so, in case of an error, the parameters of the
842 <literal>wap-capable</literal> interface must be rechecked. This can be done by
843 accessing the <emphasis role="bold">Configuration</emphasis> menu and selecting
844 <emphasis role="bold">External Interfaces</emphasis>.</para>
845 </note>
846 </section>
711</chapter> \ No newline at end of file 847</chapter> \ No newline at end of file