summaryrefslogtreecommitdiff
path: root/doc/source
diff options
context:
space:
mode:
authordongwenshuai <dong.wenshuai@zte.com.cn>2016-07-07 05:25:55 -0400
committerdongwenshuai <dong.wenshuai@zte.com.cn>2016-07-08 00:28:32 -0400
commit2a5ab357930a318800b6b15bd0a9f4ffd2c460d4 (patch)
tree9451bbee99649383dcd8005fa7841c4bb9acfa5e /doc/source
parentffb232a90e8b5c8358e017bf057a045a2d59bbfc (diff)
downloadpython-openstackclient-2a5ab357930a318800b6b15bd0a9f4ffd2c460d4.tar.gz
Add network-topolopy support
Add a new api about network-topolopy in openstackclient It is the intention for OSC to collect data from existing REST APIs Change-Id: I23709ee906555d773c3efeb094aef50587732a1b Related-Bug: #1586584 Implements: bp network-topology-support
Diffstat (limited to 'doc/source')
-rwxr-xr-xdoc/source/specs/network-topology.rst44
1 files changed, 44 insertions, 0 deletions
diff --git a/doc/source/specs/network-topology.rst b/doc/source/specs/network-topology.rst
new file mode 100755
index 00000000..6f9c8532
--- /dev/null
+++ b/doc/source/specs/network-topology.rst
@@ -0,0 +1,44 @@
+================
+network topology
+================
+
+A **network topology** shows a topological graph about
+devices which connect to the specific network. Also, it
+will return availability information for each individual
+device within the network as well. One other thing to note
+is that it is the intention for OSC to collect data from
+existing REST APIs
+
+Network v2
+
+network topology list
+---------------------
+
+List network topologies
+
+.. program:: network topology list
+.. code:: bash
+
+ os network topology list
+ [--project <project>]
+
+.. option:: --project <project>
+
+ List network topologies for given project
+ (name or ID)
+
+network topology show
+---------------------
+
+Show network topology details
+
+.. program:: network topology show
+.. code:: bash
+
+ os network topology show
+ <network>
+
+.. _network_topology_show-network
+.. describe:: <network>
+
+ Show network topology for a specific network (name or ID)