openstack-python-openstackc.../doc/source/command-objects/network.rst
Tang Chen b4e88aa3ce Trivial: Remove unuseful doc of "network list" command.
There is actually no "--dhcp" option in "network list" command.
So remove the doc from .rst file.

Change-Id: I481b260f99be635be4de8e6780206af47cdaa7ce
2015-12-05 10:43:06 +08:00

140 lines
2.1 KiB
ReStructuredText

=======
network
=======
Network v2
network create
--------------
Create new network
.. program:: network create
.. code:: bash
os network create
[--project <project> [--project-domain <project-domain>]]
[--enable | --disable]
[--share | --no-share]
<name>
.. option:: --project <project>
Owner's project (name or ID)
.. option:: --project-domain <project-domain>
Domain the project belongs to (name or ID).
This can be used in case collisions between project names exist.
.. 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]
[--long]
.. option:: --external
List external networks
.. 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)