From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mogw0415.ocn.ad.jp (mogw0415.ocn.ad.jp [118.23.109.43]) by dpdk.org (Postfix) with ESMTP id 97EF41B899 for ; Thu, 1 Feb 2018 05:04:51 +0100 (CET) Received: from mf-smf-ucb019c1 (mf-smf-ucb019c1.ocn.ad.jp [153.153.66.130]) by mogw0415.ocn.ad.jp (Postfix) with ESMTP id 0EC2429822F; Thu, 1 Feb 2018 13:04:50 +0900 (JST) Received: from ntt.pod01.mv-mta-ucb027 ([153.149.142.101]) by mf-smf-ucb019c1 with ESMTP id h67Ae0hvu6lqih67Ger4nM; Thu, 01 Feb 2018 13:04:50 +0900 Received: from smtp.ocn.ne.jp ([153.149.227.166]) by ntt.pod01.mv-mta-ucb027 with id 5G4p1x0023c2f7501G4pWv; Thu, 01 Feb 2018 04:04:50 +0000 Received: from localhost.localdomain (sp1-66-99-86.msc.spmode.ne.jp [1.66.99.86]) by smtp.ocn.ne.jp (Postfix) with ESMTPA; Thu, 1 Feb 2018 13:04:47 +0900 (JST) From: ogawa.yasufumi@lab.ntt.co.jp To: spp@dpdk.org, ferruh.yigit@intel.com Cc: Yasufumi Ogawa Date: Thu, 1 Feb 2018 13:04:50 +0900 Message-Id: <20180201040501.8004-4-ogawa.yasufumi@lab.ntt.co.jp> X-Mailer: git-send-email 2.13.1 In-Reply-To: <20180201040501.8004-1-ogawa.yasufumi@lab.ntt.co.jp> References: <20180201040501.8004-1-ogawa.yasufumi@lab.ntt.co.jp> Subject: [spp] [PATCH 04/15] docs: add common commands 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: Thu, 01 Feb 2018 04:04:52 -0000 From: Yasufumi Ogawa Common commands are for system wide operation, for instance, shutdown all of SPP processes, record or restore configurations, and show status. Signed-off-by: Yasufumi Ogawa --- docs/guides/commands/common.rst | 104 ++++++++++++++++++++++++++++++++++++++++ 1 file changed, 104 insertions(+) create mode 100644 docs/guides/commands/common.rst diff --git a/docs/guides/commands/common.rst b/docs/guides/commands/common.rst new file mode 100644 index 0000000..728e68f --- /dev/null +++ b/docs/guides/commands/common.rst @@ -0,0 +1,104 @@ +.. 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. + + +Common Commands +==================== + +status +------ + +Display number of connected primary and secondary application count +Also display connected secondary application client_id. + +.. code-block:: console + + spp > status + Soft Patch Panel Status : + primary: 1 + secondary count: 4 + Connected secondary id: 1 + Connected secondary id: 2 + + +record +------ + +.. code-block:: console + + spp > record 2nfv_uni.config + + +playback +-------- + +.. 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 +---- + +.. note:: + + ``help`` command is not implemented yet. + +Displays brief help + +.. code-block:: console + + spp > help -- 2.7.4