From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mogw0628.ocn.ad.jp (mogw0628.ocn.ad.jp [153.149.228.29]) by dpdk.org (Postfix) with ESMTP id 8330F1B299 for ; Mon, 5 Feb 2018 03:39:05 +0100 (CET) Received: from mf-smf-ucb004.ocn.ad.jp (mf-smf-ucb004.ocn.ad.jp [153.149.227.6]) by mogw0628.ocn.ad.jp (Postfix) with ESMTP id 5A2621280237; Mon, 5 Feb 2018 11:39:04 +0900 (JST) Received: from mf-smf-ucb004.ocn.ad.jp (mf-smf-ucb004 [153.149.227.6]) by mf-smf-ucb004.ocn.ad.jp (Postfix) with ESMTP id 3B704606A1; Mon, 5 Feb 2018 11:39:04 +0900 (JST) Received: from ntt.pod01.mv-mta-ucb028 (mv-mta-ucb028.ocn.ad.jp [153.149.230.162]) by mf-smf-ucb004.ocn.ad.jp (Switch-3.3.4/Switch-3.3.4) with ESMTP id w152d3OQ064920; Mon, 5 Feb 2018 11:39:03 +0900 Received: from smtp.ocn.ne.jp ([153.149.227.134]) by ntt.pod01.mv-mta-ucb028 with id 6qf31x0082ud8JZ01qf3d4; Mon, 05 Feb 2018 02:39:03 +0000 Received: from localhost.localdomain (sp49-97-109-142.msc.spmode.ne.jp [49.97.109.142]) by smtp.ocn.ne.jp (Postfix) with ESMTPA; Mon, 5 Feb 2018 11:39:03 +0900 (JST) From: ogawa.yasufumi@lab.ntt.co.jp To: ferruh.yigit@intel.com, spp@dpdk.org, nakamura.hiroyuki@po.ntt-tx.co.jp Cc: Yasufumi Ogawa Date: Mon, 5 Feb 2018 11:39:13 +0900 Message-Id: <20180205023921.7775-20-ogawa.yasufumi@lab.ntt.co.jp> X-Mailer: git-send-email 2.13.1 In-Reply-To: <20180205023921.7775-1-ogawa.yasufumi@lab.ntt.co.jp> References: <20180205023921.7775-1-ogawa.yasufumi@lab.ntt.co.jp> Subject: [spp] [PATCH 20/28] docs: add spp_vf common command section X-BeenThere: spp@dpdk.org X-Mailman-Version: 2.1.15 Precedence: list List-Id: Soft Patch Panel List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Mon, 05 Feb 2018 02:39:06 -0000 From: Yasufumi Ogawa Signed-off-by: Yasufumi Ogawa --- docs/guides/spp_vf/commands/common.rst | 131 +++++++++++++++++++++++++++++++++ 1 file changed, 131 insertions(+) create mode 100644 docs/guides/spp_vf/commands/common.rst diff --git a/docs/guides/spp_vf/commands/common.rst b/docs/guides/spp_vf/commands/common.rst new file mode 100644 index 0000000..438d345 --- /dev/null +++ b/docs/guides/spp_vf/commands/common.rst @@ -0,0 +1,131 @@ +.. BSD LICENSE + Copyright(c) 2010-2014 Intel Corporation. All rights reserved. + All rights reserved. + + Redistribution and use in source and binary forms, with or without + modification, are permitted provided that the following conditions + are met: + + * Redistributions of source code must retain the above copyright + notice, this list of conditions and the following disclaimer. + * Redistributions in binary form must reproduce the above copyright + notice, this list of conditions and the following disclaimer in + the documentation and/or other materials provided with the + distribution. + * Neither the name of Intel Corporation nor the names of its + contributors may be used to endorse or promote products derived + from this software without specific prior written permission. + + THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS + "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT + LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR + A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT + OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, + SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT + LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, + DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY + THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE + OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + +.. _spp_vf_commands_spp_vf_common: + +Common Commands +==================== + +status +------ + +Show the number of connected primary and secondary processes. +It also show a list of secondary IDs + +.. code-block:: console + + spp > status + Soft Patch Panel Status : + primary: 1 + secondary count: 4 + Connected secondary id: 1 + Connected secondary id: 2 + + +record +------ + +Start recording user's input and create a history file for ``playback`` +commnad. +Recording is stopped by executing ``exit`` or ``playback`` command. + +.. code-block:: console + + spp > record 2nfv_uni.config + +.. note:: + + It is not supported to stop recording without ``exit`` or ``playback`` + command. + It is planned to support ``stop`` command for stopping record in + next relase. + + +playback +-------- + +Restore configuration from a config file. +Content of config file is just a series of SPP commnad. +You prepare a config file by using ``record`` command or editing a text +file by hand. + +It is recommended to use extension ``.config`` to be self-sxplanatory +as a config, although you can use any of extensions such as ``.txt`` or +``.log``. + +.. code-block:: console + + spp> playback 2nfv_uni.config + + +bye +--- + +``bye`` command is for terminating SPP processes. +It supports two types of termination as sub commands. + + - sec + - all + +First one is for terminating only secondary processes at once. + +.. code-block:: console + + spp > bye sec + closing: + closing: + +Second one is for all SPP processes other than controller. + +.. code-block:: console + + spp > bye all + closing: + closing: + closing:('127.0.0.1', 53620) + + +help +---- + +Show help message for SPP commands. + +.. code-block:: console + + spp > help + + Documented commands (type help ): + ======================================== + bye help playback pri record sec status + + spp > help status + Display Soft Patch Panel Status + spp > help sec + Send command to secondary process -- 2.13.1