From: fmenguy <francoisregis.menguy@orange.com>
Date: Wed, 28 Apr 2021 11:27:15 +0000 (+0200)
Subject: Add generator VM Xtesting call example in documentation
X-Git-Tag: 5.0.1
X-Git-Url: https://gerrit.opnfv.org/gerrit/gitweb?a=commitdiff_plain;h=refs%2Ftags%2F5.0.1;p=nfvbench.git

Add generator VM Xtesting call example in documentation

Change-Id: I789caa7f46bd2b21af15ec5ffe4d857e10a7734c
Signed-off-by: fmenguy <francoisregis.menguy@orange.com>
---

diff --git a/nfvbenchvm/README.rst b/nfvbenchvm/README.rst
index 2e12bf4..0274c75 100644
--- a/nfvbenchvm/README.rst
+++ b/nfvbenchvm/README.rst
@@ -4,7 +4,7 @@ NFVBENCH VM IMAGES FOR OPENSTACK
 This repo will build two centos 7 images with:
     - testpmd and VPP installed for loop VM use case
     - NFVbench and TRex installed for generator VM use case
-The VM will come with a pre-canned user/password: nfvbench/nfvbench
+These VMs will come with a pre-canned user/password: nfvbench/nfvbench
 
 BUILD INSTRUCTIONS
 ==================
@@ -236,6 +236,20 @@ Example of return when the submission is successful:
       "status": "PENDING"
     }
 
+
+Start NFVbench test using Xtesting
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+To start a test run using Xtesting python library and NFVbench API use this type of command on the VM:
+
+.. code-block:: bash
+
+run_tests -t nfvbench-demo
+
+.. note:: `-t` option determine which test case to be runned by Xtesting
+ (see `xtesting/testcases.yaml` file content to see available list of test cases)
+
+
 Connect to the VM using SSH keypair
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^