python-openstackclient/doc/source/command-objects/address-scope.rst
Huanxuan Ao 537f5cbe8a Support deleting multi address scopes in networkv2
This patch adds support for deleting multi address scopes by
using "address scope delete" command.

Change-Id: Ic8d3ebc17db44ca5d42c336d2c4d5633f70d4e8b
Partially-Implements: blueprint multi-argument-network
2016-05-28 13:46:38 +08:00

121 lines
2.2 KiB
ReStructuredText

=============
address scope
=============
An **address scope** is a scope of IPv4 or IPv6 addresses that belongs
to a given project and may be shared between projects.
Network v2
address scope create
--------------------
Create new address scope
.. program:: address scope create
.. code:: bash
os address scope create
[--project <project> [--project-domain <project-domain>]]
[--ip-version <ip-version>]
[--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:: --ip-version <ip-version>
IP version (4 or 6, default is 4)
.. option:: --share
Share the address scope between projects
.. option:: --no-share
Do not share the address scope between projects (default)
.. _address_scope_create-name:
.. describe:: <name>
New address scope name
address scope delete
--------------------
Delete address scope(s)
.. program:: address scope delete
.. code:: bash
os address scope delete
<address-scope> [<address-scope> ...]
.. _address_scope_delete-address-scope:
.. describe:: <address-scope>
Address scope(s) to delete (name or ID)
address scope list
------------------
List address scopes
.. program:: address scope list
.. code:: bash
os address scope list
address scope set
-----------------
Set address scope properties
.. program:: address scope set
.. code:: bash
os address scope set
[--name <name>]
[--share | --no-share]
<address-scope>
.. option:: --name <name>
Set address scope name
.. option:: --share
Share the address scope between projects
.. option:: --no-share
Do not share the address scope between projects
.. _address_scope_set-address-scope:
.. describe:: <address-scope>
Address scope to modify (name or ID)
address scope show
------------------
Display address scope details
.. program:: address scope show
.. code:: bash
os address scope show
<address-scope>
.. _address_scope_show-address-scope:
.. describe:: <address-scope>
Address scope to display (name or ID)