summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorCristian Scrieciu <cristian.scrieciu@enea.com>2019-07-09 15:06:23 +0200
committerMiruna Paun <Miruna.Paun@enea.com>2019-07-09 16:09:42 +0200
commita2dd39280cf13260beec73366d0a1eec9a5a14e9 (patch)
treec5225766dac871d243516d594cf4aecb60b61594
parent6fb6a2bc7ea2f48b8d2cfb7cdde1c58ba1cd039e (diff)
downloadnfv-access-documentation-a2dd39280cf13260beec73366d0a1eec9a5a14e9.tar.gz
LXCR-9083 Add getEventsForUcpe.py & getNetworkInterfaces.py to AF-TH UG
Change-Id: Id4f0f71e9905a501dd9dd691ac9a1cdc4c7e2ef9
Diffstat
-rw-r--r--doc/book-enea-nfv-access-auto-fw-th-user-guide/doc/automation_framework_test_harness.xml160
1 files changed, 157 insertions, 3 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 3a154fa..f3d6720 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
@@ -766,8 +766,82 @@ Options:
766 </section> 766 </section>
767 </section> 767 </section>
768 768
769 <section id="print_ucpe_log">
770 <title>Printing the uCPE Device log</title>
771
772 <para>Print the events log for a specific uCPE device installed in Enea uCPE Manager.</para>
773
774 <section id="print_script_opts">
775 <title>Script Options</title>
776
777 <programlisting>
778$ python getEventsForUcpe.py -h
779Usage: getEventsForUcpe.py [options]
780
781Print the events log for a specific uCPE installed in Enea uCPE Manager.
782
783Options:
784--version show program's version number and exit
785-h, --help show this help message and exit
786-u USERNAME, --username=USERNAME Enea uCPE Manager login username
787-p PASSWORD, --password=PASSWORD Enea uCPE Manager login password
788-H HOST, --host=HOST Enea uCPE Manager host name or IP address
789-f DEVICEFILE, --file=DEVICEFILE File containing uCPE Information in JSON format
790-s SEVERITY, --severity=SEVERITY Event severity level (Critical|Major|Minor)
791
792Mandatory options:
793-H/--host, -f/--file
794 </programlisting>
795 </section>
796
797 <section id="config_json_log">
798 <title>Configuring the JSON File</title>
799
800 <para><emphasis role="bold">Sample <filename>intelc3850-2.json</filename>
801 configuration file:</emphasis></para>
802
803 <programlisting>{
804"name": "intelc3850-2",
805"description": "",
806"address": "172.24.12.114",
807"port": "22",
808"username": "root",
809"password": "root",
810"certificate": null,
811"passphrase": null,
812"maintMode": "false"
813 }</programlisting>
814 </section>
815
816 <section id="runpy_mod_log">
817 <title>Running the Python Module</title>
818
819 <para>The <literal>getEventsForUcpe</literal> Python module can be executed
820 individually by running the following command:</para>
821 <programlisting>
822$ python getEventsForUcpe.py -H localhost -f \
823../../lab_config/intelc3850-2/intelc3850-2.json
824
8252019-07-04 13:48:31,289 - DEBUG: Started logging
8262019-07-04 13:48:31,290 - INFO: Dump uCPE events
8272019-07-04 13:48:31,336 - DEBUG: Login successful on host '172.24.3.108'
8282019-07-04 13:48:31,336 - DEBUG: Session token is: a53c68d3-9e51-11e9-a715-5254007632e2
8292019-07-04 13:48:31,356 - DEBUG: Found device with name 'intelc3850-2'
8302019-07-04 13:48:31,357 - DEBUG:
831Events on device: intelc3850-2 and severity: 1000
8322019-07-04 13:48:31,450 - DEBUG: Dumping 1 events
8332019-07-04 13:48:31,450 - DEBUG: Device Disconnected | Alarm | Device | None | \
834 2019-07-04 09:57:40.042
8352019-07-04 13:48:31,469 - DEBUG: Dumping 0 events
8362019-07-04 13:48:31,469 - INFO: Done
8372019-07-04 13:48:31,488 - DEBUG: Logging out and exiting...
838 </programlisting>
839 </section>
840
841 </section>
842
769 <section id="bind_ucpe_device"> 843 <section id="bind_ucpe_device">
770 <title>Bind a network interface</title> 844 <title>Binding a network interface</title>
771 845
772 <para>Binds a physical network interface to a DPDK or SR-IOV. 846 <para>Binds a physical network interface to a DPDK or SR-IOV.
773 </para> 847 </para>
@@ -832,7 +906,7 @@ format
832 <section id="runpy_bind"> 906 <section id="runpy_bind">
833 <title>Running the Python Module</title> 907 <title>Running the Python Module</title>
834 908
835 <para>The bindNetworkInterface Python module can be executed 909 <para>The <literal>bindNetworkInterface</literal> Python module can be executed
836 individually by running the following command line:</para> 910 individually by running the following command line:</para>
837 911
838 <programlisting>$ python bindNetworkInterface.py -u admin -p admin -H localhost -f 912 <programlisting>$ python bindNetworkInterface.py -u admin -p admin -H localhost -f
@@ -849,7 +923,7 @@ format
849 </section> 923 </section>
850 924
851 <section id="unbind_ucpe_device"> 925 <section id="unbind_ucpe_device">
852 <title>Unbind a network interface</title> 926 <title>Unbinding a Network Interface</title>
853 927
854 <para>Unbinds a physical network interface from DPDK or SR-IOV.</para> 928 <para>Unbinds a physical network interface from DPDK or SR-IOV.</para>
855 929
@@ -937,6 +1011,86 @@ Unbinds a physical interface to the DPDK or SR-IOV
937 </section> 1011 </section>
938 </section> 1012 </section>
939 1013
1014 <section id="get_network_interface">
1015 <title>Getting a Network Interface</title>
1016
1017 <para>List the network interfaces for a device.</para>
1018
1019 <section id="script_opts_interface">
1020 <title>Script Options</title>
1021 <programlisting>
1022$ python getNetworkInterfaces.py -h
10232019-07-04 16:35:50,496 - DEBUG: Started logging
10242019-07-04 16:35:50,496 - INFO: Dump NICs
1025Usage: getNetworkInterfaces.py [options]
1026
1027Options:
1028 --version show program's version number and exit
1029 -h, --help show this help message and exit
1030 -u USERNAME, --username=USERNAME Enea uCPE Manager login username
1031 -p PASSWORD, --password=PASSWORD Enea uCPE Manager login password
1032 -H HOST, --host=HOST Enea uCPE Manager host name or IP address
1033 -n DEVICENAME, --device-name=DEVICENAME Name of the uCPE to get network interfaces from
1034
1035 Mandatory options:
1036 -H/--host, -n/--device-name
1037 </programlisting>
1038 </section>
1039
1040 <section id="runpy_net_interface">
1041 <title>Running the Python Module</title>
1042 <para>The <literal>getNetworkInterfaces</literal> Python module can be executed individually
1043 by running the following command:</para>
1044 <programlisting>
1045$ python getNetworkInterfaces.py -H localhost -n intelc3850-2
10462019-07-04 16:03:47,580 - DEBUG: Started logging
10472019-07-04 16:03:47,580 - INFO: Dump NICs
10482019-07-04 16:03:47,609 - DEBUG: Login successful on host 'localhost'
10492019-07-04 16:03:47,610 - DEBUG: Session token is: 8ae9b103-9e64-11e9-a715-5254007632e2
10502019-07-04 16:03:47,626 - DEBUG: Found device with name 'intelc3850-2'
10512019-07-04 16:03:47,627 - DEBUG:
1052----------------- External Network Interfaces for intelc3850-2-----------------
10532019-07-04 16:03:47,945 - DEBUG: 0000:01:00.0 DpdkTypes: [u'igb_uio', u'vfio-pci'] \
1054 MacAddress: ac:1f:6b:2d:ee:58sriov(63)
10552019-07-04 16:03:47,945 - DEBUG:
10562019-07-04 16:03:47,969 - DEBUG:
1057----------------- Configured External Network Interfaces for intelc3850-2-------------
10582019-07-04 16:03:47,969 - DEBUG: 0000:01:00.1 DpdkType: igb_uio ID: \
1059 41d31385-fafd-48fe-b702-ce72fea85478
10602019-07-04 16:03:47,969 - DEBUG: 0000:03:00.2 DpdkType: igb_uio ID: \
1061 b0a4b919-95cd-48c2-83ad-28ec233546b2
10622019-07-04 16:03:47,969 - DEBUG: 0000:03:00.3 DpdkType: igb_uio ID: \
1063 380ac405-9e51-11e9-a715-5254007632e2
10642019-07-04 16:03:47,970 - DEBUG: 0000:03:00.1 DpdkTypes: [u'igb_uio', u'vfio-pci'] \
1065 MacAddress: 0c:c4:7a:fb:85:ddsriov(7)
10662019-07-04 16:03:47,970 - DEBUG:
10672019-07-04 16:03:47,991 - DEBUG:
1068----------------- Configured External Network Interfaces for intelc3850-2-------------
10692019-07-04 16:03:47,991 - DEBUG: 0000:01:00.1 DpdkType: igb_uio ID: \
1070 41d31385-fafd-48fe-b702-ce72fea85478
10712019-07-04 16:03:47,992 - DEBUG: 0000:03:00.2 DpdkType: igb_uio ID: \
1072 b0a4b919-95cd-48c2-83ad-28ec233546b2
10732019-07-04 16:03:47,992 - DEBUG: 0000:03:00.3 DpdkType: igb_uio ID: \
1074 380ac405-9e51-11e9-a715-5254007632e2
10752019-07-04 16:03:47,992 - DEBUG: 0000:03:00.0 DpdkTypes: [u'igb_uio', u'vfio-pci'] \
1076 MacAddress: 0c:c4:7a:fb:85:dcsriov(7)
10772019-07-04 16:03:47,992 - DEBUG:
10782019-07-04 16:03:48,012 - DEBUG:
1079----------------- Configured External Network Interfaces for intelc3850-2-------------
10802019-07-04 16:03:48,012 - DEBUG: 0000:01:00.1 DpdkType: igb_uio ID: \
1081 41d31385-fafd-48fe-b702-ce72fea85478
10822019-07-04 16:03:48,012 - DEBUG: 0000:03:00.2 DpdkType: igb_uio ID: \
1083 b0a4b919-95cd-48c2-83ad-28ec233546b2
10842019-07-04 16:03:48,012 - DEBUG: 0000:03:00.3 DpdkType: igb_uio ID: \
1085 380ac405-9e51-11e9-a715-5254007632e2
10862019-07-04 16:03:48,013 - DEBUG:
10872019-07-04 16:03:48,013 - INFO: Done
10882019-07-04 16:03:48,029 - DEBUG: Logging out and exiting...</programlisting>
1089
1090 </section>
1091
1092</section>
1093
940 <section id="create_ovs_net_bridge"> 1094 <section id="create_ovs_net_bridge">
941 <title>Create an OVS Network Bridge</title> 1095 <title>Create an OVS Network Bridge</title>
942 1096
generated by cgit v1.2.3-54-g00ecf (git 2.39.0) at 2025-10-25 19:22:17 +0000