summaryrefslogtreecommitdiff
path: root/qapi/rocker.json
diff options
context:
space:
mode:
Diffstat (limited to 'qapi/rocker.json')
-rw-r--r--qapi/rocker.json14
1 files changed, 12 insertions, 2 deletions
diff --git a/qapi/rocker.json b/qapi/rocker.json
index 547864bb90..19ae4982eb 100644
--- a/qapi/rocker.json
+++ b/qapi/rocker.json
@@ -90,11 +90,21 @@
##
# @query-rocker-ports:
#
-# Return rocker switch information.
+# Return rocker switch port information.
#
-# Returns: @Rocker information
+# Returns: a list of @RockerPort information
#
# Since: 2.4
+#
+# Example:
+#
+# -> { "execute": "query-rocker-ports", "arguments": { "name": "sw1" } }
+# <- { "return": [ {"duplex": "full", "enabled": true, "name": "sw1.1",
+# "autoneg": "off", "link-up": true, "speed": 10000},
+# {"duplex": "full", "enabled": true, "name": "sw1.2",
+# "autoneg": "off", "link-up": true, "speed": 10000}
+# ]}
+#
##
{ 'command': 'query-rocker-ports',
'data': { 'name': 'str' },