Merge "conf:Traffic-type naming convention and consistency"

4 files changed, 18 insertions, 12 deletions

diff --git a/docs/configguide/trafficgen.rst b/docs/configguide/trafficgen.rst
index 3d0cfc66..6d75a56f 100644
--- a/docs/configguide/trafficgen.rst
+++ b/docs/configguide/trafficgen.rst
@@ -113,7 +113,7 @@ when the setup is complete.
             "proto": "tcp",
             "dstip": "90.90.90.90"
         },
-        "traffic_type": "continuous",
+        "traffic_type": "rfc2544_continuous",
         "multistream": 0,
         "bidir": "True",
         "vlan": {
diff --git a/docs/design/trafficgen_integration_guide.rst b/docs/design/trafficgen_integration_guide.rst
index 266c6bc0..9bb0e825 100644
--- a/docs/design/trafficgen_integration_guide.rst
+++ b/docs/design/trafficgen_integration_guide.rst
@@ -196,7 +196,8 @@ functions:
       which are discussed in detail at `integration tests userguide`_
 
       * param **traffic_type**: One of the supported traffic types,
-        e.g. **rfc2544**, **continuous** or **back2back**.
+        e.g. **rfc2544_throughput**, **rfc2544_continuous**
+        or **rfc2544_back2back**.
       * param **frame_rate**: Defines desired percentage of frame
         rate used during continuous stream tests. It can be set by test
         parameter iLoad or by CLI parameter iload.
diff --git a/docs/userguide/teststeps.rst b/docs/userguide/teststeps.rst
index 65a25b0a..c00a2749 100644
--- a/docs/userguide/teststeps.rst
+++ b/docs/userguide/teststeps.rst
@@ -122,9 +122,9 @@ of supported objects and their most common functions follows:
 
         .. code-block:: python
 
-            ['trafficgen', 'send_traffic', {'traffic_type' : 'throughput'}]
+            ['trafficgen', 'send_traffic', {'traffic_type' : 'rfc2544_throughput'}]
 
-            ['trafficgen', 'send_traffic', {'traffic_type' : 'back2back', 'bidir' : 'True'}]
+            ['trafficgen', 'send_traffic', {'traffic_type' : 'rfc2544_back2back', 'bidir' : 'True'}]
 
     * ``settings`` - reads or modifies VSPERF configuration
 
@@ -344,7 +344,8 @@ IP address = 90.90.90.90 will be forwarded to the port created at the STEP #2.
             ['vswitch', 'add_flow', 'int_br0', {'in_port': '#STEP[1][1]', \
                 'dl_type': '0x0800', 'nw_dst': '90.90.90.90', \
                 'actions': ['output:#STEP[2][1]'], 'idle_timeout': '0'}],
-            ['trafficgen', 'send_traffic', {'traffic_type' : 'continuous'}],
+            ['trafficgen', 'send_traffic', \
+                {'traffic_type' : 'rfc2544_continuous'}],
             ['vswitch', 'dump_flows', 'int_br0'],   # STEP 5
             ['vswitch', 'del_flow', 'int_br0'],     # STEP 7 == del-flows
             ['vswitch', 'del_port', 'int_br0', '#STEP[1][0]'],
@@ -393,7 +394,8 @@ That is accomplished by using "Stream Type" and "MultiStream" keywords.
                 'dl_type': '0x0800', 'nw_proto': '17', 'udp_dst': '3', \
                 'actions': ['output:#STEP[2][1]'], 'idle_timeout': '0'}],
             # Send mono-dir traffic
-            ['trafficgen', 'send_traffic', {'traffic_type' : 'continuous', \
+            ['trafficgen', 'send_traffic', \
+                {'traffic_type' : 'rfc2544_continuous', \
                 'bidir' : 'False'}],
             # Clean up
             ['vswitch', 'del_flow', 'int_br0'],
@@ -505,7 +507,8 @@ loopback application by a configuration option ``GUEST_LOOPBACK``.
                 'actions': ['output:#STEP[2][1]'], 'idle_timeout': '0'}],
             # Start VMs
             ['vnf1', 'start'],
-            ['trafficgen', 'send_traffic', {'traffic_type' : 'continuous', \
+            ['trafficgen', 'send_traffic', \
+                {'traffic_type' : 'rfc2544_continuous', \
                 'bidir' : 'False'}],
             ['vnf1', 'stop'],
             # Clean up
@@ -578,7 +581,8 @@ destination UDP port.
             # Start VMs
             ['vnf1', 'start'],                          # STEP 16
             ['vnf2', 'start'],                          # STEP 17
-            ['trafficgen', 'send_traffic', {'traffic_type' : 'continuous', \
+            ['trafficgen', 'send_traffic', \
+                {'traffic_type' : 'rfc2544_continuous', \
                 'bidir' : 'False'}],
             ['vnf1', 'stop'],
             ['vnf2', 'stop'],
diff --git a/docs/userguide/testusage.rst b/docs/userguide/testusage.rst
index f446f261..46413f03 100755
--- a/docs/userguide/testusage.rst
+++ b/docs/userguide/testusage.rst
@@ -674,9 +674,10 @@ Supported CLI options useful for traffic generator configuration are:
 
 .. code-block:: console
 
-    'traffic_type'  - One of the supported traffic types. E.g. rfc2544,
-                      back2back or continuous
-                      Default value is "rfc2544".
+    'traffic_type'  - One of the supported traffic types. E.g.
+                      rfc2544_throughput,
+                      rfc2544_back2back or rfc2544_continuous
+                      Default value is "rfc2544_throughput".
     'bidirectional' - Specifies if generated traffic will be full-duplex (true)
                       or half-duplex (false)
                       Default value is "false".
@@ -697,7 +698,7 @@ Example of execution of VSPERF in "trafficgen" mode:
 .. code-block:: console
 
     $ ./vsperf -m trafficgen --trafficgen IxNet --conf-file vsperf.conf \
-        --test-params "traffic_type=continuous;bidirectional=True;iload=60"
+        --test-params "traffic_type=rfc2544_continuous;bidirectional=True;iload=60"
 
 Code change verification by pylint
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^