Separated the Offline Config content into 4 sections.

Change-Id: Ifdb0c53d07679a38273a4697790aea1469759f0a
Signed-off-by: mrpa <miruna.paun@enea.com>

1 files changed, 106 insertions, 48 deletions

diff --git a/doc/book-enea-nfv-access-auto-fw-th-user-guide/doc/automation_framework_test_harness.xml b/doc/book-enea-nfv-access-auto-fw-th-user-guide/doc/automation_framework_test_harness.xml
index 2cf02b6..d2c686a 100644
--- a/doc/book-enea-nfv-access-auto-fw-th-user-guide/doc/automation_framework_test_harness.xml
+++ b/doc/book-enea-nfv-access-auto-fw-th-user-guide/doc/automation_framework_test_harness.xml
@@ -491,8 +491,8 @@ OK</programlisting>
 fortigateCleanup.json -d "Fortigate cleanup scenario"</programlisting>
 
         <para>Setting the console logging level to INFO:</para>
-          
-          <programlisting>consoleLoggingLevel = logging.INFO</programlisting>
+
+        <programlisting>consoleLoggingLevel = logging.INFO</programlisting>
 
         <para><emphasis role="bold">Expected Output:</emphasis></para>
 
@@ -2407,13 +2407,13 @@ phase always-after-startup from inteld1521-6
       </section>
     </section>
 
-    <section id="offline_config_store">
-      <title>Setting up an Offline Configuration Store</title>
+    <section id="add_offline_config_store">
+      <title>Adding 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>
+      <para>Steps and options on how to add a Config Store in the Enea uCPE
+      Manager are described below.</para>
 
-      <section id="script_opts_config_store">
+      <section id="script_opts_add_config_store">
         <title>Script Options</title>
 
         <para>To add a config store in the Enea uCPE Manager use the
@@ -2421,41 +2421,48 @@ phase always-after-startup from inteld1521-6
         mind a <filename>CONFIGSTORE</filename> json file is needed to
         successfully run the script in order to add an offline configuration
         store.</para>
+      </section>
+
+      <section id="json_add_config_store">
+        <title>Configuring the JSON file</title>
 
         <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"
+"descr": "intelc3850-2",
+"version": "2.2.2",
+"deviceGroupingTags": "",
+"deviceId": "intelc3850-2",
+"name": "intelc3850-2"
 }</programlisting>
+      </section>
+
+      <section id="runpy_add_config_store">
+        <title>Running the Python Module</title>
 
         <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]
+        <programlisting>python automation_framework/device/addConfigStore.py -f \
+lab_config/inteld1521-16/store.json
+2020-10-16 09:35:51,084 - INFO: Add offline config store
+2020-10-16 09:35:51,160 - INFO: Done</programlisting>
+      </section>
+    </section>
 
-Add a config store in Enea uCPE Manager.
+    <section id="upload_offline_config_store">
+      <title>Uploading an Offline Configuration Store to an uCPE
+      Device</title>
 
-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
+      <para>Steps and options on how to upload a config store to a device are
+      described below.</para>
 
-  Mandatory options:
-    -H/--host, -f/--file</programlisting>
+      <section id="script_opts_upload_config_store">
+        <title>Script options</title>
 
-        <para>Uploading an offline configuration store to a uCPE Device 
-          using the command line:</para>
+        <para>To upload a config store to a uCPE Device use the
+        <filename>uploadConfigStore.py</filename> script detailed
+        below.</para>
 
         <programlisting>python uploadConfigStore.py -h
 Usage: uploadConfigStore.py [options]
@@ -2477,9 +2484,31 @@ Options:
 
   Mandatory options:
     -H/--host, -s/--store, -d/--device</programlisting>
+      </section>
+
+      <section id="runpy_upload_config_store">
+        <title>Running the Python Modules</title>
+
+        <programlisting>python automation_framework/device/uploadConfigStore.py -s inteld1521-16 \
+-d inteld1521-16
+2020-10-16 09:37:29,074 - INFO: Upload offline configuration to uCPE Device
+2020-10-16 09:37:49,321 - INFO: The 'inteld1521-16' config store was successfully \
+uploaded on device!
+2020-10-16 09:37:49,322 - INFO: Done</programlisting>
+      </section>
+    </section>
+
+    <section id="check_upload_offline_config_store">
+      <title>Checking the Upload of an Offline Configuration Store</title>
+
+      <para>Steps and options on how to check an upload of a Config Store to a
+      Device are described below.</para>
 
-        <para>Checking the upload of an offline configuration store to a uCPE
-        Device using the command line:</para>
+      <section id="script_opts_check_upload_config_store">
+        <title>Script options</title>
+
+        <para>To check an upload a config store to a uCPE Device use the
+        <filename>getUploadStatus.py</filename> script detailed below.</para>
 
         <programlisting>python getUploadStatus.py -h
 Usage: getUploadStatus.py [options]
@@ -2499,9 +2528,44 @@ Options:
 
   Mandatory options:
     -H/--host, -d/--device</programlisting>
+      </section>
+
+      <section id="runpy_check_upload_config_store">
+        <title>Running the Python Modules</title>
+
+        <programlisting>python automation_framework/device/getUploadStatus.py -d inteld1521-16
+2020-10-16 09:38:33,388 - INFO: Get upload offline configure status on uCPE Device
+2020-10-16 09:38:33,486 - INFO: Successful: True
+2020-10-16 09:38:33,487 - INFO: Store name: inteld1521-16
+2020-10-16 09:38:33,488 - INFO: In progress: False
+2020-10-16 09:38:33,489 - INFO: A config store was successfully uploaded on device!
+2020-10-16 09:38:33,490 - INFO: Done</programlisting>
+      </section>
+    </section>
+
+    <section id="remove_offline_config_store">
+      <title>Removing an Offline Configuration Store in the Enea uCPE
+      Manager</title>
+
+      <para>Steps and options on how to remove an upload of a Config Store
+      from the uCPE Manager are described below.</para>
+
+      <note>
+        <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>
+      </note>
+
+      <section id="script_opts_remove_config_store">
+        <title>Script options</title>
 
-        <para>Removing a config store in the Enea uCPE Manager using the
-        command line:</para>
+        <para>To remove a config store from the uCPE Manager use the
+        <filename>removeConfigStore.py</filename> script detailed
+        below.</para>
 
         <programlisting>python removeConfigStore.py -h
 Usage: removeConfigStore.py [options]
@@ -2521,20 +2585,14 @@ Options:
 
   Mandatory options:
     -H/--host, -o/--store-name</programlisting>
+      </section>
 
-        <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>
+      <section id="runpy_remove_config_store">
+        <title>Running the Python Modules</title>
 
-        <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>
+        <programlisting>python automation_framework/device/removeConfigStore.py -o inteld1521-16
+2020-10-16 09:39:39,127 - INFO: Remove offline config store
+2020-10-16 09:39:39,289 - INFO: Done</programlisting>
       </section>
     </section>
   </section>
@@ -2573,8 +2631,8 @@ Options:
     needed by Automation Framework python modules and installing
     Ansible.</para>
 
-    <para>The Ansible package version installed in the test environment is 2.9.6. 
-      The playbooks are based on this version of Ansible.</para>
+    <para>The Ansible package version installed in the test environment is
+    2.9.6. The playbooks are based on this version of Ansible.</para>
 
     <para>The <literal>/playbooks</literal> directory contains all the
     implemented Ansible Playbooks. For more details please refer to the <olink
@@ -2613,4 +2671,4 @@ Options:
     <filename>ansible.log</filename> and <filename>debug.log</filename> files,
     respectively.</para>
   </section>
-</chapter>
+</chapter>
\ No newline at end of file