diff options
Diffstat (limited to 'doc/book-enea-nfv-access-getting-started/doc/net_config_options.xml')
-rw-r--r-- | doc/book-enea-nfv-access-getting-started/doc/net_config_options.xml | 711 |
1 files changed, 0 insertions, 711 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 deleted file mode 100644 index 1d51537..0000000 --- a/doc/book-enea-nfv-access-getting-started/doc/net_config_options.xml +++ /dev/null | |||
@@ -1,711 +0,0 @@ | |||
1 | <?xml version="1.0" encoding="ISO-8859-1"?> | ||
2 | <chapter id="net_config_operations"> | ||
3 | <title>Network Configuration Options</title> | ||
4 | |||
5 | <para>Various Advanced Network Configuration options can be done from Enea | ||
6 | uCPE Manager GUI.</para> | ||
7 | |||
8 | <section id="device_callhome_nat"> | ||
9 | <title>Device Call Home Connection for Deployment behind NAT</title> | ||
10 | |||
11 | <para>The Device Call Home option enables the initiation of the connection | ||
12 | between the uCPE Device and the Enea uCPE Manager, from the uCPE device. | ||
13 | The Device Call Home option is required when deploying a uCPE device | ||
14 | behind NAT since the IP address of the uCPE device is hidden for the Enea | ||
15 | uCPE Manager.</para> | ||
16 | |||
17 | <para>Enable Device Call Home by marking the Device Call Home checkbox | ||
18 | when registering the uCPE device in Enea uCPE Manager. When using this | ||
19 | mechanism, the device will initiate a connection to the Enea uCPE Manager | ||
20 | for NETCONF traffic (over SSH), while the Enea uCPE Manager waits for a | ||
21 | device connection.</para> | ||
22 | </section> | ||
23 | |||
24 | <section id="device_net_config"> | ||
25 | <title>uCPE Device Network Configuration</title> | ||
26 | |||
27 | <para>The following describes the steps required for setting up the | ||
28 | virtualization infrastructure, ensuring that a uCPE device has networking | ||
29 | setup for virtualized service deployment. Networking is enabled by | ||
30 | selecting physical interfaces to be used by virtualized networking and | ||
31 | creating different types of bridges to enable VNF communication.</para> | ||
32 | |||
33 | <para>The Zero Touch Provisioning mechanism is also touched upon, as | ||
34 | alternative to manual configuration of the virtualization | ||
35 | infrastructure.</para> | ||
36 | |||
37 | <section id="config_dpdk"> | ||
38 | <title>Configure DPDK</title> | ||
39 | |||
40 | <para>DPDK is an important functionality for accelerating networking | ||
41 | performance. The DPDK is enabled by default and should be utilized in | ||
42 | most configurations.</para> | ||
43 | |||
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 | ||
46 | to <literal>Configuration</literal> -> <literal>DPDK</literal> and | ||
47 | deselect <literal>Enable DPDK</literal> to disable the DPDK.</para> | ||
48 | |||
49 | <note> | ||
50 | <para>Disabling the DPDK cannot be done after other network | ||
51 | configurations have been made.</para> | ||
52 | </note> | ||
53 | |||
54 | <para>In <literal>Configuration</literal> -> <literal>DPDK</literal> | ||
55 | it is also possible to configure DPDK resources such as:</para> | ||
56 | |||
57 | <itemizedlist> | ||
58 | <listitem> | ||
59 | <para><emphasis role="bold">LCore Mask</emphasis>. Allocated cores | ||
60 | for non-datapath OVS-DPDK threads (CPU core bitmask). Default: | ||
61 | 0x2.</para> | ||
62 | </listitem> | ||
63 | |||
64 | <listitem> | ||
65 | <para><emphasis role="bold">PMD CPU Mask</emphasis>. Allocated cores | ||
66 | for datapath processing (CPU core bitmask). Default: 0x4.</para> | ||
67 | </listitem> | ||
68 | |||
69 | <listitem> | ||
70 | <para><emphasis role="bold">Socket Memory</emphasis>. Hugepage | ||
71 | memory allocated for DPDK. Default: 1494.</para> | ||
72 | </listitem> | ||
73 | </itemizedlist> | ||
74 | </section> | ||
75 | |||
76 | <section id="config_ext_interfaces"> | ||
77 | <title>Configure External Interfaces</title> | ||
78 | |||
79 | <para>Once a management connection with the uCPE device has been | ||
80 | established by using any of the supported methods, the virtualization | ||
81 | networking infrastructure can be configured either manually or by using | ||
82 | Zero Touch Provisioning.</para> | ||
83 | |||
84 | <para>Available network interfaces can be added to the management | ||
85 | system, for use by the networking virtualization infrastructure.</para> | ||
86 | |||
87 | <para>In order to make physical network interfaces available to the | ||
88 | virtualization infrastructure and VNFs, they must be configured into the | ||
89 | management system.</para> | ||
90 | |||
91 | <para>To add an interface into the Enea uCPE Manager, select the uCPE | ||
92 | device, then from the top toolbar select <literal>Configuration -> | ||
93 | External Interfaces -> Configuration -> Add</literal>. The | ||
94 | available Interface types are detailed below.</para> | ||
95 | |||
96 | <section id="dpdk_interface_type"> | ||
97 | <title>DPDK Interface Type</title> | ||
98 | |||
99 | <para>Configuring a physical interface in DPDK mode will require a | ||
100 | DPDK-based application (e.g. OVS-DPDK) in order to access and use the | ||
101 | interface. An interface set as DPDK can be attached to an OVS-DPDK | ||
102 | bridge.</para> | ||
103 | |||
104 | <note> | ||
105 | <para>Make sure the <literal>Enable DPDK</literal> checkbox is | ||
106 | selected in <literal>Device -> Configuration -> | ||
107 | DPDK</literal>, otherwise no interface can be assigned as | ||
108 | DPDK.</para> | ||
109 | </note> | ||
110 | |||
111 | <para>To add a DPDK interface under the management system, set | ||
112 | appropriate values for the following fields:</para> | ||
113 | |||
114 | <itemizedlist> | ||
115 | <listitem> | ||
116 | <para>Source: name of the physical interface.</para> | ||
117 | </listitem> | ||
118 | |||
119 | <listitem> | ||
120 | <para>Networking-type: dpdk</para> | ||
121 | </listitem> | ||
122 | |||
123 | <listitem> | ||
124 | <para>Dpdk-type: the kernel module that allows user space access | ||
125 | to the physical interface. Either the <literal>vfio-pci</literal> | ||
126 | (most commonly used type) or the <literal>igb_uio</literal> driver | ||
127 | can be used.</para> | ||
128 | </listitem> | ||
129 | </itemizedlist> | ||
130 | </section> | ||
131 | |||
132 | <section id="sriov_interface_type"> | ||
133 | <title>SR-IOV Interface Type</title> | ||
134 | |||
135 | <para>SR-IOV technology allows for the creation of a number of virtual | ||
136 | functions on the host interface, which can be used by VNFs running on | ||
137 | the uCPE device.</para> | ||
138 | |||
139 | <para>For SR-IOV mode configuration, the user must set values for the | ||
140 | following fields:</para> | ||
141 | |||
142 | <itemizedlist> | ||
143 | <listitem> | ||
144 | <para>Source: name of the physical interface.</para> | ||
145 | </listitem> | ||
146 | |||
147 | <listitem> | ||
148 | <para>Networking-type: srIov</para> | ||
149 | </listitem> | ||
150 | |||
151 | <listitem> | ||
152 | <para>sriov-mode: adapter-pool</para> | ||
153 | </listitem> | ||
154 | |||
155 | <listitem> | ||
156 | <para>sriov-num-vfs: the number of virtual functions to | ||
157 | create.</para> | ||
158 | </listitem> | ||
159 | </itemizedlist> | ||
160 | </section> | ||
161 | |||
162 | <section id="standard_interface_type"> | ||
163 | <title>Standard Interface Type</title> | ||
164 | |||
165 | <para>Some of the physical network interfaces available on a uCPE | ||
166 | device, including Ethernet interfaces, do not have DPDK or SR-IOV | ||
167 | support. Instead, the Linux kernel driver has to be used.</para> | ||
168 | |||
169 | <para>To add Standard Interfaces under the management system, the user | ||
170 | must set values for the following fields:</para> | ||
171 | |||
172 | <itemizedlist> | ||
173 | <listitem> | ||
174 | <para>Source: the name of physical interface.</para> | ||
175 | </listitem> | ||
176 | |||
177 | <listitem> | ||
178 | <para>Networking-type: standard.</para> | ||
179 | </listitem> | ||
180 | </itemizedlist> | ||
181 | </section> | ||
182 | |||
183 | <section id="wan_interface_type"> | ||
184 | <title>Wan Interface Type</title> | ||
185 | |||
186 | <para>WAN interfaces configured during the installation of the uCPE | ||
187 | device are automatically added in the Enea uCPE manager as type | ||
188 | <literal>wan</literal>. The WAN interface used for management of the | ||
189 | uCPE device is marked with the <literal>Management</literal> property | ||
190 | set to <literal>True</literal>.</para> | ||
191 | |||
192 | <para>If a WAN interface is to be assigned for use by a VNF, it must | ||
193 | be changed into another interface type depending on the type of | ||
194 | connection that will be used. The management WAN interface cannot be | ||
195 | changed to a different type. It is automatically used when an In-band | ||
196 | management bridge is created.</para> | ||
197 | |||
198 | <para><emphasis role="bold">How to Edit the Configuration of a Wan | ||
199 | Interface</emphasis></para> | ||
200 | |||
201 | <orderedlist> | ||
202 | <listitem> | ||
203 | <para>To edit an interface configuration type from the Enea uCPE | ||
204 | Manager, select the uCPE device, then from the top toolbar select | ||
205 | the <literal>Configuration</literal> menu then <literal>External | ||
206 | Interfaces -> Configuration</literal>. The already configured | ||
207 | interfaces are displayed here, as can be seen in the figure | ||
208 | above.</para> | ||
209 | </listitem> | ||
210 | |||
211 | <listitem> | ||
212 | <para>In order to edit an already configured interface, (as in the | ||
213 | example popup shown below, a WAN interface) double click on the | ||
214 | desired one and a popup will appear. A different popup appears for | ||
215 | each type of interface. From the <literal>Host Interface</literal> | ||
216 | window, a user can change the networking type and the IP address | ||
217 | assignment:</para> | ||
218 | |||
219 | <figure> | ||
220 | <title>Editing an Interface</title> | ||
221 | |||
222 | <mediaobject> | ||
223 | <imageobject> | ||
224 | <imagedata align="center" contentwidth="450" | ||
225 | fileref="images/edit_inter.png" /> | ||
226 | </imageobject> | ||
227 | </mediaobject> | ||
228 | </figure> | ||
229 | </listitem> | ||
230 | </orderedlist> | ||
231 | |||
232 | <note> | ||
233 | <para>When changing the <literal>address-assignment</literal> from | ||
234 | static to DHCP, if any of the <literal>ip-address</literal>, | ||
235 | <literal>netmask</literal> or <literal>gateway</literal> fields have | ||
236 | invalid values a validation error will be triggered. These fields | ||
237 | must be empty or have the valid values for their respective address | ||
238 | assignment.</para> | ||
239 | </note> | ||
240 | </section> | ||
241 | |||
242 | <section id="man_configuration"> | ||
243 | <title>Manual Configuration</title> | ||
244 | |||
245 | <para>For Manual Configuration of uCPE networking, select the uCPE | ||
246 | device first and then <literal>Configuration</literal> -> | ||
247 | <literal>External Interfaces</literal>, where one can find a list of | ||
248 | available network interfaces and their capabilities.</para> | ||
249 | |||
250 | <para>After networking interfaces have been added to the Enea uCPE | ||
251 | Manager, the user can change the interface type (DPDK, SR-IOV, | ||
252 | Standard, WAN).</para> | ||
253 | |||
254 | <figure> | ||
255 | <title>Configuration of External Interfaces</title> | ||
256 | |||
257 | <mediaobject> | ||
258 | <imageobject> | ||
259 | <imagedata align="center" contentwidth="600" | ||
260 | fileref="images/edit_inter_config.png" /> | ||
261 | </imageobject> | ||
262 | </mediaobject> | ||
263 | </figure> | ||
264 | </section> | ||
265 | </section> | ||
266 | |||
267 | <section id="configure_bridges"> | ||
268 | <title>Configuring Bridges</title> | ||
269 | |||
270 | <para>After networking interfaces have been added to the Enea uCPE | ||
271 | Manager, the user can create the necessary OVS bridges.</para> | ||
272 | |||
273 | <figure> | ||
274 | <title>OVS Bridges</title> | ||
275 | |||
276 | <mediaobject> | ||
277 | <imageobject> | ||
278 | <imagedata align="center" contentwidth="600" | ||
279 | fileref="images/ovs_bridges_tab.png" /> | ||
280 | </imageobject> | ||
281 | </mediaobject> | ||
282 | </figure> | ||
283 | |||
284 | <para><emphasis role="bold">How to add OVS bridges in the Enea uCPE | ||
285 | Manager</emphasis></para> | ||
286 | |||
287 | <orderedlist> | ||
288 | <listitem> | ||
289 | <para>Select the uCPE device.</para> | ||
290 | </listitem> | ||
291 | |||
292 | <listitem> | ||
293 | <para>Select <literal>Configuration</literal>.</para> | ||
294 | </listitem> | ||
295 | |||
296 | <listitem> | ||
297 | <para>Click <literal>OpenvSwitch</literal>.</para> | ||
298 | </listitem> | ||
299 | |||
300 | <listitem> | ||
301 | <para>Select the <literal>Bridges</literal> option, then click | ||
302 | <literal>Add</literal>.</para> | ||
303 | </listitem> | ||
304 | </orderedlist> | ||
305 | |||
306 | <note> | ||
307 | <para>Depending on the settings in <literal>Configuration -> | ||
308 | OpenVSwitch -> DPDK</literal>, OVS bridges with or without DPDK | ||
309 | support will be used on the uCPE device.</para> | ||
310 | </note> | ||
311 | |||
312 | <para>There are three types of bridges which can be created, each one | ||
313 | fulfiling a different role.</para> | ||
314 | |||
315 | <section id="inband_mg_bridge"> | ||
316 | <title>uCPE In-band Management bridge</title> | ||
317 | |||
318 | <para>In-band Management refers to a model where both the data plane | ||
319 | and control plane flow over the same network path. In some situations | ||
320 | (e.g. the uCPE device has only one routable IP address), this is the | ||
321 | only option available to both control and configure the uCPE device, | ||
322 | while also allowing for data-path traffic to pass over the same | ||
323 | physical interface.</para> | ||
324 | |||
325 | <para>The solution provided by Enea for in-band management is based | ||
326 | upon an OpenvSwitch bridge managing all traffic passing through the | ||
327 | WAN physical port. Any standard or DPDK-assigned network interface can | ||
328 | be used for the In-Band management bridge.</para> | ||
329 | |||
330 | <para>To create the In-Band Management bridge, the user must set | ||
331 | values for the following fields:</para> | ||
332 | |||
333 | <itemizedlist> | ||
334 | <listitem> | ||
335 | <para>name: name of the bridge.</para> | ||
336 | </listitem> | ||
337 | |||
338 | <listitem> | ||
339 | <para>ovs-bridge-type: inbandMgmt</para> | ||
340 | </listitem> | ||
341 | </itemizedlist> | ||
342 | </section> | ||
343 | |||
344 | <section id="inband_mg_br_vnfs"> | ||
345 | <title>In-band Management bridge for VNFs</title> | ||
346 | |||
347 | <para>If VNF management can be done over a dedicated virtual | ||
348 | interface, its possible to extend the networking infrastructure | ||
349 | configuration to also access the VNF's management interface over the | ||
350 | WAN port.</para> | ||
351 | |||
352 | <para>For this setup, three types of traffic will pass over the WAN | ||
353 | physical interface:</para> | ||
354 | |||
355 | <itemizedlist> | ||
356 | <listitem> | ||
357 | <para><emphasis role="bold">Device management</emphasis>. Part of | ||
358 | the device configuration done by the Enea uCPE Manager.</para> | ||
359 | </listitem> | ||
360 | |||
361 | <listitem> | ||
362 | <para><emphasis role="bold">VNF(s) management</emphasis>. Enabling | ||
363 | or disabling features of a VNF. E.g. enabling/disabling the | ||
364 | firewall or VPN setup.</para> | ||
365 | </listitem> | ||
366 | |||
367 | <listitem> | ||
368 | <para><emphasis role="bold">Data-path</emphasis>. All other | ||
369 | traffic that is not used in the control plane and needs to reach a | ||
370 | LAN network.</para> | ||
371 | </listitem> | ||
372 | </itemizedlist> | ||
373 | |||
374 | <para>To create a VNF In-Band Management bridge, the user must set | ||
375 | values for the following fields:</para> | ||
376 | |||
377 | <itemizedlist> | ||
378 | <listitem> | ||
379 | <para>name: name of the bridge.</para> | ||
380 | </listitem> | ||
381 | |||
382 | <listitem> | ||
383 | <para>ovs-bridge-type: vnfMgmt</para> | ||
384 | </listitem> | ||
385 | |||
386 | <listitem> | ||
387 | <para>vnf-mgmt-address: select IPv4 as the type and fill in an | ||
388 | internal IP address for the bridge interface that will be | ||
389 | connected to the VNF management network, e.g 10.0.0.1.</para> | ||
390 | </listitem> | ||
391 | </itemizedlist> | ||
392 | |||
393 | <note> | ||
394 | <para>VNF management interfaces must be configured in same subnet as | ||
395 | that used by the bridge interface connected to the VNF management | ||
396 | network.</para> | ||
397 | </note> | ||
398 | </section> | ||
399 | |||
400 | <section id="dataplane_bridge"> | ||
401 | <title>Data-plane bridge</title> | ||
402 | |||
403 | <para>Data-plane bridges are generic bridges used for the VNF | ||
404 | data-plane. There are two supported sub-types:</para> | ||
405 | |||
406 | <itemizedlist> | ||
407 | <listitem> | ||
408 | <para><emphasis role="bold">communication</emphasis>: allows for | ||
409 | VNF communication towards LAN/WAN networks. This bridge type has | ||
410 | at least one physical port attached to it.</para> | ||
411 | </listitem> | ||
412 | |||
413 | <listitem> | ||
414 | <para><emphasis role="bold">integration</emphasis>: allows for | ||
415 | VNF-to-VNF communication (usually for service function chaining). | ||
416 | This bridge type does not have any physical port attached.</para> | ||
417 | </listitem> | ||
418 | </itemizedlist> | ||
419 | |||
420 | <para>To create a Data-plane bridge, the user must set values for the | ||
421 | following fields:</para> | ||
422 | |||
423 | <itemizedlist> | ||
424 | <listitem> | ||
425 | <para>name: name of the bridge.</para> | ||
426 | </listitem> | ||
427 | |||
428 | <listitem> | ||
429 | <para>ovs-bridge-type: select <literal>communication</literal> or | ||
430 | <literal>integration</literal>, depending on intended usage. For | ||
431 | communication bridges, physical interfaces can be added to the | ||
432 | bridge.</para> | ||
433 | </listitem> | ||
434 | </itemizedlist> | ||
435 | </section> | ||
436 | </section> | ||
437 | </section> | ||
438 | |||
439 | <section id="zero_touch_prov"> | ||
440 | <title>Zero Touch Provisioning - Creating an Offline Configuration</title> | ||
441 | |||
442 | <para>Zero-Touch Provisioning (ZTP) refers to the process of when a device | ||
443 | starts up for the first time and its initial configuration is pushed down | ||
444 | by an external management system, so that it is setup for proper operation | ||
445 | without additional manual intervention by an operator. ZTP is an | ||
446 | alternative to Manual configuration.</para> | ||
447 | |||
448 | <para>A variety of operations can occur as part of ZTP such as initial | ||
449 | device setup, configuration of managed objects, etc. The goal is to set up | ||
450 | a device to the maximum possible extent without forcing an operator to be | ||
451 | physically present (initially) to manage the device.</para> | ||
452 | |||
453 | <para>An offline configuration is usually prepared in advance for the Enea | ||
454 | uCPE Manager to setup the virtualization infrastructure on the uCPE | ||
455 | device, as soon as a device enrolls into the management system.</para> | ||
456 | |||
457 | <section id="offline_configuration"> | ||
458 | <title>Offline Configuration</title> | ||
459 | |||
460 | <para>The Offline Configuration subsystem is used to pre-populate a | ||
461 | configuration for a device that will be brought under management at a | ||
462 | future point in time. When creating an offline configuration store a | ||
463 | <literal>Device ID</literal> can be specified. This ID uniquely | ||
464 | identifies the device to be initialized.</para> | ||
465 | |||
466 | <para>Alternatively, a wildcard can be used in the <literal>Device | ||
467 | ID</literal> field, which results in a configuration being pushed on all | ||
468 | uCPE devices upon their initial connection towards the Enea uCPE | ||
469 | Manager.</para> | ||
470 | |||
471 | <para>If the offline configuration is not configured for a uCPE device, | ||
472 | an alarm will be raised: <literal>Day-0 Config:ZTP:Major</literal>, | ||
473 | which occurs when the uCPE device connects to the Enea uCPE Manager | ||
474 | informing that the ZTP setup failed for the specific uCPE device.</para> | ||
475 | |||
476 | <para>To create an offline configuration, from the top toolbar menu | ||
477 | select <literal>Applications</literal> -> <literal>Offline | ||
478 | Config</literal> -> <literal>Add</literal>. The following fields | ||
479 | should be filled:</para> | ||
480 | |||
481 | <itemizedlist> | ||
482 | <listitem> | ||
483 | <para>Name: name of the device.</para> | ||
484 | </listitem> | ||
485 | |||
486 | <listitem> | ||
487 | <para>Device type: Enea universal CPE.</para> | ||
488 | </listitem> | ||
489 | |||
490 | <listitem> | ||
491 | <para>DeviceVersion: <xi:include | ||
492 | href="../../s_doceneacommon/doc/eltf_params_updated.xml" | ||
493 | xmlns:xi="http://www.w3.org/2001/XInclude" | ||
494 | xpointer="element(EneaLinux_REL_VER/1)" /></para> | ||
495 | </listitem> | ||
496 | |||
497 | <listitem> | ||
498 | <para>Config Set: uCPE Config</para> | ||
499 | </listitem> | ||
500 | |||
501 | <listitem> | ||
502 | <para>Device ID: device ID or a wildcard(*).</para> | ||
503 | </listitem> | ||
504 | |||
505 | <listitem> | ||
506 | <para>Device Grouping Tags: a tag to group devices. These tags match | ||
507 | the customer tags provided during the installation of the | ||
508 | device.</para> | ||
509 | </listitem> | ||
510 | </itemizedlist> | ||
511 | |||
512 | <para>The Name is user defined and can be set to any unique text string | ||
513 | identifying the configuration. The Device Version will match the Enea | ||
514 | NFV Access version of the uCPE device and the Device ID will be set to | ||
515 | the previously set identifier of the uCPE device.</para> | ||
516 | |||
517 | <para>When a device connects to the Enea uCPE Manager for the first | ||
518 | time, it checks the device to see if it has been Zero Touch Provisioned | ||
519 | (ZTP). If not, it looks for an offline configuration that matches these | ||
520 | values, in the following order:</para> | ||
521 | |||
522 | <itemizedlist> | ||
523 | <listitem> | ||
524 | <para>The Device ID.</para> | ||
525 | </listitem> | ||
526 | |||
527 | <listitem> | ||
528 | <para>The set of tags.</para> | ||
529 | </listitem> | ||
530 | |||
531 | <listitem> | ||
532 | <para>A "*" for Device ID (wildcard).</para> | ||
533 | </listitem> | ||
534 | </itemizedlist> | ||
535 | |||
536 | <para>If a match is found, the offline configuration is sent to the | ||
537 | device as part of Zero-Touch-Provisioning.</para> | ||
538 | |||
539 | <para>After creating the Offline Config Store, access the device through | ||
540 | <literal>Applications</literal> -> <literal>offline config</literal> | ||
541 | -> <literal>Config App</literal> and provision it with the required | ||
542 | initial configuration. This operation mirrors what happens during manual | ||
543 | configuration described previously.</para> | ||
544 | |||
545 | <note> | ||
546 | <para>The ZTP will only be triggered the first time a uCPE device | ||
547 | connects to the Enea uCPE Manager. Just changing an offline | ||
548 | configuration will not push the new changes to the device. If an | ||
549 | offline configuration is changed after uCPE device registration, a | ||
550 | factory reset can be executed to force a new ZTP to execute by | ||
551 | selecting the device, then <literal>Operations</literal> -> | ||
552 | <literal>factory reset</literal>.</para> | ||
553 | </note> | ||
554 | </section> | ||
555 | </section> | ||
556 | |||
557 | <section id="custom_scripts"> | ||
558 | <title>Custom Scripts for Custom Networking Configurations</title> | ||
559 | |||
560 | <para>The custom scripts feature allows users to execute user-defined | ||
561 | scripts on the uCPE device at various times.This allows for more flexible | ||
562 | and advanced configurations such as a LTE modem configuration, advanced | ||
563 | network configurations or OVS flow rule programming at any time.</para> | ||
564 | |||
565 | <section id="upload_scripts"> | ||
566 | <title>Uploading Scripts</title> | ||
567 | |||
568 | <para>The scripts need to be uploaded to the Enea uCPE Manager prior to | ||
569 | use. When uploading scripts to the Enea uCPE Manager make sure to select | ||
570 | the right script type.</para> | ||
571 | |||
572 | <para>The following script types are supported:</para> | ||
573 | |||
574 | <itemizedlist> | ||
575 | <listitem> | ||
576 | <para><literal>Once-before-startup</literal>. This script will only | ||
577 | execute once during the startup.</para> | ||
578 | </listitem> | ||
579 | |||
580 | <listitem> | ||
581 | <para><literal>Always-before-startup</literal>. This script will | ||
582 | always execute during the startup.</para> | ||
583 | </listitem> | ||
584 | |||
585 | <listitem> | ||
586 | <para><literal>Once-after-startup</literal>. This script will only | ||
587 | execute once after the system has been started.</para> | ||
588 | </listitem> | ||
589 | |||
590 | <listitem> | ||
591 | <para><literal>Always-after-startup</literal>. This script will | ||
592 | always execute after the system has been started.</para> | ||
593 | </listitem> | ||
594 | </itemizedlist> | ||
595 | |||
596 | <para>Follow the instruction below to upload scripts:</para> | ||
597 | |||
598 | <orderedlist> | ||
599 | <listitem> | ||
600 | <para>Select <literal>Devices</literal> -> <literal>Custom | ||
601 | Scripts</literal> -> <literal>Configure</literal>.</para> | ||
602 | </listitem> | ||
603 | |||
604 | <listitem> | ||
605 | <para>Select <literal>Upload to EMS</literal>.</para> | ||
606 | </listitem> | ||
607 | |||
608 | <listitem> | ||
609 | <para>In the <literal>Script Type</literal> menu, select the type | ||
610 | the uploaded script should have.</para> | ||
611 | </listitem> | ||
612 | |||
613 | <listitem> | ||
614 | <para>Press <literal>Choose File</literal> to select the scripts | ||
615 | needed, and then press <literal>Send</literal>.</para> | ||
616 | </listitem> | ||
617 | </orderedlist> | ||
618 | </section> | ||
619 | |||
620 | <section id="remove_scripts"> | ||
621 | <title>Removing Scripts</title> | ||
622 | |||
623 | <para>Follow the instruction below to remove scripts:</para> | ||
624 | |||
625 | <orderedlist> | ||
626 | <listitem> | ||
627 | <para>Select <literal>Devices</literal> -> <literal>Custom | ||
628 | Scripts</literal> -> <literal>Configure</literal>.</para> | ||
629 | </listitem> | ||
630 | |||
631 | <listitem> | ||
632 | <para>Select the script you want to delete from the | ||
633 | <literal>Uploaded Scripts</literal> tab and then click | ||
634 | <literal>Delete</literal>, which will remove the script immediately | ||
635 | from the Enea uCPE Manager.</para> | ||
636 | </listitem> | ||
637 | </orderedlist> | ||
638 | </section> | ||
639 | |||
640 | <section id="configure_scripts"> | ||
641 | <title>Configuring Script Location</title> | ||
642 | |||
643 | <para>The location where the scripts are staged in the Enea uCPE Manager | ||
644 | can be chanaged as described below:</para> | ||
645 | |||
646 | <orderedlist> | ||
647 | <listitem> | ||
648 | <para>Select <literal>Devices</literal> -> <literal>Custom | ||
649 | Scripts</literal> -> <literal>Configure</literal>.</para> | ||
650 | </listitem> | ||
651 | |||
652 | <listitem> | ||
653 | <para>Select the <literal>Configuration</literal> tab and specify a | ||
654 | new loacation to store the scripts.</para> | ||
655 | |||
656 | <note> | ||
657 | <para>Change the script storage location only if you have many | ||
658 | scripts which you would prefer to store on another partition, | ||
659 | otherwise leave this configuration as is.</para> | ||
660 | </note> | ||
661 | </listitem> | ||
662 | </orderedlist> | ||
663 | </section> | ||
664 | |||
665 | <section id="run_the_scripts"> | ||
666 | <title>Running the Scripts</title> | ||
667 | |||
668 | <para><emphasis role="bold">How to run Custom Scripts</emphasis></para> | ||
669 | |||
670 | <orderedlist> | ||
671 | <listitem> | ||
672 | <para>Select <literal>Devices</literal> -> <literal>Custom | ||
673 | Scripts</literal> -> <literal>Apply Scripts</literal>.</para> | ||
674 | </listitem> | ||
675 | |||
676 | <listitem> | ||
677 | <para>In the <literal>Script Config Screen</literal> pop up, select | ||
678 | the devices from the device(s) chooser list on which to run the | ||
679 | scripts. Press the <literal>></literal> button to move the | ||
680 | devices to the right side of the chooser, which is the list of | ||
681 | devices that will execute the selected scripts.</para> | ||
682 | </listitem> | ||
683 | |||
684 | <listitem> | ||
685 | <para>Select the scripts from the list under the device(s) chooser | ||
686 | by pressing the <literal>+</literal> button.</para> | ||
687 | </listitem> | ||
688 | |||
689 | <listitem> | ||
690 | <para>In the pop-up window, select the scripts from the list. If | ||
691 | there are no scripts to select, then there is no script uploaded | ||
692 | with that particular type. Upload the script(s) needed and try | ||
693 | again.</para> | ||
694 | </listitem> | ||
695 | |||
696 | <listitem> | ||
697 | <para>Check the checkbox <literal>Reboot devices</literal> if you | ||
698 | want to reboot and execute the scripts at once and then press | ||
699 | <literal>ok</literal>.</para> | ||
700 | |||
701 | <note> | ||
702 | <para>The status of execution for the scripts can be seen by | ||
703 | opening the <literal>Fault</literal> -> | ||
704 | <literal>Events</literal> screen and filtering by device and/or | ||
705 | the event name <filename>CustomScriptExecuted</filename>.</para> | ||
706 | </note> | ||
707 | </listitem> | ||
708 | </orderedlist> | ||
709 | </section> | ||
710 | </section> | ||
711 | </chapter> \ No newline at end of file | ||