diff options
Diffstat (limited to 'docs/userguides')
| -rwxr-xr-x | docs/userguides/quickstart.rst | 57 |
1 files changed, 52 insertions, 5 deletions
diff --git a/docs/userguides/quickstart.rst b/docs/userguides/quickstart.rst index caf3be04..fa951e0e 100755 --- a/docs/userguides/quickstart.rst +++ b/docs/userguides/quickstart.rst @@ -294,9 +294,9 @@ To run tests using Vanilla OVS: or use --test-param - ./vsperf --conf-file=<path_to_custom_conf>/10_custom.conf - --test-param "vanilla_tgen_tx_ip=n.n.n.n; - vanilla_tgen_tx_mac=nn:nn:nn:nn:nn:nn" + $ ./vsperf --conf-file=<path_to_custom_conf>/10_custom.conf + --test-param "vanilla_tgen_tx_ip=n.n.n.n; + vanilla_tgen_tx_mac=nn:nn:nn:nn:nn:nn" 2. Recompile src for Vanilla OVS testing @@ -356,7 +356,7 @@ following configuration parameter should be configured: or use --vswitch and --fwdapp - ./vsperf --conf-file user_settings.py + $ ./vsperf --conf-file user_settings.py --vswitch none --fwdapp TestPMD @@ -386,8 +386,55 @@ for selected Packet Forwarder: .. code-block:: console - ./vsperf --conf-file <path_to_settings_py> + $ ./vsperf --conf-file <path_to_settings_py> +VSPERF modes of operation +------------------------- +VSPERF can be run in different modes. By default it will configure vSwitch, +traffic generator and VNF. However it can be used just for configuration +and execution of traffic generator. Another option is execution of all +components except traffic generator itself. + +Mode of operation is driven by configuration parameter -m or --mode + +.. code-block:: console + + -m MODE, --mode MODE vsperf mode of operation; + Values: + "normal" - execute vSwitch, VNF and traffic generator + "trafficgen" - execute only traffic generator + "trafficgen-off" - execute vSwitch and VNF + +In case, that VSPERF is executed in "trafficgen" mode, then configuration +of traffic generator should be configured through --test-param option. +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". + 'bidirectional' - Specifies if generated traffic will be full-duplex (true) + or half-duplex (false) + Default value is "false". + 'iload' - Defines desired percentage of frame rate used during + continuous stream tests. + Default value is 100. + 'multistream' - Defines number of flows simulated by traffic generator. + Value 0 disables MultiStream feature + Default value is 0. + 'stream_type' - Stream Type is an extension of the "MultiStream" feature. + If MultiStream is disabled, then Stream Type will be + ignored. Stream Type defines ISO OSI network layer used + for simulation of multiple streams. + Default value is "L4". + +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" Code change verification by pylint ---------------------------------- |