summaryrefslogtreecommitdiffstats
path: root/docs/testing/user/userguide/cli.rst
blob: e18a36f924e4fc40d775209f32edc8f9acec7ab5 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
**************
QTIP CLI Usage
**************

QTIP consists of a number of benchmarking tools or metrics, grouped under QPI's. QPI's map to the different
components of a NFVI ecosystem, such as compute, network and storage. Depending on the type of application,
a user may group them under plans.

QTIP CLI provides interface to all of the above the components. A help page provides a list of all the commands
along with a short description.
::

  qtip [-h|--help]

Typically a complete plan is executed at the
target environment. QTIP defaults to a number of sample plans. One may be able to list them using
::

  qtip plan list

One can also be able to view the details about a specific plan.
::

  qtip plan show <plan_name>

where *plan_name* is one of those listed from the previous command.

To execute a complete plan
::

  qtip plan run <plan_name>

Similarly, the same commands can be used for the other two components making up the plans, i.e QPI's and metrics.

Debug option helps identify the error by providing a detailed traceback. It can be enabled as
::

  qtip [-d|--debug] plan run <plan_name>