summaryrefslogtreecommitdiff
path: root/doc/source/command-objects/network.rst
diff options
context:
space:
mode:
authorJenkins <jenkins@review.openstack.org>2015-01-22 15:18:33 +0000
committerGerrit Code Review <review@openstack.org>2015-01-22 15:18:33 +0000
commitb02cce567855399794e654f45eb2619eee8cc357 (patch)
tree7a8761cb34096865deff668d886f3e3748010398 /doc/source/command-objects/network.rst
parent326f7e3891e17483d9550edbed743e9d4b618d99 (diff)
parent20ec40e222dc57d0121335d9eb6abd6195daad89 (diff)
downloadpython-openstackclient-b02cce567855399794e654f45eb2619eee8cc357.tar.gz
Merge "Command docs: network"
Diffstat (limited to 'doc/source/command-objects/network.rst')
-rw-r--r--doc/source/command-objects/network.rst135
1 files changed, 135 insertions, 0 deletions
diff --git a/doc/source/command-objects/network.rst b/doc/source/command-objects/network.rst
new file mode 100644
index 00000000..cdf2ebfa
--- /dev/null
+++ 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)