path: root/doc/book-enea-nfv-access-auto-fw-th-user-guide/doc/automation_framework_test_harness.xml

<?xml version="1.0" encoding="ISO-8859-1"?>
<chapter id="auto_fw_test_harness">
  <title>Automation Framework and Test Harness</title>

  <section id="auto_fw">
    <title>Automation Framework</title>

    <para>All Automation Framework sources are under the
    <literal>&lt;AF-TH-install-dir&gt;/automation_framework</literal>
    directory.</para>

    <para>The <literal>/device</literal> folder contains Python scripts for
    adding uCPE device(s), receiving uCPE events' reports, removing a uCPE
    device, waiting for a uCPE device to connect to the uCPE Manager, as well
    as scripts for adding and removing an offline configuration store.</para>

    <para>The <literal>/network</literal> folder contains Python scripts for
    binding or unbinding a network interface to and from a uCPE device (DPDK or
    SR-IOV), creating or deleting an OVS network bridge, or dumping network
    interface information about the available interfaces. Three of the scripts
    mentioned here (binding, creating, deleting) are also applicable for an
    Offline Configuration Store.</para>

    <note>
      <para>Commands within the network folder that include the option
      <emphasis role="bold">-o</emphasis> allow the user to perform the action
      in an offline configuration store alternative available for use at a
      later setup time. All options contain either <emphasis
      role="bold">-n</emphasis>, <emphasis role="bold">-o</emphasis> or both.
      One of them must always be provided, if both are provided, -o has
      priority, and -n is thus ignored.</para>
    </note>

    <para>The <literal>/unittestSuite</literal> folder contains Python
    unit-test class and loader scripts for generating specific test cases for
    the available Python scripts. The generated test cases are injected into
    the Python unit-test suite class to be run using the Python unit-test
    framework.</para>

    <para>The <literal>/unittestSuite/config</literal> folder contains
    configuration files in JSON format that describe the list of test cases
    for a particular Python script. Each defined test case is a dictionary
    that must contain the test case name and arguments to be passed to the
    Python script for running the test case.</para>

    <para>The <literal>/vnf</literal> folder contains Python scripts for
    onboarding and offboarding a VNF image, instantiating a VNF, controlling a
    VNF instance or destroying an existing one.</para>

    <para>The <filename>eneaUcpeMgr.py</filename> file acts as a library for
    the (Python) Automation Framework scripts. It contains common functions
    and unit-test configuration options.</para>

    <section id="python_testsuite">
      <title>Python Unit-Test Suite</title>

      <para>The Python unit-test class defined in the
      <filename>unittestSuite.py</filename> script provides a way to automate
      the execution of specific test cases for each supported Python
      script.</para>

      <para>This class requires a test suite configuration JSON file that
      contains a dictionary list of the Python scripts to be processed. Each
      dictionary must contain the path of the Python script to be loaded and
      the path to the file describing the test cases to be performed against
      the designated script.</para>

      <para>Steps for running the Python unit-test suite on the uCPE Manager
      are provided below.</para>

      <section id="script_opts">
        <title>Script Options</title>

        <programlisting>$ python unittestSuite.py -h
Usage: unittestSuite.py [options]

Run selected unit-test suite against Enea uCPE Manager.

Options:
  --version             show program's version number and exit
  -h, --help            show this help message and exit
  -u USERNAME, --username=USERNAME
                        Enea uCPE Manager login username
  -p PASSWORD, --password=PASSWORD
                        Enea uCPE Manager login password
  -H HOST, --host=HOST  Enea uCPE Manager host name or IP address
  -n DEVICENAME, --deviceName=DEVICENAME
                        Name of vCPE device (Virtual Infrastructure Manager)
  -s SUITEFILE, --suite=SUITEFILE
                        Test suite configuration file in JSON format
  -d DESCRIPTION, --description=DESCRIPTION
                        Test suite description
  -o OFFLINE, --offline=OFFLINE
                        Offline Configuration(ZTP)

  Mandatory options:
    -H/--host, -n/--deviceName, -s/--suiteFile, -d/--description</programlisting>
      </section>

      <section id="config_ut_json">
        <title>Configuring Unit-Test JSON File</title>

        <para>The Unit-Test suite JSON configuration file contains a list of
        dictionaries. Each dictionary indicates the path of the Python module
        to load and the test case's configuration file to be executed against
        the loaded module.</para>

        <para>Below is a sample unit-test configuration file, describing the
        Fortigate <emphasis role="bold">deployment</emphasis> scenario
        <filename>fortigateDeploy.json</filename>:</para>

        <para><programlisting>[
   {
      "config": "config/waitDeviceUp.json",
      "module": "../device/waitDeviceUp.py"
   },
   {
      "config": "config/bindNetworkInterface.json",
      "module": "../network/bindNetworkInterface.py"
   },
   {
      "config": "config/newNetworkBridge.json",
      "module": "../network/newNetworkBridge.py"
   },
   {
      "config": "config/onboardVNFRaw.json",
      "module": "../vnf/onboardVNFRaw.py"
   },
   {
      "config": "config/instantiateVNFI.json",
      "module": "../vnf/instantiateVNFI.py"
   },
   {
      "config": "config/controlVNFI.json",
      "module": "../vnf/controlVNFI.py"
   }
]</programlisting></para>

        <para>Below is a sample unit-test configuration file, describing the
        Fortigate <emphasis role="bold">cleanup</emphasis> scenario
        <filename>fortigateCleanup.json</filename>:</para>

        <programlisting>[
   {
      "config": "config/destroyVNFI.json",
      "module": "../vnf/destroyVNFI.py"
   },
   {
      "config": "config/delNetworkBridge.json",
      "module": "../network/delNetworkBridge.py"
   },
   {
      "config": "config/unbindNetworkInterface.json",
      "module": "../network/unbindNetworkInterface.py"
   },
   {
      "config": "config/offboardVNF.json",
      "module": "../vnf/offboardVNF.py"
   }
]</programlisting>

        <para>The <literal>config</literal> key contains the path to the test
        case's configuration file.</para>

        <para>The <literal>module</literal> key contains the path to the
        Python script to be executed.</para>
      </section>

      <section id="ut_config_opts">
        <title>Unit-Test Configuration Options</title>

        <para>Unit-test behavior can be tweaked through setting any of the
        following options. This is done through the
        <filename>eneaUcpeMgr.py</filename> file:</para>

        <programlisting># Defaults for the framework
username = "admin"
password = "admin"
host = None
deviceName = None
directory =  "."
ftpUsername = "ftp"
ftpPassword = "ftp"
ftpPort = "2021"

# Stop the test run on the first error or failure
failfast = True

# Logging levels ordered by the highest severity:
#  CRITICAL      50
#  ERROR         40
#  WARNING       30
#  INFO          20
#  DEBUG         10
#  NOTSET        0
fileLoggingLevel = logging.DEBUG
consoleLoggingLevel = logging.INFO
</programlisting>

        <table>
          <title>eneaUcpeMgr.py Options</title>

          <tgroup cols="2">
            <colspec align="left" />

            <colspec colwidth="2*" />

            <colspec colwidth="5*" />

            <thead>
              <row>
                <entry align="center">Option</entry>

                <entry align="center">Description</entry>
              </row>
            </thead>

            <tbody>
              <row>
                <entry><literal>username</literal></entry>

                <entry>The user authentication used to log into the uCPE
                Manager. This can be overwritten by setting the Python
                unit-test suite command line option
                <literal>-u</literal>.</entry>
              </row>

              <row>
                <entry><literal>password</literal></entry>

                <entry>The password used to log into the uCPE Manager. This
                can be overwritten by setting the Python unit-test suite
                command line option <literal>-p</literal>.</entry>
              </row>

              <row>
                <entry><literal>host</literal></entry>

                <entry>The IP address of the uCPE Manager host. This can be
                overwritten by setting the Python unit-test suite command line
                option <literal>-H</literal>.</entry>
              </row>

              <row>
                <entry><literal>devicename</literal></entry>

                <entry>The name of the vCPE agent against which tests will be
                performed. This can be overwritten by setting the Python
                unit-test suite command line option
                <literal>-n</literal>.</entry>
              </row>

              <row>
                <entry><literal>ftpUsername</literal></entry>

                <entry>The user authentication used for the FTP connection
                when onboarding a VNF image. This can be overwritten by
                setting the Python script command line option
                <literal>-f</literal>.</entry>
              </row>

              <row>
                <entry><literal>ftpPassword</literal></entry>

                <entry>The password used for the FTP connection when
                onboarding a VNF image. This can be overwritten by setting the
                Python script command line option
                <literal><literal>-w</literal></literal>.</entry>
              </row>

              <row>
                <entry><literal>ftpPort</literal></entry>

                <entry>The port used for the FTP connection when onboarding a
                VNF image. This can be overwritten by setting the Python
                script command line option <literal>-P</literal>.</entry>
              </row>

              <row>
                <entry><literal>failfast</literal></entry>

                <entry>Describes the unit-test execution behavior on the first
                error or failure encountered.</entry>
              </row>

              <row>
                <entry><literal>fileLoggingLevel</literal></entry>

                <entry>Sets the file logging level.</entry>
              </row>

              <row>
                <entry><literal>consoleLoggingLevel</literal></entry>

                <entry>Sets the console logging level.</entry>
              </row>
            </tbody>
          </tgroup>
        </table>
      </section>

      <section id="ut_suite_log">
        <title>Python Unit-Test Suite Logging</title>

        <para>Logging messages are displayed in the console and also saved to
        the specified log file. They are shown depending on the chosen logging
        level.</para>

        <para>Logging messages are ranked by their severity
        level:<programlisting>CRITICAL 50
ERROR 40
WARNING 30
INFO 20
DEBUG 10
NOTSET 0</programlisting></para>

        <note>
          <para>Logging messages less severe than the set logging level will
          be ignored.</para>
        </note>

        <para>Setting the console logging level to INFO is done through the
        <literal>consoleLoggingLevel</literal> option:<programlisting>consoleLoggingLevel = logging.INFO</programlisting>Setting
        the file logging level to DEBUG is done through the
        <literal>fileLoggingLevel</literal> option:<programlisting>fileLoggingLevel = logging.DEBUG</programlisting></para>
      </section>

      <section id="run_ut_suite">
        <title>Running Python Unit-Test Suite</title>

        <para>Below you'll find sample unit-test command line options for
        running the Fortigate <emphasis role="bold">deployment</emphasis>
        scenario:</para>

        <programlisting>$ python unittestSuite.py -u admin -p admin -H localhost -n intelc3850-2 -s
fortigateDeploy.json -d "Fortigate deployment scenario"</programlisting>

        <para>Setting the console logging level to DEBUG:</para>

        <para><programlisting>consoleLoggingLevel = logging.DEBUG</programlisting>
        <emphasis role="bold">Expected Output:</emphasis></para>

        <programlisting>2020-04-15 07:58:40,668 - DEBUG: Started logging

Running Fortigate deployment scenario...

test 001: Wait VCPE Agent device be up (__main__.UnittestSuite) ...
2020-04-15 07:58:40,681 - INFO: Wait uCPE device
2020-04-15 07:58:40,722 - DEBUG: Login successful on host 'localhost'
2020-04-15 07:58:40,723 - DEBUG: Session token is: 280028c0-7ede-11ea-a9a8-02429dc76bdd
2020-04-15 07:58:40,746 - DEBUG: Found device with name 'intelc3850-2'
2020-04-15 07:58:40,747 - DEBUG: Wait for device 'intelc3850-2' to connect
2020-04-15 07:58:41,769 - DEBUG: HACK: sleep 30s more
2020-04-15 07:59:11,791 - DEBUG: HACK: continue
2020-04-15 07:59:11,792 - INFO: Status: Connected
2020-04-15 07:59:11,793 - INFO: Done
2020-04-15 07:59:11,827 - DEBUG: Logging out and exiting...
ok
test 002: Bind lan NIC to DPDK (__main__.UnittestSuite) ...
2020-04-15 07:59:11,832 - INFO: Bind NIC
2020-04-15 07:59:11,868 - DEBUG: Login successful on host 'localhost'
2020-04-15 07:59:11,870 - DEBUG: Session token is: 3a90a960-7ede-11ea-a9a8-02429dc76bdd
2020-04-15 07:59:11,897 - DEBUG: Found device with name 'intelc3850-2'
2020-04-15 07:59:11,898 - DEBUG: Bind NIC 'eno6' to dpdk
2020-04-15 07:59:12,952 - INFO: Done
2020-04-15 07:59:12,983 - DEBUG: Logging out and exiting...
ok
test 003: Bind wan NIC to DPDK (__main__.UnittestSuite) ...
2020-04-15 07:59:12,986 - INFO: Bind NIC
2020-04-15 07:59:13,023 - DEBUG: Login successful on host 'localhost'
2020-04-15 07:59:13,025 - DEBUG: Session token is: 3b410da0-7ede-11ea-a9a8-02429dc76bdd
2020-04-15 07:59:13,048 - DEBUG: Found device with name 'intelc3850-2'
2020-04-15 07:59:13,050 - DEBUG: Bind NIC 'eno8' to dpdk
2020-04-15 07:59:14,365 - INFO: Done
2020-04-15 07:59:14,392 - DEBUG: Logging out and exiting...
ok
test 004: Creating network bridge LAN  (__main__.UnittestSuite) ...
2020-04-15 07:59:14,395 - INFO: New OVS network bridge
2020-04-15 07:59:14,428 - DEBUG: Login successful on host 'localhost'
2020-04-15 07:59:14,429 - DEBUG: Session token is: 3c174961-7ede-11ea-a9a8-02429dc76bdd
2020-04-15 07:59:14,452 - DEBUG: Found device with name 'intelc3850-2'
2020-04-15 07:59:14,453 - DEBUG: Create new OVS network bridge 'lan_br'
2020-04-15 07:59:14,454 - DEBUG: Attaching interface 'eno6' to bridge 'lan_br'
2020-04-15 07:59:21,751 - INFO: Done
2020-04-15 07:59:21,779 - DEBUG: Logging out and exiting...
ok
test 005: Creating network bridge WAN  (__main__.UnittestSuite) ...
2020-04-15 07:59:21,782 - INFO: New OVS network bridge
2020-04-15 07:59:21,818 - DEBUG: Login successful on host 'localhost'
2020-04-15 07:59:21,819 - DEBUG: Session token is: 407ec231-7ede-11ea-a9a8-02429dc76bdd
2020-04-15 07:59:21,845 - DEBUG: Found device with name 'intelc3850-2'
2020-04-15 07:59:21,846 - DEBUG: Create new OVS network bridge 'wan_br'
2020-04-15 07:59:21,847 - DEBUG: Attaching interface 'eno8' to bridge 'wan_br'
2020-04-15 07:59:22,813 - INFO: Done
2020-04-15 07:59:22,845 - DEBUG: Logging out and exiting...
ok
test 006: Onboarding Fortigate VNF (wizard API) (__main__.UnittestSuite) ...
2020-04-15 07:59:22,849 - INFO: Onboard wizard
2020-04-15 07:59:22,885 - DEBUG: Login successful on host 'localhost'
2020-04-15 07:59:22,886 - DEBUG: Session token is: 4121b8f1-7ede-11ea-a9a8-02429dc76bdd
2020-04-15 07:59:22,890 - DEBUG: FTP file '../../vnf_image/fortios.qcow2' on host \
'localhost', port '2021'
2020-04-15 07:59:23,127 - DEBUG: Onboard VNF raw: fortios.qcow2
2020-04-15 07:59:27,107 - INFO: Done
2020-04-15 07:59:27,140 - DEBUG: Logging out and exiting...
ok
test 007: Instantiate Fortigate VNF (__main__.UnittestSuite) ...
2020-04-15 07:59:27,144 - INFO: Instantiate VNF
2020-04-15 07:59:27,182 - DEBUG: Login successful on host 'localhost'
2020-04-15 07:59:27,184 - DEBUG: Session token is: 43b16480-7ede-11ea-a9a8-02429dc76bdd
2020-04-15 07:59:27,207 - DEBUG: Found device with name 'intelc3850-2'
2020-04-15 07:59:27,281 - DEBUG: Found VNF descriptor with name 'fortigateImage'
2020-04-15 07:59:27,286 - DEBUG: Reading file content as text: \
vnf_config/fortigateImage/fortigateFW.conf
2020-04-15 07:59:27,359 - DEBUG: Encrypt file content: \
vnf_config/fortigateImage/fortigateFW.conf
2020-04-15 07:59:27,364 - DEBUG: Reading file content as text: \
vnf_config/fortigateImage/fortigateLicense.lic
2020-04-15 07:59:27,407 - DEBUG: Encrypt file content: \
vnf_config/fortigateImage/fortigateLicense.lic
2020-04-15 07:59:27,409 - DEBUG: Instantiate fortigateImage VNF on 'intelc3850-2'
2020-04-15 07:59:32,720 - INFO: Done
2020-04-15 07:59:32,747 - DEBUG: Logging out and exiting...
ok
test 008: Pause Fortigate VNF instance (__main__.UnittestSuite) ...
2020-04-15 07:59:32,840 - INFO: Control VNF
2020-04-15 07:59:32,877 - DEBUG: Login successful on host 'localhost'
2020-04-15 07:59:32,880 - DEBUG: Session token is: 47166170-7ede-11ea-a9a8-02429dc76bdd
2020-04-15 07:59:32,904 - DEBUG: Found device with name 'intelc3850-2'
2020-04-15 07:59:32,954 - DEBUG: Found VNF instance with name 'fortigateFWInstance'
2020-04-15 07:59:32,955 - DEBUG: Control VNF instance 'intelc3850-2', command: pause
2020-04-15 07:59:33,114 - INFO: Done
2020-04-15 07:59:33,138 - DEBUG: Logging out and exiting...
ok
test 009: Resume Fortigate VNF instance (__main__.UnittestSuite) ...
2020-04-15 07:59:33,142 - INFO: Control VNF
2020-04-15 07:59:33,174 - DEBUG: Login successful on host 'localhost'
2020-04-15 07:59:33,177 - DEBUG: Session token is: 4743b300-7ede-11ea-a9a8-02429dc76bdd
2020-04-15 07:59:33,209 - DEBUG: Found device with name 'intelc3850-2'
2020-04-15 07:59:33,257 - DEBUG: Found VNF instance with name 'fortigateFWInstance'
2020-04-15 07:59:33,258 - DEBUG: Control VNF instance 'intelc3850-2', command: resume
2020-04-15 07:59:33,365 - INFO: Done
2020-04-15 07:59:33,389 - DEBUG: Logging out and exiting...
ok
test 010: Stop Fortigate VNF instance  (__main__.UnittestSuite) ...
2020-04-15 07:59:33,393 - INFO: Control VNF
2020-04-15 07:59:33,436 - DEBUG: Login successful on host 'localhost'
2020-04-15 07:59:33,438 - DEBUG: Session token is: 476aea10-7ede-11ea-a9a8-02429dc76bdd
2020-04-15 07:59:33,467 - DEBUG: Found device with name 'intelc3850-2'
2020-04-15 07:59:33,511 - DEBUG: Found VNF instance with name 'fortigateFWInstance'
2020-04-15 07:59:33,513 - DEBUG: Control VNF instance 'intelc3850-2', command: stop
2020-04-15 07:59:33,865 - INFO: Done
2020-04-15 07:59:33,891 - DEBUG: Logging out and exiting...
ok
test 011: Start Fortigate VNF instance (__main__.UnittestSuite) ...
2020-04-15 07:59:33,895 - INFO: Control VNF
2020-04-15 07:59:33,931 - DEBUG: Login successful on host 'localhost'
2020-04-15 07:59:33,932 - DEBUG: Session token is: 47b70e41-7ede-11ea-a9a8-02429dc76bdd
2020-04-15 07:59:33,956 - DEBUG: Found device with name 'intelc3850-2'
2020-04-15 07:59:34,013 - DEBUG: Found VNF instance with name 'fortigateFWInstance'
2020-04-15 07:59:34,015 - DEBUG: Control VNF instance 'intelc3850-2', command: start
2020-04-15 07:59:36,599 - INFO: Done
2020-04-15 07:59:36,623 - DEBUG: Logging out and exiting...
ok

----------------------------------------------------------------------
Ran 11 tests in 55.946s

OK</programlisting>

        <para>Below you'll find sample unit-test command line options for
        running the Fortigate <emphasis role="bold">cleanup</emphasis>
        scenario:</para>

        <programlisting>$ python unittestSuite.py -u admin -p admin -H localhost -n intelc3850-2 -s
fortigateCleanup.json -d "Fortigate cleanup scenario"</programlisting>

        <para>Setting the console logging level to INFO: <programlisting>consoleLoggingLevel = logging.INFO</programlisting></para>

        <para><emphasis role="bold">Expected Output:</emphasis></para>

        <programlisting>Running Fortigate cleanup scenario...

test 001: Destroying Fortigate VNF (__main__.UnittestSuite) ...
2020-04-15 08:03:40,756 - INFO: Destroy VNF
2020-04-15 08:03:41,358 - INFO: Done
ok
test 002: Deleting network bridge LAN (__main__.UnittestSuite) ...
2020-04-15 08:03:41,494 - INFO: Delete OVS network bridge
2020-04-15 08:03:41,731 - INFO: Done
ok
test 003: Deleting network bridge WAN (__main__.UnittestSuite) ...
2020-04-15 08:03:41,766 - INFO: Delete OVS network bridge
2020-04-15 08:03:43,270 - INFO: Done
ok
test 004: Unbind lan NIC from DPDK (__main__.UnittestSuite) ...
2020-04-15 08:03:43,375 - INFO: Unbind NIC
2020-04-15 08:03:45,405 - INFO: Done
ok
test 005: Unbind wan NIC from DPDK (__main__.UnittestSuite) ...
2020-04-15 08:03:45,434 - INFO: Unbind NIC
2020-04-15 08:03:47,633 - INFO: Done
ok
test 006: Offboarding Fortigate VNF (__main__.UnittestSuite) ...
2020-04-15 08:03:47,701 - INFO: Offboard VNF
2020-04-15 08:03:47,919 - INFO: Done
ok

----------------------------------------------------------------------
Ran 6 tests in 7.192s

OK</programlisting>
      </section>
    </section>

    <section id="add_ucpe_device">
      <title>Adding a uCPE Device</title>

      <para>Steps for adding, configuring and running a uCPE device onto the
      uCPE manager are described below .</para>

      <section id="opts_add_device">
        <title>Script Options</title>

        <programlisting>$ python addDevice.py -h
Usage: addDevice.py [options]

Add a uCPE device in Enea uCPE Manager.

Options:
 --version show program's version number and exit
 -h, --help show this help message and exit
 -u USERNAME, --username=USERNAME
 Enea uCPE Manager login username
 -p PASSWORD, --password=PASSWORD
 Enea uCPE Manager login password
 -H HOST, --host=HOST Enea uCPE Manager host name or IP address
 -f DEVICEFILE, --file=DEVICEFILE
 File containing uCPE Information in JSON format

 Mandatory options:
 -H/--host, -f/--file</programlisting>
      </section>

      <section id="config_json_adddev">
        <title>Configuring the JSON File</title>

        <para>The JSON configuration file needed for adding a uCPE device
        should contain a list of dictionaries. Each dictionary indicates the
        test case name and the arguments passed to the
        <literal>addDevice</literal> Python module.</para>

        <para><emphasis role="bold">Sample configuration file in JSON
        format:</emphasis></para>

        <programlisting>[
 {
 "name": "Add VCPE Agent device ",
 "args": "-f ../../lab_config/intelc3850-2/intelc3850-2.json"
 }
]</programlisting>

        <para><emphasis role="bold">Sample
        <filename>intelc3850-2.json</filename> configuration
        file:</emphasis></para>

        <programlisting>{
 "name": " intelc3850-2",
 "description": "",
 "address": "192.168.1.100",
 "port": "22",
 "username": "root",
 "password": "root",
 "certificate": null,
 "passphrase": null,
 "maintMode": "false"
}</programlisting>
      </section>

      <section id="run_py_mod">
        <title>Running the Python Module</title>

        <para>The <filename>addDevice</filename> Python module can be executed
        independently by running the following command:</para>

        <programlisting>$ python addDevice.py -u admin -p admin -H localhost -f config/device.json
2019-03-07 17:33:10,755 - DEBUG: Started logging
2019-03-07 17:33:10,756 - INFO: Add uCPE device
2019-03-07 17:33:10,975 - DEBUG: Login successful on host 'localhost'
2019-03-07 17:33:10,979 - DEBUG: Session token is: 508b6ea2-40ee-11e9-a81f525400d08e1d
2019-03-07 17:33:11,049 - DEBUG: Add new device 'intelc3850-2' to uCPE Manager host
2019-03-07 17:33:11,483 - INFO: Done
2019-03-07 17:33:11,501 - DEBUG: Logging out and exiting....</programlisting>
      </section>
    </section>

    <section id="remove_ucpe_device">
      <title>Removing a uCPE Device</title>

      <para>Steps for removing a uCPE device from the uCPE manager are
      described below.</para>

      <section id="rem_script_opts">
        <title>Script Options</title>

        <programlisting>$ python removeDevice.py -h
Usage: removeDevice.py [options]

Remove a uCPE from Enea uCPE Manager.

Options:
 --version show program's version number and exit
 -h, --help show this help message and exit
 -u USERNAME, --username=USERNAME
 Enea uCPE Manager login username
 -p PASSWORD, --password=PASSWORD
 Enea uCPE Manager login password
 -H HOST, --host=HOST Enea uCPE Manager host name or IP address
 -f DEVICEFILE, --file=DEVICEFILE
 File containing uCPE Information in JSON format

 Mandatory options:
 -H/--host, -f/--file</programlisting>
      </section>

      <section id="config_json_rem">
        <title>Configuring the JSON File</title>

        <para>The JSON configuration file needed to remove a uCPE device
        should contain a list of dictionaries. Each dictionary indicates the
        test case name and the arguments passed to the
        <filename>removeDevice</filename> Python module.</para>

        <para><emphasis role="bold">Sample unit-test JSON file
        format:</emphasis></para>

        <programlisting>[
 {
 "name": "Remove VCPE Agent device ",
 "args": "-f ../../lab_config/intelc3850-2/intelc3850-2.json"
 }
]</programlisting>

        <para><emphasis role="bold">Sample
        <filename>intelc3850-2.json</filename> configuration
        file:</emphasis></para>

        <programlisting>{
 "name": "intelc3850-2"
}</programlisting>
      </section>

      <section id="Run_py_mod_rem">
        <title>Running the Python Module</title>

        <para>The <filename>removeDevice</filename> Python module can be
        executed individually by running the following command:</para>

        <programlisting>$ python removeDevice.py -u admin -p admin -H localhost -f
../../lab_config/intelc3850-2/intelc3850-2.json
2019-03-07 17:33:56,834 - DEBUG: Started logging
2019-03-07 17:33:56,835 - INFO: Remove uCPE device
2019-03-07 17:33:56,856 - DEBUG: Login successful on host 'localhost'
2019-03-07 17:33:56,856 - DEBUG: Session token is: 6bebcb43-40ee-11e9-a81f525400d08e1d
2019-03-07 17:33:56,856 - DEBUG: Delete device 'intelc3850-2' from uCPE Manager
host
2019-03-07 17:33:56,875 - DEBUG: Found device with name 'intelc3850-2'
2019-03-07 17:33:57,159 - INFO: Done
2019-03-07 17:33:57,171 - DEBUG: Logging out and exiting...</programlisting>
      </section>
    </section>

    <section id="wait_ucpe_device">
      <title>Waiting a uCPE Device</title>

      <para>Steps and details for how to Wait a uCPE device to connect to the
      uCPE Manager after installation, are described below.</para>

      <section id="wait_script_opts">
        <title>Script Options</title>

        <programlisting>$ python waitDeviceUp.py -h
Usage: waitDeviceUp.py [options]

Wait for uCPE to connect to the Enea uCPE Manager after installation.

Options:
 --version show program's version number and exit
 -h, --help show this help message and exit
 -u USERNAME, --username=USERNAME
 Enea uCPE Manager login username
 -p PASSWORD, --password=PASSWORD
 Enea uCPE Manager login password
 -H HOST, --host=HOST Enea uCPE Manager host name or IP address
 -f DEVICEFILE, --file=DEVICEFILE
 File containing uCPE Information in JSON format
 -t TIMEOUT, --timeout=TIMEOUT
 Time in seconds for maximum wait period, default =
 instant

 Mandatory options:
 -H/--host, -f/--file</programlisting>
      </section>

      <section id="config_json_wait">
        <title>Configuring the JSON File</title>

        <para>The JSON configuration file needed to wait a uCPE device should
        contain a list of dictionaries. Each dictionary indicates the test
        case name and the test case arguments passed to the
        <filename>waitDeviceUp</filename> Python module.</para>

        <para><emphasis role="bold">Sample unit-test JSON file
        format:</emphasis></para>

        <programlisting>[
 {
 "name": "Wait VCPE Agent device be up",
 "args": "-f ../../lab_config/intelc3850-2/intelc3850-2.json -t 60"
 }
]</programlisting>

        <para><emphasis role="bold">Sample
        <filename>intelc3850-2.json</filename> configuration
        file:</emphasis></para>

        <programlisting>{
 "name": "intelc3850-2"
}</programlisting>
      </section>

      <section id="runpy_mod_wait">
        <title>Running the Python Module</title>

        <para>The <filename>waitDeviceUp</filename> Python module can be
        executed individually by running the following command
        line:<programlisting>$ python waitDeviceUp.py -u admin -p admin -H localhost -t 60 -f
../../lab_config/intelc3850-2/intelc3850-2.json
2019-03-07 18:03:21,132 - DEBUG: Started logging
2019-03-07 18:03:21,133 - INFO: Wait uCPE device
2019-03-07 18:03:21,149 - DEBUG: Login successful on host 'localhost'
2019-03-07 18:03:21,149 - DEBUG: Session token is: 8785b1a0-40f2-11e9-a81f525400d08e1d
2019-03-07 18:03:21,157 - DEBUG: Found device with name 'intelc3850-2'
2019-03-07 18:03:21,157 - DEBUG: Wait for device 'intelc3850-2' to connect
2019-03-07 18:03:29,356 - DEBUG: Status: Connected
2019-03-07 18:03:29,356 - INFO: Done
2019-03-07 18:03:29,365 - DEBUG: Logging out and exiting...</programlisting></para>
      </section>
    </section>

    <section id="print_ucpe_log">
      <title>Printing the uCPE Device Log</title>

      <para>Steps and details on how to Print the events log for a specific
      uCPE device installed in the uCPE Manager, are explained below.</para>

      <section id="print_script_opts">
        <title>Script Options</title>

        <programlisting>$ python getEventsForUcpe.py -h
Usage: getEventsForUcpe.py [options]

Print the events log for a specific uCPE installed in Enea uCPE Manager.

Options:
--version                          show program's version number and exit
-h, --help                         show this help message and exit
-u USERNAME, --username=USERNAME   Enea uCPE Manager login username
-p PASSWORD, --password=PASSWORD   Enea uCPE Manager login password
-H HOST, --host=HOST               Enea uCPE Manager host name or IP address
-f DEVICEFILE, --file=DEVICEFILE   File containing uCPE Information in JSON format
-s SEVERITY, --severity=SEVERITY   Event severity level (Critical|Major|Minor)

Mandatory options:
-H/--host, -f/--file            </programlisting>
      </section>

      <section id="config_json_log">
        <title>Configuring the JSON File</title>

        <para><emphasis role="bold">Sample
        <filename>intelc3850-2.json</filename> configuration
        file:</emphasis></para>

        <programlisting>{
"name": "intelc3850-2",
"description": "",
"address": "172.24.12.114",
"port": "22",
"username": "root",
"password": "root",
"certificate": null,
"passphrase": null,
"maintMode": "false"
              }</programlisting>
      </section>

      <section id="runpy_mod_log">
        <title>Running the Python Module</title>

        <para>The <literal>getEventsForUcpe</literal> Python module can be
        executed individually by running the following command:</para>

        <programlisting>$ python getEventsForUcpe.py -H localhost -f \
../../lab_config/intelc3850-2/intelc3850-2.json

2019-07-04 13:48:31,289 - DEBUG: Started logging
2019-07-04 13:48:31,290 - INFO: Dump uCPE events
2019-07-04 13:48:31,336 - DEBUG: Login successful on host '172.24.3.108'
2019-07-04 13:48:31,336 - DEBUG: Session token is: a53c68d3-9e51-11e9-a715-5254007632e2
2019-07-04 13:48:31,356 - DEBUG: Found device with name 'intelc3850-2'
2019-07-04 13:48:31,357 - DEBUG:
Events on device: intelc3850-2 and severity: 1000
2019-07-04 13:48:31,450 - DEBUG:  Dumping 1 events
2019-07-04 13:48:31,450 - DEBUG: Device Disconnected | Alarm | Device | None | \
    2019-07-04 09:57:40.042
2019-07-04 13:48:31,469 - DEBUG:  Dumping 0 events
2019-07-04 13:48:31,469 - INFO: Done
2019-07-04 13:48:31,488 - DEBUG: Logging out and exiting... </programlisting>
      </section>
    </section>

    <section id="enable_disable_dpdk">
      <title>Enabling or Disabling the DPDK</title>

      <para>Steps and details on how to enable or disable the DPDK are
      explained below.</para>

      <section id="script_dpdk">
        <title>Script Options</title>

        <programlisting>$ python configDPDK.py -h
Usage: configDPDK.py [options]

Configure DPDK

Options:
  --version             show program's version number and exit
  -h, --help            show this help message and exit
  -u USERNAME, --username=USERNAME
                        Enea uCPE Manager login username
  -p PASSWORD, --password=PASSWORD
                        Enea uCPE Manager login password
  -H HOST, --host=HOST  Enea uCPE Manager host name or IP address
  -s STATE, --state=STATE
                        Enable/Disable
  -n DEVICENAME, --device-name=DEVICENAME
                        Name of the device
  -o STORENAME, --store-name=STORENAME
                        Name of the store

  Mandatory options:
    -H/--host, -s/--state, -n/--device-name or -o/--store-name</programlisting>
      </section>

      <section id="run_pydpdk">
        <title>Running the Python Module</title>

        <para>The <literal>configDPDK</literal> Python module can be executed
        individually by running the following command lines:</para>

        <para>To Enable DPDK:</para>

        <programlisting>$ python configDPDK.py -s enable -n intelc3850-2

2020-01-06 08:35:16,820 - DEBUG: Started logging
2020-01-06 08:35:16,821 - INFO: Configure DPDK
2020-01-06 08:35:16,870 - DEBUG: Login successful on host '172.24.3.90'
2020-01-06 08:35:16,871 - DEBUG: Session token is: 601149e0-3089-11ea-b0c7-525400b7889f
2020-01-06 08:35:16,894 - DEBUG: Found device with name 'inteld1521-1'
2020-01-06 08:35:16,895 - DEBUG: Set DPDK state to enable
2020-01-06 08:35:16,936 - INFO: Done
2020-01-06 08:35:16,961 - DEBUG: Logging out and exiting...</programlisting>

        <para>To Disable DPDK:</para>

        <programlisting>$ python configDPDK.py -s disable -n intelc3850-2

2020-01-06 08:33:57,157 - DEBUG: Started logging
2020-01-06 08:33:57,158 - INFO: Configure DPDK
2020-01-06 08:33:57,215 - DEBUG: Login successful on host '172.24.3.90'
2020-01-06 08:33:57,216 - DEBUG: Session token is: 3096e670-3089-11ea-b0c7-525400b7889f
2020-01-06 08:33:57,239 - DEBUG: Found device with name 'inteld1521-1'
2020-01-06 08:33:57,241 - DEBUG: Set DPDK state to disable
2020-01-06 08:33:57,284 - INFO: Done
2020-01-06 08:33:57,310 - DEBUG: Logging out and exiting...</programlisting>
      </section>
    </section>

    <section id="bind_ucpe_device">
      <title>Binding a Network Interface</title>

      <para>How to Bind a physical network interface to a DPDK, Standard or
      SR-IOV is detailed below.</para>

      <section id="script_opts_bind">
        <title>Script Options</title>

        <programlisting>$ python bindNetworkInterface.py -h
Usage: bindNetworkInterface.py [options]

Binds a physical network interface to a DPDK or SR-IOV.

Options:
  --version             show program's version number and exit
  -h, --help            show this help message and exit
  -u USERNAME, --username=USERNAME
                        Enea uCPE Manager login username
  -p PASSWORD, --password=PASSWORD
                        Enea uCPE Manager login password
  -H HOST, --host=HOST  Enea uCPE Manager host name or IP address
  -f NICFILE, --file=NICFILE
                        File containing network interface Information in JSON
                        format
  -n DEVICENAME, --device-name=DEVICENAME
                        Name of the device
  -o STORENAME, --store-name=STORENAME
                        Name of the store

  Mandatory options:
    -H/--host, -f/--file, -n/--device-name or -o/--store-name</programlisting>
      </section>

      <section id="bind_config">
        <title>Configuring the JSON File</title>

        <para>The JSON configuration file needed to bind a physical network
        interface should contain a list of dictionaries. Each dictionary
        indicates the test case name and the test case arguments passed to the
        <filename>bindNetworkInterface</filename> Python module.</para>

        <para><emphasis role="bold">Sample unit-test JSON file
        format:</emphasis><programlisting>[
 {
 "name": "Bind lan NIC to DPDK",
 "args": "-f ../../lab_config/intelc3850-2/lan_nic.json"
 },
 {
 "name": "Bind wan NIC to DPDK",
 "args": "-f ../../lab_config/intelc3850-2/wan_nic.json"
 },
 {
 "name": "Bind wan/lan NIC to SR-IOV",
 "args": "-f ../../lab_config/intelc3850-2/sriov_nic.json"
 },
 {
 "name": "Bind wan/lan NIC to Standard",
 "args": "-f ../../lab_config/intelc3850-2/std_nic.json"
 }
]</programlisting><emphasis role="bold">Sample
        <filename>lan_nic.json</filename> configuration
        file:</emphasis><programlisting>{
 "name": "enp4s0f0",
 "type": "dpdk",
 "subType": "vfio-pci"
}</programlisting><emphasis role="bold">Sample
        <filename>wan_nic.json</filename> configuration
        file:</emphasis><programlisting>{
 "name": "enp4s0f1",
 "type": "dpdk",
 "subType": "vfio-pci"
}</programlisting><emphasis role="bold">Sample
        <filename>sriov_nic.json</filename> configuration
        file:</emphasis><programlisting>{
 "name": "eno1",
 "type": "srIov",
 "subType": "passthrough | adapter-pool"
}</programlisting><emphasis role="bold">Sample
        <filename>std_nic.json</filename> configuration
        file:</emphasis><programlisting>{
 "name": "eno2",
 "type": "standard"
}</programlisting></para>
      </section>

      <section id="runpy_bind">
        <title>Running the Python Module</title>

        <para>The <literal>bindNetworkInterface</literal> Python module can be
        executed individually by running the following command line:</para>

        <programlisting>$ python bindNetworkInterface.py -u admin -p admin -H localhost -f
../../lab_config/intelc3850-2/lan_nic.json -n intelc3850-2
2019-03-07 18:03:29,365 - DEBUG: Started logging
2019-03-07 18:03:29,366 - INFO: Bind NIC
2019-03-07 18:03:29,406 - DEBUG: Login successful on host 'localhost'
2019-03-07 18:03:29,406 - DEBUG: Session token is: 8c719cb0-40f2-11e9-a81f525400d08e1d
2019-03-07 18:03:29,415 - DEBUG: Found device with name 'intelc3850-2'
2019-03-07 18:03:29,415 - DEBUG: Bind NIC '0000:01:00.1'
2019-03-07 18:03:30,030 - INFO: Done
2019-03-07 18:03:30,067 - DEBUG: Logging out and exiting...</programlisting>
      </section>
    </section>

    <section id="unbind_ucpe_device">
      <title>Unbinding a Network Interface</title>

      <para>How to Unbind a physical network interface from a DPDK or SR-IOV
      is described below.</para>

      <section id="script_opts_unbind">
        <title>Script Options</title>

        <programlisting>$ python unbindNetworkInterface.py -h
Usage: unbindNetworkInterface.py [options]

Unbinds a physical interface to the DPDK or SR-IOV.

Options:
 --version show program's version number and exit
 -h, --help show this help message and exit
 -u USERNAME, --username=USERNAME
 Enea uCPE Manager login username
 -p PASSWORD, --password=PASSWORD
 Enea uCPE Manager login password
 -H HOST, --host=HOST Enea uCPE Manager host name or IP address
 -f NICFILE, --file=NICFILE
 File containing network interface Information in JSON
 format
 -n DEVICENAME, --device-name=DEVICENAME
 Name of the device

 Mandatory options:
 -H/--host, -f/--file, -n/--device-name</programlisting>
      </section>

      <section id="json_unbind">
        <title>Configuring the JSON File</title>

        <para>The JSON configuration file needed to unbind a network interface
        should contain a list of dictionaries. Each dictionary indicates the
        test case name and the test case arguments passed to the
        <filename>unbindNetworkInterface</filename> Python module.</para>

        <para><emphasis role="bold">Sample unit-test JSON file
        format:</emphasis><programlisting>[
 {
 "name": "Unbind lan NIC",
 "args": "-f ../../lab_config/intelc3850-2/lan_nic.json"
 },
 {
  name": "Unbind wan NIe",
Unbinds a physical interface to the DPDK or SR-IOV
 "args": "-f ../../lab_config/intelc3850-2/wan_nic.json"
 }
]</programlisting></para>

        <para><emphasis role="bold">Sample <filename>lan_nic.json</filename>
        configuration file:</emphasis></para>

        <programlisting>{
 "name": "enp4s0f0",
 "type": "dpdk"
}</programlisting>

        <para><emphasis role="bold">Sample <filename>wan_nic.json</filename>
        configuration file:</emphasis></para>

        <programlisting>{
 "name": "enp4s0f1",
 "type": "dpdk",
}
</programlisting>
      </section>

      <section id="pymod_unbind">
        <title>Running the Python Module</title>

        <para>The <filename>unbindNetworkInterface</filename> Python module
        can be executed individually by running the following command
        line:</para>

        <programlisting>$ python unbindNetworkInterface.py -u admin -p admin -H localhost -f
../../lab_config/intelc3850-2/lan_nic.json -n intelc3850-2
2019-03-07 17:33:54,377 - DEBUG: Started logging
2019-03-07 17:33:54,378 - INFO: Unbind NIC
2019-03-07 17:33:54,431 - DEBUG: Login successful on host 'localhost'
2019-03-07 17:33:54,432 - DEBUG: Session token is: 6a77a1d1-40ee-11e9-a81f525400d08e1d
2019-03-07 17:33:54,467 - DEBUG: Found device with name 'intelc3850-2'
2019-03-07 17:33:54,468 - DEBUG: Unbind NIC '0000:01:00.1'
2019-03-07 17:33:55,616 - INFO: Done
2019-03-07 17:33:55,659 - DEBUG: Logging out and exiting...</programlisting>
      </section>
    </section>

    <section id="get_network_interface">
      <title>Getting a Network Interface</title>

      <para>Details and steps on how to List the network interfaces for a
      device, are described below.</para>

      <section id="script_opts_interface">
        <title>Script Options</title>

        <programlisting>$ python getNetworkInterfaces.py -h
2019-07-04 16:35:50,496 - DEBUG: Started logging
2019-07-04 16:35:50,496 - INFO: Dump NICs
Usage: getNetworkInterfaces.py [options]

Options:
  --version                               show program's version number and exit
  -h, --help                              show this help message and exit
  -u USERNAME, --username=USERNAME        Enea uCPE Manager login username
  -p PASSWORD, --password=PASSWORD        Enea uCPE Manager login password
  -H HOST, --host=HOST                    Enea uCPE Manager host name or IP address
  -n DEVICENAME, --device-name=DEVICENAME Name of the uCPE to get network /
                                          interfaces from

  Mandatory options:
    -H/--host, -n/--device-name</programlisting>
      </section>

      <section id="runpy_net_interface">
        <title>Running the Python Module</title>

        <para>The <literal>getNetworkInterfaces</literal> Python module can be
        executed individually by running the following command:</para>

        <programlisting>$ python getNetworkInterfaces.py -H localhost -n intelc3850-2
2020-01-07 05:58:03,630 - DEBUG: Started logging
2020-01-07 05:58:03,630 - INFO: Dump NICs
2020-01-07 05:58:03,687 - DEBUG: Login successful on host '172.24.3.90'
2020-01-07 05:58:03,688 - DEBUG: Session token is: 93dd3cd0-313c-11ea-b0c7-525400b7889f
2020-01-07 05:58:03,715 - DEBUG: Found device with name 'intelc3850-2'
2020-01-07 05:58:03,717 - DEBUG:
----------------External Network Interfaces for intelc3850-2----------------
2020-01-07 05:58:07,622 - DEBUG: eno4 DpdkTypes: [u'igb_uio', u'vfio-pci'] \ 
MacAddress: 0c:c4:7a:fb:85:dfsriov(7)
2020-01-07 05:58:07,624 - DEBUG:
2020-01-07 05:58:07,656 - DEBUG:
----------------Configured External Network Interfaces for intelc3850-2----------------
2020-01-07 05:58:07,657 - DEBUG: eno3 DpdkType: vfio-pci ID: \
47556b22-b5c2-4acb-b3cb-09b1f024b3a7
2020-01-07 05:58:07,658 - DEBUG: enp1s0f1 DpdkType: vfio-pci ID: \
2c06b4f7-6814-4432-8765-a9d0cd5303c1
2020-01-07 05:58:07,659 - DEBUG: enp1s0f0 DpdkTypes: [u'igb_uio', u'vfio-pci'] \
MacAddress: ac:1f:6b:2d:ee:58sriov(63)
2020-01-07 05:58:07,660 - DEBUG:
2020-01-07 05:58:07,690 - DEBUG:
----------------Configured External Network Interfaces for intelc3850-2----------------
2020-01-07 05:58:07,691 - DEBUG: eno3 DpdkType: vfio-pci ID: \
47556b22-b5c2-4acb-b3cb-09b1f024b3a7
2020-01-07 05:58:07,692 - DEBUG: enp1s0f1 DpdkType: vfio-pci ID: \
2c06b4f7-6814-4432-8765-a9d0cd5303c1
2020-01-07 05:58:07,693 - DEBUG: eno2 DpdkTypes: [u'igb_uio', u'vfio-pci'] \
MacAddress: 0c:c4:7a:fb:85:ddsriov(7)
2020-01-07 05:58:07,695 - DEBUG:
2020-01-07 05:58:07,724 - DEBUG:
----------------Configured External Network Interfaces for intelc3850-2----------------
2020-01-07 05:58:07,725 - DEBUG: eno3 DpdkType: vfio-pci ID: \
47556b22-b5c2-4acb-b3cb-09b1f024b3a7
2020-01-07 05:58:07,726 - DEBUG: enp1s0f1 DpdkType: vfio-pci ID: \
2c06b4f7-6814-4432-8765-a9d0cd5303c1
2020-01-07 05:58:07,727 - DEBUG: eno1 DpdkTypes: [u'igb_uio', u'vfio-pci'] \
MacAddress: 0c:c4:7a:fb:85:dcsriov(7)
2020-01-07 05:58:07,728 - DEBUG:
2020-01-07 05:58:07,760 - DEBUG:
----------------Configured External Network Interfaces for intelc3850-2----------------
2020-01-07 05:58:07,761 - DEBUG: eno3 DpdkType: vfio-pci ID: \
47556b22-b5c2-4acb-b3cb-09b1f024b3a7
2020-01-07 05:58:07,761 - DEBUG: enp1s0f1 DpdkType: vfio-pci ID: \
2c06b4f7-6814-4432-8765-a9d0cd5303c1
2020-01-07 05:58:07,762 - DEBUG:
2020-01-07 05:58:07,763 - INFO: Done
2020-01-07 05:58:07,787 - DEBUG: Logging out and exiting...</programlisting>
      </section>
    </section>

    <section id="create_ovs_net_bridge">
      <title>Creating an OVS Network Bridge</title>

      <para>Instructions on how to Create an OVS Bridge on a device are
      detailed below.</para>

      <section id="script_opts_creovs">
        <title>Script Options</title>

        <programlisting>$ python newNetworkBridge.py -h
Usage: newNetworkBridge.py [options]

Create an OVS Bridge on a device.

Options:
  --version             show program's version number and exit
  -h, --help            show this help message and exit
  -u USERNAME, --username=USERNAME
                        Enea uCPE Manager login username
  -p PASSWORD, --password=PASSWORD
                        Enea uCPE Manager login password
  -H HOST, --host=HOST  Enea uCPE Manager host name or IP address
  -f OVSFILE, --file=OVSFILE
                        File containing OVS bridge Information in JSON format
  -n DEVICENAME, --device-name=DEVICENAME
                        Name of the device
  -o STORENAME, --store-name=STORENAME
                        Name of the store

  Mandatory options:
    -H/--host, -f/--file, -n/--device-name or -o/--store-name</programlisting>
      </section>

      <section id="json_creovs">
        <title>Configuring the JSON File</title>

        <para>The JSON configuration file needed to create a new network
        bridge should contain a list of dictionaries. Each dictionary
        indicates the test case name and the test case arguments passed to the
        <literal>newNetworkBridge</literal> Python module.</para>

        <para><emphasis role="bold">Sample unit-test JSON file
        format:</emphasis></para>

        <programlisting>[
 {
 "name": "Creating network bridge LAN ",
 "args": "-f ../../lab_config/intelc3850-2/lan_br.json"
 },
 {
 "name": "Creating network bridge WAN ",
 "args": "-f ../../lab_config/intelc3850-2/wan_br.json"
 }
]</programlisting>

        <para><emphasis role="bold">Sample <filename>lan_br.json</filename>
        configuration file:</emphasis></para>

        <programlisting>{
 "name": "lan_br",
 "interfaces": ["enp4s0f0"]
}</programlisting>

        <para><emphasis role="bold">Sample <filename>wan_br.json</filename>
        configuration file:</emphasis></para>

        <programlisting>{
 "name": "wan_br",
 "interfaces": ["enp4s0f1"]
}</programlisting>
      </section>

      <section id="pymod_creovs">
        <title>Running the Python Module</title>

        <para>The <filename>newNetworkBridge</filename> Python module can be
        executed individually by running the following command line:</para>

        <programlisting>$ python newNetworkBridge.py -u admin -p admin -H localhost -f
../../lab_config/intelc3850-2/lan_br.json -n intelc3850-2
2019-03-07 18:03:30,767 - DEBUG: Started logging
2019-03-07 18:03:30,768 - INFO: New OVS network bridge
2019-03-07 18:03:30,801 - DEBUG: Login successful on host 'localhost'
2019-03-07 18:03:30,801 - DEBUG: Session token is: 8d454061-40f2-11e9-a81f525400d08e1d
2019-03-07 18:03:30,811 - DEBUG: Found device with name 'intelc3850-2'
2019-03-07 18:03:30,812 - DEBUG: Create new OVS network bridge 'lan_br'
2019-03-07 18:03:37,358 - INFO: Done
2019-03-07 18:03:37,402 - DEBUG: Logging out and exiting...</programlisting>
      </section>
    </section>

    <section id="delete_ovs_net_bridge">
      <title>Deleting an OVS Network Bridge</title>

      <para>How to Delete an OVS Bridge from a device is detailed in the
      following.</para>

      <section id="script_opts_delovs">
        <title>Script Options</title>

        <programlisting>$ python delNetworkBridge.py -h
Usage: delNetworkBridge.py [options]

Delete an OVS Bridge from a device.

Options:
  --version             show program's version number and exit
  -h, --help            show this help message and exit
  -u USERNAME, --username=USERNAME
                        Enea uCPE Manager login username
  -p PASSWORD, --password=PASSWORD
                        Enea uCPE Manager login password
  -H HOST, --host=HOST  Enea uCPE Manager host name or IP address
  -f OVSFILE, --file=OVSFILE
                        File containing OVS bridge Information in JSON format
  -n DEVICENAME, --device-name=DEVICENAME
                        Name of the device
  -o STORENAME, --store-name=STORENAME
                        Name of the store

  Mandatory options:
    -H/--host, -f/--file, -n/--device-name or -o/--store-name</programlisting>
      </section>

      <section id="json_delovs">
        <title>Configuring the JSON File</title>

        <para>The JSON configuration file needed to delete a network bridge
        should contain a list of dictionaries. Each dictionary indicates the
        test case name and the test case arguments passed to the
        <filename>delNetworkBridge</filename> Python module.</para>

        <para><emphasis role="bold">Sample unit-test JSON file
        format:</emphasis></para>

        <programlisting>[
 {
 "name": "Deleting network bridge LAN ",
 "args": "-f ../../lab_config/intelc3850-2/lan_br.json"
 },
 {
 "name": "Deleting network bridge WAN ",
 "args": "-f ../../lab_config/intelc3850-2/wan_br.json"
 }
]</programlisting>

        <para><emphasis role="bold">Sample <filename>lan_br.json</filename>
        configuration file:</emphasis></para>

        <programlisting>{
 "name" : "lan_br"
}</programlisting>

        <para><emphasis role="bold">Sample <filename>wan_br.json</filename>
        configuration file:</emphasis></para>

        <programlisting>{
 "name" : "wan_br"
}</programlisting>
      </section>

      <section id="pymod_delovs">
        <title>Running the Python Module</title>

        <para>The <filename>delNetworkBridge</filename> Python module can be
        executed individually by running the following command line:</para>

        <programlisting>$ python delNetworkBridge.py -u admin -p admin -H localhost -f
../../lab_config/intelc3850-2/lan_br.json -n intelc3850-2
2019-03-07 17:33:51,712 - DEBUG: Started logging
2019-03-07 17:33:51,713 - INFO: Delete OVS network bridge
2019-03-07 17:33:51,751 - DEBUG: Login successful on host 'localhost'
2019-03-07 17:33:51,752 - DEBUG: Session token is: 68e08711-40ee-11e9-a81f525400d08e1d
2019-03-07 17:33:51,768 - DEBUG: Found device with name 'intelc3850-2'
2019-03-07 17:33:51,768 - DEBUG: Delete OVS network bridge 'lan_br'
2019-03-07 17:33:52,839 - INFO: Done
2019-03-07 17:33:52,872 - DEBUG: Logging out and exiting...</programlisting>
      </section>
    </section>

    <section id="onboard_vnf_bundle">
      <title>Onboarding a VNF Image</title>

      <para>The specifics of how to Onboard a VNF image onto the Enea uCPE
      Manager is detailed below.</para>

      <section id="script_opts_onbvnf">
        <title>Script Options</title>

        <programlisting>$ python onboardVNF.py -h
Usage: onboardVNF.py [options]

Onboard a VNF to Enea uCPE Manager.

Options:
 --version show program's version number and exit
 -h, --help show this help message and exit
 -u USERNAME, --username=USERNAME
 Enea uCPE Manager login username
 -p PASSWORD, --password=PASSWORD
 Enea uCPE Manager login password
 -H HOST, --host=HOST Enea uCPE Manager host name or IP address
 -f FTPUSERNAME, --ftpUsername=FTPUSERNAME
 Username for FTP
 -w FTPPASSWORD, --ftpPassword=FTPPASSWORD
 FTP password
 -P FTPPORT, --ftpPort=FTPPORT
 FTP port
 -b VNFBUNDLE, --bundle=VNFBUNDLE
 File name of VNF bundle in ZIP format

 Mandatory options:
 -H/--host, -b/--bundle</programlisting>
      </section>

      <section id="json_onbvnf">
        <title>Configuring the JSON File</title>

        <para>The JSON configuration file needed to onboard a VNF image should
        contain a list of dictionaries. Each dictionary indicates the test
        case name and the test case arguments passed to the
        <filename>onboardVNF</filename> Python module.</para>

        <para><emphasis role="bold">Sample unit-test JSON file
        format:</emphasis><programlisting>[
 {
 "name": "Onboarding Fortigate VNF ",
 "args": "-b ../../vnf_images/Fortigate.zip"
 }
]</programlisting></para>
      </section>

      <section id="pymod_onbvnf">
        <title>Running the Python Module</title>

        <para>The <filename>onboardVNF</filename> Python module can be
        executed individually by running the following command line:</para>

        <programlisting>$ python onboardVNF.py -u admin -p admin -f ftp -w ftp -H localhost -b
../../vnf_images/Fortigate.zip
2019-02-25 16:00:53,890 - DEBUG: Started logging
2019-02-25 16:00:53,890 - INFO: Onboard VNF
2019-02-25 16:00:53,985 - DEBUG: Login successful on host 'localhost'
2019-02-25 16:00:53,985 - DEBUG: Session token is: c421cd03-3905-11e9-a81f525400d08e1d
2019-02-25 16:00:53,994 - DEBUG: FTP file '../../vnf_images/Fortigate.zip' on host
'localhost', port '2021'
2019-02-25 16:00:54,229 - DEBUG: Onboard VNF: Fortigate
2019-02-25 16:00:56,836 - INFO: Done
2019-02-25 16:00:56,861 - DEBUG: Logging out and exiting...</programlisting>
      </section>
    </section>

    <section id="onboard_vnf_image">
      <title>Onboarding a VNF Image Raw</title>

      <para>How to Onboard a VNF image in the uCPE Manager based upon its raw
      constituents, is detailed in depth below.</para>

      <section id="script_opts_image">
        <title>Script Options</title>

        <programlisting>$ python onboardVNFRaw.py -h
Usage: onboardVNFRaw.py [options]

Onboard a VNF in Enea uCPE Manager based upon its raw constituents.

Options:
  --version             show program's version number and exit
  -h, --help            show this help message and exit
  -u USERNAME, --username=USERNAME
                        Enea uCPE Manager login username
  -p PASSWORD, --password=PASSWORD
                        Enea uCPE Manager login password
  -H HOST, --host=HOST  Enea uCPE Manager host name or IP address
  -f FTPUSERNAME, --ftpUsername=FTPUSERNAME
                        Username for FTP
  -w FTPPASSWORD, --ftpPassword=FTPPASSWORD
                        FTP password
  -P FTPPORT, --ftpPort=FTPPORT
                        FTP port
  -i IMAGEPATH, --imagePath=IMAGEPATH
                        VNF image path
  -b IMAGEINFO, --imageInfo=IMAGEINFO
                        File name of VNF image information in JSON format

  Mandatory options:
    -H/--host, -b/--imageInfo, -i/--imagePath</programlisting>
      </section>

      <section id="json_image">
        <title>Configuring the JSON File</title>

        <para>The JSON configuration file needed to onboard a VNF image Raw
        should contain a list of dictionaries. Each dictionary indicates the
        test case name and the test case arguments passed to the
        <filename>onboardVNFRaw</filename> Python module.</para>

        <para><emphasis role="bold">Sample unit-test JSON file
        format:</emphasis></para>

        <programlisting>[
 {
 "name": "Onboarding Fortigate VNF (wizard API)",
 "args": "-b ../../vnf_config/fortigateImage/fortigateImage.json -i
../../vnf_images/fortios.qcow2"
 }
]</programlisting>

        <para><emphasis role="bold">Sample
        <filename>fortigateImage.json</filename> configuration
        file:</emphasis><programlisting>{
 "name" : "fortigateImage",
 "version" : "1.0",
 "description" : "Fortigate VNF Image",
 "provider" : "Fortinet, Inc",
 "numVcpus" : 1,
 "imageFormat" : "QCOW2",
 "memoryInMb" : 1024,
 "storageInGb" : 20,
 "image" : "fortios.qcow2",
 "interfaces" : [
 {
 "name" : "external",
 "type" : "PhysicalPort",
 "description" : "External interface"
 },
 {
 "name" : "in",
 "type" : "PhysicalPort",
 "description" : "Incoming interface"
 },
 {
 "name" : "out",
 "type" : "PhysicalPort",
 "description" : "Outgoing interface"
 }
 ],
 "cloudInitDataSource" : "ConfigDrive",
 "cloudInitDriveType" : "cdrom",
 "cloudInitContentParams" : [
 {
 "path" : "License",
 "description" : "Operational license"
 }
 ]
}</programlisting></para>
      </section>

      <section id="pymod_image">
        <title>Running the Python Module</title>

        <para>The <filename>onboardVNFRaw</filename> Python module can be
        executed individually by running the following command line:</para>

        <programlisting>$ python onboardVNFRaw.py -u admin -p admin -f ftp -w ftp -H localhost -b b
../../vnf_config/fortigateImage/fortigateImage.json -i
../../vnf_images/fortios.qcow2
2019-03-07 18:03:37,791 - DEBUG: Started logging
2019-03-07 18:03:37,792 - INFO: Onboard wizard
2019-03-07 18:03:37,859 - DEBUG: Login successful on host 'localhost'
2019-03-07 18:03:37,859 - DEBUG: Session token is: 91770330-40f2-11e9-a81f525400d08e1d
2019-03-07 18:03:37,860 - DEBUG: FTP file '../../vnf_images/fortios.qcow2' on host
'localhost', port '2021'
2019-03-07 18:03:38,027 - DEBUG: Onboard VNF raw: fortios.qcow2
2019-03-07 18:03:41,701 - INFO: Done
2019-03-07 18:03:41,748 - DEBUG: Logging out and exiting...</programlisting>
      </section>
    </section>

    <section id="offboard_vnf">
      <title>Offboarding a VNF</title>

      <para>Steps on how to Offboard a VNF from the uCPE Manager are detailed
      below.</para>

      <section id="script_opts_offimage">
        <title>Script Options</title>

        <programlisting>$ python offboardVNF.py -h
Usage: offboardVNF.py [options]

Offboard a VNF from Enea uCPE Manager.

Options:
 --version show program's version number and exit
 -h, --help show this help message and exit
 -u USERNAME, --username=USERNAME
 Enea uCPE Manager login username
 -p PASSWORD, --password=PASSWORD
 Enea uCPE Manager login password
 -H HOST, --host=HOST Enea uCPE Manager host name or IP address
 -n VNFDNAME, --vnfdName=VNFDNAME
 Name of VNF descriptor to offboard

 Mandatory options:
 -H/--host, -n/--vnfdName</programlisting>
      </section>

      <section id="json_offimage">
        <title>Configuring the JSON File</title>

        <para>The JSON configuration file needed to offboard a VNF should
        contain a list of dictionaries. Each dictionary indicates the test
        case name and the test case arguments passed to the
        <filename>offboardVNF</filename> Python module.</para>

        <para><emphasis role="bold">Sample unit-test JSON file
        format:</emphasis></para>

        <programlisting>[
 {
 "name": "Offboarding Fortigate VNF ",
 "args": "-n fortigateImage"
 }
]</programlisting>
      </section>

      <section id="pymod_offimage">
        <title>Running the Python Module</title>

        <para>The <filename>offboardVNF</filename> Python module can be
        executed individually by running the following command line:</para>

        <programlisting>$ python offboardVNF.py -u admin -p admin -H localhost -n fortigateImage
2019-03-07 17:33:56,523 - DEBUG: Started logging
2019-03-07 17:33:56,524 - INFO: Offboard VNF
2019-03-07 17:33:56,557 - DEBUG: Login successful on host 'localhost'
2019-03-07 17:33:56,557 - DEBUG: Session token is: 6bbe2b90-40ee-11e9-a81f525400d08e1d
2019-03-07 17:33:56,682 - DEBUG: Found VNF descriptor with name 'fortigateImage'
2019-03-07 17:33:56,683 - DEBUG: Offboard VNF: fortigateImage
2019-03-07 17:33:56,811 - INFO: Done
2019-03-07 17:33:56,834 - DEBUG: Logging out and exiting...</programlisting>
      </section>
    </section>

    <section id="instantiate_vnf">
      <title>Instantiating a VNF</title>

      <para>Instantiating a VNF via the uCPE Manager is detailed below.</para>

      <section id="script_opts_inst">
        <title>Script Options</title>

        <programlisting>$ python instantiateVNFI.py -h
Usage: instantiateVNFI.py [options]

Instantiate a VNF via Enea uCPE Manager.

Options:
  --version             show program's version number and exit
  -h, --help            show this help message and exit
  -u USERNAME, --username=USERNAME
                        Enea uCPE Manager login username
  -p PASSWORD, --password=PASSWORD
                        Enea uCPE Manager login password
  -H HOST, --host=HOST  Enea uCPE Manager host name or IP address
  -t VNFTYPE, --vnfType=VNFTYPE
                        VNF Type (Name of VNF descriptor)
  -n VIMDEVICENAME, --device-name=VIMDEVICENAME
                        Name of the device
  -f PROPSFILE, --file=PROPSFILE
                        File containing VNF instance properties in JSON format

  Mandatory options:
    -H/--host, -t/--vnfType, -n/--device-name, -f/--file</programlisting>
      </section>

      <section id="json_inst">
        <title>Configuring the JSON File</title>

        <para>The JSON configuration file needed to instantiate a VNF should
        contain a list of dictionaries. Each dictionary indicates the test
        case name and the test case arguments passed to the
        <filename>instantiateVNFI</filename> Python module.</para>

        <para><emphasis role="bold">Sample unit-test JSON file
        format:</emphasis></para>

        <programlisting>[
 {
 "name": "Instantiate Fortigate VNF ",
 "args": "-t fortigateImage -f
../../vnf_config/fortigateImage/fortigateFWInstance.json"
 }
]</programlisting>

        <para>The VNF instance JSON configuration file is specific to each
        VNF.</para>
      </section>

      <section id="pymod_inst">
        <title>Running the Python Module</title>

        <para>The <filename>instantiateVNFI</filename> Python module can be
        executed individually by running the following command line:</para>

        <programlisting>$ python instantiateVNFI.py -u admin -p admin -H localhost -n intelc3850-2 -t
fortigateImage -f ../../vnf_config/fortigateImage/fortigateFWInstance.json
2019-03-07 18:03:41,777 - DEBUG: Started logging
2019-03-07 18:03:41,778 - INFO: Instantiate VNF
2019-03-07 18:03:41,813 - DEBUG: Login successful on host 'localhost'
2019-03-07 18:03:41,815 - DEBUG: Session token is: 93d69e10-40f2-11e9-a81f525400d08e1d
2019-03-07 18:03:41,834 - DEBUG: Found device with name 'intelc3850-2'
2019-03-07 18:03:41,878 - DEBUG: Found VNF descriptor with name 'fortigateImage'
2019-03-07 18:03:41,888 - DEBUG: Encrypt string content:
cloudInit("vnf_config/fortigateImage/fortigateFW.conf")
2019-03-07 18:03:41,889 - DEBUG: Encrypt string content:
License("vnf_config/fortigateImage/fortigateLicense.lic")
2019-03-07 18:03:41,889 - DEBUG: Instantiate fortigateImage VNF on 'intelc3850-2'
2019-03-07 18:03:49,887 - INFO: Done
2019-03-07 18:03:49,921 - DEBUG: Logging out and exiting...</programlisting>
      </section>
    </section>

    <section id="control_vnf_inst">
      <title>Controlling a VNF Instance</title>

      <para>How to Control a VNF instance from the Enea uCPE Manager is
      detailed below.</para>

      <section id="script_opts_control">
        <title>Script Options</title>

        <programlisting>$ python controlVNFI.py -h
Usage: controlVNFI.py [options]

Controls a VNF instance from Enea uCPE Manager.

Options:
  --version             show program's version number and exit
  -h, --help            show this help message and exit
  -u USERNAME, --username=USERNAME
                        Enea uCPE Manager login username
  -p PASSWORD, --password=PASSWORD
                        Enea uCPE Manager login password
  -H HOST, --host=HOST  Enea uCPE Manager host name or IP address
  -i VNFINSTANCENAME, --vnfInstanceName=VNFINSTANCENAME
                        Name of VNF instance
  -n VIMDEVICENAME, --device-name=VIMDEVICENAME
                        Name of the device
  -c COMMAND, --command=COMMAND
                        Control command (stop, start, pause or resume)

  Mandatory options:
    -H/--host, -i/--vnfInstanceName, -n/--device-name, -c/--command</programlisting>
      </section>

      <section id="json_control">
        <title>Configuring the JSON File</title>

        <para>The JSON configuration file needed to control a VNF instance
        should contain a list of dictionaries. Each dictionary indicates the
        test case name and the test case arguments passed to the
        <filename>controlVNFI</filename> Python module.</para>

        <para><emphasis role="bold">Sample unit-test JSON file
        format:</emphasis></para>

        <programlisting>[
 {
 "name": "Pause Fortigate VNF instance",
 "args": "-i fortigateFWInstance -c pause"
 },
 {
 "name": "Resume Fortigate VNF instance",
 "args": "-i fortigateFWInstance -c resume"
 },
 {
 "name": "Stop Fortigate VNF instance ",
 "args": "-i fortigateFWInstance -c stop"
 },
 {
 "name": "Start Fortigate VNF instance",
 "args": "-i fortigateFWInstance -c start"
 }
]</programlisting>
      </section>

      <section id="pymod_control">
        <title>Running the Python Module</title>

        <para>The <filename>controlVNFI</filename> Python module can be
        executed individually by running the following command line:</para>

        <programlisting>$ python controlVNFI.py -u admin -p admin -H localhost -n intelc3850-2 -i
fortigateFWInstance -c stop
2019-03-07 18:03:51,991 - DEBUG: Started logging
2019-03-07 18:03:51,992 - INFO: Control VNF
2019-03-07 18:03:52,031 - DEBUG: Login successful on host 'localhost'
2019-03-07 18:03:52,031 - DEBUG: Session token is: 99ed9ba3-40f2-11e9-a81f525400d08e1d
2019-03-07 18:03:52,046 - DEBUG: Found device with name 'intelc3850-2'
2019-03-07 18:03:52,073 - DEBUG: Found VNF instance with name 'fortigateFWInstance'
2019-03-07 18:03:52,073 - DEBUG: Control VNF instance 'intelc3850-2', command: stop
2019-03-07 18:03:53,011 - INFO: Done
2019-03-07 18:03:53,047 - DEBUG: Logging out and exiting...</programlisting>
      </section>
    </section>

    <section id="destroy_vnf_inst">
      <title>Destroying a VNF Instance</title>

      <para>Steps and options on how to Destroy a VNF instance from the Enea
      uCPE Manager are described below.</para>

      <section id="script_opts_destroy">
        <title>Script Options</title>

        <programlisting>$ python destroyVNFI.py -h
Usage: destroyVNFI.py [options]

Destroys a VNF instance from Enea uCPE Manager.

Options:
  --version             show program's version number and exit
  -h, --help            show this help message and exit
  -u USERNAME, --username=USERNAME
                        Enea uCPE Manager login username
  -p PASSWORD, --password=PASSWORD
                        Enea uCPE Manager login password
  -H HOST, --host=HOST  Enea uCPE Manager host name or IP address
  -i VNFINSTANCENAME, --vnfInstanceName=VNFINSTANCENAME
                        Name of VNF instance
  -n VIMDEVICENAME, --device-name=VIMDEVICENAME
                        Name of the device

  Mandatory options:
    -H/--host, -i/--vnfInstanceName, -n/--device-name</programlisting>
      </section>

      <section id="json_destroy">
        <title>Configuring the JSON File</title>

        <para>The JSON configuration file needed to destroy a VNF instance
        should contain a list of dictionaries. Each dictionary indicates the
        test case name and the test case arguments passed to the
        <filename>destroyVNFI</filename> Python module.</para>

        <para><emphasis role="bold">Sample unit-test JSON file
        format:</emphasis><programlisting>[
 {
 "name": "Destroying Fortigate VNF ",
 "args": "-i fortigateFWInstance"
 }
]</programlisting></para>
      </section>

      <section id="pymod_destory">
        <title>Running the Python Module</title>

        <para>The <filename>destroyVNFI</filename> Python module can be
        executed individually by running the following command line:</para>

        <programlisting>$ python destroyVNFI.py -u admin -p admin -H localhost -n intelc3850-2 -i
fortigateFWInstance
2019-03-07 17:33:51,025 - DEBUG: Started logging
2019-03-07 17:33:51,026 - INFO: Destroy VNF
2019-03-07 17:33:51,119 - DEBUG: Login successful on host 'localhost'
2019-03-07 17:33:51,119 - DEBUG: Session token is: 68803ea5-40ee-11e9-a81f525400d08e1d
2019-03-07 17:33:51,128 - DEBUG: Found device with name 'intelc3850-2'
2019-03-07 17:33:51,148 - DEBUG: Found VNF instance with name 'fortigateFWInstance'
2019-03-07 17:33:51,149 - DEBUG: Destroy VNF: fortigateFWInstance
2019-03-07 17:33:51,655 - INFO: Done
2019-03-07 17:33:51,712 - DEBUG: Logging out and exiting...</programlisting>
      </section>
    </section>

    <section id="upload_vnf_image">
      <title>Uploading a NFV Access image onto the Enea uCPE Manager</title>

      <para>Steps and options on how to Upload a NFV Access image onto the
      Enea uCPE Manager are described below.</para>

      <section id="script_opts_upload">
        <title>Script Options</title>

        <programlisting>$ python uploadImage.py -h
Upload NFVA image on uCPE Manager
Usage: uploadImage.py [options]

Upload NFVA image on uCPE Manager.

Options:
  --version             show program's version number and exit
  -h, --help            show this help message and exit
  -u USERNAME, --username=USERNAME
                        Enea uCPE Manager login username
  -p PASSWORD, --password=PASSWORD
                        Enea uCPE Manager login password
  -H HOST, --host=HOST  Enea uCPE Manager host name or IP address
  -f FILENAME, --fileName=FILENAME
                        Path to NFVA image file name
  -m MODULE, --module=MODULE
                        Module name (default is: VcpeAgent)
  -t UPGRADETYPE, --upgradeType=UPGRADETYPE
                        Upgrade Type depends on architecture: xeon_d or
                        atom_c3000

  Mandatory options:
    -H/--host, -f/--fileName, -m/--module, -t/--upgradeType</programlisting>
      </section>

      <section id="json_upload">
        <title>Configuring the JSON File</title>

        <para>The JSON configuration file needed to upload a NFV Access image
        should contain a list of dictionaries. Each dictionary indicates the
        test case name and the test case arguments passed to the
        <filename>uploadImage</filename> Python module.</para>

        <para><emphasis role="bold">Sample unit-test JSON file
        format:</emphasis><programlisting>[
 {
 "name": "Upload NFVA image on uCPE Manager",
 "args": "-f /tmp/enea-nfv-access-xeon-d.rootfs.ostree.tar.bz2 -t xeon_d"
 }
]</programlisting></para>
      </section>

      <section id="pymod_upload">
        <title>Running the Python Module</title>

        <para>The <filename>uploadImage</filename> Python module can be
        executed individually by running the following command line:</para>

        <programlisting>$ python uploadImage.py -u admin -p admin -H localhost \
-f /tmp/enea-nfv-access-xeon-d.rootfs.ostree.tar.bz2 -t xeon_d
2020-02-28 11:38:42,754 - DEBUG: Started logging
2020-02-28 11:38:42,755 - INFO: Upload NFVA image on uCPE Manager
2020-02-28 11:38:43,307 - DEBUG: Login successful on host 'localhost'
2020-02-28 11:38:43,308 - DEBUG: Session token is: 7da3f960-5a16-11ea-a3de-5652b3ac1c30
2020-02-28 11:41:29,148 - INFO: Verify image validation flag
2020-02-28 11:41:29,149 - INFO: Valid flag: True
2020-02-28 11:41:29,344 - INFO: The image \
'enea-nfv-access-xeon-d.rootfs.ostree.tar.bz2' was successfully uploaded
2020-02-28 11:41:29,344 - INFO: Done
2020-02-28 11:41:29,388 - DEBUG: Logging out and exiting...</programlisting>
      </section>
    </section>

    <section id="delete_vnf_image">
      <title>Deleting a NFV Access image file from the Enea uCPE
      Manager</title>

      <para>Steps and options on how to Delete a NFV Access image from the
      Enea uCPE Manager are described below.</para>

      <section id="script_opts_deleteupload">
        <title>Script Options</title>

        <programlisting>$ python deleteUpgradeFile.py -h
Delete NFVA image from uCPE Manager
Usage: deleteUpgradeFile.py [options]

Delete NFVA image from uCPE Manager.

Options:
  --version             show program's version number and exit
  -h, --help            show this help message and exit
  -u USERNAME, --username=USERNAME
                        Enea uCPE Manager login username
  -p PASSWORD, --password=PASSWORD
                        Enea uCPE Manager login password
  -H HOST, --host=HOST  Enea uCPE Manager host name or IP address
  -i IMAGENAME, --imageName=IMAGENAME
                        NFVA Image name
  -m MODULE, --module=MODULE
                        Module name - default is VcpeAgent

  Mandatory options:
    -H/--host, -i/--imageName, -m/--module.</programlisting>
      </section>

      <section id="json_delete_upload">
        <title>Configuring the JSON File</title>

        <para>The JSON configuration file needed to delete a NFV Access image
        should contain a list of dictionaries. Each dictionary indicates the
        test case name and the test case arguments passed to the
        <filename>deleteUpgradeFile</filename> Python module.</para>

        <para><emphasis role="bold">Sample unit-test JSON file
        format:</emphasis><programlisting>[
 {
 "name": "Delete NFVA image on uCPE Manager",
 "args": "-i enea-nfv-access-xeon-d.rootfs.ostree.tar.bz2"
 }
]</programlisting></para>
      </section>

      <section id="pymod_delete_upload">
        <title>Running the Python Module</title>

        <para>The <filename>deleteUpgradeFile</filename> Python module can be
        executed individually by running the following command line:</para>

        <programlisting>$ python deleteUpgradeFile.py -u admin -p admin -H localhost -i \
enea-nfv-access-xeon-d.rootfs.ostree.tar.bz2
2020-02-28 12:06:20,111 - DEBUG: Started logging
2020-02-28 12:06:20,112 - INFO: Delete NFVA image from uCPE Manager
2020-02-28 12:06:20,210 - DEBUG: Login successful on host 'localhost'
2020-02-28 12:06:20,211 - DEBUG: Session token is: 594b2d50-5a1a-11ea-a3de-5652b3ac1c30
2020-02-28 12:06:20,255 - INFO: The image \
'enea-nfv-access-xeon-d.rootfs.ostree.tar.bz2' was successfully found
2020-02-28 12:06:20,256 - INFO: The oid for \
'enea-nfv-access-xeon-d.rootfs.ostree.tar.bz2' image name is as follows: \
VcpeAgent/xeon_d/enea-nfv-access-xeon-d.rootfs.ostree.tar.bz2
2020-02-28 12:06:20,449 - INFO: The 'enea-nfv-access-xeon-d.rootfs.ostree.tar.bz2' \
image was successfully removed
2020-02-28 12:06:20,479 - INFO: Done
2020-02-28 12:06:20,517 - DEBUG: Logging out and exiting...</programlisting>
      </section>
    </section>

    <section id="install_activate_vnf_image">
      <title>Installing and activating a NFV Access image on an uCPE device
      from the Enea uCPE Manager</title>

      <para>Steps and options on how to Install and Activate a NFV Access
      image on an uCPE device from the Enea uCPE Manager are described
      below.</para>

      <section id="script_opts_install_activate">
        <title>Script Options</title>

        <programlisting>$ python installAndActivate.py -h
Install and activate NFVA image from uCPE Manager
Usage: installAndActivate.py [options]

Install and activate NFVA image from uCPE Manager.

Options:
  --version             show program's version number and exit
  -h, --help            show this help message and exit
  -u USERNAME, --username=USERNAME
                        Enea uCPE Manager login username
  -p PASSWORD, --password=PASSWORD
                        Enea uCPE Manager login password
  -H HOST, --host=HOST  Enea uCPE Manager host name or IP address
  -i IMAGENAME, --imageName=IMAGENAME
                        Image name
  -m MODULE, --module=MODULE
                        Module name -- VcpeAgent
  -t UPGRADETYPE, --upgradeType=UPGRADETYPE
                        Upgrade Type -- xeon_d or atom_c3000
  -d DEVICENAME, --deviceName=DEVICENAME
                        Device Name

  Mandatory options:
    -H/--host, -i/--imageName, -t/--upgradeType, -d/--deviceName,
    -m/--module</programlisting>
      </section>

      <section id="json_install_activate">
        <title>Configuring the JSON File</title>

        <para>The JSON configuration file needed to install and activate a NFV
        Access image on a uCPE device from the Enea uCPE Manager should
        contain a list of dictionaries. Each dictionary indicates the test
        case name and the test case arguments passed to the
        <filename>installAndActivate</filename> Python module.</para>

        <para><emphasis role="bold">Sample unit-test JSON file
        format:</emphasis></para>

        <programlisting>[
 {
 "name": "Install and activate NFVA image on uCPE device from uCPE Manager",
 "args": "-i enea-nfv-access-xeon-d.rootfs.ostree.tar.bz2 -t xeon_d -d inteld1521-16"
 }
]</programlisting>
      </section>

      <section id="pymod_install_activate">
        <title>Running the Python Module</title>

        <para>The <filename>installAndActivate</filename> Python module can be
        executed individually by running the following command line:</para>

        <programlisting>$ python installAndActivate.py -u admin -p admin -H localhost -i \
enea-nfv-access-xeon-d.rootfs.ostree.tar.bz2 -t xeon_d -d inteld1521-16
2020-02-28 12:36:46,137 - DEBUG: Started logging
2020-02-28 12:36:46,138 - INFO: Install and activate NFVA image from uCPE Manager
2020-02-28 12:36:46,288 - DEBUG: Login successful on host 'localhost'
2020-02-28 12:36:46,288 - DEBUG: Session token is: 99b7cde0-5a1e-11ea-a3de-5652b3ac1c30
2020-02-28 12:36:46,325 - DEBUG: Found device with name 'inteld1521-16'
2020-02-28 12:36:46,459 - INFO: Display info about NFVA installation \
[inteld1521-16:1001:172.24.12.152] Install Started
2020-02-28 12:36:46,492 - INFO: Transferring Image: \
enea-nfv-access-xeon-d.rootfs.ostree.tar.bz2
2020-02-28 12:36:56,552 - INFO: Verifying Release [1]
2020-02-28 12:37:06,599 - INFO: Verifying Release [2]
2020-02-28 12:37:16,652 - INFO: Validating Upgrade to \
enea-nfv-access-xeon-d.rootfs.ostree.tar.bz2
2020-02-28 12:37:26,713 - INFO: Validating upgrade to \
enea-nfv-access-xeon-d.rootfs.ostree.tar.bz2 [3]
2020-02-28 12:37:36,770 - INFO: Validating upgrade to \
enea-nfv-access-xeon-d.rootfs.ostree.tar.bz2 [5]
2020-02-28 12:37:46,819 - INFO: Validating upgrade to \
enea-nfv-access-xeon-d.rootfs.ostree.tar.bz2 [7]
2020-02-28 12:37:56,879 - INFO: Validating upgrade to \
enea-nfv-access-xeon-d.rootfs.ostree.tar.bz2 [9]
2020-02-28 12:38:06,920 - INFO: Validating upgrade to \
enea-nfv-access-xeon-d.rootfs.ostree.tar.bz2 [11]
2020-02-28 12:38:16,975 - INFO: Validating upgrade to \
enea-nfv-access-xeon-d.rootfs.ostree.tar.bz2 [13]
2020-02-28 12:38:27,019 - INFO: Validating upgrade to \
enea-nfv-access-xeon-d.rootfs.ostree.tar.bz2 [15]
2020-02-28 12:38:37,091 - INFO: Validating upgrade to \
enea-nfv-access-xeon-d.rootfs.ostree.tar.bz2 [18]
2020-02-28 12:38:47,133 - INFO: Validating upgrade to \
enea-nfv-access-xeon-d.rootfs.ostree.tar.bz2 [20]
2020-02-28 12:38:57,186 - INFO: Waiting for release to become active
2020-02-28 12:39:07,231 - INFO: Upgrade Request Complete
2020-02-28 12:39:17,242 - INFO: Installation completed!
2020-02-28 12:39:17,243 - INFO: Done
2020-02-28 12:39:17,294 - DEBUG: Logging out and exiting...</programlisting>
      </section>
    </section>

    <section id="clearing_info_upgrade">
      <title>Clearing information about completed upgrades of uCPE devices
      from the Enea uCPE Manager</title>

      <para>Steps and options on how to clear information about completed
      upgrades of uCPE devices from the Enea uCPE Manager are described
      below.</para>

      <section id="script_opts_clearinfo">
        <title>Script Options</title>

        <programlisting>$ python clearCompletedUpgradesInfo.py -h
Clear info about completed upgrades
Usage: clearCompletedUpgradesInfo.py [options]

Clear info about completed upgrades

Options:
  --version             show program's version number and exit
  -h, --help            show this help message and exit
  -u USERNAME, --username=USERNAME
                        Enea uCPE Manager login username
  -p PASSWORD, --password=PASSWORD
                        Enea uCPE Manager login password
  -H HOST, --host=HOST  Enea uCPE Manager host name or IP address

  Mandatory options:
    -H/--host </programlisting>
      </section>

      <section id="json_clear_info">
        <title>Configuring the JSON File</title>

        <para>No JSON configuration file is needed to clear information about
        completed upgrades of uCPE devices from the Enea uCPE Manager. The
        <filename>clearCompletedUpgradesInfo</filename> Python module can be
        run without a JSON file as a parameter.</para>
      </section>

      <section id="pymod_clear_info">
        <title>Running the Python Module</title>

        <para>The <filename>clearCompletedUpgradesInfo</filename> Python
        module can be executed individually by running the following command
        line:</para>

        <programlisting>$ python clearCompletedUpgradesInfo.py -u admin -p admin -H localhost
2020-02-28 12:51:55,861 - DEBUG: Started logging
2020-02-28 12:51:55,862 - INFO: Clear info about completed upgrades
2020-02-28 12:51:55,950 - DEBUG: Login successful on host 'localhost'
2020-02-28 12:51:55,951 - DEBUG: Session token is: b7eb83e0-5a20-11ea-a3de-5652b3ac1c30
2020-02-28 12:51:55,993 - INFO: Done
2020-02-28 12:51:56,025 - DEBUG: Logging out and exiting...</programlisting>
      </section>
    </section>

    <section id="upload_custom_script">
      <title>Uploading a Custom Script to the uCPE Manager</title>

      <para>Steps and options on how to upload a custom script to the uCPE
      Manager are described below.</para>

      <section id="script_opts_upload_custom_script">
        <title>Script Options</title>

        <programlisting>$ python customScripts/upload.py -h
2020-04-14 10:26:23,582 - INFO: Upload Custom Script
Usage: upload.py [options]

Add a Custom Script to Enea uCPE Manager

Options:
  --version             show program's version number and exit
  -h, --help            show this help message and exit
  -u USERNAME, --username=USERNAME
                        Enea uCPE Manager login username
  -p PASSWORD, --password=PASSWORD
                        Enea uCPE Manager login password
  -H HOST, --host=HOST  Enea uCPE Manager host name or IP address
  -f CUSTOMSCRIPT, --file=CUSTOMSCRIPT
                        Custom Script File
  -e PHASE, --phase=PHASE
                        Execution phase. Must be one of the following: once-
                        before-startup | always-before-startup | once-after-
                        startup | always-after-startup

  Mandatory options:
    -H/--host, -f/--file, -e/--phase</programlisting>
      </section>

      <section id="json_upload_custom_script">
        <title>Configuring the JSON File</title>

        <para>The JSON configuration file needed to upload a Custom Script to
        the uCPE Manager must contain a list of dictionaries. Each dictionary
        indicates the test case name and the test case arguments passed to the
        <filename>customScripts/upload</filename> Python module.</para>

        <para><emphasis role="bold">Sample unit-test JSON file
        format:</emphasis></para>

        <programlisting>[
 {
  "name": "Uploading a Custom Script to the uCPE Manager",
  "args": "-f ../../lab_config/customScripts/test_success_after_always \
  -e always-after-startup"
 }
]</programlisting>
      </section>

      <section id="pymod_upload_custom_script">
        <title>Running the Python Module</title>

        <para>The <filename>customScripts/upload</filename> Python module can
        be executed individually by running the following command line:</para>

        <programlisting>$ python automation_framework/customScripts/upload.py \
-f lab_config/customScripts/test_success_after_always -e always-after-startup
2020-04-14 14:08:02,824 - DEBUG: Started logging
2020-04-14 14:08:02,915 - INFO: Upload Custom Script
2020-04-14 14:08:02,994 - DEBUG: Login successful on host '172.24.3.109'
2020-04-14 14:08:02,995 - DEBUG: Session token is: 97544990-7e48-11ea-835c-02423a1c239f
2020-04-14 14:08:02,996 - DEBUG: Upload test_success_after_always to uCPE Manager. \
Content: #!/bin/bash
echo test_success_after_always
2020-04-14 14:08:03,138 - INFO: Done
2020-04-14 14:08:03,169 - DEBUG: Logging out and exiting...</programlisting>
      </section>
    </section>

    <section id="upload_custom_script_device">
      <title>Uploading a Custom Script from the uCPE Manager to a
      Device</title>

      <para>Steps and options on how to upload a custom script from the uCPE
      Manager to a Device are described below.</para>

      <section id="script_opts_upload_custom_script_device">
        <title>Script Options</title>

        <programlisting>$ python customScripts/uploadOnDevice.py -h
2020-04-14 10:27:05,614 - INFO: Upload Custom Script on Device
Usage: uploadOnDevice.py [options]

Add a Custom Script to a Device

Options:
  --version             show program's version number and exit
  -h, --help            show this help message and exit
  -u USERNAME, --username=USERNAME
                        Enea uCPE Manager login username
  -p PASSWORD, --password=PASSWORD
                        Enea uCPE Manager login password
  -H HOST, --host=HOST  Enea uCPE Manager host name or IP address
  -c CUSTOMSCRIPTNAME, --customScriptName=CUSTOMSCRIPTNAME
                        Custom Script Name that resides on Enea uCPE Manager
  -e PHASE, --phase=PHASE
                        Execution phase. Must be one of the following: once-
                        before-startup | always-before-startup | once-after-
                        startup | always-after-startup
  -n DEVICENAME, --device-name=DEVICENAME
                        Name of the device
  -r, --reboot          Reboot the device after uploading

  Mandatory options:
    -H/--host, -c/--customScriptName, -e/--phase, -n/--device-name</programlisting>
      </section>

      <section id="json_upload_custom_script_device">
        <title>Configuring the JSON File</title>

        <para>The JSON configuration file needed to upload a Custom Script
        from the uCPE Manager to a Device must contain a list of dictionaries.
        Each dictionary indicates the test case name and the test case
        arguments passed to the
        <filename>customScripts/uploadOnDevice</filename> Python
        module.</para>

        <para><emphasis role="bold">Sample unit-test JSON file
        format:</emphasis></para>

        <programlisting>[
{
"name": "Uploading a Custom Script from uCPE Manager to device",
"args": "-c test_success_after_always -e always-after-startup -n inteld1521-6"
}
]</programlisting>
      </section>

      <section id="pymod_upload_custom_script_device">
        <title>Running the Python Module</title>

        <para>The <filename>customScripts/uploadOnDevice</filename> Python
        module can be executed individually by running the following command
        line:</para>

        <programlisting>$ python automation_framework/customScripts/uploadOnDevice.py -c \
test_success_after_always -e always-after-startup -n inteld1521-6
2020-04-14 14:26:26,205 - DEBUG: Started logging
2020-04-14 14:26:26,206 - INFO: Upload Custom Script on Device
2020-04-14 14:26:26,251 - DEBUG: Login successful on host '172.24.3.109'
2020-04-14 14:26:26,252 - DEBUG: Session token is: 28ebcb10-7e4b-11ea-835c-02423a1c239f
2020-04-14 14:26:26,286 - DEBUG: Found device with name 'inteld1521-6'
2020-04-14 14:26:26,287 - DEBUG: Upload test_success_after_always to inteld1521-6
2020-04-14 14:26:26,314 - INFO: Done
2020-04-14 14:26:26,341 - DEBUG: Logging out and exiting...</programlisting>
      </section>
    </section>

    <section id="delete_custom_script">
      <title>Removing a Custom Script from the uCPE Manager</title>

      <para>Steps and options on how to remove a custom script from the uCPE
      Manager are described below.</para>

      <section id="script_opts_delete_custom_script">
        <title>Script Options</title>

        <programlisting>$ python customScripts/delete.py -h
2020-04-14 14:36:52,010 - INFO: Delete Custom Script on uCPE Manager
Usage: delete.py [options]

Delete a Custom Script from a Device

Options:
  --version             show program's version number and exit
  -h, --help            show this help message and exit
  -u USERNAME, --username=USERNAME
                        Enea uCPE Manager login username
  -p PASSWORD, --password=PASSWORD
                        Enea uCPE Manager login password
  -H HOST, --host=HOST  Enea uCPE Manager host name or IP address
  -c CUSTOMSCRIPTNAME, --customScriptName=CUSTOMSCRIPTNAME
                        Custom Script Name that resides on a Device
  -e PHASE, --phase=PHASE
                        Execution phase. Must be one of the following: once-
                        before-startup | always-before-startup | once-after-
                        startup | always-after-startup

  Mandatory options:
    -H/--host, -e/--phase</programlisting>
      </section>

      <section id="json_delete_custom_script">
        <title>Configuring the JSON File</title>

        <para>The JSON configuration file needed to remove a Custom Script
        from the uCPE Manager<remark>did you mean device or uCPE
        Manager?</remark> must contain a list of dictionaries. Each dictionary
        indicates the test case name and the test case arguments passed to the
        <filename>customScripts/delete</filename> Python module.</para>

        <para><emphasis role="bold">Sample unit-test JSON file
        format:</emphasis></para>

        <programlisting>[
{
"name": "Removing a Custom Script from uCPE Manager",
"args": "-c test_success_after_always -e always-after-startup"
}
]</programlisting>
      </section>

      <section id="pymod_delete_custom_script">
        <title>Running the Python Module</title>

        <para>The <filename>customScripts/delete</filename> Python module can
        be executed individually by running the following command line:</para>

        <programlisting>$ python automation_framework/customScripts/delete.py -c \
test_success_after_always -e always-after-startup
2020-04-14 14:39:22,042 - DEBUG: Started logging
2020-04-14 14:39:22,042 - INFO: Delete Custom Script on uCPE Manager
2020-04-14 14:39:22,081 - DEBUG: Login successful on host '172.24.3.109'
2020-04-14 14:39:22,082 - DEBUG: Session token is: f75a83a0-7e4c-11ea-835c-02423a1c239f
2020-04-14 14:39:22,099 - DEBUG: Found custom script: 'test_success_after_always'
2020-04-14 14:39:22,099 - DEBUG: Delete script test_success_after_always, \
phase always-after-startup from uCPE Manager
2020-04-14 14:39:22,118 - INFO: Done
2020-04-14 14:39:22,135 - DEBUG: Logging out and exiting...</programlisting>
      </section>
    </section>

    <section id="delete_custom_script_device">
      <title>Removing a Custom Script from a Device</title>

      <para>Steps and options on how to remove a custom script from a device
      are described below.</para>

      <section id="script_opts_delete_custom_script_device">
        <title>Script Options</title>

        <programlisting>$ python customScripts/deleteOnDevice.py -h
2020-04-14 10:27:23,536 - INFO: Delete Custom Script on Device
Usage: deleteOnDevice.py [options]

Delete a Custom Script from a Device

Options:
  --version             show program's version number and exit
  -h, --help            show this help message and exit
  -u USERNAME, --username=USERNAME
                        Enea uCPE Manager login username
  -p PASSWORD, --password=PASSWORD
                        Enea uCPE Manager login password
  -H HOST, --host=HOST  Enea uCPE Manager host name or IP address
  -c CUSTOMSCRIPTNAME, --customScriptName=CUSTOMSCRIPTNAME
                        Custom Script Name that resides on a Device
  -e PHASE, --phase=PHASE
                        Execution phase. Must be one of the following: once-
                        before-startup | always-before-startup | once-after-
                        startup | always-after-startup
  -n DEVICENAME, --device-name=DEVICENAME
                        Name of the device

  Mandatory options:
    -H/--host, -n/--device-name</programlisting>
      </section>

      <section id="json_delete_custom_script_device">
        <title>Configuring the JSON File</title>

        <para>The JSON configuration file needed to remove a Custom Script
        from a device must contain a list of dictionaries. Each dictionary
        indicates the test case name and the test case arguments passed to the
        <filename>customScripts/deleteOnDevice</filename> Python
        module.</para>

        <para><emphasis role="bold">Sample unit-test JSON file
        format:</emphasis></para>

        <programlisting>[
{
"name": "Removing a Custom Script from device",
"args": "-c test_success_after_always -e always-after-startup -n inteld1521-6"
}
]</programlisting>
      </section>

      <section id="pymod_delete_custom_script_delete">
        <title>Running the Python Module</title>

        <para>The <filename>customScripts/deleteOnDevice</filename> Python
        module can be executed individually by running the following command
        line:</para>

        <programlisting>$ python automation_framework/customScripts/deleteOnDevice.py -c \
test_success_after_always -e always-after-startup -n inteld1521-6
2020-04-14 14:33:52,288 - DEBUG: Started logging
2020-04-14 14:33:52,288 - INFO: Delete Custom Script on Device
2020-04-14 14:33:52,327 - DEBUG: Login successful on host '172.24.3.109'
2020-04-14 14:33:52,327 - DEBUG: Session token is: 32cde4f0-7e4c-11ea-835c-02423a1c239f
2020-04-14 14:33:52,349 - DEBUG: Found device with name 'inteld1521-6'
2020-04-14 14:33:52,349 - DEBUG: Delete test_success_after_always, \
phase always-after-startup from inteld1521-6
2020-04-14 14:33:52,373 - INFO: Done
2020-04-14 14:33:52,391 - DEBUG: Logging out and exiting...</programlisting>
      </section>
    </section>

    <section id="offline_config_store">
      <title>Setting up an Offline Configuration Store</title>

      <para>Steps and options on how to add and remove a Config Store in the
      Enea uCPE Manager are described below.</para>

      <section id="script_opts_config_store">
        <title>Script Options</title>

        <para>To add a config store in the Enea uCPE Manager use the
        <filename>addConfigStore.py</filename> script detailed below. Bear in
        mind a <filename>CONFIGSTORE</filename> json file is needed to
        successfully run the script in order to add an offline configuration
        store.</para>

        <para>Example of a <filename>CONFIGSTORE</filename> json file:</para>

        <programlisting>{
    "descr": "intelc3850-2",
    "version": "2.2.2",
    "deviceGroupingTags": "",
    "deviceId": "intelc3850-2",
    "name": "intelc3850-2"
}</programlisting>

        <para>Adding an offline config store in the Enea uCPE Manager using
        the command line:</para>

        <programlisting>$ python addConfigStore.py -h
Usage: addConfigStore.py [options]

Add a config store in Enea uCPE Manager.

Options:
  --version             show program's version number and exit
  -h, --help            show this help message and exit
  -u USERNAME, --username=USERNAME
                        Enea uCPE Manager login username
  -p PASSWORD, --password=PASSWORD
                        Enea uCPE Manager login password
  -H HOST, --host=HOST  Enea uCPE Manager host name or IP address
  -f CONFIGSTOREFILE, --file=CONFIGSTOREFILE
                        File containing Store Information in JSON format

  Mandatory options:
    -H/--host, -f/--file</programlisting>

        <para>Removing a config store in the Enea uCPE Manager using the
        command line:</para>

        <programlisting>python removeConfigStore.py -h
Usage: removeConfigStore.py [options]

Remove a config store from Enea uCPE Manager.

Options:
  --version             show program's version number and exit
  -h, --help            show this help message and exit
  -u USERNAME, --username=USERNAME
                        Enea uCPE Manager login username
  -p PASSWORD, --password=PASSWORD
                        Enea uCPE Manager login password
  -H HOST, --host=HOST  Enea uCPE Manager host name or IP address
  -o STORENAME, --store-name=STORENAME
                        Name of the Offline Config Store

  Mandatory options:
    -H/--host, -o/--store-name</programlisting>

        <para>Modifications of an Offline Configurations Store are not possible 
          post deployment in the uCPE Manager, as there is no option for
          changing script states (e.g. changing the DPDK state in the 
          <filename>configDPDK.py</filename> python script or unbinding interfaces). 
          The offline store must be deleted and the new state(s)/changes added in, 
          before being deployed anew. This was not deemed necessary
          for the current ZTP functionality.</para>
          
          <para>An action on a device is applied immediately, while 
          a configuration in an offline configuration store is something 
          prepared for the future (when the device is added to the
        uCPE Manager and the configuration is sent to it). The
        configuration is ideally created with the needed modifications from
          the start.</para>
      </section>
    </section>
  </section>

  <section id="test_harness">
    <title>Test Harness</title>

    <para>All Test Harness sources are under the
    <literal>&lt;AF-TH-install-dir&gt;</literal> directory and the host file
    is the Ansible inventory file. See the complete tree listing at the
    beginning of this chapter for details.</para>

    <para>The Ansible based Test Harness represents an example of how to
    structure all the files needed for creating automated test cases using the
    AF and provides a way to implement them. The
    <filename>ansible.cfg</filename> file contains an example of the Ansible
    default configuration. It offers the possibility to display the Ansible
    console output in different ways, by setting the
    <literal>stdout_callback</literal> option to <literal>selective</literal>
    or <literal>debug</literal>. The default value for this option is set to
    <literal>selective</literal> to print only certain tasks. It is
    recommended to switch to <literal>debug</literal> when a test fails. By
    setting the parameter <literal>any_errors_fatal</literal> to
    <literal>True</literal>, task failures will be considered fatal errors
    (the play execution will stop). <remark>and why would this stop of play
    execution help in this debugging scenario</remark></para>

    <para>All Playbooks that execute AF python modules run on
    <literal>localhost</literal>. New entries have to be created for direct
    communication over SSH with the boards, as done in the
    <literal>[fortigateFW]</literal> example.</para>

    <para>The <filename>setup_env.sh</filename> script sets up the
    <literal>testHarness</literal> test environment by creating
    <literal>testHarness-venv python virtualenv</literal>, executing requests
    needed by Automation Framework python modules and installing Ansible. The
    playbooks directory contains all the implemented Ansible Playbooks. For
    more details please refer to chapter "Sample Test Cases" from the Enea NFV
    Access System Test Specification document <remark>need an olink to that
    chapter here.</remark>.</para>

    <para>The <literal>uCPEM_config</literal> directory stores JSON
    configuration files needed for the setup of the uCPE Manager used by TH.
    One configuration file is needed per uCPE Manager installation, to be used
    in the TH. The <literal>vnf_image</literal> directory stores the VNF
    Images needed by the Ansible Playbooks (i.e. the sample test
    cases).</para>

    <para>The <literal>lab_config</literal> directory stores the JSON
    configuration files related to a device (devices<remark>clarify this
    please, what devices do you mean?</remark>, NICs and bridges). Each
    subfolder should be named exactly like the device name and should contain
    all the related configuration files needed for the test cases to be run on
    it.</para>

    <para>The <literal>vnf_config</literal> directory stores the configuration
    files related to a VNF Descriptor. Typically these include a VNF Image
    JSON, VNF Instance JSON, VNF license and any other files required by the
    type of the VNF. Each subfolder should be named exactly like the name of
    the VNF Descriptor and should contain all the related configuration files
    needed for test cases to be run using this VNF.</para>

    <para>The log directory is created when the
    <literal>setup_env.sh</literal> is run. When test cases are run, the
    Ansible and the Python logs are stored in the
    <filename>ansible.log</filename> and <filename>debug.log</filename> files,
    respectively.</para>
  </section>
</chapter>