Command docs: network

Change-Id: Ia88b6c0ca5205fa5bfc3efa06ac7f84c4a9e5d4e
2015-01-20 16:44:50 -06:00
parent 95fe3fda3d
commit 20ec40e222
2 changed files with 174 additions and 24 deletions
--- a/doc/source/command-objects/network.rst
+++ b/doc/source/command-objects/network.rst
@ -0,0 +1,135 @@
+=======
+network
+=======
+
+Network v2
+
+network create
+--------------
+
+Create new network
+
+.. program:: network create
+.. code:: bash
+
+    os network create
+        [--enable | --disable]
+        [--share | --no-share]
+        <name>
+
+.. option:: --enable
+
+    Enable network (default)
+
+.. option:: --disable
+
+    Disable network
+
+.. option:: --share
+
+    Share the network between projects
+
+.. option:: --no-share
+
+    Do not share the network between projects
+
+.. _network_create-name:
+.. describe:: <name>
+
+    New network name
+
+network delete
+--------------
+
+Delete network(s)
+
+.. program:: network delete
+.. code:: bash
+
+    os network delete
+        <network> [<network> ...]
+
+.. _network_delete-project:
+.. describe:: <network>
+
+    Network to delete (name or ID)
+
+network list
+------------
+
+List networks
+
+.. program:: network list
+.. code:: bash
+
+    os network list
+        [--external]
+        [--dhcp]
+        [--long]
+
+.. option:: --external
+
+    List external networks
+
+.. option:: --dhcp
+
+    ID of the DHCP agent
+
+.. option:: --long
+
+    List additional fields in output
+
+network set
+-----------
+
+Set network properties
+
+.. program:: network set
+.. code:: bash
+
+    os network set
+        [--name <name>]
+        [--enable | --disable]
+        [--share | --no-share]
+        <network>
+
+.. option:: --name <name>
+
+    Set network name
+
+.. option:: --enable
+
+    Enable network
+
+.. option:: --disable
+
+    Disable network
+
+.. option:: --share
+
+    Share the network between projects
+
+.. option:: --no-share
+
+    Do not share the network between projects
+
+.. _network_set-name:
+.. describe:: <network>
+
+    Network to modify (name or ID)
+
+network show
+------------
+
+Display network details
+
+.. program:: network show
+.. code:: bash
+
+    os network show
+        <network>
+
+.. _network_show-name:
+.. describe:: <network>
+
+    Network to display (name or ID)