From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from bcmv-tmail01.ecl.ntt.co.jp (bcmv-tmail01.ecl.ntt.co.jp [124.146.185.148]) by dpdk.org (Postfix) with ESMTP id C11C11B49C for ; Tue, 9 Oct 2018 12:54:29 +0200 (CEST) Received: from bcmv-ns01.ecl.ntt.co.jp (bcmv-ns01.ecl.ntt.co.jp [129.60.83.123]) by bcmv-tmail01.ecl.ntt.co.jp (8.14.4/8.14.4) with ESMTP id w99AsSCK017874; Tue, 9 Oct 2018 19:54:28 +0900 Received: from bcmv-ns01.ecl.ntt.co.jp (localhost [127.0.0.1]) by bcmv-ns01.ecl.ntt.co.jp (Postfix) with ESMTP id 8F3FF125; Tue, 9 Oct 2018 19:54:28 +0900 (JST) Received: from localhost.localdomain (unknown [129.60.13.51]) by bcmv-ns01.ecl.ntt.co.jp (Postfix) with ESMTP id 78CAA119; Tue, 9 Oct 2018 19:54:28 +0900 (JST) From: ogawa.yasufumi@lab.ntt.co.jp To: spp@dpdk.org, ferruh.yigit@intel.com, ogawa.yasufumi@lab.ntt.co.jp Date: Tue, 9 Oct 2018 19:54:20 +0900 Message-Id: <20181009105420.42875-1-ogawa.yasufumi@lab.ntt.co.jp> X-Mailer: git-send-email 2.13.1 X-TM-AS-MML: disable Subject: [spp] [PATCH] docs: add primary status in spp-ctl APIs 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: Tue, 09 Oct 2018 10:54:30 -0000 From: Yasufumi Ogawa Add response parameters and its example of status of spp_primary in the API reference. Signed-off-by: Yasufumi Ogawa --- docs/guides/spp-ctl/api-reference.rst | 110 +++++++++++++++++++++++++++++++++- 1 file changed, 108 insertions(+), 2 deletions(-) diff --git a/docs/guides/spp-ctl/api-reference.rst b/docs/guides/spp-ctl/api-reference.rst index 23bc8db..3ae90fd 100644 --- a/docs/guides/spp-ctl/api-reference.rst +++ b/docs/guides/spp-ctl/api-reference.rst @@ -125,8 +125,114 @@ Request example Response ^^^^^^^^ -There is no data at the moment. The statistical information will be returned -when ``spp_primary`` implements it. +.. _table_spp_ctl_primary_status: + +.. table:: Response params of primary status. + + +------------+-------+-------------------------------------------+ + | Name | Type | Description | + | | | | + +============+=======+===========================================+ + | phy_ports | array | An array of statistics of physical ports. | + +------------+-------+-------------------------------------------+ + | ring_ports | array | An array of statistics of ring ports. | + +------------+-------+-------------------------------------------+ + +Physical port object. + +.. _table_spp_ctl_primary_status_phy: + +.. table:: Attributes of physical port of primary status. + + +---------+---------+-----------------------------------------------------+ + | Name | Type | Description | + | | | | + +=========+=========+=====================================================+ + | id | integer | Port ID of the physical port. | + +---------+---------+-----------------------------------------------------+ + | rx | integer | The total number of received packets. | + +---------+---------+-----------------------------------------------------+ + | tx | integer | The total number of transferred packets. | + +---------+---------+-----------------------------------------------------+ + | tx_drop | integer | The total number of dropped packets of transferred. | + +---------+---------+-----------------------------------------------------+ + | eth | string | MAC address of the port. | + +---------+---------+-----------------------------------------------------+ + +Ring port object. + +.. _table_spp_ctl_primary_status_ring: + +.. table:: Attributes of ring port of primary status. + + +---------+---------+-----------------------------------------------------+ + | Name | Type | Description | + | | | | + +=========+=========+=====================================================+ + | id | integer | Port ID of the ring port. | + +---------+---------+-----------------------------------------------------+ + | rx | integer | The total number of received packets. | + +---------+---------+-----------------------------------------------------+ + | rx_drop | integer | The total number of dropped packets of received. | + +---------+---------+-----------------------------------------------------+ + | tx | integer | The total number of transferred packets. | + +---------+---------+-----------------------------------------------------+ + | tx_drop | integer | The total number of dropped packets of transferred. | + +---------+---------+-----------------------------------------------------+ + +Response example +^^^^^^^^^^^^^^^^ + +.. code-block:: json + + { + "phy_ports": [ + { + "id": 0, + "rx": 0, + "tx": 0, + "tx_drop": 0, + "eth": "56:48:4f:53:54:00" + }, + { + "id": 1, + "rx": 0, + "tx": 0, + "tx_drop": 0, + "eth": "56:48:4f:53:54:01" + } + ], + "ring_ports": [ + { + "id": 0, + "rx": 0, + "rx_drop": 0, + "tx": 0, + "tx_drop": 0 + }, + { + "id": 1, + "rx": 0, + "rx_drop": 0, + "tx": 0, + "tx_drop": 0 + }, + { + "id": 2, + "rx": 0, + "rx_drop": 0, + "tx": 0, + "tx_drop": 0 + }, + { + "id": 3, + "rx": 0, + "rx_drop": 0, + "tx": 0, + "tx_drop": 0 + } + ] + } DELETE /v1/primary/status -- 2.7.4