diff options
| author | mrpa <miruna.paun@enea.com> | 2021-02-19 03:04:09 +0100 |
|---|---|---|
| committer | Miruna Paun <mrpa@enea.se> | 2021-02-19 16:12:17 +0100 |
| commit | 5b9afc6f840a0d3e47694162a321c39e6433f195 (patch) | |
| tree | 44362d06184688f058c277f66e03e6263070e1ce /doc | |
| parent | fb6a28550a5049b6d07e34149c6d2f3af7afc0b2 (diff) | |
| download | nfv-access-documentation-5b9afc6f840a0d3e47694162a321c39e6433f195.tar.gz | |
Last edit to the scripting phrasing made.
Change-Id: I979f9fb673c46a10ae4f279e2e9c76612da698a2
Signed-off-by: mrpa <miruna.paun@enea.com>
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/book-enea-nfv-access-getting-started/doc/net_config_options.xml | 286 |
1 files changed, 162 insertions, 124 deletions
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 53f45c9..f610651 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 | |||
| @@ -1,4 +1,4 @@ | |||
| 1 | <?xml version="1.0" encoding="ISO-8859-1"?> | 1 | <?xml version="1.0" encoding="UTF-8"?> |
| 2 | <chapter id="net_config_operations"> | 2 | <chapter id="net_config_operations"> |
| 3 | <title>Network Configuration Options</title> | 3 | <title>Network Configuration Options</title> |
| 4 | 4 | ||
| @@ -43,16 +43,18 @@ | |||
| 43 | 43 | ||
| 44 | <para>In use cases where CPU capacity is very limited, disabling DPDK | 44 | <para>In use cases where CPU capacity is very limited, disabling DPDK |
| 45 | can free up CPU capacity and overall performance can improve. Navigate | 45 | can free up CPU capacity and overall performance can improve. Navigate |
| 46 | to <emphasis role="bold">Configuration</emphasis>, then <emphasis role="bold">DPDK</emphasis> and | 46 | to <emphasis role="bold">Configuration</emphasis>, then <emphasis |
| 47 | deselect <emphasis role="bold">Enable DPDK</emphasis> to disable the DPDK.</para> | 47 | role="bold">DPDK</emphasis> and deselect <emphasis role="bold">Enable |
| 48 | DPDK</emphasis> to disable the DPDK.</para> | ||
| 48 | 49 | ||
| 49 | <note> | 50 | <note> |
| 50 | <para>Disabling the DPDK cannot be done after other network | 51 | <para>Disabling the DPDK cannot be done after other network |
| 51 | configurations have been made.</para> | 52 | configurations have been made.</para> |
| 52 | </note> | 53 | </note> |
| 53 | 54 | ||
| 54 | <para>In <emphasis role="bold">Configuration</emphasis>, select <emphasis role="bold">DPDK</emphasis> | 55 | <para>In <emphasis role="bold">Configuration</emphasis>, select |
| 55 | where DPDK resources can also be configured such as:</para> | 56 | <emphasis role="bold">DPDK</emphasis> where DPDK resources can also be |
| 57 | configured such as:</para> | ||
| 56 | 58 | ||
| 57 | <itemizedlist> | 59 | <itemizedlist> |
| 58 | <listitem> | 60 | <listitem> |
| @@ -89,9 +91,12 @@ | |||
| 89 | management system.</para> | 91 | management system.</para> |
| 90 | 92 | ||
| 91 | <para>To add an interface into the Enea uCPE Manager, select the uCPE | 93 | <para>To add an interface into the Enea uCPE Manager, select the uCPE |
| 92 | device, then from the top toolbar select <emphasis role="bold">Configuration</emphasis>, then | 94 | device, then from the top toolbar select <emphasis |
| 93 | <emphasis role="bold">External Interfaces</emphasis>, <emphasis role="bold">Configuration</emphasis>, | 95 | role="bold">Configuration</emphasis>, then <emphasis |
| 94 | and click the <emphasis role="bold">Add</emphasis> button. The available Interface types are detailed below.</para> | 96 | role="bold">External Interfaces</emphasis>, <emphasis |
| 97 | role="bold">Configuration</emphasis>, and click the <emphasis | ||
| 98 | role="bold">Add</emphasis> button. The available Interface types are | ||
| 99 | detailed below.</para> | ||
| 95 | 100 | ||
| 96 | <section id="dpdk_interface_type"> | 101 | <section id="dpdk_interface_type"> |
| 97 | <title>DPDK Interface Type</title> | 102 | <title>DPDK Interface Type</title> |
| @@ -102,10 +107,12 @@ and click the <emphasis role="bold">Add</emphasis> button. The available Interfa | |||
| 102 | bridge.</para> | 107 | bridge.</para> |
| 103 | 108 | ||
| 104 | <note> | 109 | <note> |
| 105 | <para>Make sure the <emphasis role="bold">Enable DPDK</emphasis> checkbox is | 110 | <para>Make sure the <emphasis role="bold">Enable DPDK</emphasis> |
| 106 | selected by accessing <emphasis role="bold">Device</emphasis>, | 111 | checkbox is selected by accessing <emphasis |
| 107 | <emphasis role="bold">Configuration</emphasis> and choosing | 112 | role="bold">Device</emphasis>, <emphasis |
| 108 | <emphasis role="bold">DPDK</emphasis>, otherwise no interface can be assigned as DPDK.</para> | 113 | role="bold">Configuration</emphasis> and choosing <emphasis |
| 114 | role="bold">DPDK</emphasis>, otherwise no interface can be assigned | ||
| 115 | as DPDK.</para> | ||
| 109 | </note> | 116 | </note> |
| 110 | 117 | ||
| 111 | <para>To add a DPDK interface under the management system, set | 118 | <para>To add a DPDK interface under the management system, set |
| @@ -202,18 +209,19 @@ and click the <emphasis role="bold">Add</emphasis> button. The available Interfa | |||
| 202 | <listitem> | 209 | <listitem> |
| 203 | <para>To edit an interface configuration type from the Enea uCPE | 210 | <para>To edit an interface configuration type from the Enea uCPE |
| 204 | Manager, select the uCPE device, then from the top toolbar select | 211 | Manager, select the uCPE device, then from the top toolbar select |
| 205 | the <emphasis role="bold">Configuration</emphasis> menu, then <emphasis role="bold">External | 212 | the <emphasis role="bold">Configuration</emphasis> menu, then |
| 206 | Interfaces</emphasis> and <emphasis role="bold">Configuration</emphasis>. | 213 | <emphasis role="bold">External Interfaces</emphasis> and <emphasis |
| 207 | The already configured interfaces are displayed here, as seen in the figure above.</para> | 214 | role="bold">Configuration</emphasis>. The already configured |
| 215 | interfaces are displayed here, as seen in the figure above.</para> | ||
| 208 | </listitem> | 216 | </listitem> |
| 209 | 217 | ||
| 210 | <listitem> | 218 | <listitem> |
| 211 | <para>In order to edit an already configured interface, (as in the | 219 | <para>In order to edit an already configured interface, (as in the |
| 212 | example popup shown below, a WAN interface) double click on the | 220 | example popup shown below, a WAN interface) double click on the |
| 213 | desired one and a popup will appear. A different popup appears for | 221 | desired one and a popup will appear. A different popup appears for |
| 214 | each type of interface. From the <emphasis role="bold">Host Interface</emphasis> | 222 | each type of interface. From the <emphasis role="bold">Host |
| 215 | window, a user can change the networking type and the IP address | 223 | Interface</emphasis> window, a user can change the networking type |
| 216 | assignment:</para> | 224 | and the IP address assignment:</para> |
| 217 | 225 | ||
| 218 | <figure> | 226 | <figure> |
| 219 | <title>Editing an Interface</title> | 227 | <title>Editing an Interface</title> |
| @@ -241,9 +249,10 @@ and click the <emphasis role="bold">Add</emphasis> button. The available Interfa | |||
| 241 | <section id="wap_interface_type"> | 249 | <section id="wap_interface_type"> |
| 242 | <title>Wap Interface Type</title> | 250 | <title>Wap Interface Type</title> |
| 243 | 251 | ||
| 244 | <para>Wireless Access Point (Wap) interfaces are used to create Wireless | 252 | <para>Wireless Access Point (Wap) interfaces are used to create |
| 245 | Access Points. Only interfaces with <literal>wap-capable</literal> | 253 | Wireless Access Points. Only interfaces with |
| 246 | capabilities can be added as WAP interfaces.</para> | 254 | <literal>wap-capable</literal> capabilities can be added as WAP |
| 255 | interfaces.</para> | ||
| 247 | 256 | ||
| 248 | <para><emphasis role="bold">How to edit the Configuration of a Wap | 257 | <para><emphasis role="bold">How to edit the Configuration of a Wap |
| 249 | Interface</emphasis></para> | 258 | Interface</emphasis></para> |
| @@ -252,30 +261,32 @@ and click the <emphasis role="bold">Add</emphasis> button. The available Interfa | |||
| 252 | <listitem> | 261 | <listitem> |
| 253 | <para>To edit an interface configuration from the Enea uCPE | 262 | <para>To edit an interface configuration from the Enea uCPE |
| 254 | Manager, select the uCPE device, then from the top toolbar select | 263 | Manager, select the uCPE device, then from the top toolbar select |
| 255 | the <emphasis role="bold">Configuration</emphasis> menu then | 264 | the <emphasis role="bold">Configuration</emphasis> menu then |
| 256 | <emphasis role="bold">External Interfaces</emphasis> and select | 265 | <emphasis role="bold">External Interfaces</emphasis> and select |
| 257 | <emphasis role="bold">Configuration</emphasis>. The already configured | 266 | <emphasis role="bold">Configuration</emphasis>. The already |
| 258 | interfaces will be displayed here.</para> | 267 | configured interfaces will be displayed here.</para> |
| 259 | </listitem> | 268 | </listitem> |
| 260 | 269 | ||
| 261 | <listitem> | 270 | <listitem> |
| 262 | <para>In order to edit an already configured interface, (as in the | 271 | <para>In order to edit an already configured interface, (as in the |
| 263 | example popup shown below, a WAP interface) double click on the | 272 | 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 | 273 | desired one and a pop-up will appear. A different pop-up appears |
| 265 | each type of interface. From the <literal>Host Interface</literal> | 274 | for each type of interface. From the <literal>Host |
| 266 | window, the following parameters are configurable:</para> | 275 | Interface</literal> window, the following parameters are |
| 267 | 276 | configurable:</para> | |
| 268 | <itemizedlist> | ||
| 269 | <listitem> | ||
| 270 | <para>Country Code: the country code, a 2 letter identifier.</para> | ||
| 271 | </listitem> | ||
| 272 | 277 | ||
| 273 | <listitem> | 278 | <itemizedlist> |
| 274 | <para>Wireless Band: 2.4 GHz or 5 GHz. Depending on the band | 279 | <listitem> |
| 275 | selection, the correct <literal>Wireless Mode</literal> and | 280 | <para>Country Code: the country code, a 2 letter |
| 276 | <literal>Radio Channel</literal> must be provided.</para> | 281 | identifier.</para> |
| 277 | </listitem> | 282 | </listitem> |
| 278 | </itemizedlist> | 283 | |
| 284 | <listitem> | ||
| 285 | <para>Wireless Band: 2.4 GHz or 5 GHz. Depending on the band | ||
| 286 | selection, the correct <literal>Wireless Mode</literal> and | ||
| 287 | <literal>Radio Channel</literal> must be provided.</para> | ||
| 288 | </listitem> | ||
| 289 | </itemizedlist> | ||
| 279 | 290 | ||
| 280 | <figure> | 291 | <figure> |
| 281 | <title>Editing an Interface</title> | 292 | <title>Editing an Interface</title> |
| @@ -291,20 +302,22 @@ and click the <emphasis role="bold">Add</emphasis> button. The available Interfa | |||
| 291 | </orderedlist> | 302 | </orderedlist> |
| 292 | 303 | ||
| 293 | <note> | 304 | <note> |
| 294 | <para>Correct <emphasis role="bold">Country Code</emphasis> selection is mandatory. | 305 | <para>Correct <emphasis role="bold">Country Code</emphasis> |
| 295 | All configuration options are available in the Enea uCPE Manager GUI but only the | 306 | selection is mandatory. All configuration options are available in |
| 296 | Radio Settings that conform with the selected country's official regulatory laws | 307 | the Enea uCPE Manager GUI but only the Radio Settings that conform |
| 297 | will be applied when the Wireless AP is started on the uCPE Device.</para> | 308 | with the selected country's official regulatory laws will be applied |
| 309 | when the Wireless AP is started on the uCPE Device.</para> | ||
| 298 | </note> | 310 | </note> |
| 299 | </section> | 311 | </section> |
| 300 | 312 | ||
| 301 | <section id="man_configuration"> | 313 | <section id="man_configuration"> |
| 302 | <title>Manual Configuration</title> | 314 | <title>Manual Configuration</title> |
| 303 | 315 | ||
| 304 | <para>For Manual Configuration of uCPE networking, select the uCPE device first, then | 316 | <para>For Manual Configuration of uCPE networking, select the uCPE |
| 305 | access the <emphasis role="bold">Configuration</emphasis> menu, and choose | 317 | device first, then access the <emphasis |
| 306 | <emphasis role="bold">External Interfaces</emphasis>, where a list of | 318 | role="bold">Configuration</emphasis> menu, and choose <emphasis |
| 307 | available network interfaces and their capabilities can be found.</para> | 319 | role="bold">External Interfaces</emphasis>, where a list of available |
| 320 | network interfaces and their capabilities can be found.</para> | ||
| 308 | 321 | ||
| 309 | <para>After networking interfaces have been added to the Enea uCPE | 322 | <para>After networking interfaces have been added to the Enea uCPE |
| 310 | Manager, the user can change the interface type (DPDK, SR-IOV, | 323 | Manager, the user can change the interface type (DPDK, SR-IOV, |
| @@ -357,16 +370,16 @@ and click the <emphasis role="bold">Add</emphasis> button. The available Interfa | |||
| 357 | </listitem> | 370 | </listitem> |
| 358 | 371 | ||
| 359 | <listitem> | 372 | <listitem> |
| 360 | <para>Select the <emphasis role="bold">Bridges</emphasis> option, then click | 373 | <para>Select the <emphasis role="bold">Bridges</emphasis> option, |
| 361 | <emphasis role="bold">Add</emphasis>.</para> | 374 | then click <emphasis role="bold">Add</emphasis>.</para> |
| 362 | </listitem> | 375 | </listitem> |
| 363 | </orderedlist> | 376 | </orderedlist> |
| 364 | 377 | ||
| 365 | <note> | 378 | <note> |
| 366 | <para>Depending on the settings found when accessing | 379 | <para>Depending on the settings found when accessing the <emphasis |
| 367 | <emphasis role="bold">Configuration</emphasis>, <emphasis role="bold">OpenVSwitch</emphasis> | 380 | role="bold">Configuration</emphasis> menu and selecting <emphasis |
| 368 | and selecting <emphasis role="bold">DPDK</emphasis>, OVS bridges with or without DPDK | 381 | role="bold">DPDK</emphasis>, OVS bridges with or without DPDK support |
| 369 | support will be used on the uCPE device.</para> | 382 | will be used on the uCPE device.</para> |
| 370 | </note> | 383 | </note> |
| 371 | 384 | ||
| 372 | <para>There are three types of bridges which can be created, each one | 385 | <para>There are three types of bridges which can be created, each one |
| @@ -474,8 +487,9 @@ and click the <emphasis role="bold">Add</emphasis> button. The available Interfa | |||
| 474 | </listitem> | 487 | </listitem> |
| 475 | 488 | ||
| 476 | <listitem> | 489 | <listitem> |
| 477 | <para>Allows for creation of <literal>Wireless Access Points</literal>. | 490 | <para>Allows for creation of <literal>Wireless Access |
| 478 | This bridge type does not need a physical port attached to it.</para> | 491 | Points</literal>. This bridge type does not need a physical |
| 492 | port attached to it.</para> | ||
| 479 | </listitem> | 493 | </listitem> |
| 480 | </itemizedlist></para> | 494 | </itemizedlist></para> |
| 481 | </listitem> | 495 | </listitem> |
| @@ -492,14 +506,16 @@ and click the <emphasis role="bold">Add</emphasis> button. The available Interfa | |||
| 492 | 506 | ||
| 493 | <itemizedlist> | 507 | <itemizedlist> |
| 494 | <listitem> | 508 | <listitem> |
| 495 | <para><emphasis role="bold">name</emphasis>: name of the bridge.</para> | 509 | <para><emphasis role="bold">name</emphasis>: name of the |
| 510 | bridge.</para> | ||
| 496 | </listitem> | 511 | </listitem> |
| 497 | 512 | ||
| 498 | <listitem> | 513 | <listitem> |
| 499 | <para><emphasis role="bold">ovs-bridge-type</emphasis>: select | 514 | <para><emphasis role="bold">ovs-bridge-type</emphasis>: select |
| 500 | <literal>communication</literal> or <literal>integration</literal>, | 515 | <literal>communication</literal> or |
| 501 | depending on intended usage. For communication bridges, physical | 516 | <literal>integration</literal>, depending on intended usage. For |
| 502 | interfaces can be added to the bridge.</para> | 517 | communication bridges, physical interfaces can be added to the |
| 518 | bridge.</para> | ||
| 503 | </listitem> | 519 | </listitem> |
| 504 | </itemizedlist> | 520 | </itemizedlist> |
| 505 | </section> | 521 | </section> |
| @@ -543,10 +559,11 @@ and click the <emphasis role="bold">Add</emphasis> button. The available Interfa | |||
| 543 | which occurs when the uCPE device connects to the Enea uCPE Manager | 559 | which occurs when the uCPE device connects to the Enea uCPE Manager |
| 544 | informing that the ZTP setup failed for the specific uCPE device.</para> | 560 | informing that the ZTP setup failed for the specific uCPE device.</para> |
| 545 | 561 | ||
| 546 | <para>To create an offline configuration, select from the top toolbar | 562 | <para>To create an offline configuration, select from the top toolbar |
| 547 | the <emphasis role="bold">Applications</emphasis> menu, then <emphasis role="bold">Offline | 563 | the <emphasis role="bold">Applications</emphasis> menu, then <emphasis |
| 548 | Config</emphasis> and choose <emphasis role="bold">Add</emphasis>. The following fields | 564 | role="bold">Offline Config</emphasis> and choose <emphasis |
| 549 | should be filled:</para> | 565 | role="bold">Add</emphasis>. The following fields should be |
| 566 | filled:</para> | ||
| 550 | 567 | ||
| 551 | <itemizedlist> | 568 | <itemizedlist> |
| 552 | <listitem> | 569 | <listitem> |
| @@ -606,9 +623,10 @@ and click the <emphasis role="bold">Add</emphasis> button. The available Interfa | |||
| 606 | <para>If a match is found, the offline configuration is sent to the | 623 | <para>If a match is found, the offline configuration is sent to the |
| 607 | device as part of Zero-Touch-Provisioning.</para> | 624 | device as part of Zero-Touch-Provisioning.</para> |
| 608 | 625 | ||
| 609 | <para>After creating the Offline Config Store, access the device by selecting | 626 | <para>After creating the Offline Config Store, access the device by |
| 610 | <emphasis role="bold">Applications</emphasis>, then <emphasis role="bold">offline config</emphasis> | 627 | selecting <emphasis role="bold">Applications</emphasis>, then <emphasis |
| 611 | and clicking <emphasis role="bold">Config App</emphasis>, to provision it with the required | 628 | role="bold">offline config</emphasis> and clicking <emphasis |
| 629 | role="bold">Config App</emphasis>, to provision it with the required | ||
| 612 | initial configuration. This operation mirrors what happens during manual | 630 | initial configuration. This operation mirrors what happens during manual |
| 613 | configuration described previously.</para> | 631 | configuration described previously.</para> |
| 614 | 632 | ||
| @@ -617,9 +635,10 @@ and click the <emphasis role="bold">Add</emphasis> button. The available Interfa | |||
| 617 | connects to the Enea uCPE Manager. Just changing an offline | 635 | connects to the Enea uCPE Manager. Just changing an offline |
| 618 | configuration will not push the new changes to the device. If an | 636 | configuration will not push the new changes to the device. If an |
| 619 | offline configuration is changed after uCPE device registration, a | 637 | offline configuration is changed after uCPE device registration, a |
| 620 | factory reset can be executed to force a new ZTP to execute. | 638 | factory reset can be executed to force a new ZTP to execute. Select |
| 621 | Select the device, then access the <emphasis role="bold">Operations</emphasis> menu | 639 | the device, then access the <emphasis |
| 622 | and select <emphasis role="bold">factory reset</emphasis>.</para> | 640 | role="bold">Operations</emphasis> menu and select <emphasis |
| 641 | role="bold">factory reset</emphasis>.</para> | ||
| 623 | </note> | 642 | </note> |
| 624 | </section> | 643 | </section> |
| 625 | </section> | 644 | </section> |
| @@ -643,32 +662,43 @@ and select <emphasis role="bold">factory reset</emphasis>.</para> | |||
| 643 | 662 | ||
| 644 | <itemizedlist> | 663 | <itemizedlist> |
| 645 | <listitem> | 664 | <listitem> |
| 646 | <para><literal>Once-before-startup</literal>. This script will only | 665 | <para><literal>Once-before-startup</literal>. This script will only |
| 647 | execute once during the startup.</para> | 666 | execute once after the system has rebooted, prior to processing any |
| 667 | device configuration.</para> | ||
| 648 | </listitem> | 668 | </listitem> |
| 649 | 669 | ||
| 650 | <listitem> | 670 | <listitem> |
| 651 | <para><literal>Always-before-startup</literal>. This script will | 671 | <para><literal>Always-before-startup</literal>. This script will always |
| 652 | always execute during the startup.</para> | 672 | execute after the system has rebooted, prior to processing any device |
| 673 | configuration.</para> | ||
| 653 | </listitem> | 674 | </listitem> |
| 654 | 675 | ||
| 655 | <listitem> | 676 | <listitem> |
| 656 | <para><literal>Once-after-startup</literal>. This script will only | 677 | <para><literal>Once-after-startup</literal>. The script will always |
| 657 | execute once after the system has been started.</para> | 678 | execute after the system has rebooted, after all device configuration |
| 679 | processes have completed.</para> | ||
| 658 | </listitem> | 680 | </listitem> |
| 659 | 681 | ||
| 660 | <listitem> | 682 | <listitem> |
| 661 | <para><literal>Always-after-startup</literal>. This script will | 683 | <para><literal>Always-after-startup</literal>. This script will |
| 662 | always execute after the system has been started.</para> | 684 | always execute after all device configuration processes have |
| 685 | completed after the system has rebooted.</para> | ||
| 663 | </listitem> | 686 | </listitem> |
| 664 | </itemizedlist> | 687 | </itemizedlist> |
| 665 | 688 | ||
| 689 | <note> | ||
| 690 | <para>After a factory reset, any of the | ||
| 691 | <literal>Once-before-*</literal> or <literal>Once-after-*</literal> | ||
| 692 | scripts will be re-run as described above.</para> | ||
| 693 | </note> | ||
| 694 | |||
| 666 | <para>Follow the instruction below to upload scripts:</para> | 695 | <para>Follow the instruction below to upload scripts:</para> |
| 667 | 696 | ||
| 668 | <orderedlist> | 697 | <orderedlist> |
| 669 | <listitem> | 698 | <listitem> |
| 670 | <para>Access the <emphasis role="bold">Devices</emphasis> menu, then <emphasis role="bold">Custom | 699 | <para>Access the <emphasis role="bold">Devices</emphasis> menu, then |
| 671 | Scripts</emphasis> and choose <emphasis role="bold">Configure</emphasis>.</para> | 700 | <emphasis role="bold">Custom Scripts</emphasis> and choose <emphasis |
| 701 | role="bold">Configure</emphasis>.</para> | ||
| 672 | </listitem> | 702 | </listitem> |
| 673 | 703 | ||
| 674 | <listitem> | 704 | <listitem> |
| @@ -676,13 +706,14 @@ and select <emphasis role="bold">factory reset</emphasis>.</para> | |||
| 676 | </listitem> | 706 | </listitem> |
| 677 | 707 | ||
| 678 | <listitem> | 708 | <listitem> |
| 679 | <para>In the <emphasis role="bold">Script Type</emphasis> menu, select the type | 709 | <para>In the <emphasis role="bold">Script Type</emphasis> menu, |
| 680 | the uploaded script should have.</para> | 710 | select the type the uploaded script should have.</para> |
| 681 | </listitem> | 711 | </listitem> |
| 682 | 712 | ||
| 683 | <listitem> | 713 | <listitem> |
| 684 | <para>Press <emphasis role="bold">Choose File</emphasis> to select the scripts | 714 | <para>Press <emphasis role="bold">Choose File</emphasis> to select |
| 685 | needed, and then click <emphasis role="bold">Send</emphasis>.</para> | 715 | the scripts needed, and then click <emphasis |
| 716 | role="bold">Send</emphasis>.</para> | ||
| 686 | </listitem> | 717 | </listitem> |
| 687 | </orderedlist> | 718 | </orderedlist> |
| 688 | </section> | 719 | </section> |
| @@ -694,15 +725,16 @@ and select <emphasis role="bold">factory reset</emphasis>.</para> | |||
| 694 | 725 | ||
| 695 | <orderedlist> | 726 | <orderedlist> |
| 696 | <listitem> | 727 | <listitem> |
| 697 | <para>Access the <emphasis role="bold">Devices</emphasis> menu, then <emphasis role="bold">Custom | 728 | <para>Access the <emphasis role="bold">Devices</emphasis> menu, then |
| 698 | Scripts</emphasis> and select <emphasis role="bold">Configure</emphasis>.</para> | 729 | <emphasis role="bold">Custom Scripts</emphasis> and select <emphasis |
| 730 | role="bold">Configure</emphasis>.</para> | ||
| 699 | </listitem> | 731 | </listitem> |
| 700 | 732 | ||
| 701 | <listitem> | 733 | <listitem> |
| 702 | <para>Select the script you want to delete from the | 734 | <para>Select the script you want to delete from the <emphasis |
| 703 | <emphasis role="bold">Uploaded Scripts</emphasis> tab and then click | 735 | role="bold">Uploaded Scripts</emphasis> tab and then click <emphasis |
| 704 | <emphasis role="bold">Delete</emphasis>, which will remove the script immediately | 736 | role="bold">Delete</emphasis>, which will remove the script |
| 705 | from the Enea uCPE Manager.</para> | 737 | immediately from the Enea uCPE Manager.</para> |
| 706 | </listitem> | 738 | </listitem> |
| 707 | </orderedlist> | 739 | </orderedlist> |
| 708 | </section> | 740 | </section> |
| @@ -715,13 +747,14 @@ and select <emphasis role="bold">factory reset</emphasis>.</para> | |||
| 715 | 747 | ||
| 716 | <orderedlist> | 748 | <orderedlist> |
| 717 | <listitem> | 749 | <listitem> |
| 718 | <para>Access the <emphasis role="bold">Devices</emphasis> menu, choose <emphasis role="bold">Custom | 750 | <para>Access the <emphasis role="bold">Devices</emphasis> menu, |
| 719 | Scripts</emphasis> and select <emphasis role="bold">Configure</emphasis>.</para> | 751 | choose <emphasis role="bold">Custom Scripts</emphasis> and select |
| 752 | <emphasis role="bold">Configure</emphasis>.</para> | ||
| 720 | </listitem> | 753 | </listitem> |
| 721 | 754 | ||
| 722 | <listitem> | 755 | <listitem> |
| 723 | <para>Select the <emphasis role="bold">Configuration</emphasis> tab and specify a | 756 | <para>Select the <emphasis role="bold">Configuration</emphasis> tab |
| 724 | new loacation to store the scripts.</para> | 757 | and specify a new loacation to store the scripts.</para> |
| 725 | 758 | ||
| 726 | <note> | 759 | <note> |
| 727 | <para>Change the script storage location only if you have many | 760 | <para>Change the script storage location only if you have many |
| @@ -739,16 +772,18 @@ and select <emphasis role="bold">factory reset</emphasis>.</para> | |||
| 739 | 772 | ||
| 740 | <orderedlist> | 773 | <orderedlist> |
| 741 | <listitem> | 774 | <listitem> |
| 742 | <para>Access the <emphasis role="bold">Devices</emphasis> menu, choose <emphasis role="bold">Custom | 775 | <para>Access the <emphasis role="bold">Devices</emphasis> menu, |
| 743 | Scripts</emphasis> and select <emphasis role="bold">Apply Scripts</emphasis>.</para> | 776 | choose <emphasis role="bold">Custom Scripts</emphasis> and select |
| 777 | <emphasis role="bold">Apply Scripts</emphasis>.</para> | ||
| 744 | </listitem> | 778 | </listitem> |
| 745 | 779 | ||
| 746 | <listitem> | 780 | <listitem> |
| 747 | <para>In the <emphasis role="bold">Script Config Screen</emphasis> pop up, select | 781 | <para>In the <emphasis role="bold">Script Config Screen</emphasis> |
| 748 | the devices from the device(s) chooser list on which to run the | 782 | pop up, select the devices from the device(s) chooser list on which |
| 749 | scripts. Press the <emphasis role="bold">></emphasis> button to move the | 783 | to run the scripts. Press the <emphasis role="bold">></emphasis> |
| 750 | devices to the right side of the chooser, which is the list of | 784 | button to move the devices to the right side of the chooser, which |
| 751 | devices that will execute the selected scripts.</para> | 785 | is the list of devices that will execute the selected |
| 786 | scripts.</para> | ||
| 752 | </listitem> | 787 | </listitem> |
| 753 | 788 | ||
| 754 | <listitem> | 789 | <listitem> |
| @@ -764,15 +799,16 @@ and select <emphasis role="bold">factory reset</emphasis>.</para> | |||
| 764 | </listitem> | 799 | </listitem> |
| 765 | 800 | ||
| 766 | <listitem> | 801 | <listitem> |
| 767 | <para>Check the <emphasis role="bold">Reboot devices</emphasis> checkbox if you | 802 | <para>Check the <emphasis role="bold">Reboot devices</emphasis> |
| 768 | want to reboot and execute the scripts at once and then select | 803 | checkbox if you want to reboot and execute the scripts at once and |
| 769 | <emphasis role="bold">ok</emphasis>.</para> | 804 | then select <emphasis role="bold">ok</emphasis>.</para> |
| 770 | 805 | ||
| 771 | <note> | 806 | <note> |
| 772 | <para>The status of execution for the scripts can be seen by | 807 | <para>The status of execution for the scripts can be seen by |
| 773 | accessing <emphasis role="bold">Fault</emphasis>, opening the | 808 | accessing <emphasis role="bold">Fault</emphasis>, opening the |
| 774 | <emphasis role="bold">Events</emphasis> screen and filtering by device and/or | 809 | <emphasis role="bold">Events</emphasis> screen and filtering by |
| 775 | the event name <filename>CustomScriptExecuted</filename>.</para> | 810 | device and/or the event name |
| 811 | <filename>CustomScriptExecuted</filename>.</para> | ||
| 776 | </note> | 812 | </note> |
| 777 | </listitem> | 813 | </listitem> |
| 778 | </orderedlist> | 814 | </orderedlist> |
| @@ -782,19 +818,19 @@ and select <emphasis role="bold">factory reset</emphasis>.</para> | |||
| 782 | <section> | 818 | <section> |
| 783 | <title>Wireless Access Point</title> | 819 | <title>Wireless Access Point</title> |
| 784 | 820 | ||
| 785 | <para>The Wireless AP Screen from the Enea uCPE Manager | 821 | <para>The Wireless AP Screen from the Enea uCPE Manager Configuration menu |
| 786 | Configuration menu allows users to configure a <literal>Wireless Access | 822 | allows users to configure a <literal>Wireless Access Point</literal>. A |
| 787 | Point</literal>. A <literal>wap-capable</literal> interface and a LAN | 823 | <literal>wap-capable</literal> interface and a LAN bridge must be added |
| 788 | bridge must be added before doing the Wireless AP configuration. For more details | 824 | before doing the Wireless AP configuration. For more details see sections |
| 789 | see sections <link linkend="wap_interface_type">Wap interface Type</link> | 825 | <link linkend="wap_interface_type">Wap interface Type</link> and <link |
| 790 | and <link linkend="dataplane_bridge">Data-plane bridge</link>.</para> | 826 | linkend="dataplane_bridge">Data-plane bridge</link>.</para> |
| 791 | 827 | ||
| 792 | <para>The following parameters are configurable:</para> | 828 | <para>The following parameters are configurable:</para> |
| 793 | 829 | ||
| 794 | <itemizedlist> | 830 | <itemizedlist> |
| 795 | <listitem> | 831 | <listitem> |
| 796 | <para>SSID: the Wireless network name - any string with a max. length of 32 | 832 | <para>SSID: the Wireless network name - any string with a max. length |
| 797 | octets.</para> | 833 | of 32 octets.</para> |
| 798 | </listitem> | 834 | </listitem> |
| 799 | 835 | ||
| 800 | <listitem> | 836 | <listitem> |
| @@ -811,15 +847,16 @@ and select <emphasis role="bold">factory reset</emphasis>.</para> | |||
| 811 | <para>WAP Security Mode: <literal>open</literal> or | 847 | <para>WAP Security Mode: <literal>open</literal> or |
| 812 | <literal>wpa2Psk</literal>. When choosing <literal>wpa2Psk</literal>, | 848 | <literal>wpa2Psk</literal>. When choosing <literal>wpa2Psk</literal>, |
| 813 | a <literal>password</literal> and an <literal>encryption</literal> | 849 | a <literal>password</literal> and an <literal>encryption</literal> |
| 814 | must be provided. The <literal>password</literal> can be any string | 850 | 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> | 851 | with a minimum length of 8 and a maximum length of 63 |
| 852 | characters.</para> | ||
| 816 | </listitem> | 853 | </listitem> |
| 817 | 854 | ||
| 818 | <listitem> | 855 | <listitem> |
| 819 | <para>DHCP Server: <literal>disabled</literal> or | 856 | <para>DHCP Server: <literal>disabled</literal> or |
| 820 | <literal>enabled</literal>. When <literal>enabled</literal> is selected, | 857 | <literal>enabled</literal>. When <literal>enabled</literal> is |
| 821 | the range of IPs (<literal>IP Address Start</literal> - <literal>IP | 858 | selected, the range of IPs (<literal>IP Address Start</literal> - |
| 822 | Address End</literal>), <literal>Netmask</literal> and | 859 | <literal>IP Address End</literal>), <literal>Netmask</literal> and |
| 823 | <literal>Gateway</literal> values must be provided.</para> | 860 | <literal>Gateway</literal> values must be provided.</para> |
| 824 | </listitem> | 861 | </listitem> |
| 825 | </itemizedlist> | 862 | </itemizedlist> |
| @@ -829,7 +866,7 @@ and select <emphasis role="bold">factory reset</emphasis>.</para> | |||
| 829 | 866 | ||
| 830 | <mediaobject> | 867 | <mediaobject> |
| 831 | <imageobject> | 868 | <imageobject> |
| 832 | <imagedata align="center" contentwidth="600" | 869 | <imagedata align="center" contentwidth="600" |
| 833 | fileref="images/wap_wireless_ap.png" /> | 870 | fileref="images/wap_wireless_ap.png" /> |
| 834 | </imageobject> | 871 | </imageobject> |
| 835 | </mediaobject> | 872 | </mediaobject> |
| @@ -839,9 +876,10 @@ and select <emphasis role="bold">factory reset</emphasis>.</para> | |||
| 839 | <para>Only a single Wireless AP is allowed on a physical interface. The | 876 | <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 | 877 | 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 | 878 | 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 | 879 | <literal>wap-capable</literal> interface must be rechecked. This can be |
| 843 | accessing the <emphasis role="bold">Configuration</emphasis> menu and selecting | 880 | done by accessing the <emphasis role="bold">Configuration</emphasis> |
| 844 | <emphasis role="bold">External Interfaces</emphasis>.</para> | 881 | menu and selecting <emphasis role="bold">External |
| 882 | Interfaces</emphasis>.</para> | ||
| 845 | </note> | 883 | </note> |
| 846 | </section> | 884 | </section> |
| 847 | </chapter> \ No newline at end of file | 885 | </chapter> \ No newline at end of file |
