From 20ec40e222dc57d0121335d9eb6abd6195daad89 Mon Sep 17 00:00:00 2001 From: Dean Troyer Date: Tue, 20 Jan 2015 16:44:50 -0600 Subject: Command docs: network Change-Id: Ia88b6c0ca5205fa5bfc3efa06ac7f84c4a9e5d4e --- doc/source/command-objects/network.rst | 135 +++++++++++++++++++++++++++++++++ 1 file changed, 135 insertions(+) create mode 100644 doc/source/command-objects/network.rst (limited to 'doc/source/command-objects/network.rst') 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] + + +.. 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:: + + New network name + +network delete +-------------- + +Delete network(s) + +.. program:: network delete +.. code:: bash + + os network delete + [ ...] + +.. _network_delete-project: +.. describe:: + + 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 ] + [--enable | --disable] + [--share | --no-share] + + +.. option:: --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 to modify (name or ID) + +network show +------------ + +Display network details + +.. program:: network show +.. code:: bash + + os network show + + +.. _network_show-name: +.. describe:: + + Network to display (name or ID) -- cgit v1.2.1