From: ogawa.yasufumi@lab.ntt.co.jp
To: spp@dpdk.org, ferruh.yigit@intel.com, ogawa.yasufumi@lab.ntt.co.jp
Subject: [spp] [PATCH] docs: add primary status in spp-ctl APIs
Date: Tue, 9 Oct 2018 19:54:20 +0900 [thread overview]
Message-ID: <20181009105420.42875-1-ogawa.yasufumi@lab.ntt.co.jp> (raw)
From: Yasufumi Ogawa <ogawa.yasufumi@lab.ntt.co.jp>
Add response parameters and its example of status of spp_primary in the
API reference.
Signed-off-by: Yasufumi Ogawa <ogawa.yasufumi@lab.ntt.co.jp>
---
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
reply other threads:[~2018-10-09 10:54 UTC|newest]
Thread overview: [no followups] expand[flat|nested] mbox.gz Atom feed
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20181009105420.42875-1-ogawa.yasufumi@lab.ntt.co.jp \
--to=ogawa.yasufumi@lab.ntt.co.jp \
--cc=ferruh.yigit@intel.com \
--cc=spp@dpdk.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).