summaryrefslogtreecommitdiffstats
path: root/doc/book-enea-nfv-access-auto-fw-th-user-guide/doc
diff options
context:
space:
mode:
Diffstat (limited to 'doc/book-enea-nfv-access-auto-fw-th-user-guide/doc')
-rw-r--r--doc/book-enea-nfv-access-auto-fw-th-user-guide/doc/automation_framework_test_harness.xml364
-rw-r--r--doc/book-enea-nfv-access-auto-fw-th-user-guide/doc/book.xml2
-rw-r--r--doc/book-enea-nfv-access-auto-fw-th-user-guide/doc/components.xml51
-rw-r--r--doc/book-enea-nfv-access-auto-fw-th-user-guide/doc/getting_started.xml32
-rw-r--r--doc/book-enea-nfv-access-auto-fw-th-user-guide/doc/overview.xml23
-rw-r--r--doc/book-enea-nfv-access-auto-fw-th-user-guide/doc/troubleshooting_guide.xml4
6 files changed, 237 insertions, 239 deletions
diff --git a/doc/book-enea-nfv-access-auto-fw-th-user-guide/doc/automation_framework_test_harness.xml b/doc/book-enea-nfv-access-auto-fw-th-user-guide/doc/automation_framework_test_harness.xml
index 5e6ba24..a569d59 100644
--- a/doc/book-enea-nfv-access-auto-fw-th-user-guide/doc/automation_framework_test_harness.xml
+++ b/doc/book-enea-nfv-access-auto-fw-th-user-guide/doc/automation_framework_test_harness.xml
@@ -11,15 +11,15 @@
11 11
12 <para>The <literal>/device</literal> folder contains Python scripts for 12 <para>The <literal>/device</literal> folder contains Python scripts for
13 adding uCPE device(s), receiving uCPE events' reports, removing a uCPE 13 adding uCPE device(s), receiving uCPE events' reports, removing a uCPE
14 device, waiting for a uCPE device to connect to the uCPE Manager, as well 14 device, waiting for a uCPE device to connect to the Enea Edge Management, as well
15 as scripts for adding and removing an offline configuration store. This 15 as scripts for adding and removing an offline configuration store. This
16 folder also contains scripts for uploading and removing an NFVA image into 16 folder also contains scripts for uploading and removing an NFVA image into
17 the uCPE Manager, and for installing and activating a NFVA image on a uCPE 17 the Enea Edge Management, and for installing and activating a NFVA image on a uCPE
18 Device.</para> 18 Device.</para>
19 19
20 <para>The <literal>/customScripts</literal> folder contains Python scripts 20 <para>The <literal>/customScripts</literal> folder contains Python scripts
21 for uploading custom scripts onto the uCPE Manager and uCPE device(s), for 21 for uploading custom scripts onto the Enea Edge Management and uCPE device(s), for
22 removing custom scripts from the uCPE Manager and uCPE device(s).</para> 22 removing custom scripts from the Enea Edge Management and uCPE device(s).</para>
23 23
24 <para>The <literal>/network</literal> folder contains Python scripts for 24 <para>The <literal>/network</literal> folder contains Python scripts for
25 binding or unbinding a network interface to and from a uCPE device (DPDK 25 binding or unbinding a network interface to and from a uCPE device (DPDK
@@ -79,7 +79,7 @@
79 the path to the file describing the test cases to be performed against 79 the path to the file describing the test cases to be performed against
80 the designated script.</para> 80 the designated script.</para>
81 81
82 <para>Steps for running the Python unit-test suite on the uCPE Manager 82 <para>Steps for running the Python unit-test suite on the Enea Edge Management
83 are provided below.</para> 83 are provided below.</para>
84 84
85 <section id="script_opts"> 85 <section id="script_opts">
@@ -88,16 +88,16 @@
88 <programlisting>$ python unittestSuite.py -h 88 <programlisting>$ python unittestSuite.py -h
89Usage: unittestSuite.py [options] 89Usage: unittestSuite.py [options]
90 90
91Run selected unit-test suite against Enea uCPE Manager. 91Run selected unit-test suite against Enea Edge Management.
92 92
93Options: 93Options:
94 --version show program's version number and exit 94 --version show program's version number and exit
95 -h, --help show this help message and exit 95 -h, --help show this help message and exit
96 -u USERNAME, --username=USERNAME 96 -u USERNAME, --username=USERNAME
97 Enea uCPE Manager login username 97 Enea Edge Management login username
98 -p PASSWORD, --password=PASSWORD 98 -p PASSWORD, --password=PASSWORD
99 Enea uCPE Manager login password 99 Enea Edge Management login password
100 -H HOST, --host=HOST Enea uCPE Manager host name or IP address 100 -H HOST, --host=HOST Enea Edge Management host name or IP address
101 -n DEVICENAME, --deviceName=DEVICENAME 101 -n DEVICENAME, --deviceName=DEVICENAME
102 Name of vCPE device (Virtual Infrastructure Manager) 102 Name of vCPE device (Virtual Infrastructure Manager)
103 -s SUITEFILE, --suite=SUITEFILE 103 -s SUITEFILE, --suite=SUITEFILE
@@ -234,8 +234,8 @@ consoleLoggingLevel = logging.INFO
234 <row> 234 <row>
235 <entry><literal>username</literal></entry> 235 <entry><literal>username</literal></entry>
236 236
237 <entry>The user authentication used to log into the uCPE 237 <entry>The user authentication used to log into the
238 Manager. This can be overwritten by setting the Python 238 Enea Edge Management. This can be overwritten by setting the Python
239 unit-test suite command line option 239 unit-test suite command line option
240 <literal>-u</literal>.</entry> 240 <literal>-u</literal>.</entry>
241 </row> 241 </row>
@@ -243,7 +243,7 @@ consoleLoggingLevel = logging.INFO
243 <row> 243 <row>
244 <entry><literal>password</literal></entry> 244 <entry><literal>password</literal></entry>
245 245
246 <entry>The password used to log into the uCPE Manager. This 246 <entry>The password used to log into the Enea Edge Management. This
247 can be overwritten by setting the Python unit-test suite 247 can be overwritten by setting the Python unit-test suite
248 command line option <literal>-p</literal>.</entry> 248 command line option <literal>-p</literal>.</entry>
249 </row> 249 </row>
@@ -251,7 +251,7 @@ consoleLoggingLevel = logging.INFO
251 <row> 251 <row>
252 <entry><literal>host</literal></entry> 252 <entry><literal>host</literal></entry>
253 253
254 <entry>The IP address of the uCPE Manager host. This can be 254 <entry>The IP address of the Enea Edge Management host. This can be
255 overwritten by setting the Python unit-test suite command line 255 overwritten by setting the Python unit-test suite command line
256 option <literal>-H</literal>.</entry> 256 option <literal>-H</literal>.</entry>
257 </row> 257 </row>
@@ -540,7 +540,7 @@ OK</programlisting>
540 <title>Adding a uCPE Device</title> 540 <title>Adding a uCPE Device</title>
541 541
542 <para>Steps for adding, configuring and running a uCPE device onto the 542 <para>Steps for adding, configuring and running a uCPE device onto the
543 uCPE manager are described below .</para> 543 Enea Edge Management are described below .</para>
544 544
545 <section id="opts_add_device"> 545 <section id="opts_add_device">
546 <title>Script Options</title> 546 <title>Script Options</title>
@@ -548,16 +548,16 @@ OK</programlisting>
548 <programlisting>$ python addDevice.py -h 548 <programlisting>$ python addDevice.py -h
549Usage: addDevice.py [options] 549Usage: addDevice.py [options]
550 550
551Add a uCPE device in Enea uCPE Manager. 551Add a uCPE device in Enea Edge Management.
552 552
553Options: 553Options:
554 --version show program's version number and exit 554 --version show program's version number and exit
555 -h, --help show this help message and exit 555 -h, --help show this help message and exit
556 -u USERNAME, --username=USERNAME 556 -u USERNAME, --username=USERNAME
557 Enea uCPE Manager login username 557 Enea Edge Management login username
558 -p PASSWORD, --password=PASSWORD 558 -p PASSWORD, --password=PASSWORD
559 Enea uCPE Manager login password 559 Enea Edge Management login password
560 -H HOST, --host=HOST Enea uCPE Manager host name or IP address 560 -H HOST, --host=HOST Enea Edge Management host name or IP address
561 -f DEVICEFILE, --file=DEVICEFILE 561 -f DEVICEFILE, --file=DEVICEFILE
562 File containing uCPE Information in JSON format 562 File containing uCPE Information in JSON format
563 563
@@ -615,7 +615,7 @@ Options:
6152019-03-07 17:33:10,756 - INFO: Add uCPE device 6152019-03-07 17:33:10,756 - INFO: Add uCPE device
6162019-03-07 17:33:10,975 - DEBUG: Login successful on host 'localhost' 6162019-03-07 17:33:10,975 - DEBUG: Login successful on host 'localhost'
6172019-03-07 17:33:10,979 - DEBUG: Session token is: 508b6ea2-40ee-11e9-a81f525400d08e1d 6172019-03-07 17:33:10,979 - DEBUG: Session token is: 508b6ea2-40ee-11e9-a81f525400d08e1d
6182019-03-07 17:33:11,049 - DEBUG: Add new device 'intelc3850-2' to uCPE Manager host 6182019-03-07 17:33:11,049 - DEBUG: Add new device 'intelc3850-2' to Enea Edge Management host
6192019-03-07 17:33:11,483 - INFO: Done 6192019-03-07 17:33:11,483 - INFO: Done
6202019-03-07 17:33:11,501 - DEBUG: Logging out and exiting....</programlisting> 6202019-03-07 17:33:11,501 - DEBUG: Logging out and exiting....</programlisting>
621 </section> 621 </section>
@@ -624,7 +624,7 @@ Options:
624 <section id="remove_ucpe_device"> 624 <section id="remove_ucpe_device">
625 <title>Removing a uCPE Device</title> 625 <title>Removing a uCPE Device</title>
626 626
627 <para>Steps for removing a uCPE device from the uCPE manager are 627 <para>Steps for removing a uCPE device from the Enea Edge Management are
628 described below.</para> 628 described below.</para>
629 629
630 <section id="rem_script_opts"> 630 <section id="rem_script_opts">
@@ -633,16 +633,16 @@ Options:
633 <programlisting>$ python removeDevice.py -h 633 <programlisting>$ python removeDevice.py -h
634Usage: removeDevice.py [options] 634Usage: removeDevice.py [options]
635 635
636Remove a uCPE from Enea uCPE Manager. 636Remove a uCPE from Enea Edge Management.
637 637
638Options: 638Options:
639 --version show program's version number and exit 639 --version show program's version number and exit
640 -h, --help show this help message and exit 640 -h, --help show this help message and exit
641 -u USERNAME, --username=USERNAME 641 -u USERNAME, --username=USERNAME
642 Enea uCPE Manager login username 642 Enea Edge Management login username
643 -p PASSWORD, --password=PASSWORD 643 -p PASSWORD, --password=PASSWORD
644 Enea uCPE Manager login password 644 Enea Edge Management login password
645 -H HOST, --host=HOST Enea uCPE Manager host name or IP address 645 -H HOST, --host=HOST Enea Edge Management host name or IP address
646 -f DEVICEFILE, --file=DEVICEFILE 646 -f DEVICEFILE, --file=DEVICEFILE
647 File containing uCPE Information in JSON format 647 File containing uCPE Information in JSON format
648 648
@@ -689,7 +689,7 @@ Options:
6892019-03-07 17:33:56,835 - INFO: Remove uCPE device 6892019-03-07 17:33:56,835 - INFO: Remove uCPE device
6902019-03-07 17:33:56,856 - DEBUG: Login successful on host 'localhost' 6902019-03-07 17:33:56,856 - DEBUG: Login successful on host 'localhost'
6912019-03-07 17:33:56,856 - DEBUG: Session token is: 6bebcb43-40ee-11e9-a81f525400d08e1d 6912019-03-07 17:33:56,856 - DEBUG: Session token is: 6bebcb43-40ee-11e9-a81f525400d08e1d
6922019-03-07 17:33:56,856 - DEBUG: Delete device 'intelc3850-2' from uCPE Manager 6922019-03-07 17:33:56,856 - DEBUG: Delete device 'intelc3850-2' from Enea Edge Management
693host 693host
6942019-03-07 17:33:56,875 - DEBUG: Found device with name 'intelc3850-2' 6942019-03-07 17:33:56,875 - DEBUG: Found device with name 'intelc3850-2'
6952019-03-07 17:33:57,159 - INFO: Done 6952019-03-07 17:33:57,159 - INFO: Done
@@ -701,7 +701,7 @@ host
701 <title>Waiting a uCPE Device</title> 701 <title>Waiting a uCPE Device</title>
702 702
703 <para>Steps and details for how to Wait a uCPE device to connect to the 703 <para>Steps and details for how to Wait a uCPE device to connect to the
704 uCPE Manager after installation, are described below.</para> 704 Enea Edge Management after installation, are described below.</para>
705 705
706 <section id="wait_script_opts"> 706 <section id="wait_script_opts">
707 <title>Script Options</title> 707 <title>Script Options</title>
@@ -709,16 +709,16 @@ host
709 <programlisting>$ python waitDeviceUp.py -h 709 <programlisting>$ python waitDeviceUp.py -h
710Usage: waitDeviceUp.py [options] 710Usage: waitDeviceUp.py [options]
711 711
712Wait for uCPE to connect to the Enea uCPE Manager after installation. 712Wait for uCPE to connect to the Enea Edge Management after installation.
713 713
714Options: 714Options:
715 --version show program's version number and exit 715 --version show program's version number and exit
716 -h, --help show this help message and exit 716 -h, --help show this help message and exit
717 -u USERNAME, --username=USERNAME 717 -u USERNAME, --username=USERNAME
718 Enea uCPE Manager login username 718 Enea Edge Management login username
719 -p PASSWORD, --password=PASSWORD 719 -p PASSWORD, --password=PASSWORD
720 Enea uCPE Manager login password 720 Enea Edge Management login password
721 -H HOST, --host=HOST Enea uCPE Manager host name or IP address 721 -H HOST, --host=HOST Enea Edge Management host name or IP address
722 -f DEVICEFILE, --file=DEVICEFILE 722 -f DEVICEFILE, --file=DEVICEFILE
723 File containing uCPE Information in JSON format 723 File containing uCPE Information in JSON format
724 -t TIMEOUT, --timeout=TIMEOUT 724 -t TIMEOUT, --timeout=TIMEOUT
@@ -779,7 +779,7 @@ Options:
779 <title>Printing the uCPE Device Log</title> 779 <title>Printing the uCPE Device Log</title>
780 780
781 <para>Steps and details on how to Print the events log for a specific 781 <para>Steps and details on how to Print the events log for a specific
782 uCPE device installed in the uCPE Manager, are explained below.</para> 782 uCPE device installed in the Enea Edge Management, are explained below.</para>
783 783
784 <section id="print_script_opts"> 784 <section id="print_script_opts">
785 <title>Script Options</title> 785 <title>Script Options</title>
@@ -787,14 +787,14 @@ Options:
787 <programlisting>$ python getEventsForUcpe.py -h 787 <programlisting>$ python getEventsForUcpe.py -h
788Usage: getEventsForUcpe.py [options] 788Usage: getEventsForUcpe.py [options]
789 789
790Print the events log for a specific uCPE installed in Enea uCPE Manager. 790Print the events log for a specific uCPE installed in Enea Edge Management.
791 791
792Options: 792Options:
793--version show program's version number and exit 793--version show program's version number and exit
794-h, --help show this help message and exit 794-h, --help show this help message and exit
795-u USERNAME, --username=USERNAME Enea uCPE Manager login username 795-u USERNAME, --username=USERNAME Enea Edge Management login username
796-p PASSWORD, --password=PASSWORD Enea uCPE Manager login password 796-p PASSWORD, --password=PASSWORD Enea Edge Management login password
797-H HOST, --host=HOST Enea uCPE Manager host name or IP address 797-H HOST, --host=HOST Enea Edge Management host name or IP address
798-f DEVICEFILE, --file=DEVICEFILE File containing uCPE Information in JSON format 798-f DEVICEFILE, --file=DEVICEFILE File containing uCPE Information in JSON format
799-s SEVERITY, --severity=SEVERITY Event severity level (Critical|Major|Minor) 799-s SEVERITY, --severity=SEVERITY Event severity level (Critical|Major|Minor)
800 800
@@ -869,10 +869,10 @@ Options:
869 --version show program's version number and exit 869 --version show program's version number and exit
870 -h, --help show this help message and exit 870 -h, --help show this help message and exit
871 -u USERNAME, --username=USERNAME 871 -u USERNAME, --username=USERNAME
872 Enea uCPE Manager login username 872 Enea Edge Management login username
873 -p PASSWORD, --password=PASSWORD 873 -p PASSWORD, --password=PASSWORD
874 Enea uCPE Manager login password 874 Enea Edge Management login password
875 -H HOST, --host=HOST Enea uCPE Manager host name or IP address 875 -H HOST, --host=HOST Enea Edge Management host name or IP address
876 -s STATE, --state=STATE 876 -s STATE, --state=STATE
877 Enable/Disable 877 Enable/Disable
878 -n DEVICENAME, --device-name=DEVICENAME 878 -n DEVICENAME, --device-name=DEVICENAME
@@ -936,10 +936,10 @@ Options:
936 --version show program's version number and exit 936 --version show program's version number and exit
937 -h, --help show this help message and exit 937 -h, --help show this help message and exit
938 -u USERNAME, --username=USERNAME 938 -u USERNAME, --username=USERNAME
939 Enea uCPE Manager login username 939 Enea Edge Management login username
940 -p PASSWORD, --password=PASSWORD 940 -p PASSWORD, --password=PASSWORD
941 Enea uCPE Manager login password 941 Enea Edge Management login password
942 -H HOST, --host=HOST Enea uCPE Manager host name or IP address 942 -H HOST, --host=HOST Enea Edge Management host name or IP address
943 -f NICFILE, --file=NICFILE 943 -f NICFILE, --file=NICFILE
944 File containing network interface Information in JSON 944 File containing network interface Information in JSON
945 format 945 format
@@ -1042,10 +1042,10 @@ Options:
1042 --version show program's version number and exit 1042 --version show program's version number and exit
1043 -h, --help show this help message and exit 1043 -h, --help show this help message and exit
1044 -u USERNAME, --username=USERNAME 1044 -u USERNAME, --username=USERNAME
1045 Enea uCPE Manager login username 1045 Enea Edge Management login username
1046 -p PASSWORD, --password=PASSWORD 1046 -p PASSWORD, --password=PASSWORD
1047 Enea uCPE Manager login password 1047 Enea Edge Management login password
1048 -H HOST, --host=HOST Enea uCPE Manager host name or IP address 1048 -H HOST, --host=HOST Enea Edge Management host name or IP address
1049 -f NICFILE, --file=NICFILE 1049 -f NICFILE, --file=NICFILE
1050 File containing network interface Information in JSON 1050 File containing network interface Information in JSON
1051 format 1051 format
@@ -1131,9 +1131,9 @@ Usage: getNetworkInterfaces.py [options]
1131Options: 1131Options:
1132 --version show program's version number and exit 1132 --version show program's version number and exit
1133 -h, --help show this help message and exit 1133 -h, --help show this help message and exit
1134 -u USERNAME, --username=USERNAME Enea uCPE Manager login username 1134 -u USERNAME, --username=USERNAME Enea Edge Management login username
1135 -p PASSWORD, --password=PASSWORD Enea uCPE Manager login password 1135 -p PASSWORD, --password=PASSWORD Enea Edge Management login password
1136 -H HOST, --host=HOST Enea uCPE Manager host name or IP address 1136 -H HOST, --host=HOST Enea Edge Management host name or IP address
1137 -n DEVICENAME, --device-name=DEVICENAME Name of the uCPE to get network / 1137 -n DEVICENAME, --device-name=DEVICENAME Name of the uCPE to get network /
1138 interfaces from 1138 interfaces from
1139 1139
@@ -1215,10 +1215,10 @@ Options:
1215 --version show program's version number and exit 1215 --version show program's version number and exit
1216 -h, --help show this help message and exit 1216 -h, --help show this help message and exit
1217 -u USERNAME, --username=USERNAME 1217 -u USERNAME, --username=USERNAME
1218 Enea uCPE Manager login username 1218 Enea Edge Management login username
1219 -p PASSWORD, --password=PASSWORD 1219 -p PASSWORD, --password=PASSWORD
1220 Enea uCPE Manager login password 1220 Enea Edge Management login password
1221 -H HOST, --host=HOST Enea uCPE Manager host name or IP address 1221 -H HOST, --host=HOST Enea Edge Management host name or IP address
1222 -f OVSFILE, --file=OVSFILE 1222 -f OVSFILE, --file=OVSFILE
1223 File containing OVS bridge Information in JSON format 1223 File containing OVS bridge Information in JSON format
1224 -n DEVICENAME, --device-name=DEVICENAME 1224 -n DEVICENAME, --device-name=DEVICENAME
@@ -1306,10 +1306,10 @@ Options:
1306 --version show program's version number and exit 1306 --version show program's version number and exit
1307 -h, --help show this help message and exit 1307 -h, --help show this help message and exit
1308 -u USERNAME, --username=USERNAME 1308 -u USERNAME, --username=USERNAME
1309 Enea uCPE Manager login username 1309 Enea Edge Management login username
1310 -p PASSWORD, --password=PASSWORD 1310 -p PASSWORD, --password=PASSWORD
1311 Enea uCPE Manager login password 1311 Enea Edge Management login password
1312 -H HOST, --host=HOST Enea uCPE Manager host name or IP address 1312 -H HOST, --host=HOST Enea Edge Management host name or IP address
1313 -f OVSFILE, --file=OVSFILE 1313 -f OVSFILE, --file=OVSFILE
1314 File containing OVS bridge Information in JSON format 1314 File containing OVS bridge Information in JSON format
1315 -n DEVICENAME, --device-name=DEVICENAME 1315 -n DEVICENAME, --device-name=DEVICENAME
@@ -1380,7 +1380,7 @@ Options:
1380 <section id="onboard_vnf_image"> 1380 <section id="onboard_vnf_image">
1381 <title>Onboarding a VNF Image Raw</title> 1381 <title>Onboarding a VNF Image Raw</title>
1382 1382
1383 <para>How to Onboard a VNF image in the uCPE Manager based upon its raw 1383 <para>How to Onboard a VNF image in the Enea Edge Management based upon its raw
1384 constituents, is detailed in depth below.</para> 1384 constituents, is detailed in depth below.</para>
1385 1385
1386 <section id="script_opts_image"> 1386 <section id="script_opts_image">
@@ -1389,16 +1389,16 @@ Options:
1389 <programlisting>$ python onboardVNFRaw.py -h 1389 <programlisting>$ python onboardVNFRaw.py -h
1390Usage: onboardVNFRaw.py [options] 1390Usage: onboardVNFRaw.py [options]
1391 1391
1392Onboard a VNF in Enea uCPE Manager based upon its raw constituents. 1392Onboard a VNF in Enea Edge Management based upon its raw constituents.
1393 1393
1394Options: 1394Options:
1395 --version show program's version number and exit 1395 --version show program's version number and exit
1396 -h, --help show this help message and exit 1396 -h, --help show this help message and exit
1397 -u USERNAME, --username=USERNAME 1397 -u USERNAME, --username=USERNAME
1398 Enea uCPE Manager login username 1398 Enea Edge Management login username
1399 -p PASSWORD, --password=PASSWORD 1399 -p PASSWORD, --password=PASSWORD
1400 Enea uCPE Manager login password 1400 Enea Edge Management login password
1401 -H HOST, --host=HOST Enea uCPE Manager host name or IP address 1401 -H HOST, --host=HOST Enea Edge Management host name or IP address
1402 -f FTPUSERNAME, --ftpUsername=FTPUSERNAME 1402 -f FTPUSERNAME, --ftpUsername=FTPUSERNAME
1403 Username for FTP 1403 Username for FTP
1404 -w FTPPASSWORD, --ftpPassword=FTPPASSWORD 1404 -w FTPPASSWORD, --ftpPassword=FTPPASSWORD
@@ -1497,7 +1497,7 @@ Options:
1497 <section id="offboard_vnf"> 1497 <section id="offboard_vnf">
1498 <title>Offboarding a VNF</title> 1498 <title>Offboarding a VNF</title>
1499 1499
1500 <para>Steps on how to Offboard a VNF from the uCPE Manager are detailed 1500 <para>Steps on how to Offboard a VNF from the Enea Edge Management are detailed
1501 below.</para> 1501 below.</para>
1502 1502
1503 <section id="script_opts_offimage"> 1503 <section id="script_opts_offimage">
@@ -1506,16 +1506,16 @@ Options:
1506 <programlisting>$ python offboardVNF.py -h 1506 <programlisting>$ python offboardVNF.py -h
1507Usage: offboardVNF.py [options] 1507Usage: offboardVNF.py [options]
1508 1508
1509Offboard a VNF from Enea uCPE Manager. 1509Offboard a VNF from Enea Edge Management.
1510 1510
1511Options: 1511Options:
1512 --version show program's version number and exit 1512 --version show program's version number and exit
1513 -h, --help show this help message and exit 1513 -h, --help show this help message and exit
1514 -u USERNAME, --username=USERNAME 1514 -u USERNAME, --username=USERNAME
1515 Enea uCPE Manager login username 1515 Enea Edge Management login username
1516 -p PASSWORD, --password=PASSWORD 1516 -p PASSWORD, --password=PASSWORD
1517 Enea uCPE Manager login password 1517 Enea Edge Management login password
1518 -H HOST, --host=HOST Enea uCPE Manager host name or IP address 1518 -H HOST, --host=HOST Enea Edge Management host name or IP address
1519 -n VNFDNAME, --vnfdName=VNFDNAME 1519 -n VNFDNAME, --vnfdName=VNFDNAME
1520 Name of VNF descriptor to offboard 1520 Name of VNF descriptor to offboard
1521 1521
@@ -1563,7 +1563,7 @@ Options:
1563 <section id="instantiate_vnf"> 1563 <section id="instantiate_vnf">
1564 <title>Instantiating a VNF</title> 1564 <title>Instantiating a VNF</title>
1565 1565
1566 <para>Instantiating a VNF via the uCPE Manager is detailed below.</para> 1566 <para>Instantiating a VNF via the Enea Edge Management is detailed below.</para>
1567 1567
1568 <section id="script_opts_inst"> 1568 <section id="script_opts_inst">
1569 <title>Script Options</title> 1569 <title>Script Options</title>
@@ -1571,16 +1571,16 @@ Options:
1571 <programlisting>$ python instantiateVNFI.py -h 1571 <programlisting>$ python instantiateVNFI.py -h
1572Usage: instantiateVNFI.py [options] 1572Usage: instantiateVNFI.py [options]
1573 1573
1574Instantiate a VNF via Enea uCPE Manager. 1574Instantiate a VNF via Enea Edge Management.
1575 1575
1576Options: 1576Options:
1577 --version show program's version number and exit 1577 --version show program's version number and exit
1578 -h, --help show this help message and exit 1578 -h, --help show this help message and exit
1579 -u USERNAME, --username=USERNAME 1579 -u USERNAME, --username=USERNAME
1580 Enea uCPE Manager login username 1580 Enea Edge Management login username
1581 -p PASSWORD, --password=PASSWORD 1581 -p PASSWORD, --password=PASSWORD
1582 Enea uCPE Manager login password 1582 Enea Edge Management login password
1583 -H HOST, --host=HOST Enea uCPE Manager host name or IP address 1583 -H HOST, --host=HOST Enea Edge Management host name or IP address
1584 -t VNFTYPE, --vnfType=VNFTYPE 1584 -t VNFTYPE, --vnfType=VNFTYPE
1585 VNF Type (Name of VNF descriptor) 1585 VNF Type (Name of VNF descriptor)
1586 -n VIMDEVICENAME, --device-name=VIMDEVICENAME 1586 -n VIMDEVICENAME, --device-name=VIMDEVICENAME
@@ -1642,7 +1642,7 @@ License("vnf_config/fortigateImage/fortigateLicense.lic")
1642 <section id="control_vnf_inst"> 1642 <section id="control_vnf_inst">
1643 <title>Controlling a VNF Instance</title> 1643 <title>Controlling a VNF Instance</title>
1644 1644
1645 <para>How to Control a VNF instance from the Enea uCPE Manager is 1645 <para>How to Control a VNF instance from the Enea Edge Management is
1646 detailed below.</para> 1646 detailed below.</para>
1647 1647
1648 <note> 1648 <note>
@@ -1651,7 +1651,7 @@ License("vnf_config/fortigateImage/fortigateLicense.lic")
1651 become unresponsive. Depending on the actual VNF, the time required 1651 become unresponsive. Depending on the actual VNF, the time required
1652 between life-cycle operations may vary from several seconds to half a 1652 between life-cycle operations may vary from several seconds to half a
1653 minute or even more. If a VNF becomes unresponsive, the only possible 1653 minute or even more. If a VNF becomes unresponsive, the only possible
1654 action is to "Force Delete" the instance from the uCPE Manager.</para> 1654 action is to "Force Delete" the instance from the Enea Edge Management.</para>
1655 </note> 1655 </note>
1656 1656
1657 <section id="script_opts_control"> 1657 <section id="script_opts_control">
@@ -1660,16 +1660,16 @@ License("vnf_config/fortigateImage/fortigateLicense.lic")
1660 <programlisting>$ python controlVNFI.py -h 1660 <programlisting>$ python controlVNFI.py -h
1661Usage: controlVNFI.py [options] 1661Usage: controlVNFI.py [options]
1662 1662
1663Controls a VNF instance from Enea uCPE Manager. 1663Controls a VNF instance from Enea Edge Management.
1664 1664
1665Options: 1665Options:
1666 --version show program's version number and exit 1666 --version show program's version number and exit
1667 -h, --help show this help message and exit 1667 -h, --help show this help message and exit
1668 -u USERNAME, --username=USERNAME 1668 -u USERNAME, --username=USERNAME
1669 Enea uCPE Manager login username 1669 Enea Edge Management login username
1670 -p PASSWORD, --password=PASSWORD 1670 -p PASSWORD, --password=PASSWORD
1671 Enea uCPE Manager login password 1671 Enea Edge Management login password
1672 -H HOST, --host=HOST Enea uCPE Manager host name or IP address 1672 -H HOST, --host=HOST Enea Edge Management host name or IP address
1673 -i VNFINSTANCENAME, --vnfInstanceName=VNFINSTANCENAME 1673 -i VNFINSTANCENAME, --vnfInstanceName=VNFINSTANCENAME
1674 Name of VNF instance 1674 Name of VNF instance
1675 -n VIMDEVICENAME, --device-name=VIMDEVICENAME 1675 -n VIMDEVICENAME, --device-name=VIMDEVICENAME
@@ -1736,7 +1736,7 @@ fortigateFWInstance -c stop
1736 <title>Destroying a VNF Instance</title> 1736 <title>Destroying a VNF Instance</title>
1737 1737
1738 <para>Steps and options on how to Destroy a VNF instance from the Enea 1738 <para>Steps and options on how to Destroy a VNF instance from the Enea
1739 uCPE Manager are described below.</para> 1739 Edge Management are described below.</para>
1740 1740
1741 <section id="script_opts_destroy"> 1741 <section id="script_opts_destroy">
1742 <title>Script Options</title> 1742 <title>Script Options</title>
@@ -1744,16 +1744,16 @@ fortigateFWInstance -c stop
1744 <programlisting>$ python destroyVNFI.py -h 1744 <programlisting>$ python destroyVNFI.py -h
1745Usage: destroyVNFI.py [options] 1745Usage: destroyVNFI.py [options]
1746 1746
1747Destroys a VNF instance from Enea uCPE Manager. 1747Destroys a VNF instance from Enea Edge Management.
1748 1748
1749Options: 1749Options:
1750 --version show program's version number and exit 1750 --version show program's version number and exit
1751 -h, --help show this help message and exit 1751 -h, --help show this help message and exit
1752 -u USERNAME, --username=USERNAME 1752 -u USERNAME, --username=USERNAME
1753 Enea uCPE Manager login username 1753 Enea Edge Management login username
1754 -p PASSWORD, --password=PASSWORD 1754 -p PASSWORD, --password=PASSWORD
1755 Enea uCPE Manager login password 1755 Enea Edge Management login password
1756 -H HOST, --host=HOST Enea uCPE Manager host name or IP address 1756 -H HOST, --host=HOST Enea Edge Management host name or IP address
1757 -i VNFINSTANCENAME, --vnfInstanceName=VNFINSTANCENAME 1757 -i VNFINSTANCENAME, --vnfInstanceName=VNFINSTANCENAME
1758 Name of VNF instance 1758 Name of VNF instance
1759 -n VIMDEVICENAME, --device-name=VIMDEVICENAME 1759 -n VIMDEVICENAME, --device-name=VIMDEVICENAME
@@ -1801,28 +1801,28 @@ fortigateFWInstance
1801 </section> 1801 </section>
1802 1802
1803 <section id="upload_vnf_image"> 1803 <section id="upload_vnf_image">
1804 <title>Uploading a NFV Access image onto the Enea uCPE Manager</title> 1804 <title>Uploading a Enea Edge image onto the Enea Edge Management</title>
1805 1805
1806 <para>Steps and options on how to Upload a NFV Access image onto the 1806 <para>Steps and options on how to Upload a Enea Edge image onto the
1807 Enea uCPE Manager are described below.</para> 1807 Enea Edge Management are described below.</para>
1808 1808
1809 <section id="script_opts_upload"> 1809 <section id="script_opts_upload">
1810 <title>Script Options</title> 1810 <title>Script Options</title>
1811 1811
1812 <programlisting>$ python uploadImage.py -h 1812 <programlisting>$ python uploadImage.py -h
1813Upload NFVA image on uCPE Manager 1813Upload NFVA image on Enea Edge Management
1814Usage: uploadImage.py [options] 1814Usage: uploadImage.py [options]
1815 1815
1816Upload NFVA image on uCPE Manager. 1816Upload NFVA image on Enea Edge Management.
1817 1817
1818Options: 1818Options:
1819 --version show program's version number and exit 1819 --version show program's version number and exit
1820 -h, --help show this help message and exit 1820 -h, --help show this help message and exit
1821 -u USERNAME, --username=USERNAME 1821 -u USERNAME, --username=USERNAME
1822 Enea uCPE Manager login username 1822 Enea Edge Management login username
1823 -p PASSWORD, --password=PASSWORD 1823 -p PASSWORD, --password=PASSWORD
1824 Enea uCPE Manager login password 1824 Enea Edge Management login password
1825 -H HOST, --host=HOST Enea uCPE Manager host name or IP address 1825 -H HOST, --host=HOST Enea Edge Management host name or IP address
1826 -f FILENAME, --fileName=FILENAME 1826 -f FILENAME, --fileName=FILENAME
1827 Path to NFVA image file name 1827 Path to NFVA image file name
1828 -m MODULE, --module=MODULE 1828 -m MODULE, --module=MODULE
@@ -1838,7 +1838,7 @@ Options:
1838 <section id="json_upload"> 1838 <section id="json_upload">
1839 <title>Configuring the JSON File</title> 1839 <title>Configuring the JSON File</title>
1840 1840
1841 <para>The JSON configuration file needed to upload a NFV Access image 1841 <para>The JSON configuration file needed to upload a Enea Edge image
1842 should contain a list of dictionaries. Each dictionary indicates the 1842 should contain a list of dictionaries. Each dictionary indicates the
1843 test case name and the test case arguments passed to the 1843 test case name and the test case arguments passed to the
1844 <filename>uploadImage</filename> Python module.</para> 1844 <filename>uploadImage</filename> Python module.</para>
@@ -1846,7 +1846,7 @@ Options:
1846 <para><emphasis role="bold">Sample unit-test JSON file 1846 <para><emphasis role="bold">Sample unit-test JSON file
1847 format:</emphasis><programlisting>[ 1847 format:</emphasis><programlisting>[
1848 { 1848 {
1849 "name": "Upload NFVA image on uCPE Manager", 1849 "name": "Upload NFVA image on Enea Edge Management",
1850 "args": "-f /tmp/enea-nfv-access-xeon-d.rootfs.ostree.tar.bz2 -t xeon_d" 1850 "args": "-f /tmp/enea-nfv-access-xeon-d.rootfs.ostree.tar.bz2 -t xeon_d"
1851 } 1851 }
1852]</programlisting></para> 1852]</programlisting></para>
@@ -1861,7 +1861,7 @@ Options:
1861 <programlisting>$ python uploadImage.py -u admin -p admin -H localhost \ 1861 <programlisting>$ python uploadImage.py -u admin -p admin -H localhost \
1862-f /tmp/enea-nfv-access-xeon-d.rootfs.ostree.tar.bz2 -t xeon_d 1862-f /tmp/enea-nfv-access-xeon-d.rootfs.ostree.tar.bz2 -t xeon_d
18632020-02-28 11:38:42,754 - DEBUG: Started logging 18632020-02-28 11:38:42,754 - DEBUG: Started logging
18642020-02-28 11:38:42,755 - INFO: Upload NFVA image on uCPE Manager 18642020-02-28 11:38:42,755 - INFO: Upload NFVA image on Enea Edge Management
18652020-02-28 11:38:43,307 - DEBUG: Login successful on host 'localhost' 18652020-02-28 11:38:43,307 - DEBUG: Login successful on host 'localhost'
18662020-02-28 11:38:43,308 - DEBUG: Session token is: 7da3f960-5a16-11ea-a3de-5652b3ac1c30 18662020-02-28 11:38:43,308 - DEBUG: Session token is: 7da3f960-5a16-11ea-a3de-5652b3ac1c30
18672020-02-28 11:41:29,148 - INFO: Verify image validation flag 18672020-02-28 11:41:29,148 - INFO: Verify image validation flag
@@ -1874,29 +1874,29 @@ Options:
1874 </section> 1874 </section>
1875 1875
1876 <section id="delete_vnf_image"> 1876 <section id="delete_vnf_image">
1877 <title>Deleting a NFV Access image file from the Enea uCPE 1877 <title>Deleting a Enea Edge image file from the
1878 Manager</title> 1878 Enea Edge Management</title>
1879 1879
1880 <para>Steps and options on how to Delete a NFV Access image from the 1880 <para>Steps and options on how to Delete a Enea Edge image from the
1881 Enea uCPE Manager are described below.</para> 1881 Enea Edge Management are described below.</para>
1882 1882
1883 <section id="script_opts_deleteupload"> 1883 <section id="script_opts_deleteupload">
1884 <title>Script Options</title> 1884 <title>Script Options</title>
1885 1885
1886 <programlisting>$ python deleteUpgradeFile.py -h 1886 <programlisting>$ python deleteUpgradeFile.py -h
1887Delete NFVA image from uCPE Manager 1887Delete NFVA image from Enea Edge Management
1888Usage: deleteUpgradeFile.py [options] 1888Usage: deleteUpgradeFile.py [options]
1889 1889
1890Delete NFVA image from uCPE Manager. 1890Delete NFVA image from Enea Edge Management.
1891 1891
1892Options: 1892Options:
1893 --version show program's version number and exit 1893 --version show program's version number and exit
1894 -h, --help show this help message and exit 1894 -h, --help show this help message and exit
1895 -u USERNAME, --username=USERNAME 1895 -u USERNAME, --username=USERNAME
1896 Enea uCPE Manager login username 1896 Enea Edge Management login username
1897 -p PASSWORD, --password=PASSWORD 1897 -p PASSWORD, --password=PASSWORD
1898 Enea uCPE Manager login password 1898 Enea Edge Management login password
1899 -H HOST, --host=HOST Enea uCPE Manager host name or IP address 1899 -H HOST, --host=HOST Enea Edge Management host name or IP address
1900 -i IMAGENAME, --imageName=IMAGENAME 1900 -i IMAGENAME, --imageName=IMAGENAME
1901 NFVA Image name 1901 NFVA Image name
1902 -m MODULE, --module=MODULE 1902 -m MODULE, --module=MODULE
@@ -1909,7 +1909,7 @@ Options:
1909 <section id="json_delete_upload"> 1909 <section id="json_delete_upload">
1910 <title>Configuring the JSON File</title> 1910 <title>Configuring the JSON File</title>
1911 1911
1912 <para>The JSON configuration file needed to delete a NFV Access image 1912 <para>The JSON configuration file needed to delete a Enea Edge image
1913 should contain a list of dictionaries. Each dictionary indicates the 1913 should contain a list of dictionaries. Each dictionary indicates the
1914 test case name and the test case arguments passed to the 1914 test case name and the test case arguments passed to the
1915 <filename>deleteUpgradeFile</filename> Python module.</para> 1915 <filename>deleteUpgradeFile</filename> Python module.</para>
@@ -1917,7 +1917,7 @@ Options:
1917 <para><emphasis role="bold">Sample unit-test JSON file 1917 <para><emphasis role="bold">Sample unit-test JSON file
1918 format:</emphasis><programlisting>[ 1918 format:</emphasis><programlisting>[
1919 { 1919 {
1920 "name": "Delete NFVA image on uCPE Manager", 1920 "name": "Delete NFVA image on Enea Edge Management",
1921 "args": "-i enea-nfv-access-xeon-d.rootfs.ostree.tar.bz2" 1921 "args": "-i enea-nfv-access-xeon-d.rootfs.ostree.tar.bz2"
1922 } 1922 }
1923]</programlisting></para> 1923]</programlisting></para>
@@ -1932,7 +1932,7 @@ Options:
1932 <programlisting>$ python deleteUpgradeFile.py -u admin -p admin -H localhost -i \ 1932 <programlisting>$ python deleteUpgradeFile.py -u admin -p admin -H localhost -i \
1933enea-nfv-access-xeon-d.rootfs.ostree.tar.bz2 1933enea-nfv-access-xeon-d.rootfs.ostree.tar.bz2
19342020-02-28 12:06:20,111 - DEBUG: Started logging 19342020-02-28 12:06:20,111 - DEBUG: Started logging
19352020-02-28 12:06:20,112 - INFO: Delete NFVA image from uCPE Manager 19352020-02-28 12:06:20,112 - INFO: Delete NFVA image from Enea Edge Management
19362020-02-28 12:06:20,210 - DEBUG: Login successful on host 'localhost' 19362020-02-28 12:06:20,210 - DEBUG: Login successful on host 'localhost'
19372020-02-28 12:06:20,211 - DEBUG: Session token is: 594b2d50-5a1a-11ea-a3de-5652b3ac1c30 19372020-02-28 12:06:20,211 - DEBUG: Session token is: 594b2d50-5a1a-11ea-a3de-5652b3ac1c30
19382020-02-28 12:06:20,255 - INFO: The image \ 19382020-02-28 12:06:20,255 - INFO: The image \
@@ -1948,30 +1948,30 @@ image was successfully removed
1948 </section> 1948 </section>
1949 1949
1950 <section id="install_activate_vnf_image"> 1950 <section id="install_activate_vnf_image">
1951 <title>Installing and activating a NFV Access image on an uCPE device 1951 <title>Installing and activating a Enea Edge image on an uCPE device
1952 from the Enea uCPE Manager</title> 1952 from the Enea Edge Management</title>
1953 1953
1954 <para>Steps and options on how to Install and Activate a NFV Access 1954 <para>Steps and options on how to Install and Activate a Enea Edge
1955 image on an uCPE device from the Enea uCPE Manager are described 1955 image on an uCPE device from the Enea Edge Management are described
1956 below.</para> 1956 below.</para>
1957 1957
1958 <section id="script_opts_install_activate"> 1958 <section id="script_opts_install_activate">
1959 <title>Script Options</title> 1959 <title>Script Options</title>
1960 1960
1961 <programlisting>$ python installAndActivate.py -h 1961 <programlisting>$ python installAndActivate.py -h
1962Install and activate NFVA image from uCPE Manager 1962Install and activate NFVA image from Enea Edge Management
1963Usage: installAndActivate.py [options] 1963Usage: installAndActivate.py [options]
1964 1964
1965Install and activate NFVA image from uCPE Manager. 1965Install and activate NFVA image from Enea Edge Management.
1966 1966
1967Options: 1967Options:
1968 --version show program's version number and exit 1968 --version show program's version number and exit
1969 -h, --help show this help message and exit 1969 -h, --help show this help message and exit
1970 -u USERNAME, --username=USERNAME 1970 -u USERNAME, --username=USERNAME
1971 Enea uCPE Manager login username 1971 Enea Edge Management login username
1972 -p PASSWORD, --password=PASSWORD 1972 -p PASSWORD, --password=PASSWORD
1973 Enea uCPE Manager login password 1973 Enea Edge Management login password
1974 -H HOST, --host=HOST Enea uCPE Manager host name or IP address 1974 -H HOST, --host=HOST Enea Edge Management host name or IP address
1975 -i IMAGENAME, --imageName=IMAGENAME 1975 -i IMAGENAME, --imageName=IMAGENAME
1976 Image name 1976 Image name
1977 -m MODULE, --module=MODULE 1977 -m MODULE, --module=MODULE
@@ -1989,8 +1989,8 @@ Options:
1989 <section id="json_install_activate"> 1989 <section id="json_install_activate">
1990 <title>Configuring the JSON File</title> 1990 <title>Configuring the JSON File</title>
1991 1991
1992 <para>The JSON configuration file needed to install and activate a NFV 1992 <para>The JSON configuration file needed to install and activate a Enea Edge
1993 Access image on a uCPE device from the Enea uCPE Manager should 1993 image on a uCPE device from the Enea Edge Management should
1994 contain a list of dictionaries. Each dictionary indicates the test 1994 contain a list of dictionaries. Each dictionary indicates the test
1995 case name and the test case arguments passed to the 1995 case name and the test case arguments passed to the
1996 <filename>installAndActivate</filename> Python module.</para> 1996 <filename>installAndActivate</filename> Python module.</para>
@@ -2000,7 +2000,7 @@ Options:
2000 2000
2001 <programlisting>[ 2001 <programlisting>[
2002 { 2002 {
2003 "name": "Install and activate NFVA image on uCPE device from uCPE Manager", 2003 "name": "Install and activate NFVA image on uCPE device from Enea Edge Management",
2004 "args": "-i enea-nfv-access-xeon-d.rootfs.ostree.tar.bz2 -t xeon_d -d inteld1521-16" 2004 "args": "-i enea-nfv-access-xeon-d.rootfs.ostree.tar.bz2 -t xeon_d -d inteld1521-16"
2005 } 2005 }
2006]</programlisting> 2006]</programlisting>
@@ -2015,7 +2015,7 @@ Options:
2015 <programlisting>$ python installAndActivate.py -u admin -p admin -H localhost -i \ 2015 <programlisting>$ python installAndActivate.py -u admin -p admin -H localhost -i \
2016enea-nfv-access-xeon-d.rootfs.ostree.tar.bz2 -t xeon_d -d inteld1521-16 2016enea-nfv-access-xeon-d.rootfs.ostree.tar.bz2 -t xeon_d -d inteld1521-16
20172020-02-28 12:36:46,137 - DEBUG: Started logging 20172020-02-28 12:36:46,137 - DEBUG: Started logging
20182020-02-28 12:36:46,138 - INFO: Install and activate NFVA image from uCPE Manager 20182020-02-28 12:36:46,138 - INFO: Install and activate NFVA image from Enea Edge Management
20192020-02-28 12:36:46,288 - DEBUG: Login successful on host 'localhost' 20192020-02-28 12:36:46,288 - DEBUG: Login successful on host 'localhost'
20202020-02-28 12:36:46,288 - DEBUG: Session token is: 99b7cde0-5a1e-11ea-a3de-5652b3ac1c30 20202020-02-28 12:36:46,288 - DEBUG: Session token is: 99b7cde0-5a1e-11ea-a3de-5652b3ac1c30
20212020-02-28 12:36:46,325 - DEBUG: Found device with name 'inteld1521-16' 20212020-02-28 12:36:46,325 - DEBUG: Found device with name 'inteld1521-16'
@@ -2055,10 +2055,10 @@ enea-nfv-access-xeon-d.rootfs.ostree.tar.bz2 [20]
2055 2055
2056 <section id="clearing_info_upgrade"> 2056 <section id="clearing_info_upgrade">
2057 <title>Clearing information about completed upgrades of uCPE devices 2057 <title>Clearing information about completed upgrades of uCPE devices
2058 from the Enea uCPE Manager</title> 2058 from the Enea Edge Management</title>
2059 2059
2060 <para>Steps and options on how to clear information about completed 2060 <para>Steps and options on how to clear information about completed
2061 upgrades of uCPE devices from the Enea uCPE Manager are described 2061 upgrades of uCPE devices from the Enea Edge Management are described
2062 below.</para> 2062 below.</para>
2063 2063
2064 <section id="script_opts_clearinfo"> 2064 <section id="script_opts_clearinfo">
@@ -2074,10 +2074,10 @@ Options:
2074 --version show program's version number and exit 2074 --version show program's version number and exit
2075 -h, --help show this help message and exit 2075 -h, --help show this help message and exit
2076 -u USERNAME, --username=USERNAME 2076 -u USERNAME, --username=USERNAME
2077 Enea uCPE Manager login username 2077 Enea Edge Management login username
2078 -p PASSWORD, --password=PASSWORD 2078 -p PASSWORD, --password=PASSWORD
2079 Enea uCPE Manager login password 2079 Enea Edge Management login password
2080 -H HOST, --host=HOST Enea uCPE Manager host name or IP address 2080 -H HOST, --host=HOST Enea Edge Management host name or IP address
2081 2081
2082 Mandatory options: 2082 Mandatory options:
2083 -H/--host </programlisting> 2083 -H/--host </programlisting>
@@ -2087,7 +2087,7 @@ Options:
2087 <title>Configuring the JSON File</title> 2087 <title>Configuring the JSON File</title>
2088 2088
2089 <para>No JSON configuration file is needed to clear information about 2089 <para>No JSON configuration file is needed to clear information about
2090 completed upgrades of uCPE devices from the Enea uCPE Manager. The 2090 completed upgrades of uCPE devices from the Enea Edge Management. The
2091 <filename>clearCompletedUpgradesInfo</filename> Python module can be 2091 <filename>clearCompletedUpgradesInfo</filename> Python module can be
2092 run without a JSON file as a parameter.</para> 2092 run without a JSON file as a parameter.</para>
2093 </section> 2093 </section>
@@ -2110,10 +2110,10 @@ Options:
2110 </section> 2110 </section>
2111 2111
2112 <section id="upload_custom_script"> 2112 <section id="upload_custom_script">
2113 <title>Uploading a Custom Script to the uCPE Manager</title> 2113 <title>Uploading a Custom Script to the Enea Edge Management</title>
2114 2114
2115 <para>Steps and options on how to upload a custom script to the uCPE 2115 <para>Steps and options on how to upload a custom script to the
2116 Manager are described below.</para> 2116 Enea Edge Management are described below.</para>
2117 2117
2118 <section id="script_opts_upload_custom_script"> 2118 <section id="script_opts_upload_custom_script">
2119 <title>Script Options</title> 2119 <title>Script Options</title>
@@ -2122,16 +2122,16 @@ Options:
21222020-04-14 10:26:23,582 - INFO: Upload Custom Script 21222020-04-14 10:26:23,582 - INFO: Upload Custom Script
2123Usage: upload.py [options] 2123Usage: upload.py [options]
2124 2124
2125Add a Custom Script to Enea uCPE Manager 2125Add a Custom Script to Enea Edge Management
2126 2126
2127Options: 2127Options:
2128 --version show program's version number and exit 2128 --version show program's version number and exit
2129 -h, --help show this help message and exit 2129 -h, --help show this help message and exit
2130 -u USERNAME, --username=USERNAME 2130 -u USERNAME, --username=USERNAME
2131 Enea uCPE Manager login username 2131 Enea Edge Management login username
2132 -p PASSWORD, --password=PASSWORD 2132 -p PASSWORD, --password=PASSWORD
2133 Enea uCPE Manager login password 2133 Enea Edge Management login password
2134 -H HOST, --host=HOST Enea uCPE Manager host name or IP address 2134 -H HOST, --host=HOST Enea Edge Management host name or IP address
2135 -f CUSTOMSCRIPT, --file=CUSTOMSCRIPT 2135 -f CUSTOMSCRIPT, --file=CUSTOMSCRIPT
2136 Custom Script File 2136 Custom Script File
2137 -e PHASE, --phase=PHASE 2137 -e PHASE, --phase=PHASE
@@ -2147,7 +2147,7 @@ Options:
2147 <title>Configuring the JSON File</title> 2147 <title>Configuring the JSON File</title>
2148 2148
2149 <para>The JSON configuration file needed to upload a Custom Script to 2149 <para>The JSON configuration file needed to upload a Custom Script to
2150 the uCPE Manager must contain a list of dictionaries. Each dictionary 2150 the Enea Edge Management must contain a list of dictionaries. Each dictionary
2151 indicates the test case name and the test case arguments passed to the 2151 indicates the test case name and the test case arguments passed to the
2152 <filename>customScripts/upload</filename> Python module.</para> 2152 <filename>customScripts/upload</filename> Python module.</para>
2153 2153
@@ -2156,7 +2156,7 @@ Options:
2156 2156
2157 <programlisting>[ 2157 <programlisting>[
2158 { 2158 {
2159 "name": "Uploading a Custom Script to the uCPE Manager", 2159 "name": "Uploading a Custom Script to the Enea Edge Management",
2160 "args": "-f ../../lab_config/customScripts/test_success_after_always \ 2160 "args": "-f ../../lab_config/customScripts/test_success_after_always \
2161 -e always-after-startup" 2161 -e always-after-startup"
2162 } 2162 }
@@ -2175,7 +2175,7 @@ Options:
21752020-04-14 14:08:02,915 - INFO: Upload Custom Script 21752020-04-14 14:08:02,915 - INFO: Upload Custom Script
21762020-04-14 14:08:02,994 - DEBUG: Login successful on host '172.24.3.109' 21762020-04-14 14:08:02,994 - DEBUG: Login successful on host '172.24.3.109'
21772020-04-14 14:08:02,995 - DEBUG: Session token is: 97544990-7e48-11ea-835c-02423a1c239f 21772020-04-14 14:08:02,995 - DEBUG: Session token is: 97544990-7e48-11ea-835c-02423a1c239f
21782020-04-14 14:08:02,996 - DEBUG: Upload test_success_after_always to uCPE Manager. \ 21782020-04-14 14:08:02,996 - DEBUG: Upload test_success_after_always to Enea Edge Management. \
2179Content: #!/bin/bash 2179Content: #!/bin/bash
2180echo test_success_after_always 2180echo test_success_after_always
21812020-04-14 14:08:03,138 - INFO: Done 21812020-04-14 14:08:03,138 - INFO: Done
@@ -2184,11 +2184,11 @@ echo test_success_after_always
2184 </section> 2184 </section>
2185 2185
2186 <section id="upload_custom_script_device"> 2186 <section id="upload_custom_script_device">
2187 <title>Uploading a Custom Script from the uCPE Manager to a 2187 <title>Uploading a Custom Script from the Enea Edge Management to a
2188 Device</title> 2188 Device</title>
2189 2189
2190 <para>Steps and options on how to upload a custom script from the uCPE 2190 <para>Steps and options on how to upload a custom script from the
2191 Manager to a Device are described below.</para> 2191 Enea Edge Management to a Device are described below.</para>
2192 2192
2193 <section id="script_opts_upload_custom_script_device"> 2193 <section id="script_opts_upload_custom_script_device">
2194 <title>Script Options</title> 2194 <title>Script Options</title>
@@ -2203,12 +2203,12 @@ Options:
2203 --version show program's version number and exit 2203 --version show program's version number and exit
2204 -h, --help show this help message and exit 2204 -h, --help show this help message and exit
2205 -u USERNAME, --username=USERNAME 2205 -u USERNAME, --username=USERNAME
2206 Enea uCPE Manager login username 2206 Enea Edge Management login username
2207 -p PASSWORD, --password=PASSWORD 2207 -p PASSWORD, --password=PASSWORD
2208 Enea uCPE Manager login password 2208 Enea Edge Management login password
2209 -H HOST, --host=HOST Enea uCPE Manager host name or IP address 2209 -H HOST, --host=HOST Enea Edge Management host name or IP address
2210 -c CUSTOMSCRIPTNAME, --customScriptName=CUSTOMSCRIPTNAME 2210 -c CUSTOMSCRIPTNAME, --customScriptName=CUSTOMSCRIPTNAME
2211 Custom Script Name that resides on Enea uCPE Manager 2211 Custom Script Name that resides on Enea Edge Management
2212 -e PHASE, --phase=PHASE 2212 -e PHASE, --phase=PHASE
2213 Execution phase. Must be one of the following: once- 2213 Execution phase. Must be one of the following: once-
2214 before-startup | always-before-startup | once-after- 2214 before-startup | always-before-startup | once-after-
@@ -2225,7 +2225,7 @@ Options:
2225 <title>Configuring the JSON File</title> 2225 <title>Configuring the JSON File</title>
2226 2226
2227 <para>The JSON configuration file needed to upload a Custom Script 2227 <para>The JSON configuration file needed to upload a Custom Script
2228 from the uCPE Manager to a Device must contain a list of dictionaries. 2228 from the Enea Edge Management to a Device must contain a list of dictionaries.
2229 Each dictionary indicates the test case name and the test case 2229 Each dictionary indicates the test case name and the test case
2230 arguments passed to the 2230 arguments passed to the
2231 <filename>customScripts/uploadOnDevice</filename> Python 2231 <filename>customScripts/uploadOnDevice</filename> Python
@@ -2236,7 +2236,7 @@ Options:
2236 2236
2237 <programlisting>[ 2237 <programlisting>[
2238{ 2238{
2239"name": "Uploading a Custom Script from uCPE Manager to device", 2239"name": "Uploading a Custom Script from Enea Edge Management to device",
2240"args": "-c test_success_after_always -e always-after-startup -n inteld1521-6" 2240"args": "-c test_success_after_always -e always-after-startup -n inteld1521-6"
2241} 2241}
2242]</programlisting> 2242]</programlisting>
@@ -2263,16 +2263,16 @@ test_success_after_always -e always-after-startup -n inteld1521-6
2263 </section> 2263 </section>
2264 2264
2265 <section id="delete_custom_script"> 2265 <section id="delete_custom_script">
2266 <title>Removing a Custom Script from the uCPE Manager</title> 2266 <title>Removing a Custom Script from the Enea Edge Management</title>
2267 2267
2268 <para>Steps and options on how to remove a custom script from the uCPE 2268 <para>Steps and options on how to remove a custom script from the
2269 Manager are described below.</para> 2269 Enea Edge Management are described below.</para>
2270 2270
2271 <section id="script_opts_delete_custom_script"> 2271 <section id="script_opts_delete_custom_script">
2272 <title>Script Options</title> 2272 <title>Script Options</title>
2273 2273
2274 <programlisting>$ python customScripts/delete.py -h 2274 <programlisting>$ python customScripts/delete.py -h
22752020-04-14 14:36:52,010 - INFO: Delete Custom Script on uCPE Manager 22752020-04-14 14:36:52,010 - INFO: Delete Custom Script on Enea Edge Management
2276Usage: delete.py [options] 2276Usage: delete.py [options]
2277 2277
2278Delete a Custom Script from a Device 2278Delete a Custom Script from a Device
@@ -2281,10 +2281,10 @@ Options:
2281 --version show program's version number and exit 2281 --version show program's version number and exit
2282 -h, --help show this help message and exit 2282 -h, --help show this help message and exit
2283 -u USERNAME, --username=USERNAME 2283 -u USERNAME, --username=USERNAME
2284 Enea uCPE Manager login username 2284 Enea Edge Management login username
2285 -p PASSWORD, --password=PASSWORD 2285 -p PASSWORD, --password=PASSWORD
2286 Enea uCPE Manager login password 2286 Enea Edge Management login password
2287 -H HOST, --host=HOST Enea uCPE Manager host name or IP address 2287 -H HOST, --host=HOST Enea Edge Management host name or IP address
2288 -c CUSTOMSCRIPTNAME, --customScriptName=CUSTOMSCRIPTNAME 2288 -c CUSTOMSCRIPTNAME, --customScriptName=CUSTOMSCRIPTNAME
2289 Custom Script Name that resides on a Device 2289 Custom Script Name that resides on a Device
2290 -e PHASE, --phase=PHASE 2290 -e PHASE, --phase=PHASE
@@ -2300,8 +2300,8 @@ Options:
2300 <title>Configuring the JSON File</title> 2300 <title>Configuring the JSON File</title>
2301 2301
2302 <para>The JSON configuration file needed to remove a Custom Script 2302 <para>The JSON configuration file needed to remove a Custom Script
2303 from the uCPE Manager<remark>did you mean device or uCPE 2303 from the Enea Edge Management<remark>did you mean device or
2304 Manager?</remark> must contain a list of dictionaries. Each dictionary 2304 Enea Edge Management?</remark> must contain a list of dictionaries. Each dictionary
2305 indicates the test case name and the test case arguments passed to the 2305 indicates the test case name and the test case arguments passed to the
2306 <filename>customScripts/delete</filename> Python module.</para> 2306 <filename>customScripts/delete</filename> Python module.</para>
2307 2307
@@ -2310,7 +2310,7 @@ Options:
2310 2310
2311 <programlisting>[ 2311 <programlisting>[
2312{ 2312{
2313"name": "Removing a Custom Script from uCPE Manager", 2313"name": "Removing a Custom Script from Enea Edge Management",
2314"args": "-c test_success_after_always -e always-after-startup" 2314"args": "-c test_success_after_always -e always-after-startup"
2315} 2315}
2316]</programlisting> 2316]</programlisting>
@@ -2325,12 +2325,12 @@ Options:
2325 <programlisting>$ python automation_framework/customScripts/delete.py -c \ 2325 <programlisting>$ python automation_framework/customScripts/delete.py -c \
2326test_success_after_always -e always-after-startup 2326test_success_after_always -e always-after-startup
23272020-04-14 14:39:22,042 - DEBUG: Started logging 23272020-04-14 14:39:22,042 - DEBUG: Started logging
23282020-04-14 14:39:22,042 - INFO: Delete Custom Script on uCPE Manager 23282020-04-14 14:39:22,042 - INFO: Delete Custom Script on Enea Edge Management
23292020-04-14 14:39:22,081 - DEBUG: Login successful on host '172.24.3.109' 23292020-04-14 14:39:22,081 - DEBUG: Login successful on host '172.24.3.109'
23302020-04-14 14:39:22,082 - DEBUG: Session token is: f75a83a0-7e4c-11ea-835c-02423a1c239f 23302020-04-14 14:39:22,082 - DEBUG: Session token is: f75a83a0-7e4c-11ea-835c-02423a1c239f
23312020-04-14 14:39:22,099 - DEBUG: Found custom script: 'test_success_after_always' 23312020-04-14 14:39:22,099 - DEBUG: Found custom script: 'test_success_after_always'
23322020-04-14 14:39:22,099 - DEBUG: Delete script test_success_after_always, \ 23322020-04-14 14:39:22,099 - DEBUG: Delete script test_success_after_always, \
2333phase always-after-startup from uCPE Manager 2333phase always-after-startup from Enea Edge Management
23342020-04-14 14:39:22,118 - INFO: Done 23342020-04-14 14:39:22,118 - INFO: Done
23352020-04-14 14:39:22,135 - DEBUG: Logging out and exiting...</programlisting> 23352020-04-14 14:39:22,135 - DEBUG: Logging out and exiting...</programlisting>
2336 </section> 2336 </section>
@@ -2355,10 +2355,10 @@ Options:
2355 --version show program's version number and exit 2355 --version show program's version number and exit
2356 -h, --help show this help message and exit 2356 -h, --help show this help message and exit
2357 -u USERNAME, --username=USERNAME 2357 -u USERNAME, --username=USERNAME
2358 Enea uCPE Manager login username 2358 Enea Edge Management login username
2359 -p PASSWORD, --password=PASSWORD 2359 -p PASSWORD, --password=PASSWORD
2360 Enea uCPE Manager login password 2360 Enea Edge Management login password
2361 -H HOST, --host=HOST Enea uCPE Manager host name or IP address 2361 -H HOST, --host=HOST Enea Edge Management host name or IP address
2362 -c CUSTOMSCRIPTNAME, --customScriptName=CUSTOMSCRIPTNAME 2362 -c CUSTOMSCRIPTNAME, --customScriptName=CUSTOMSCRIPTNAME
2363 Custom Script Name that resides on a Device 2363 Custom Script Name that resides on a Device
2364 -e PHASE, --phase=PHASE 2364 -e PHASE, --phase=PHASE
@@ -2469,7 +2469,7 @@ phase always-after-startup from inteld1521-6
2469 </note> 2469 </note>
2470 2470
2471 <section id="upload_customscrp_ucpemg"> 2471 <section id="upload_customscrp_ucpemg">
2472 <title>Uploading a Custom Script to the uCPE Manager</title> 2472 <title>Uploading a Custom Script to the Enea Edge Management</title>
2473 2473
2474 <programlisting>$ python automation_framework/customScripts/upload.py \ 2474 <programlisting>$ python automation_framework/customScripts/upload.py \
2475-f lab_config/customScripts/test_success_after_always -e always-after-startup 2475-f lab_config/customScripts/test_success_after_always -e always-after-startup
@@ -2477,7 +2477,7 @@ phase always-after-startup from inteld1521-6
24772020-04-14 14:08:02,915 - INFO: Upload Custom Script 24772020-04-14 14:08:02,915 - INFO: Upload Custom Script
24782020-04-14 14:08:02,994 - DEBUG: Login successful on host '172.24.3.109' 24782020-04-14 14:08:02,994 - DEBUG: Login successful on host '172.24.3.109'
24792020-04-14 14:08:02,995 - DEBUG: Session token is: 97544990-7e48-11ea-835c-02423a1c239f 24792020-04-14 14:08:02,995 - DEBUG: Session token is: 97544990-7e48-11ea-835c-02423a1c239f
24802020-04-14 14:08:02,996 - DEBUG: Upload test_success_after_always to uCPE Manager. \ 24802020-04-14 14:08:02,996 - DEBUG: Upload test_success_after_always to Enea Edge Management. \
2481Content: #!/bin/bash 2481Content: #!/bin/bash
2482echo test_success_after_always 2482echo test_success_after_always
24832020-04-14 14:08:03,138 - INFO: Done 24832020-04-14 14:08:03,138 - INFO: Done
@@ -2485,7 +2485,7 @@ echo test_success_after_always
2485 </section> 2485 </section>
2486 2486
2487 <section id="upload_customscrp_device"> 2487 <section id="upload_customscrp_device">
2488 <title>Uploading a Custom Script from the uCPE Manager to a 2488 <title>Uploading a Custom Script from the Enea Edge Management to a
2489 Device</title> 2489 Device</title>
2490 2490
2491 <programlisting>$ python automation_framework/customScripts/uploadOnDevice.py -c \ 2491 <programlisting>$ python automation_framework/customScripts/uploadOnDevice.py -c \
@@ -2517,17 +2517,17 @@ phase always-after-startup from inteld1521-6
2517 </section> 2517 </section>
2518 2518
2519 <section id="remove_customscrp_ucpemg"> 2519 <section id="remove_customscrp_ucpemg">
2520 <title>Removing a Custom Script from the uCPE Manager</title> 2520 <title>Removing a Custom Script from the Enea Edge Management</title>
2521 2521
2522 <programlisting>$ python automation_framework/customScripts/delete.py -c \ 2522 <programlisting>$ python automation_framework/customScripts/delete.py -c \
2523test_success_after_always -e always-after-startup 2523test_success_after_always -e always-after-startup
25242020-04-14 14:39:22,042 - DEBUG: Started logging 25242020-04-14 14:39:22,042 - DEBUG: Started logging
25252020-04-14 14:39:22,042 - INFO: Delete Custom Script on uCPE Manager 25252020-04-14 14:39:22,042 - INFO: Delete Custom Script on Enea Edge Management
25262020-04-14 14:39:22,081 - DEBUG: Login successful on host '172.24.3.109' 25262020-04-14 14:39:22,081 - DEBUG: Login successful on host '172.24.3.109'
25272020-04-14 14:39:22,082 - DEBUG: Session token is: f75a83a0-7e4c-11ea-835c-02423a1c239f 25272020-04-14 14:39:22,082 - DEBUG: Session token is: f75a83a0-7e4c-11ea-835c-02423a1c239f
25282020-04-14 14:39:22,099 - DEBUG: Found custom script: 'test_success_after_always' 25282020-04-14 14:39:22,099 - DEBUG: Found custom script: 'test_success_after_always'
25292020-04-14 14:39:22,099 - DEBUG: Delete script test_success_after_always, \ 25292020-04-14 14:39:22,099 - DEBUG: Delete script test_success_after_always, \
2530phase always-after-startup from uCPE Manager 2530phase always-after-startup from Enea Edge Management
25312020-04-14 14:39:22,118 - INFO: Done 25312020-04-14 14:39:22,118 - INFO: Done
25322020-04-14 14:39:22,135 - DEBUG: Logging out and exiting...</programlisting> 25322020-04-14 14:39:22,135 - DEBUG: Logging out and exiting...</programlisting>
2533 </section> 2533 </section>
@@ -2536,13 +2536,13 @@ phase always-after-startup from uCPE Manager
2536 <section id="add_offline_config_store"> 2536 <section id="add_offline_config_store">
2537 <title>Adding an Offline Configuration Store</title> 2537 <title>Adding an Offline Configuration Store</title>
2538 2538
2539 <para>Steps and options on how to add a Config Store in the Enea uCPE 2539 <para>Steps and options on how to add a Config Store in the
2540 Manager are described below.</para> 2540 Enea Edge Management are described below.</para>
2541 2541
2542 <section id="script_opts_add_config_store"> 2542 <section id="script_opts_add_config_store">
2543 <title>Script Options</title> 2543 <title>Script Options</title>
2544 2544
2545 <para>To add a config store in the Enea uCPE Manager use the 2545 <para>To add a config store in the Enea Edge Management use the
2546 <filename>addConfigStore.py</filename> script detailed below. Bear in 2546 <filename>addConfigStore.py</filename> script detailed below. Bear in
2547 mind a <filename>CONFIGSTORE</filename> json file is needed to 2547 mind a <filename>CONFIGSTORE</filename> json file is needed to
2548 successfully run the script in order to add an offline configuration 2548 successfully run the script in order to add an offline configuration
@@ -2566,7 +2566,7 @@ phase always-after-startup from uCPE Manager
2566 <section id="runpy_add_config_store"> 2566 <section id="runpy_add_config_store">
2567 <title>Running the Python Module</title> 2567 <title>Running the Python Module</title>
2568 2568
2569 <para>Adding an offline config store in the Enea uCPE Manager using 2569 <para>Adding an offline config store in the Enea Edge Management using
2570 the command line:</para> 2570 the command line:</para>
2571 2571
2572 <programlisting>python automation_framework/device/addConfigStore.py -f \ 2572 <programlisting>python automation_framework/device/addConfigStore.py -f \
@@ -2599,10 +2599,10 @@ Options:
2599 --version show program's version number and exit 2599 --version show program's version number and exit
2600 -h, --help show this help message and exit 2600 -h, --help show this help message and exit
2601 -u USERNAME, --username=USERNAME 2601 -u USERNAME, --username=USERNAME
2602 Enea uCPE Manager login username 2602 Enea Edge Management login username
2603 -p PASSWORD, --password=PASSWORD 2603 -p PASSWORD, --password=PASSWORD
2604 Enea uCPE Manager login password 2604 Enea Edge Management login password
2605 -H HOST, --host=HOST Enea uCPE Manager host name or IP address 2605 -H HOST, --host=HOST Enea Edge Management host name or IP address
2606 -s STORE, --store=STORE 2606 -s STORE, --store=STORE
2607 Offline config store name 2607 Offline config store name
2608 -d DEVICE, --device=DEVICE 2608 -d DEVICE, --device=DEVICE
@@ -2645,10 +2645,10 @@ Options:
2645 --version show program's version number and exit 2645 --version show program's version number and exit
2646 -h, --help show this help message and exit 2646 -h, --help show this help message and exit
2647 -u USERNAME, --username=USERNAME 2647 -u USERNAME, --username=USERNAME
2648 Enea uCPE Manager login username 2648 Enea Edge Management login username
2649 -p PASSWORD, --password=PASSWORD 2649 -p PASSWORD, --password=PASSWORD
2650 Enea uCPE Manager login password 2650 Enea Edge Management login password
2651 -H HOST, --host=HOST Enea uCPE Manager host name or IP address 2651 -H HOST, --host=HOST Enea Edge Management host name or IP address
2652 -d DEVICE, --device=DEVICE 2652 -d DEVICE, --device=DEVICE
2653 Device Name 2653 Device Name
2654 2654
@@ -2670,15 +2670,15 @@ Options:
2670 </section> 2670 </section>
2671 2671
2672 <section id="remove_offline_config_store"> 2672 <section id="remove_offline_config_store">
2673 <title>Removing an Offline Configuration Store in the Enea uCPE 2673 <title>Removing an Offline Configuration Store in the
2674 Manager</title> 2674 Enea Edge Management</title>
2675 2675
2676 <para>Steps and options on how to remove an upload of a Config Store 2676 <para>Steps and options on how to remove an upload of a Config Store
2677 from the uCPE Manager are described below.</para> 2677 from the Enea Edge Management are described below.</para>
2678 2678
2679 <note> 2679 <note>
2680 <para>Modifications of an Offline Configurations Store are not 2680 <para>Modifications of an Offline Configurations Store are not
2681 possible post deployment in the uCPE Manager, as there is no option 2681 possible post deployment in the Enea Edge Management, as there is no option
2682 for changing script states (e.g. changing the DPDK state in the 2682 for changing script states (e.g. changing the DPDK state in the
2683 <filename>configDPDK.py</filename> python script or unbinding 2683 <filename>configDPDK.py</filename> python script or unbinding
2684 interfaces). The offline store must be deleted and the new 2684 interfaces). The offline store must be deleted and the new
@@ -2689,23 +2689,23 @@ Options:
2689 <section id="script_opts_remove_config_store"> 2689 <section id="script_opts_remove_config_store">
2690 <title>Script options</title> 2690 <title>Script options</title>
2691 2691
2692 <para>To remove a config store from the uCPE Manager use the 2692 <para>To remove a config store from the Enea Edge Management use the
2693 <filename>removeConfigStore.py</filename> script detailed 2693 <filename>removeConfigStore.py</filename> script detailed
2694 below.</para> 2694 below.</para>
2695 2695
2696 <programlisting>python removeConfigStore.py -h 2696 <programlisting>python removeConfigStore.py -h
2697Usage: removeConfigStore.py [options] 2697Usage: removeConfigStore.py [options]
2698 2698
2699Remove a config store from Enea uCPE Manager. 2699Remove a config store from Enea Edge Management.
2700 2700
2701Options: 2701Options:
2702 --version show program's version number and exit 2702 --version show program's version number and exit
2703 -h, --help show this help message and exit 2703 -h, --help show this help message and exit
2704 -u USERNAME, --username=USERNAME 2704 -u USERNAME, --username=USERNAME
2705 Enea uCPE Manager login username 2705 Enea Edge Management login username
2706 -p PASSWORD, --password=PASSWORD 2706 -p PASSWORD, --password=PASSWORD
2707 Enea uCPE Manager login password 2707 Enea Edge Management login password
2708 -H HOST, --host=HOST Enea uCPE Manager host name or IP address 2708 -H HOST, --host=HOST Enea Edge Management host name or IP address
2709 -o STORENAME, --store-name=STORENAME 2709 -o STORENAME, --store-name=STORENAME
2710 Name of the Offline Config Store 2710 Name of the Offline Config Store
2711 2711
@@ -2770,8 +2770,8 @@ Options:
2770 Manual.</para> 2770 Manual.</para>
2771 2771
2772 <para>The /<literal>uCPEM_config</literal> directory stores JSON 2772 <para>The /<literal>uCPEM_config</literal> directory stores JSON
2773 configuration files needed for the setup of the uCPE Manager used by TH. 2773 configuration files needed for the setup of the Enea Edge Management used by TH.
2774 One configuration file is needed per uCPE Manager installation, to be used 2774 One configuration file is needed per Enea Edge Management installation, to be used
2775 in the TH.</para> 2775 in the TH.</para>
2776 2776
2777 <para>The <literal>/vnf_image</literal> directory stores the VNF Images 2777 <para>The <literal>/vnf_image</literal> directory stores the VNF Images
diff --git a/doc/book-enea-nfv-access-auto-fw-th-user-guide/doc/book.xml b/doc/book-enea-nfv-access-auto-fw-th-user-guide/doc/book.xml
index 0b96de2..6398606 100644
--- a/doc/book-enea-nfv-access-auto-fw-th-user-guide/doc/book.xml
+++ b/doc/book-enea-nfv-access-auto-fw-th-user-guide/doc/book.xml
@@ -4,7 +4,7 @@
4<!ENTITY % local.common.attrib "xml:base CDATA #IMPLIED"> 4<!ENTITY % local.common.attrib "xml:base CDATA #IMPLIED">
5]> 5]>
6<book id="book_enea_nfv_access_auto_fw_th_user_guide"> 6<book id="book_enea_nfv_access_auto_fw_th_user_guide">
7 <title><trademark class="registered">Enea</trademark> NFV Access Automation Framework and Test Harness User Guide</title> 7 <title><trademark class="registered">Enea</trademark> Enea Edge Automation Framework and Test Harness User Guide</title>
8 8
9 <subtitle>Release Version 9 <subtitle>Release Version
10 <xi:include href="../../s_doceneacommon/doc/eltf_params_updated.xml" xpointer="element(EneaLinux_REL_VER/1)" 10 <xi:include href="../../s_doceneacommon/doc/eltf_params_updated.xml" xpointer="element(EneaLinux_REL_VER/1)"
diff --git a/doc/book-enea-nfv-access-auto-fw-th-user-guide/doc/components.xml b/doc/book-enea-nfv-access-auto-fw-th-user-guide/doc/components.xml
index 9b775a7..24a7a29 100644
--- a/doc/book-enea-nfv-access-auto-fw-th-user-guide/doc/components.xml
+++ b/doc/book-enea-nfv-access-auto-fw-th-user-guide/doc/components.xml
@@ -2,8 +2,8 @@
2<chapter id="components"> 2<chapter id="components">
3 <title>Components</title> 3 <title>Components</title>
4 4
5 <para>An overview of the Enea NFV Access Runtime Platform and the uCPE 5 <para>An overview of the Enea Edge Runtime and the Edge Management
6 Manager in cooperation with the Automation Framework and Test Harness, will 6 in cooperation with the Automation Framework and Test Harness, will
7 be presented in detail.</para> 7 be presented in detail.</para>
8 8
9 <figure> 9 <figure>
@@ -18,23 +18,23 @@
18 </figure> 18 </figure>
19 19
20 <section id="enfva_runtime_plt"> 20 <section id="enfva_runtime_plt">
21 <title>Enea NFV Access</title> 21 <title>Enea Edge</title>
22 22
23 <para>Enea NFV Access is comprised of the Enea uCPE Manager and the Enea 23 <para>Enea Edge is comprised of the Enea Edge Management and the Enea
24 NFV Access Runtime Platform.</para> 24 Edge Runtime.</para>
25 25
26 <section id="eucpe_manager"> 26 <section id="eucpe_manager">
27 <title>Enea uCPE Manager</title> 27 <title>Enea Edge Management</title>
28 28
29 <para>The Enea uCPE Manager application needs to be installed on a 29 <para>The Enea Edge Management application needs to be installed on a
30 supported platform. Upon installation, the system will be set up to 30 supported platform. Upon installation, the system will be set up to
31 manage Enea NFV Access "devices", these are the virtualized CPE devices 31 manage Enea Edge "devices", these are the virtualized CPE devices
32 used in testing.</para> 32 used in testing.</para>
33 33
34 <para>For more on Enea uCPE Manager installation instructions, please 34 <para>For more on Enea Edge Management installation instructions, please
35 refer to the section on how to <olink 35 refer to the section on how to <olink
36 targetdoc="book_enea_nfv_access_getting_started" 36 targetdoc="book_enea_nfv_access_getting_started"
37 targetptr="install_ucpe_mg">Installing the Enea uCPE Manager in the 37 targetptr="install_ucpe_mg">Installing the Enea Edge Management in the
38 <xi:include href="../../s_docbuild/olinkdb/pardoc-names.xml" 38 <xi:include href="../../s_docbuild/olinkdb/pardoc-names.xml"
39 xmlns:xi="http://www.w3.org/2001/XInclude" 39 xmlns:xi="http://www.w3.org/2001/XInclude"
40 xpointer="element(book_enea_nfv_access_getting_started/1)" /></olink> 40 xpointer="element(book_enea_nfv_access_getting_started/1)" /></olink>
@@ -42,38 +42,37 @@
42 </section> 42 </section>
43 43
44 <section id="ena_plat"> 44 <section id="ena_plat">
45 <title>Enea NFV Access Runtime Platform</title> 45 <title>Enea Edge Runtime</title>
46 46
47 <para>One or more uCPE devices running the Enea NFV Access Runtime 47 <para>One or more uCPE devices running the Enea Edge Runtime
48 Platform are required as hosts to run the VNF(s). The uCPE device is 48 are required as hosts to run the VNF(s). The uCPE device is
49 known to the uCPE Manager as the "VcpeAgent" device module.</para> 49 known to the Enea Edge Management as the "VcpeAgent" device module.</para>
50 50
51 <note> 51 <note>
52 <para>Before running any use case with the Automation Framework or the 52 <para>Before running any use case with the Automation Framework or the
53 Test Harness, make sure the uCPE device(s) have been added to the uCPE 53 Test Harness, make sure the uCPE device(s) have been added to the Edge Management.</para>
54 Manager.</para>
55 </note> 54 </note>
56 55
57 <para>Adding a VcpeAgent device can be done via two methods:</para> 56 <para>Adding a VcpeAgent device can be done via two methods:</para>
58 57
59 <itemizedlist> 58 <itemizedlist>
60 <listitem> 59 <listitem>
61 <para>Through the uCPE Manager GUI. Add the device using the 60 <para>Through the Enea Edge Management GUI. Add the device using the
62 appropriate parameters by launching the UI under 61 appropriate parameters by launching the UI under
63 <literal>Devices</literal> -&gt; <literal>Manage</literal> in the 62 <literal>Devices</literal> -&gt; <literal>Manage</literal> in the
64 main screen.</para> 63 main screen.</para>
65 </listitem> 64 </listitem>
66 65
67 <listitem> 66 <listitem>
68 <para>REST API. Invoke the uCPE Manager REST API to add a 67 <para>REST API. Invoke the Enea Edge Management REST API to add a
69 device.</para> 68 device.</para>
70 </listitem> 69 </listitem>
71 </itemizedlist> 70 </itemizedlist>
72 71
73 <para>For more on Enea NFV Access installation instructions, please 72 <para>For more on Enea Edge installation instructions, please
74 refer to chapter <olink targetdoc="book_enea_nfv_access_getting_started" 73 refer to chapter <olink targetdoc="book_enea_nfv_access_getting_started"
75 targetptr="prep_usb_ena">Preparing the USB stick for installation of the 74 targetptr="prep_usb_ena">Preparing the USB stick for installation of the
76 Enea NFV Access Runtime Platform in the <xi:include 75 Enea Edge Runtime in the <xi:include
77 href="../../s_docbuild/olinkdb/pardoc-names.xml" 76 href="../../s_docbuild/olinkdb/pardoc-names.xml"
78 xmlns:xi="http://www.w3.org/2001/XInclude" 77 xmlns:xi="http://www.w3.org/2001/XInclude"
79 xpointer="element(book_enea_nfv_access_getting_started/1)" /></olink> 78 xpointer="element(book_enea_nfv_access_getting_started/1)" /></olink>
@@ -85,14 +84,14 @@
85 <title>Automation Framework</title> 84 <title>Automation Framework</title>
86 85
87 <para>Testing can be performed by running the available Python scripts 86 <para>Testing can be performed by running the available Python scripts
88 against the uCPE Manager REST API (Python samples supplied). This can be 87 against the Enea Edge Management REST API (Python samples supplied). This can be
89 done by using the Python scripts individually or by using the Python 88 done by using the Python scripts individually or by using the Python
90 unit-test suite that is able to automatically run test-cases defined for 89 unit-test suite that is able to automatically run test-cases defined for
91 each available Python script.</para> 90 each available Python script.</para>
92 91
93 <para>In either case, it is desirable to use a different host (instead of 92 <para>In either case, it is desirable to use a different host (instead of
94 running the tests on the same system as the uCPE Manager) in order to 93 running the tests on the same system as the Enea Edge Management) in order to
95 ensure that the uCPE Manager is setup and installed correctly in terms of 94 ensure that the Enea Edge Management is setup and installed correctly in terms of
96 allowing external users to access it and use it effectively.</para> 95 allowing external users to access it and use it effectively.</para>
97 </section> 96 </section>
98 97
@@ -102,7 +101,7 @@
102 <para>The Test Harness (TH) provides a way for driving configuration with 101 <para>The Test Harness (TH) provides a way for driving configuration with
103 Ansible Playbooks, by running the python modules from the Automation 102 Ansible Playbooks, by running the python modules from the Automation
104 Framework (AF) and by direct connection over SSH to the boards that run 103 Framework (AF) and by direct connection over SSH to the boards that run
105 Enea NFV Access.</para> 104 Enea Edge.</para>
106 105
107 <para>The Test Harness includes an automated test suite that 106 <para>The Test Harness includes an automated test suite that
108 contains:</para> 107 contains:</para>
@@ -110,14 +109,14 @@
110 <itemizedlist> 109 <itemizedlist>
111 <listitem> 110 <listitem>
112 <para>VNF, Device and Network Smoke Test Cases. A sample test suite 111 <para>VNF, Device and Network Smoke Test Cases. A sample test suite
113 that acts as basic smoke tests for Enea NFV Access and also as a 112 that acts as basic smoke tests for Enea Edge and also as a
114 sanity-check test suite for the AF and TH.</para> 113 sanity-check test suite for the AF and TH.</para>
115 </listitem> 114 </listitem>
116 115
117 <listitem> 116 <listitem>
118 <para>VNF Deployment and Lifecycle. A sample test suite that verifies 117 <para>VNF Deployment and Lifecycle. A sample test suite that verifies
119 the instantiation, lifecycle control and destruction of a VNF for Enea 118 the instantiation, lifecycle control and destruction of a VNF for Enea
120 NFV Access.</para> 119 Edge.</para>
121 </listitem> 120 </listitem>
122 121
123 <listitem> 122 <listitem>
diff --git a/doc/book-enea-nfv-access-auto-fw-th-user-guide/doc/getting_started.xml b/doc/book-enea-nfv-access-auto-fw-th-user-guide/doc/getting_started.xml
index eee6636..97666cf 100644
--- a/doc/book-enea-nfv-access-auto-fw-th-user-guide/doc/getting_started.xml
+++ b/doc/book-enea-nfv-access-auto-fw-th-user-guide/doc/getting_started.xml
@@ -29,7 +29,7 @@
29 29
30 <note> 30 <note>
31 <para>The Automation Framework and Test Harness installation may be done 31 <para>The Automation Framework and Test Harness installation may be done
32 on the same machine used for uCPE Manager installation, although this is 32 on the same machine used for Enea Edge Management installation, although this is
33 not encouraged. For more details see section <olink 33 not encouraged. For more details see section <olink
34 targetdoc="book_enea_nfv_access_auto_fw_th_user_guide" 34 targetdoc="book_enea_nfv_access_auto_fw_th_user_guide"
35 targetptr="automation">Automation Framework in the <xi:include 35 targetptr="automation">Automation Framework in the <xi:include
@@ -69,7 +69,7 @@
69 </listitem> 69 </listitem>
70 </itemizedlist></para> 70 </itemizedlist></para>
71 71
72 <para><emphasis role="bold">uCPE Manager Host 72 <para><emphasis role="bold">Enea Edge Management Host
73 Requirements</emphasis></para> 73 Requirements</emphasis></para>
74 74
75 <itemizedlist spacing="compact"> 75 <itemizedlist spacing="compact">
@@ -82,12 +82,12 @@
82 </listitem> 82 </listitem>
83 83
84 <listitem> 84 <listitem>
85 <para>uCPE Manager installed.</para> 85 <para>Enea Edge Management installed.</para>
86 86
87 <note> 87 <note>
88 <para>For details on how to install the uCPE Manager, see <olink 88 <para>For details on how to install the Enea Edge Management, see <olink
89 targetdoc="book_enea_nfv_access_getting_started" 89 targetdoc="book_enea_nfv_access_getting_started"
90 targetptr="install_ucpe_mg">Installing the Enea uCPE Manager in the 90 targetptr="install_ucpe_mg">Installing the Enea Edge Management in the
91 <xi:include href="../../s_docbuild/olinkdb/pardoc-names.xml" 91 <xi:include href="../../s_docbuild/olinkdb/pardoc-names.xml"
92 xmlns:xi="http://www.w3.org/2001/XInclude" 92 xmlns:xi="http://www.w3.org/2001/XInclude"
93 xpointer="element(book_enea_nfv_access_getting_started/1)" /></olink> 93 xpointer="element(book_enea_nfv_access_getting_started/1)" /></olink>
@@ -111,13 +111,13 @@
111 </listitem> 111 </listitem>
112 112
113 <listitem> 113 <listitem>
114 <para>Enea NFV Access Runtime Platform installed.</para> 114 <para>Enea Edge Runtime installed.</para>
115 115
116 <note> 116 <note>
117 <para>For information on how to install Enea NFV Access refer to 117 <para>For information on how to install Enea Edge refer to
118 <olink targetdoc="book_enea_nfv_access_getting_started" 118 <olink targetdoc="book_enea_nfv_access_getting_started"
119 targetptr="prep_usb_ena">Preparing the USB stick for installation 119 targetptr="prep_usb_ena">Preparing the USB stick for installation
120 of the Enea NFV Access Runtime Platform in the <xi:include 120 of the Enea Edge Runtime in the <xi:include
121 href="../../s_docbuild/olinkdb/pardoc-names.xml" 121 href="../../s_docbuild/olinkdb/pardoc-names.xml"
122 xmlns:xi="http://www.w3.org/2001/XInclude" 122 xmlns:xi="http://www.w3.org/2001/XInclude"
123 xpointer="element(book_enea_nfv_access_getting_started/1)" /></olink> 123 xpointer="element(book_enea_nfv_access_getting_started/1)" /></olink>
@@ -155,7 +155,7 @@
155 </listitem> 155 </listitem>
156 156
157 <listitem> 157 <listitem>
158 <para>Enea NFV Access Runtime Platform installed.</para> 158 <para>Enea Edge Runtime installed.</para>
159 </listitem> 159 </listitem>
160 </itemizedlist></para> 160 </itemizedlist></para>
161 </section> 161 </section>
@@ -180,16 +180,16 @@
180 </listitem> 180 </listitem>
181 181
182 <listitem> 182 <listitem>
183 <para>Set up the uCPE Manager which will be used by the TH:</para> 183 <para>Set up the Enea Edge Management which will be used by the TH:</para>
184 184
185 <orderedlist spacing="compact"> 185 <orderedlist spacing="compact">
186 <listitem> 186 <listitem>
187 <para>Create the uCPE Manager JSON config file in the 187 <para>Create the Enea Edge Management JSON config file in the
188 <literal>&lt;AF-TH-install-dir&gt;/uCPEM_config/</literal> 188 <literal>&lt;AF-TH-install-dir&gt;/uCPEM_config/</literal>
189 directory:<programlisting>{ 189 directory:<programlisting>{
190"ucpe_usr":"uCPE Manager Username", 190"ucpe_usr":"Enea Edge Management Username",
191"ucpe_pass":"uCPE Manager Password", 191"ucpe_pass":"Enea Edge Management Password",
192"ucpe_host":"uCPE Manager IP/Hostname", 192"ucpe_host":"Enea Edge Management IP/Hostname",
193"ftp_usr":"FTP Username", 193"ftp_usr":"FTP Username",
194"ftp_pass":"FTP Password", 194"ftp_pass":"FTP Password",
195"ftp_port":"FTP Port" 195"ftp_port":"FTP Port"
@@ -225,10 +225,10 @@
225 <literal>source 225 <literal>source
226 &lt;AF-TH-install-dir&gt;/testHarness-venv/bin/activate</literal>.</para> 226 &lt;AF-TH-install-dir&gt;/testHarness-venv/bin/activate</literal>.</para>
227 227
228 <para>Furthermore, if a user wants to use a new uCPE Manager instance for 228 <para>Furthermore, if a user wants to use a new Enea Edge Management instance for
229 a new session, the user also has to re-run the 229 a new session, the user also has to re-run the
230 <filename>setupuCPEManager.yml</filename> playbook with the corresponding 230 <filename>setupuCPEManager.yml</filename> playbook with the corresponding
231 JSON config for the new uCPE Manager instance.</para> 231 JSON config for the new Enea Edge Management instance.</para>
232 232
233 <note> 233 <note>
234 <para>Automation Framework and Test Harness History Information can be 234 <para>Automation Framework and Test Harness History Information can be
diff --git a/doc/book-enea-nfv-access-auto-fw-th-user-guide/doc/overview.xml b/doc/book-enea-nfv-access-auto-fw-th-user-guide/doc/overview.xml
index eadc1d5..b2486a0 100644
--- a/doc/book-enea-nfv-access-auto-fw-th-user-guide/doc/overview.xml
+++ b/doc/book-enea-nfv-access-auto-fw-th-user-guide/doc/overview.xml
@@ -3,21 +3,20 @@
3 <title>Overview</title> 3 <title>Overview</title>
4 4
5 <para>This document describes the Automation Framework and Test Harness for 5 <para>This document describes the Automation Framework and Test Harness for
6 Enea NFV Access, along with instructions regarding the necessary steps to 6 Enea Edge, along with instructions regarding the necessary steps to
7 run these software tools.</para> 7 run these software tools.</para>
8 8
9 <section id="descrip"> 9 <section id="descrip">
10 <title>Description</title> 10 <title>Description</title>
11 11
12 <para>The Automation Framework provides a way for driving configuration 12 <para>The Automation Framework provides a way for driving configuration
13 with Python scripting. It complements the Enea uCPE Manager GUI and uses 13 with Python scripting. It complements the Enea Edge Management GUI and uses
14 the northbound REST APIs, given to provide full usability of the Enea uCPE 14 the northbound REST APIs, given to provide full usability of the Enea Management
15 Manager features.</para> 15 features.</para>
16 16
17 <para>The Test Harness is based on running Ansible Playbooks to complete 17 <para>The Test Harness is based on running Ansible Playbooks to complete
18 different test cases, which make use of the Automation Framework Python 18 different test cases, which make use of the Automation Framework Python
19 modules and/or direct commands on the uCPE devices running the Enea NFV 19 modules and/or direct commands on the uCPE devices running the Enea Edge Runtime.</para>
20 Access Runtime Platform.</para>
21 </section> 20 </section>
22 21
23 <section id="def_acro"> 22 <section id="def_acro">
@@ -39,10 +38,10 @@
39 38
40 <tbody> 39 <tbody>
41 <row> 40 <row>
42 <entry>Enea NFV Access</entry> 41 <entry>Enea Edge</entry>
43 42
44 <entry>The Enea NFV Access (with ODM) Runtime Platform and the 43 <entry>The Enea Edge (with ODM) Runtime and the
45 Enea uCPE Manager.</entry> 44 Enea Edge Management.</entry>
46 </row> 45 </row>
47 </tbody> 46 </tbody>
48 </tgroup> 47 </tgroup>
@@ -66,7 +65,7 @@
66 <row> 65 <row>
67 <entry>AF</entry> 66 <entry>AF</entry>
68 67
69 <entry>Automation Framework for Enea NFV Access.</entry> 68 <entry>Automation Framework for Enea Edge.</entry>
70 </row> 69 </row>
71 70
72 <row> 71 <row>
@@ -162,11 +161,11 @@
162 <row> 161 <row>
163 <entry>TH</entry> 162 <entry>TH</entry>
164 163
165 <entry>Test Harness for Enea NFV Access.</entry> 164 <entry>Test Harness for Enea Edge.</entry>
166 </row> 165 </row>
167 166
168 <row> 167 <row>
169 <entry>uCPE Manager</entry> 168 <entry>Enea Edge Management</entry>
170 169
171 <entry>Enea Universal Customer Premises Equipment Manager.</entry> 170 <entry>Enea Universal Customer Premises Equipment Manager.</entry>
172 </row> 171 </row>
diff --git a/doc/book-enea-nfv-access-auto-fw-th-user-guide/doc/troubleshooting_guide.xml b/doc/book-enea-nfv-access-auto-fw-th-user-guide/doc/troubleshooting_guide.xml
index f51fe11..a5cd664 100644
--- a/doc/book-enea-nfv-access-auto-fw-th-user-guide/doc/troubleshooting_guide.xml
+++ b/doc/book-enea-nfv-access-auto-fw-th-user-guide/doc/troubleshooting_guide.xml
@@ -21,11 +21,11 @@
21 </listitem> 21 </listitem>
22 22
23 <listitem> 23 <listitem>
24 <para>When setting up the uCPE Manager to be used by the TH through the 24 <para>When setting up the Enea Edge Management to be used by the TH through the
25 <literal>setupuCPEManager.yml</literal> Playbook, if the uCPE 25 <literal>setupuCPEManager.yml</literal> Playbook, if the uCPE
26 username/password/host are incorrect or are missing, all the Sample test 26 username/password/host are incorrect or are missing, all the Sample test
27 cases will fail. If the FTP username/password/port are wrong or are 27 cases will fail. If the FTP username/password/port are wrong or are
28 missing, the tests that require file transfer to the uCPE Manager will 28 missing, the tests that require file transfer to the Enea Edge Management will
29 fail.</para> 29 fail.</para>
30 </listitem> 30 </listitem>
31 31