summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
Diffstat
-rw-r--r--doc/book-enea-edge-auto-fw-th-open-source/doc/about.xml2
-rw-r--r--doc/book-enea-edge-auto-fw-th-open-source/doc/licenses.xml6
-rw-r--r--doc/book-enea-edge-auto-fw-th-user-guide/doc/automation_framework_test_harness.xml268
-rw-r--r--doc/book-enea-edge-auto-fw-th-user-guide/doc/components.xml10
-rw-r--r--doc/book-enea-edge-auto-fw-th-user-guide/doc/getting_started.xml18
-rw-r--r--doc/book-enea-edge-auto-fw-th-user-guide/doc/overview.xml12
6 files changed, 156 insertions, 160 deletions
diff --git a/doc/book-enea-edge-auto-fw-th-open-source/doc/about.xml b/doc/book-enea-edge-auto-fw-th-open-source/doc/about.xml
index 4dc19aa..24f674d 100644
--- a/doc/book-enea-edge-auto-fw-th-open-source/doc/about.xml
+++ b/doc/book-enea-edge-auto-fw-th-open-source/doc/about.xml
@@ -5,7 +5,7 @@
5 <title>About this Report</title> 5 <title>About this Report</title>
6 6
7 <para>This document contains the open source and license information 7 <para>This document contains the open source and license information
8 pertaining to the Automation Framework and Test Harness provided with 8 pertaining to the Enea Edge Automation Framework and Test Harness provided with
9 Enea Edge <xi:include 9 Enea Edge <xi:include
10 href="../../s_doceneacommon/doc/eltf_params_updated.xml" 10 href="../../s_doceneacommon/doc/eltf_params_updated.xml"
11 xmlns:xi="http://www.w3.org/2001/XInclude" 11 xmlns:xi="http://www.w3.org/2001/XInclude"
diff --git a/doc/book-enea-edge-auto-fw-th-open-source/doc/licenses.xml b/doc/book-enea-edge-auto-fw-th-open-source/doc/licenses.xml
index 76a34e2..dd9597e 100644
--- a/doc/book-enea-edge-auto-fw-th-open-source/doc/licenses.xml
+++ b/doc/book-enea-edge-auto-fw-th-open-source/doc/licenses.xml
@@ -33,7 +33,7 @@
33 33
34 <tbody valign="top"> 34 <tbody valign="top">
35 <row> 35 <row>
36 <entry>Automation Framework and Test Harness</entry> 36 <entry>Enea Edge Automation Framework and Test Harness</entry>
37 37
38 <entry><xi:include 38 <entry><xi:include
39 href="../../s_doceneacommon/doc/eltf_params_updated.xml" 39 href="../../s_doceneacommon/doc/eltf_params_updated.xml"
@@ -47,7 +47,7 @@
47 </row> 47 </row>
48 48
49 <row> 49 <row>
50 <entry>Automation Framework and Test Harness</entry> 50 <entry>Enea Edge Automation Framework and Test Harness</entry>
51 51
52 <entry><xi:include 52 <entry><xi:include
53 href="../../s_doceneacommon/doc/eltf_params_updated.xml" 53 href="../../s_doceneacommon/doc/eltf_params_updated.xml"
@@ -74,7 +74,7 @@
74 <section id="lic_0"> 74 <section id="lic_0">
75 <title>ENEA-SRC-R2</title> 75 <title>ENEA-SRC-R2</title>
76 76
77 <para><programlisting> Copyright (C) 2019 by Enea. 77 <para><programlisting> Copyright (C) 2019 by Enea Software AB.
78 All rights reserved. 78 All rights reserved.
79 79
80 This Software is furnished under a software license agreement and 80 This Software is furnished under a software license agreement and
diff --git a/doc/book-enea-edge-auto-fw-th-user-guide/doc/automation_framework_test_harness.xml b/doc/book-enea-edge-auto-fw-th-user-guide/doc/automation_framework_test_harness.xml
index a569d59..6a47839 100644
--- a/doc/book-enea-edge-auto-fw-th-user-guide/doc/automation_framework_test_harness.xml
+++ b/doc/book-enea-edge-auto-fw-th-user-guide/doc/automation_framework_test_harness.xml
@@ -32,12 +32,14 @@
32 <para>Commands within the network folder that include the option 32 <para>Commands within the network folder that include the option
33 <emphasis role="bold">-o</emphasis> allow the user to perform the action 33 <emphasis role="bold">-o</emphasis> allow the user to perform the action
34 in an offline configuration store alternative available for use at a 34 in an offline configuration store alternative available for use at a
35 later setup time. Commands that include the <emphasis 35 later setup time.</para>
36 role="bold">-n</emphasis> option refer to a uCPE device, with the 36 <para>Commands that include the <emphasis role="bold">-n</emphasis>
37 operation being performed on uCPE device. All options contain either 37 option refer to a uCPE device, with the operation being performed on uCPE device.</para>
38 <emphasis role="bold">-n</emphasis>, <emphasis role="bold">-o</emphasis> 38 <para>All options contain either <emphasis role="bold">-n</emphasis>,
39 or both. One of them must always be provided, if both are provided, -o 39 <emphasis role="bold">-o</emphasis> or both. One of them must always be provided,
40 has priority, and -n is thus ignored.</para> 40 if both are provided, -o has priority, and -n is thus ignored.</para>
41 <para>In the following script examples <emphasis role="bold"> Enea Edge Management
42 </emphasis> is reffered as <emphasis role="bold">Enea uCPE Manager</emphasis>.</para>
41 </note> 43 </note>
42 44
43 <para>The <literal>/unittestSuite</literal> folder contains JSON files for 45 <para>The <literal>/unittestSuite</literal> folder contains JSON files for
@@ -88,16 +90,16 @@
88 <programlisting>$ python unittestSuite.py -h 90 <programlisting>$ python unittestSuite.py -h
89Usage: unittestSuite.py [options] 91Usage: unittestSuite.py [options]
90 92
91Run selected unit-test suite against Enea Edge Management. 93Run selected unit-test suite against Enea uCPE Manager.
92 94
93Options: 95Options:
94 --version show program's version number and exit 96 --version show program's version number and exit
95 -h, --help show this help message and exit 97 -h, --help show this help message and exit
96 -u USERNAME, --username=USERNAME 98 -u USERNAME, --username=USERNAME
97 Enea Edge Management login username 99 Enea uCPE Manager login username
98 -p PASSWORD, --password=PASSWORD 100 -p PASSWORD, --password=PASSWORD
99 Enea Edge Management login password 101 Enea uCPE Manager login password
100 -H HOST, --host=HOST Enea Edge Management host name or IP address 102 -H HOST, --host=HOST Enea uCPE Manager host name or IP address
101 -n DEVICENAME, --deviceName=DEVICENAME 103 -n DEVICENAME, --deviceName=DEVICENAME
102 Name of vCPE device (Virtual Infrastructure Manager) 104 Name of vCPE device (Virtual Infrastructure Manager)
103 -s SUITEFILE, --suite=SUITEFILE 105 -s SUITEFILE, --suite=SUITEFILE
@@ -548,16 +550,16 @@ OK</programlisting>
548 <programlisting>$ python addDevice.py -h 550 <programlisting>$ python addDevice.py -h
549Usage: addDevice.py [options] 551Usage: addDevice.py [options]
550 552
551Add a uCPE device in Enea Edge Management. 553Add a uCPE device in Enea uCPE Manager.
552 554
553Options: 555Options:
554 --version show program's version number and exit 556 --version show program's version number and exit
555 -h, --help show this help message and exit 557 -h, --help show this help message and exit
556 -u USERNAME, --username=USERNAME 558 -u USERNAME, --username=USERNAME
557 Enea Edge Management login username 559 Enea uCPE Manager login username
558 -p PASSWORD, --password=PASSWORD 560 -p PASSWORD, --password=PASSWORD
559 Enea Edge Management login password 561 Enea uCPE Manager login password
560 -H HOST, --host=HOST Enea Edge Management host name or IP address 562 -H HOST, --host=HOST Enea uCPE Manager host name or IP address
561 -f DEVICEFILE, --file=DEVICEFILE 563 -f DEVICEFILE, --file=DEVICEFILE
562 File containing uCPE Information in JSON format 564 File containing uCPE Information in JSON format
563 565
@@ -615,7 +617,7 @@ Options:
6152019-03-07 17:33:10,756 - INFO: Add uCPE device 6172019-03-07 17:33:10,756 - INFO: Add uCPE device
6162019-03-07 17:33:10,975 - DEBUG: Login successful on host 'localhost' 6182019-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 6192019-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 Enea Edge Management host 6202019-03-07 17:33:11,049 - DEBUG: Add new device 'intelc3850-2' to uCPE Manager host
6192019-03-07 17:33:11,483 - INFO: Done 6212019-03-07 17:33:11,483 - INFO: Done
6202019-03-07 17:33:11,501 - DEBUG: Logging out and exiting....</programlisting> 6222019-03-07 17:33:11,501 - DEBUG: Logging out and exiting....</programlisting>
621 </section> 623 </section>
@@ -633,16 +635,16 @@ Options:
633 <programlisting>$ python removeDevice.py -h 635 <programlisting>$ python removeDevice.py -h
634Usage: removeDevice.py [options] 636Usage: removeDevice.py [options]
635 637
636Remove a uCPE from Enea Edge Management. 638Remove a uCPE from Enea uCPE Manager.
637 639
638Options: 640Options:
639 --version show program's version number and exit 641 --version show program's version number and exit
640 -h, --help show this help message and exit 642 -h, --help show this help message and exit
641 -u USERNAME, --username=USERNAME 643 -u USERNAME, --username=USERNAME
642 Enea Edge Management login username 644 Enea uCPE Manager login username
643 -p PASSWORD, --password=PASSWORD 645 -p PASSWORD, --password=PASSWORD
644 Enea Edge Management login password 646 Enea uCPE Manager login password
645 -H HOST, --host=HOST Enea Edge Management host name or IP address 647 -H HOST, --host=HOST Enea uCPE Manager host name or IP address
646 -f DEVICEFILE, --file=DEVICEFILE 648 -f DEVICEFILE, --file=DEVICEFILE
647 File containing uCPE Information in JSON format 649 File containing uCPE Information in JSON format
648 650
@@ -689,7 +691,7 @@ Options:
6892019-03-07 17:33:56,835 - INFO: Remove uCPE device 6912019-03-07 17:33:56,835 - INFO: Remove uCPE device
6902019-03-07 17:33:56,856 - DEBUG: Login successful on host 'localhost' 6922019-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 6932019-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 Enea Edge Management 6942019-03-07 17:33:56,856 - DEBUG: Delete device 'intelc3850-2' from uCPE Manager
693host 695host
6942019-03-07 17:33:56,875 - DEBUG: Found device with name 'intelc3850-2' 6962019-03-07 17:33:56,875 - DEBUG: Found device with name 'intelc3850-2'
6952019-03-07 17:33:57,159 - INFO: Done 6972019-03-07 17:33:57,159 - INFO: Done
@@ -709,16 +711,16 @@ host
709 <programlisting>$ python waitDeviceUp.py -h 711 <programlisting>$ python waitDeviceUp.py -h
710Usage: waitDeviceUp.py [options] 712Usage: waitDeviceUp.py [options]
711 713
712Wait for uCPE to connect to the Enea Edge Management after installation. 714Wait for uCPE to connect to the Enea uCPE Manager after installation.
713 715
714Options: 716Options:
715 --version show program's version number and exit 717 --version show program's version number and exit
716 -h, --help show this help message and exit 718 -h, --help show this help message and exit
717 -u USERNAME, --username=USERNAME 719 -u USERNAME, --username=USERNAME
718 Enea Edge Management login username 720 Enea uCPE Manager login username
719 -p PASSWORD, --password=PASSWORD 721 -p PASSWORD, --password=PASSWORD
720 Enea Edge Management login password 722 Enea uCPE Manager login password
721 -H HOST, --host=HOST Enea Edge Management host name or IP address 723 -H HOST, --host=HOST Enea uCPE Manager host name or IP address
722 -f DEVICEFILE, --file=DEVICEFILE 724 -f DEVICEFILE, --file=DEVICEFILE
723 File containing uCPE Information in JSON format 725 File containing uCPE Information in JSON format
724 -t TIMEOUT, --timeout=TIMEOUT 726 -t TIMEOUT, --timeout=TIMEOUT
@@ -787,14 +789,14 @@ Options:
787 <programlisting>$ python getEventsForUcpe.py -h 789 <programlisting>$ python getEventsForUcpe.py -h
788Usage: getEventsForUcpe.py [options] 790Usage: getEventsForUcpe.py [options]
789 791
790Print the events log for a specific uCPE installed in Enea Edge Management. 792Print the events log for a specific uCPE installed in Enea uCPE Manager.
791 793
792Options: 794Options:
793--version show program's version number and exit 795--version show program's version number and exit
794-h, --help show this help message and exit 796-h, --help show this help message and exit
795-u USERNAME, --username=USERNAME Enea Edge Management login username 797-u USERNAME, --username=USERNAME Enea uCPE Manager login username
796-p PASSWORD, --password=PASSWORD Enea Edge Management login password 798-p PASSWORD, --password=PASSWORD Enea uCPE Manager login password
797-H HOST, --host=HOST Enea Edge Management host name or IP address 799-H HOST, --host=HOST Enea uCPE Manager host name or IP address
798-f DEVICEFILE, --file=DEVICEFILE File containing uCPE Information in JSON format 800-f DEVICEFILE, --file=DEVICEFILE File containing uCPE Information in JSON format
799-s SEVERITY, --severity=SEVERITY Event severity level (Critical|Major|Minor) 801-s SEVERITY, --severity=SEVERITY Event severity level (Critical|Major|Minor)
800 802
@@ -869,10 +871,10 @@ Options:
869 --version show program's version number and exit 871 --version show program's version number and exit
870 -h, --help show this help message and exit 872 -h, --help show this help message and exit
871 -u USERNAME, --username=USERNAME 873 -u USERNAME, --username=USERNAME
872 Enea Edge Management login username 874 Enea uCPE Manager login username
873 -p PASSWORD, --password=PASSWORD 875 -p PASSWORD, --password=PASSWORD
874 Enea Edge Management login password 876 Enea uCPE Manager login password
875 -H HOST, --host=HOST Enea Edge Management host name or IP address 877 -H HOST, --host=HOST Enea uCPE Manager host name or IP address
876 -s STATE, --state=STATE 878 -s STATE, --state=STATE
877 Enable/Disable 879 Enable/Disable
878 -n DEVICENAME, --device-name=DEVICENAME 880 -n DEVICENAME, --device-name=DEVICENAME
@@ -936,10 +938,10 @@ Options:
936 --version show program's version number and exit 938 --version show program's version number and exit
937 -h, --help show this help message and exit 939 -h, --help show this help message and exit
938 -u USERNAME, --username=USERNAME 940 -u USERNAME, --username=USERNAME
939 Enea Edge Management login username 941 Enea uCPE Manager login username
940 -p PASSWORD, --password=PASSWORD 942 -p PASSWORD, --password=PASSWORD
941 Enea Edge Management login password 943 Enea uCPE Manager login password
942 -H HOST, --host=HOST Enea Edge Management host name or IP address 944 -H HOST, --host=HOST Enea uCPE Manager host name or IP address
943 -f NICFILE, --file=NICFILE 945 -f NICFILE, --file=NICFILE
944 File containing network interface Information in JSON 946 File containing network interface Information in JSON
945 format 947 format
@@ -1042,10 +1044,10 @@ Options:
1042 --version show program's version number and exit 1044 --version show program's version number and exit
1043 -h, --help show this help message and exit 1045 -h, --help show this help message and exit
1044 -u USERNAME, --username=USERNAME 1046 -u USERNAME, --username=USERNAME
1045 Enea Edge Management login username 1047 Enea uCPE Manager login username
1046 -p PASSWORD, --password=PASSWORD 1048 -p PASSWORD, --password=PASSWORD
1047 Enea Edge Management login password 1049 Enea uCPE Manager login password
1048 -H HOST, --host=HOST Enea Edge Management host name or IP address 1050 -H HOST, --host=HOST Enea uCPE Manager host name or IP address
1049 -f NICFILE, --file=NICFILE 1051 -f NICFILE, --file=NICFILE
1050 File containing network interface Information in JSON 1052 File containing network interface Information in JSON
1051 format 1053 format
@@ -1131,9 +1133,9 @@ Usage: getNetworkInterfaces.py [options]
1131Options: 1133Options:
1132 --version show program's version number and exit 1134 --version show program's version number and exit
1133 -h, --help show this help message and exit 1135 -h, --help show this help message and exit
1134 -u USERNAME, --username=USERNAME Enea Edge Management login username 1136 -u USERNAME, --username=USERNAME Enea uCPE Manager login username
1135 -p PASSWORD, --password=PASSWORD Enea Edge Management login password 1137 -p PASSWORD, --password=PASSWORD Enea uCPE Manager login password
1136 -H HOST, --host=HOST Enea Edge Management host name or IP address 1138 -H HOST, --host=HOST Enea uCPE Manager host name or IP address
1137 -n DEVICENAME, --device-name=DEVICENAME Name of the uCPE to get network / 1139 -n DEVICENAME, --device-name=DEVICENAME Name of the uCPE to get network /
1138 interfaces from 1140 interfaces from
1139 1141
@@ -1215,10 +1217,10 @@ Options:
1215 --version show program's version number and exit 1217 --version show program's version number and exit
1216 -h, --help show this help message and exit 1218 -h, --help show this help message and exit
1217 -u USERNAME, --username=USERNAME 1219 -u USERNAME, --username=USERNAME
1218 Enea Edge Management login username 1220 Enea uCPE Manager login username
1219 -p PASSWORD, --password=PASSWORD 1221 -p PASSWORD, --password=PASSWORD
1220 Enea Edge Management login password 1222 Enea uCPE Manager login password
1221 -H HOST, --host=HOST Enea Edge Management host name or IP address 1223 -H HOST, --host=HOST Enea uCPE Manager host name or IP address
1222 -f OVSFILE, --file=OVSFILE 1224 -f OVSFILE, --file=OVSFILE
1223 File containing OVS bridge Information in JSON format 1225 File containing OVS bridge Information in JSON format
1224 -n DEVICENAME, --device-name=DEVICENAME 1226 -n DEVICENAME, --device-name=DEVICENAME
@@ -1306,10 +1308,10 @@ Options:
1306 --version show program's version number and exit 1308 --version show program's version number and exit
1307 -h, --help show this help message and exit 1309 -h, --help show this help message and exit
1308 -u USERNAME, --username=USERNAME 1310 -u USERNAME, --username=USERNAME
1309 Enea Edge Management login username 1311 Enea uCPE Manager login username
1310 -p PASSWORD, --password=PASSWORD 1312 -p PASSWORD, --password=PASSWORD
1311 Enea Edge Management login password 1313 Enea uCPE Manager login password
1312 -H HOST, --host=HOST Enea Edge Management host name or IP address 1314 -H HOST, --host=HOST Enea uCPE Manager host name or IP address
1313 -f OVSFILE, --file=OVSFILE 1315 -f OVSFILE, --file=OVSFILE
1314 File containing OVS bridge Information in JSON format 1316 File containing OVS bridge Information in JSON format
1315 -n DEVICENAME, --device-name=DEVICENAME 1317 -n DEVICENAME, --device-name=DEVICENAME
@@ -1389,16 +1391,16 @@ Options:
1389 <programlisting>$ python onboardVNFRaw.py -h 1391 <programlisting>$ python onboardVNFRaw.py -h
1390Usage: onboardVNFRaw.py [options] 1392Usage: onboardVNFRaw.py [options]
1391 1393
1392Onboard a VNF in Enea Edge Management based upon its raw constituents. 1394Onboard a VNF in Enea uCPE Manager based upon its raw constituents.
1393 1395
1394Options: 1396Options:
1395 --version show program's version number and exit 1397 --version show program's version number and exit
1396 -h, --help show this help message and exit 1398 -h, --help show this help message and exit
1397 -u USERNAME, --username=USERNAME 1399 -u USERNAME, --username=USERNAME
1398 Enea Edge Management login username 1400 Enea uCPE Manager login username
1399 -p PASSWORD, --password=PASSWORD 1401 -p PASSWORD, --password=PASSWORD
1400 Enea Edge Management login password 1402 Enea uCPE Manager login password
1401 -H HOST, --host=HOST Enea Edge Management host name or IP address 1403 -H HOST, --host=HOST Enea uCPE Manager host name or IP address
1402 -f FTPUSERNAME, --ftpUsername=FTPUSERNAME 1404 -f FTPUSERNAME, --ftpUsername=FTPUSERNAME
1403 Username for FTP 1405 Username for FTP
1404 -w FTPPASSWORD, --ftpPassword=FTPPASSWORD 1406 -w FTPPASSWORD, --ftpPassword=FTPPASSWORD
@@ -1506,16 +1508,16 @@ Options:
1506 <programlisting>$ python offboardVNF.py -h 1508 <programlisting>$ python offboardVNF.py -h
1507Usage: offboardVNF.py [options] 1509Usage: offboardVNF.py [options]
1508 1510
1509Offboard a VNF from Enea Edge Management. 1511Offboard a VNF from Enea uCPE Manager.
1510 1512
1511Options: 1513Options:
1512 --version show program's version number and exit 1514 --version show program's version number and exit
1513 -h, --help show this help message and exit 1515 -h, --help show this help message and exit
1514 -u USERNAME, --username=USERNAME 1516 -u USERNAME, --username=USERNAME
1515 Enea Edge Management login username 1517 Enea uCPE Manager login username
1516 -p PASSWORD, --password=PASSWORD 1518 -p PASSWORD, --password=PASSWORD
1517 Enea Edge Management login password 1519 Enea uCPE Manager login password
1518 -H HOST, --host=HOST Enea Edge Management host name or IP address 1520 -H HOST, --host=HOST Enea uCPE Manager host name or IP address
1519 -n VNFDNAME, --vnfdName=VNFDNAME 1521 -n VNFDNAME, --vnfdName=VNFDNAME
1520 Name of VNF descriptor to offboard 1522 Name of VNF descriptor to offboard
1521 1523
@@ -1571,16 +1573,16 @@ Options:
1571 <programlisting>$ python instantiateVNFI.py -h 1573 <programlisting>$ python instantiateVNFI.py -h
1572Usage: instantiateVNFI.py [options] 1574Usage: instantiateVNFI.py [options]
1573 1575
1574Instantiate a VNF via Enea Edge Management. 1576Instantiate a VNF via Enea uCPE Manager.
1575 1577
1576Options: 1578Options:
1577 --version show program's version number and exit 1579 --version show program's version number and exit
1578 -h, --help show this help message and exit 1580 -h, --help show this help message and exit
1579 -u USERNAME, --username=USERNAME 1581 -u USERNAME, --username=USERNAME
1580 Enea Edge Management login username 1582 Enea uCPE Manager login username
1581 -p PASSWORD, --password=PASSWORD 1583 -p PASSWORD, --password=PASSWORD
1582 Enea Edge Management login password 1584 Enea uCPE Manager login password
1583 -H HOST, --host=HOST Enea Edge Management host name or IP address 1585 -H HOST, --host=HOST Enea uCPE Manager host name or IP address
1584 -t VNFTYPE, --vnfType=VNFTYPE 1586 -t VNFTYPE, --vnfType=VNFTYPE
1585 VNF Type (Name of VNF descriptor) 1587 VNF Type (Name of VNF descriptor)
1586 -n VIMDEVICENAME, --device-name=VIMDEVICENAME 1588 -n VIMDEVICENAME, --device-name=VIMDEVICENAME
@@ -1660,16 +1662,16 @@ License("vnf_config/fortigateImage/fortigateLicense.lic")
1660 <programlisting>$ python controlVNFI.py -h 1662 <programlisting>$ python controlVNFI.py -h
1661Usage: controlVNFI.py [options] 1663Usage: controlVNFI.py [options]
1662 1664
1663Controls a VNF instance from Enea Edge Management. 1665Controls a VNF instance from Enea uCPE Manager.
1664 1666
1665Options: 1667Options:
1666 --version show program's version number and exit 1668 --version show program's version number and exit
1667 -h, --help show this help message and exit 1669 -h, --help show this help message and exit
1668 -u USERNAME, --username=USERNAME 1670 -u USERNAME, --username=USERNAME
1669 Enea Edge Management login username 1671 Enea uCPE Manager login username
1670 -p PASSWORD, --password=PASSWORD 1672 -p PASSWORD, --password=PASSWORD
1671 Enea Edge Management login password 1673 Enea uCPE Manager login password
1672 -H HOST, --host=HOST Enea Edge Management host name or IP address 1674 -H HOST, --host=HOST Enea uCPE Manager host name or IP address
1673 -i VNFINSTANCENAME, --vnfInstanceName=VNFINSTANCENAME 1675 -i VNFINSTANCENAME, --vnfInstanceName=VNFINSTANCENAME
1674 Name of VNF instance 1676 Name of VNF instance
1675 -n VIMDEVICENAME, --device-name=VIMDEVICENAME 1677 -n VIMDEVICENAME, --device-name=VIMDEVICENAME
@@ -1744,16 +1746,16 @@ fortigateFWInstance -c stop
1744 <programlisting>$ python destroyVNFI.py -h 1746 <programlisting>$ python destroyVNFI.py -h
1745Usage: destroyVNFI.py [options] 1747Usage: destroyVNFI.py [options]
1746 1748
1747Destroys a VNF instance from Enea Edge Management. 1749Destroys a VNF instance from Enea uCPE Manager.
1748 1750
1749Options: 1751Options:
1750 --version show program's version number and exit 1752 --version show program's version number and exit
1751 -h, --help show this help message and exit 1753 -h, --help show this help message and exit
1752 -u USERNAME, --username=USERNAME 1754 -u USERNAME, --username=USERNAME
1753 Enea Edge Management login username 1755 Enea uCPE Manager login username
1754 -p PASSWORD, --password=PASSWORD 1756 -p PASSWORD, --password=PASSWORD
1755 Enea Edge Management login password 1757 Enea uCPE Manager login password
1756 -H HOST, --host=HOST Enea Edge Management host name or IP address 1758 -H HOST, --host=HOST Enea uCPE Manager host name or IP address
1757 -i VNFINSTANCENAME, --vnfInstanceName=VNFINSTANCENAME 1759 -i VNFINSTANCENAME, --vnfInstanceName=VNFINSTANCENAME
1758 Name of VNF instance 1760 Name of VNF instance
1759 -n VIMDEVICENAME, --device-name=VIMDEVICENAME 1761 -n VIMDEVICENAME, --device-name=VIMDEVICENAME
@@ -1801,28 +1803,28 @@ fortigateFWInstance
1801 </section> 1803 </section>
1802 1804
1803 <section id="upload_vnf_image"> 1805 <section id="upload_vnf_image">
1804 <title>Uploading a Enea Edge image onto the Enea Edge Management</title> 1806 <title>Uploading an Enea Edge image onto the Enea Edge Management</title>
1805 1807
1806 <para>Steps and options on how to Upload a Enea Edge image onto the 1808 <para>Steps and options on how to Upload an Enea Edge image onto the
1807 Enea Edge Management are described below.</para> 1809 Enea Edge Management are described below.</para>
1808 1810
1809 <section id="script_opts_upload"> 1811 <section id="script_opts_upload">
1810 <title>Script Options</title> 1812 <title>Script Options</title>
1811 1813
1812 <programlisting>$ python uploadImage.py -h 1814 <programlisting>$ python uploadImage.py -h
1813Upload NFVA image on Enea Edge Management 1815Upload NFVA image on uCPE Manager
1814Usage: uploadImage.py [options] 1816Usage: uploadImage.py [options]
1815 1817
1816Upload NFVA image on Enea Edge Management. 1818Upload NFVA image on uCPE Manager.
1817 1819
1818Options: 1820Options:
1819 --version show program's version number and exit 1821 --version show program's version number and exit
1820 -h, --help show this help message and exit 1822 -h, --help show this help message and exit
1821 -u USERNAME, --username=USERNAME 1823 -u USERNAME, --username=USERNAME
1822 Enea Edge Management login username 1824 Enea uCPE Manager login username
1823 -p PASSWORD, --password=PASSWORD 1825 -p PASSWORD, --password=PASSWORD
1824 Enea Edge Management login password 1826 Enea uCPE Manager login password
1825 -H HOST, --host=HOST Enea Edge Management host name or IP address 1827 -H HOST, --host=HOST Enea uCPE Manager host name or IP address
1826 -f FILENAME, --fileName=FILENAME 1828 -f FILENAME, --fileName=FILENAME
1827 Path to NFVA image file name 1829 Path to NFVA image file name
1828 -m MODULE, --module=MODULE 1830 -m MODULE, --module=MODULE
@@ -1838,7 +1840,7 @@ Options:
1838 <section id="json_upload"> 1840 <section id="json_upload">
1839 <title>Configuring the JSON File</title> 1841 <title>Configuring the JSON File</title>
1840 1842
1841 <para>The JSON configuration file needed to upload a Enea Edge image 1843 <para>The JSON configuration file needed to upload an Enea Edge image
1842 should contain a list of dictionaries. Each dictionary indicates the 1844 should contain a list of dictionaries. Each dictionary indicates the
1843 test case name and the test case arguments passed to the 1845 test case name and the test case arguments passed to the
1844 <filename>uploadImage</filename> Python module.</para> 1846 <filename>uploadImage</filename> Python module.</para>
@@ -1846,7 +1848,7 @@ Options:
1846 <para><emphasis role="bold">Sample unit-test JSON file 1848 <para><emphasis role="bold">Sample unit-test JSON file
1847 format:</emphasis><programlisting>[ 1849 format:</emphasis><programlisting>[
1848 { 1850 {
1849 "name": "Upload NFVA image on Enea Edge Management", 1851 "name": "Upload NFVA image on uCPE Manager",
1850 "args": "-f /tmp/enea-nfv-access-xeon-d.rootfs.ostree.tar.bz2 -t xeon_d" 1852 "args": "-f /tmp/enea-nfv-access-xeon-d.rootfs.ostree.tar.bz2 -t xeon_d"
1851 } 1853 }
1852]</programlisting></para> 1854]</programlisting></para>
@@ -1861,7 +1863,7 @@ Options:
1861 <programlisting>$ python uploadImage.py -u admin -p admin -H localhost \ 1863 <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 1864-f /tmp/enea-nfv-access-xeon-d.rootfs.ostree.tar.bz2 -t xeon_d
18632020-02-28 11:38:42,754 - DEBUG: Started logging 18652020-02-28 11:38:42,754 - DEBUG: Started logging
18642020-02-28 11:38:42,755 - INFO: Upload NFVA image on Enea Edge Management 18662020-02-28 11:38:42,755 - INFO: Upload NFVA image on uCPE Manager
18652020-02-28 11:38:43,307 - DEBUG: Login successful on host 'localhost' 18672020-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 18682020-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 18692020-02-28 11:41:29,148 - INFO: Verify image validation flag
@@ -1874,29 +1876,29 @@ Options:
1874 </section> 1876 </section>
1875 1877
1876 <section id="delete_vnf_image"> 1878 <section id="delete_vnf_image">
1877 <title>Deleting a Enea Edge image file from the 1879 <title>Deleting an Enea Edge image file from the
1878 Enea Edge Management</title> 1880 Enea Edge Management</title>
1879 1881
1880 <para>Steps and options on how to Delete a Enea Edge image from the 1882 <para>Steps and options on how to Delete an Enea Edge image from the
1881 Enea Edge Management are described below.</para> 1883 Enea Edge Management are described below.</para>
1882 1884
1883 <section id="script_opts_deleteupload"> 1885 <section id="script_opts_deleteupload">
1884 <title>Script Options</title> 1886 <title>Script Options</title>
1885 1887
1886 <programlisting>$ python deleteUpgradeFile.py -h 1888 <programlisting>$ python deleteUpgradeFile.py -h
1887Delete NFVA image from Enea Edge Management 1889Delete NFVA image from uCPE Manager
1888Usage: deleteUpgradeFile.py [options] 1890Usage: deleteUpgradeFile.py [options]
1889 1891
1890Delete NFVA image from Enea Edge Management. 1892Delete NFVA image from uCPE Manager.
1891 1893
1892Options: 1894Options:
1893 --version show program's version number and exit 1895 --version show program's version number and exit
1894 -h, --help show this help message and exit 1896 -h, --help show this help message and exit
1895 -u USERNAME, --username=USERNAME 1897 -u USERNAME, --username=USERNAME
1896 Enea Edge Management login username 1898 Enea uCPE Manager login username
1897 -p PASSWORD, --password=PASSWORD 1899 -p PASSWORD, --password=PASSWORD
1898 Enea Edge Management login password 1900 Enea uCPE Manager login password
1899 -H HOST, --host=HOST Enea Edge Management host name or IP address 1901 -H HOST, --host=HOST Enea uCPE Manager host name or IP address
1900 -i IMAGENAME, --imageName=IMAGENAME 1902 -i IMAGENAME, --imageName=IMAGENAME
1901 NFVA Image name 1903 NFVA Image name
1902 -m MODULE, --module=MODULE 1904 -m MODULE, --module=MODULE
@@ -1909,7 +1911,7 @@ Options:
1909 <section id="json_delete_upload"> 1911 <section id="json_delete_upload">
1910 <title>Configuring the JSON File</title> 1912 <title>Configuring the JSON File</title>
1911 1913
1912 <para>The JSON configuration file needed to delete a Enea Edge image 1914 <para>The JSON configuration file needed to delete an Enea Edge image
1913 should contain a list of dictionaries. Each dictionary indicates the 1915 should contain a list of dictionaries. Each dictionary indicates the
1914 test case name and the test case arguments passed to the 1916 test case name and the test case arguments passed to the
1915 <filename>deleteUpgradeFile</filename> Python module.</para> 1917 <filename>deleteUpgradeFile</filename> Python module.</para>
@@ -1917,7 +1919,7 @@ Options:
1917 <para><emphasis role="bold">Sample unit-test JSON file 1919 <para><emphasis role="bold">Sample unit-test JSON file
1918 format:</emphasis><programlisting>[ 1920 format:</emphasis><programlisting>[
1919 { 1921 {
1920 "name": "Delete NFVA image on Enea Edge Management", 1922 "name": "Delete NFVA image on uCPE Manager",
1921 "args": "-i enea-nfv-access-xeon-d.rootfs.ostree.tar.bz2" 1923 "args": "-i enea-nfv-access-xeon-d.rootfs.ostree.tar.bz2"
1922 } 1924 }
1923]</programlisting></para> 1925]</programlisting></para>
@@ -1932,7 +1934,7 @@ Options:
1932 <programlisting>$ python deleteUpgradeFile.py -u admin -p admin -H localhost -i \ 1934 <programlisting>$ python deleteUpgradeFile.py -u admin -p admin -H localhost -i \
1933enea-nfv-access-xeon-d.rootfs.ostree.tar.bz2 1935enea-nfv-access-xeon-d.rootfs.ostree.tar.bz2
19342020-02-28 12:06:20,111 - DEBUG: Started logging 19362020-02-28 12:06:20,111 - DEBUG: Started logging
19352020-02-28 12:06:20,112 - INFO: Delete NFVA image from Enea Edge Management 19372020-02-28 12:06:20,112 - INFO: Delete NFVA image from uCPE Manager
19362020-02-28 12:06:20,210 - DEBUG: Login successful on host 'localhost' 19382020-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 19392020-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 \ 19402020-02-28 12:06:20,255 - INFO: The image \
@@ -1948,10 +1950,10 @@ image was successfully removed
1948 </section> 1950 </section>
1949 1951
1950 <section id="install_activate_vnf_image"> 1952 <section id="install_activate_vnf_image">
1951 <title>Installing and activating a Enea Edge image on an uCPE device 1953 <title>Installing and activating an Enea Edge image on an uCPE device
1952 from the Enea Edge Management</title> 1954 from the Enea Edge Management</title>
1953 1955
1954 <para>Steps and options on how to Install and Activate a Enea Edge 1956 <para>Steps and options on how to Install and Activate an Enea Edge
1955 image on an uCPE device from the Enea Edge Management are described 1957 image on an uCPE device from the Enea Edge Management are described
1956 below.</para> 1958 below.</para>
1957 1959
@@ -1959,19 +1961,19 @@ image was successfully removed
1959 <title>Script Options</title> 1961 <title>Script Options</title>
1960 1962
1961 <programlisting>$ python installAndActivate.py -h 1963 <programlisting>$ python installAndActivate.py -h
1962Install and activate NFVA image from Enea Edge Management 1964Install and activate NFVA image from uCPE Manager
1963Usage: installAndActivate.py [options] 1965Usage: installAndActivate.py [options]
1964 1966
1965Install and activate NFVA image from Enea Edge Management. 1967Install and activate NFVA image from uCPE Manager.
1966 1968
1967Options: 1969Options:
1968 --version show program's version number and exit 1970 --version show program's version number and exit
1969 -h, --help show this help message and exit 1971 -h, --help show this help message and exit
1970 -u USERNAME, --username=USERNAME 1972 -u USERNAME, --username=USERNAME
1971 Enea Edge Management login username 1973 Enea uCPE Manager login username
1972 -p PASSWORD, --password=PASSWORD 1974 -p PASSWORD, --password=PASSWORD
1973 Enea Edge Management login password 1975 Enea uCPE Manager login password
1974 -H HOST, --host=HOST Enea Edge Management host name or IP address 1976 -H HOST, --host=HOST Enea uCPE Manager host name or IP address
1975 -i IMAGENAME, --imageName=IMAGENAME 1977 -i IMAGENAME, --imageName=IMAGENAME
1976 Image name 1978 Image name
1977 -m MODULE, --module=MODULE 1979 -m MODULE, --module=MODULE
@@ -1989,7 +1991,7 @@ Options:
1989 <section id="json_install_activate"> 1991 <section id="json_install_activate">
1990 <title>Configuring the JSON File</title> 1992 <title>Configuring the JSON File</title>
1991 1993
1992 <para>The JSON configuration file needed to install and activate a Enea Edge 1994 <para>The JSON configuration file needed to install and activate an Enea Edge
1993 image on a uCPE device from the Enea Edge Management should 1995 image on a uCPE device from the Enea Edge Management should
1994 contain a list of dictionaries. Each dictionary indicates the test 1996 contain a list of dictionaries. Each dictionary indicates the test
1995 case name and the test case arguments passed to the 1997 case name and the test case arguments passed to the
@@ -2000,7 +2002,7 @@ Options:
2000 2002
2001 <programlisting>[ 2003 <programlisting>[
2002 { 2004 {
2003 "name": "Install and activate NFVA image on uCPE device from Enea Edge Management", 2005 "name": "Install and activate NFVA image on uCPE device from uCPE Manager",
2004 "args": "-i enea-nfv-access-xeon-d.rootfs.ostree.tar.bz2 -t xeon_d -d inteld1521-16" 2006 "args": "-i enea-nfv-access-xeon-d.rootfs.ostree.tar.bz2 -t xeon_d -d inteld1521-16"
2005 } 2007 }
2006]</programlisting> 2008]</programlisting>
@@ -2015,7 +2017,7 @@ Options:
2015 <programlisting>$ python installAndActivate.py -u admin -p admin -H localhost -i \ 2017 <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 2018enea-nfv-access-xeon-d.rootfs.ostree.tar.bz2 -t xeon_d -d inteld1521-16
20172020-02-28 12:36:46,137 - DEBUG: Started logging 20192020-02-28 12:36:46,137 - DEBUG: Started logging
20182020-02-28 12:36:46,138 - INFO: Install and activate NFVA image from Enea Edge Management 20202020-02-28 12:36:46,138 - INFO: Install and activate NFVA image from uCPE Manager
20192020-02-28 12:36:46,288 - DEBUG: Login successful on host 'localhost' 20212020-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 20222020-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' 20232020-02-28 12:36:46,325 - DEBUG: Found device with name 'inteld1521-16'
@@ -2074,10 +2076,10 @@ Options:
2074 --version show program's version number and exit 2076 --version show program's version number and exit
2075 -h, --help show this help message and exit 2077 -h, --help show this help message and exit
2076 -u USERNAME, --username=USERNAME 2078 -u USERNAME, --username=USERNAME
2077 Enea Edge Management login username 2079 Enea uCPE Manager login username
2078 -p PASSWORD, --password=PASSWORD 2080 -p PASSWORD, --password=PASSWORD
2079 Enea Edge Management login password 2081 Enea uCPE Manager login password
2080 -H HOST, --host=HOST Enea Edge Management host name or IP address 2082 -H HOST, --host=HOST Enea uCPE Manager host name or IP address
2081 2083
2082 Mandatory options: 2084 Mandatory options:
2083 -H/--host </programlisting> 2085 -H/--host </programlisting>
@@ -2122,16 +2124,16 @@ Options:
21222020-04-14 10:26:23,582 - INFO: Upload Custom Script 21242020-04-14 10:26:23,582 - INFO: Upload Custom Script
2123Usage: upload.py [options] 2125Usage: upload.py [options]
2124 2126
2125Add a Custom Script to Enea Edge Management 2127Add a Custom Script to Enea uCPE Manager
2126 2128
2127Options: 2129Options:
2128 --version show program's version number and exit 2130 --version show program's version number and exit
2129 -h, --help show this help message and exit 2131 -h, --help show this help message and exit
2130 -u USERNAME, --username=USERNAME 2132 -u USERNAME, --username=USERNAME
2131 Enea Edge Management login username 2133 Enea uCPE Manager login username
2132 -p PASSWORD, --password=PASSWORD 2134 -p PASSWORD, --password=PASSWORD
2133 Enea Edge Management login password 2135 Enea uCPE Manager login password
2134 -H HOST, --host=HOST Enea Edge Management host name or IP address 2136 -H HOST, --host=HOST Enea uCPE Manager host name or IP address
2135 -f CUSTOMSCRIPT, --file=CUSTOMSCRIPT 2137 -f CUSTOMSCRIPT, --file=CUSTOMSCRIPT
2136 Custom Script File 2138 Custom Script File
2137 -e PHASE, --phase=PHASE 2139 -e PHASE, --phase=PHASE
@@ -2156,7 +2158,7 @@ Options:
2156 2158
2157 <programlisting>[ 2159 <programlisting>[
2158 { 2160 {
2159 "name": "Uploading a Custom Script to the Enea Edge Management", 2161 "name": "Uploading a Custom Script to the uCPE Manager",
2160 "args": "-f ../../lab_config/customScripts/test_success_after_always \ 2162 "args": "-f ../../lab_config/customScripts/test_success_after_always \
2161 -e always-after-startup" 2163 -e always-after-startup"
2162 } 2164 }
@@ -2175,7 +2177,7 @@ Options:
21752020-04-14 14:08:02,915 - INFO: Upload Custom Script 21772020-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' 21782020-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 21792020-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 Enea Edge Management. \ 21802020-04-14 14:08:02,996 - DEBUG: Upload test_success_after_always to uCPE Manager. \
2179Content: #!/bin/bash 2181Content: #!/bin/bash
2180echo test_success_after_always 2182echo test_success_after_always
21812020-04-14 14:08:03,138 - INFO: Done 21832020-04-14 14:08:03,138 - INFO: Done
@@ -2203,12 +2205,12 @@ Options:
2203 --version show program's version number and exit 2205 --version show program's version number and exit
2204 -h, --help show this help message and exit 2206 -h, --help show this help message and exit
2205 -u USERNAME, --username=USERNAME 2207 -u USERNAME, --username=USERNAME
2206 Enea Edge Management login username 2208 Enea uCPE Manager login username
2207 -p PASSWORD, --password=PASSWORD 2209 -p PASSWORD, --password=PASSWORD
2208 Enea Edge Management login password 2210 Enea uCPE Manager login password
2209 -H HOST, --host=HOST Enea Edge Management host name or IP address 2211 -H HOST, --host=HOST Enea uCPE Manager host name or IP address
2210 -c CUSTOMSCRIPTNAME, --customScriptName=CUSTOMSCRIPTNAME 2212 -c CUSTOMSCRIPTNAME, --customScriptName=CUSTOMSCRIPTNAME
2211 Custom Script Name that resides on Enea Edge Management 2213 Custom Script Name that resides on Enea uCPE Manager
2212 -e PHASE, --phase=PHASE 2214 -e PHASE, --phase=PHASE
2213 Execution phase. Must be one of the following: once- 2215 Execution phase. Must be one of the following: once-
2214 before-startup | always-before-startup | once-after- 2216 before-startup | always-before-startup | once-after-
@@ -2236,7 +2238,7 @@ Options:
2236 2238
2237 <programlisting>[ 2239 <programlisting>[
2238{ 2240{
2239"name": "Uploading a Custom Script from Enea Edge Management to device", 2241"name": "Uploading a Custom Script from uCPE Manager to device",
2240"args": "-c test_success_after_always -e always-after-startup -n inteld1521-6" 2242"args": "-c test_success_after_always -e always-after-startup -n inteld1521-6"
2241} 2243}
2242]</programlisting> 2244]</programlisting>
@@ -2272,7 +2274,7 @@ test_success_after_always -e always-after-startup -n inteld1521-6
2272 <title>Script Options</title> 2274 <title>Script Options</title>
2273 2275
2274 <programlisting>$ python customScripts/delete.py -h 2276 <programlisting>$ python customScripts/delete.py -h
22752020-04-14 14:36:52,010 - INFO: Delete Custom Script on Enea Edge Management 22772020-04-14 14:36:52,010 - INFO: Delete Custom Script on uCPE Manager
2276Usage: delete.py [options] 2278Usage: delete.py [options]
2277 2279
2278Delete a Custom Script from a Device 2280Delete a Custom Script from a Device
@@ -2281,10 +2283,10 @@ Options:
2281 --version show program's version number and exit 2283 --version show program's version number and exit
2282 -h, --help show this help message and exit 2284 -h, --help show this help message and exit
2283 -u USERNAME, --username=USERNAME 2285 -u USERNAME, --username=USERNAME
2284 Enea Edge Management login username 2286 Enea uCPE Manager login username
2285 -p PASSWORD, --password=PASSWORD 2287 -p PASSWORD, --password=PASSWORD
2286 Enea Edge Management login password 2288 Enea uCPE Manager login password
2287 -H HOST, --host=HOST Enea Edge Management host name or IP address 2289 -H HOST, --host=HOST Enea uCPE Manager host name or IP address
2288 -c CUSTOMSCRIPTNAME, --customScriptName=CUSTOMSCRIPTNAME 2290 -c CUSTOMSCRIPTNAME, --customScriptName=CUSTOMSCRIPTNAME
2289 Custom Script Name that resides on a Device 2291 Custom Script Name that resides on a Device
2290 -e PHASE, --phase=PHASE 2292 -e PHASE, --phase=PHASE
@@ -2310,7 +2312,7 @@ Options:
2310 2312
2311 <programlisting>[ 2313 <programlisting>[
2312{ 2314{
2313"name": "Removing a Custom Script from Enea Edge Management", 2315"name": "Removing a Custom Script from uCPE Manager",
2314"args": "-c test_success_after_always -e always-after-startup" 2316"args": "-c test_success_after_always -e always-after-startup"
2315} 2317}
2316]</programlisting> 2318]</programlisting>
@@ -2325,12 +2327,12 @@ Options:
2325 <programlisting>$ python automation_framework/customScripts/delete.py -c \ 2327 <programlisting>$ python automation_framework/customScripts/delete.py -c \
2326test_success_after_always -e always-after-startup 2328test_success_after_always -e always-after-startup
23272020-04-14 14:39:22,042 - DEBUG: Started logging 23292020-04-14 14:39:22,042 - DEBUG: Started logging
23282020-04-14 14:39:22,042 - INFO: Delete Custom Script on Enea Edge Management 23302020-04-14 14:39:22,042 - INFO: Delete Custom Script on uCPE Manager
23292020-04-14 14:39:22,081 - DEBUG: Login successful on host '172.24.3.109' 23312020-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 23322020-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' 23332020-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, \ 23342020-04-14 14:39:22,099 - DEBUG: Delete script test_success_after_always, \
2333phase always-after-startup from Enea Edge Management 2335phase always-after-startup from uCPE Manager
23342020-04-14 14:39:22,118 - INFO: Done 23362020-04-14 14:39:22,118 - INFO: Done
23352020-04-14 14:39:22,135 - DEBUG: Logging out and exiting...</programlisting> 23372020-04-14 14:39:22,135 - DEBUG: Logging out and exiting...</programlisting>
2336 </section> 2338 </section>
@@ -2355,10 +2357,10 @@ Options:
2355 --version show program's version number and exit 2357 --version show program's version number and exit
2356 -h, --help show this help message and exit 2358 -h, --help show this help message and exit
2357 -u USERNAME, --username=USERNAME 2359 -u USERNAME, --username=USERNAME
2358 Enea Edge Management login username 2360 Enea uCPE Manager login username
2359 -p PASSWORD, --password=PASSWORD 2361 -p PASSWORD, --password=PASSWORD
2360 Enea Edge Management login password 2362 Enea uCPE Manager login password
2361 -H HOST, --host=HOST Enea Edge Management host name or IP address 2363 -H HOST, --host=HOST Enea uCPE Manager host name or IP address
2362 -c CUSTOMSCRIPTNAME, --customScriptName=CUSTOMSCRIPTNAME 2364 -c CUSTOMSCRIPTNAME, --customScriptName=CUSTOMSCRIPTNAME
2363 Custom Script Name that resides on a Device 2365 Custom Script Name that resides on a Device
2364 -e PHASE, --phase=PHASE 2366 -e PHASE, --phase=PHASE
@@ -2477,7 +2479,7 @@ phase always-after-startup from inteld1521-6
24772020-04-14 14:08:02,915 - INFO: Upload Custom Script 24792020-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' 24802020-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 24812020-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 Enea Edge Management. \ 24822020-04-14 14:08:02,996 - DEBUG: Upload test_success_after_always to uCPE Manager. \
2481Content: #!/bin/bash 2483Content: #!/bin/bash
2482echo test_success_after_always 2484echo test_success_after_always
24832020-04-14 14:08:03,138 - INFO: Done 24852020-04-14 14:08:03,138 - INFO: Done
@@ -2522,12 +2524,12 @@ phase always-after-startup from inteld1521-6
2522 <programlisting>$ python automation_framework/customScripts/delete.py -c \ 2524 <programlisting>$ python automation_framework/customScripts/delete.py -c \
2523test_success_after_always -e always-after-startup 2525test_success_after_always -e always-after-startup
25242020-04-14 14:39:22,042 - DEBUG: Started logging 25262020-04-14 14:39:22,042 - DEBUG: Started logging
25252020-04-14 14:39:22,042 - INFO: Delete Custom Script on Enea Edge Management 25272020-04-14 14:39:22,042 - INFO: Delete Custom Script on uCPE Manager
25262020-04-14 14:39:22,081 - DEBUG: Login successful on host '172.24.3.109' 25282020-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 25292020-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' 25302020-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, \ 25312020-04-14 14:39:22,099 - DEBUG: Delete script test_success_after_always, \
2530phase always-after-startup from Enea Edge Management 2532phase always-after-startup from uCPE Manager
25312020-04-14 14:39:22,118 - INFO: Done 25332020-04-14 14:39:22,118 - INFO: Done
25322020-04-14 14:39:22,135 - DEBUG: Logging out and exiting...</programlisting> 25342020-04-14 14:39:22,135 - DEBUG: Logging out and exiting...</programlisting>
2533 </section> 2535 </section>
@@ -2599,10 +2601,10 @@ Options:
2599 --version show program's version number and exit 2601 --version show program's version number and exit
2600 -h, --help show this help message and exit 2602 -h, --help show this help message and exit
2601 -u USERNAME, --username=USERNAME 2603 -u USERNAME, --username=USERNAME
2602 Enea Edge Management login username 2604 Enea uCPE Manager login username
2603 -p PASSWORD, --password=PASSWORD 2605 -p PASSWORD, --password=PASSWORD
2604 Enea Edge Management login password 2606 Enea uCPE Manager login password
2605 -H HOST, --host=HOST Enea Edge Management host name or IP address 2607 -H HOST, --host=HOST Enea uCPE Manager host name or IP address
2606 -s STORE, --store=STORE 2608 -s STORE, --store=STORE
2607 Offline config store name 2609 Offline config store name
2608 -d DEVICE, --device=DEVICE 2610 -d DEVICE, --device=DEVICE
@@ -2645,10 +2647,10 @@ Options:
2645 --version show program's version number and exit 2647 --version show program's version number and exit
2646 -h, --help show this help message and exit 2648 -h, --help show this help message and exit
2647 -u USERNAME, --username=USERNAME 2649 -u USERNAME, --username=USERNAME
2648 Enea Edge Management login username 2650 Enea uCPE Manager login username
2649 -p PASSWORD, --password=PASSWORD 2651 -p PASSWORD, --password=PASSWORD
2650 Enea Edge Management login password 2652 Enea uCPE Manager login password
2651 -H HOST, --host=HOST Enea Edge Management host name or IP address 2653 -H HOST, --host=HOST Enea uCPE Manager host name or IP address
2652 -d DEVICE, --device=DEVICE 2654 -d DEVICE, --device=DEVICE
2653 Device Name 2655 Device Name
2654 2656
@@ -2696,16 +2698,16 @@ Options:
2696 <programlisting>python removeConfigStore.py -h 2698 <programlisting>python removeConfigStore.py -h
2697Usage: removeConfigStore.py [options] 2699Usage: removeConfigStore.py [options]
2698 2700
2699Remove a config store from Enea Edge Management. 2701Remove a config store from Enea uCPE Manager.
2700 2702
2701Options: 2703Options:
2702 --version show program's version number and exit 2704 --version show program's version number and exit
2703 -h, --help show this help message and exit 2705 -h, --help show this help message and exit
2704 -u USERNAME, --username=USERNAME 2706 -u USERNAME, --username=USERNAME
2705 Enea Edge Management login username 2707 Enea uCPE Manager login username
2706 -p PASSWORD, --password=PASSWORD 2708 -p PASSWORD, --password=PASSWORD
2707 Enea Edge Management login password 2709 Enea uCPE Manager login password
2708 -H HOST, --host=HOST Enea Edge Management host name or IP address 2710 -H HOST, --host=HOST Enea uCPE Manager host name or IP address
2709 -o STORENAME, --store-name=STORENAME 2711 -o STORENAME, --store-name=STORENAME
2710 Name of the Offline Config Store 2712 Name of the Offline Config Store
2711 2713
diff --git a/doc/book-enea-edge-auto-fw-th-user-guide/doc/components.xml b/doc/book-enea-edge-auto-fw-th-user-guide/doc/components.xml
index 24a7a29..33c1135 100644
--- a/doc/book-enea-edge-auto-fw-th-user-guide/doc/components.xml
+++ b/doc/book-enea-edge-auto-fw-th-user-guide/doc/components.xml
@@ -3,7 +3,7 @@
3 <title>Components</title> 3 <title>Components</title>
4 4
5 <para>An overview of the Enea Edge Runtime and the Edge Management 5 <para>An overview of the Enea Edge Runtime and the Edge Management
6 in cooperation with the Automation Framework and Test Harness, will 6 in cooperation with the Enea Edge Automation Framework and Test Harness, will
7 be presented in detail.</para> 7 be presented in detail.</para>
8 8
9 <figure> 9 <figure>
@@ -28,7 +28,7 @@
28 28
29 <para>The Enea Edge Management 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 Edge "devices", these are the virtualized CPE devices 31 manage Enea Edge Runtime "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 Edge Management installation instructions, please 34 <para>For more on Enea Edge Management installation instructions, please
@@ -49,7 +49,7 @@
49 known to the Enea Edge Management 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 Enea Edge Automation Framework and
53 Test Harness, make sure the uCPE device(s) have been added to the Edge Management.</para> 53 Test Harness, make sure the uCPE device(s) have been added to the Edge Management.</para>
54 </note> 54 </note>
55 55
@@ -83,7 +83,7 @@
83 <section id="automation"> 83 <section id="automation">
84 <title>Automation Framework</title> 84 <title>Automation Framework</title>
85 85
86 <para>Testing can be performed by running the available Python scripts 86 <para>Testing can be performed by running Automation Framework (AF) Python scripts
87 against the Enea Edge Management REST API (Python samples supplied). This can be 87 against the Enea Edge Management REST API (Python samples supplied). This can be
88 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
89 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
@@ -100,7 +100,7 @@
100 100
101 <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
102 Ansible Playbooks, by running the python modules from the Automation 102 Ansible Playbooks, by running the python modules from the Automation
103 Framework (AF) and by direct connection over SSH to the boards that run 103 Framework and by direct connection over SSH to the boards that run
104 Enea Edge.</para> 104 Enea Edge.</para>
105 105
106 <para>The Test Harness includes an automated test suite that 106 <para>The Test Harness includes an automated test suite that
diff --git a/doc/book-enea-edge-auto-fw-th-user-guide/doc/getting_started.xml b/doc/book-enea-edge-auto-fw-th-user-guide/doc/getting_started.xml
index 97666cf..1a6dc0b 100644
--- a/doc/book-enea-edge-auto-fw-th-user-guide/doc/getting_started.xml
+++ b/doc/book-enea-edge-auto-fw-th-user-guide/doc/getting_started.xml
@@ -1,12 +1,12 @@
1<?xml version="1.0" encoding="ISO-8859-1"?> 1<?xml version="1.0" encoding="ISO-8859-1"?>
2<chapter id="getting_started"> 2<chapter id="getting_started">
3 <title>Getting Started with the Automation Framework and Test 3 <title>Getting Started with the Enea Edge Automation Framework and Test
4 Harness</title> 4 Harness</title>
5 5
6 <section id="prerequisites"> 6 <section id="prerequisites">
7 <title>Prerequisites</title> 7 <title>Prerequisites</title>
8 8
9 <para>For installation of the Automation Framework and Test Harness a 9 <para>For installation of the Enea Edge Automation Framework and Test Harness a
10 CentOS 7 host machine is needed with support for:</para> 10 CentOS 7 host machine is needed with support for:</para>
11 11
12 <itemizedlist> 12 <itemizedlist>
@@ -28,7 +28,7 @@
28 </itemizedlist> 28 </itemizedlist>
29 29
30 <note> 30 <note>
31 <para>The Automation Framework and Test Harness installation may be done 31 <para>The Enea Edge Automation Framework and Test Harness installation may be done
32 on the same machine used for Enea Edge Management 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"
@@ -166,7 +166,7 @@
166 <orderedlist> 166 <orderedlist>
167 <listitem> 167 <listitem>
168 <para>Unzip the 168 <para>Unzip the
169 <filename>Enea_NFV_Access_AF-TH_&lt;version&gt;-build&lt;build_number&gt;.zip</filename> 169 <filename>Enea_Edge_AF-TH_&lt;version&gt;-build&lt;build_number&gt;.zip</filename>
170 archive file, provided by Enea, on a supported host machine.</para> 170 archive file, provided by Enea, on a supported host machine.</para>
171 171
172 <para>The directory in which the archive has been unpacked will be 172 <para>The directory in which the archive has been unpacked will be
@@ -187,9 +187,9 @@
187 <para>Create the Enea Edge Management 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":"Enea Edge Management Username", 190"ucpe_usr":"uCPE Manager Username",
191"ucpe_pass":"Enea Edge Management Password", 191"ucpe_pass":"uCPE Manager Password",
192"ucpe_host":"Enea Edge Management IP/Hostname", 192"ucpe_host":"uCPE Manager 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"
@@ -221,7 +221,7 @@
221 <literal>&lt;AF-THinstall-dir&gt;</literal> directory.</para> 221 <literal>&lt;AF-THinstall-dir&gt;</literal> directory.</para>
222 222
223 <para>Subsequent use of the installation requires activating the Python 223 <para>Subsequent use of the installation requires activating the Python
224 virtual enviroment before using the Automation Framework and Test Harness: 224 virtual enviroment before using the Enea Edge Automation Framework and Test Harness:
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
@@ -231,7 +231,7 @@
231 JSON config for the new Enea Edge Management 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>Enea Edge Automation Framework and Test Harness History Information can be
235 found in the AF&amp;TH CHANGELOG file available in: 235 found in the AF&amp;TH CHANGELOG file available in:
236 <filename>&lt;AF-TH-install-dir&gt;/CHANGELOG</filename></para> 236 <filename>&lt;AF-TH-install-dir&gt;/CHANGELOG</filename></para>
237 </note> 237 </note>
diff --git a/doc/book-enea-edge-auto-fw-th-user-guide/doc/overview.xml b/doc/book-enea-edge-auto-fw-th-user-guide/doc/overview.xml
index b2486a0..4fec3d9 100644
--- a/doc/book-enea-edge-auto-fw-th-user-guide/doc/overview.xml
+++ b/doc/book-enea-edge-auto-fw-th-user-guide/doc/overview.xml
@@ -2,8 +2,7 @@
2<chapter id="overview"> 2<chapter id="overview">
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 Enea Edge Automation Framework and Test Harness, 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> 6 run these software tools.</para>
8 7
9 <section id="descrip"> 8 <section id="descrip">
@@ -40,7 +39,7 @@
40 <row> 39 <row>
41 <entry>Enea Edge</entry> 40 <entry>Enea Edge</entry>
42 41
43 <entry>The Enea Edge (with ODM) Runtime and the 42 <entry>The Enea Edge Runtime and the
44 Enea Edge Management.</entry> 43 Enea Edge Management.</entry>
45 </row> 44 </row>
46 </tbody> 45 </tbody>
@@ -128,12 +127,7 @@
128 <entry>Network Functions Virtualization.</entry> 127 <entry>Network Functions Virtualization.</entry>
129 </row> 128 </row>
130 129
131 <row> 130
132 <entry>ODM</entry>
133
134 <entry>Enea Element On Device Management.</entry>
135 </row>
136
137 <row> 131 <row>
138 <entry>OVS</entry> 132 <entry>OVS</entry>
139 133
generated by cgit v1.2.3-54-g00ecf (git 2.39.0) at 2025-11-08 03:12:10 +0000