summaryrefslogtreecommitdiff
path: root/doc/source/command-objects/address-scope.rst
diff options
context:
space:
mode:
authorDoug Hellmann <doug@doughellmann.com>2017-06-13 15:55:33 -0400
committerAndreas Jaeger <aj@suse.com>2017-06-23 11:54:32 +0200
commit9599ffe65d9dcd4b3aa780d346eccd1e760890bf (patch)
tree9281e521e50b8bed66eca087bc11fa03adf2aed3 /doc/source/command-objects/address-scope.rst
parent19c8cabeca1ea3c83da734ab5269318b27eb5634 (diff)
downloadpython-openstackclient-9599ffe65d9dcd4b3aa780d346eccd1e760890bf.tar.gz
reorganize existing documentation according to the new standard layout
Move existing content around based on the doc-migration specification. Replace :doc: markup with :ref: to have sphinx keep track of where the files move and generate valid hyperlinks. Add a few toctrees and index pages for the new directories. Depends-On: Ia750cb049c0f53a234ea70ce1f2bbbb7a2aa9454 Change-Id: I253ee8f89d3ec40e39310c18bb87ed1d3d5de330 Signed-off-by: Doug Hellmann <doug@doughellmann.com>
Diffstat (limited to 'doc/source/command-objects/address-scope.rst')
-rw-r--r--doc/source/command-objects/address-scope.rst149
1 files changed, 0 insertions, 149 deletions
diff --git a/doc/source/command-objects/address-scope.rst b/doc/source/command-objects/address-scope.rst
deleted file mode 100644
index 9155d09e..00000000
--- a/doc/source/command-objects/address-scope.rst
+++ /dev/null
@@ -1,149 +0,0 @@
-=============
-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
-
- openstack 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
-
- openstack 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
-
- openstack address scope list
- [--name <name>]
- [--ip-version <ip-version>]
- [--project <project> [--project-domain <project-domain>]]
- [--share | --no-share]
-
-.. option:: --name <name>
-
- List only address scopes of given name in output
-
-.. option:: --ip-version <ip-version>
-
- List address scopes of given IP version networks (4 or 6)
-
-.. option:: --project <project>
-
- List address scopes according to their 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:: --share
-
- List address scopes shared between projects
-
-.. option:: --no-share
-
- List address scopes not shared between projects
-
-address scope set
------------------
-
-Set address scope properties
-
-.. program:: address scope set
-.. code:: bash
-
- openstack 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
-
- openstack address scope show
- <address-scope>
-
-.. _address_scope_show-address-scope:
-.. describe:: <address-scope>
-
- Address scope to display (name or ID)