From 9599ffe65d9dcd4b3aa780d346eccd1e760890bf Mon Sep 17 00:00:00 2001 From: Doug Hellmann Date: Tue, 13 Jun 2017 15:55:33 -0400 Subject: 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 --- doc/source/cli/command-objects/address-scope.rst | 149 +++++++++++++++++++++++ 1 file changed, 149 insertions(+) create mode 100644 doc/source/cli/command-objects/address-scope.rst (limited to 'doc/source/cli/command-objects/address-scope.rst') diff --git a/doc/source/cli/command-objects/address-scope.rst b/doc/source/cli/command-objects/address-scope.rst new file mode 100644 index 00000000..9155d09e --- /dev/null +++ b/doc/source/cli/command-objects/address-scope.rst @@ -0,0 +1,149 @@ +============= +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-domain ]] + [--ip-version ] + [--share | --no-share] + + +.. option:: --project + + Owner's project (name or ID) + +.. option:: --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 (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:: + + New address scope name + +address scope delete +-------------------- + +Delete address scope(s) + +.. program:: address scope delete +.. code:: bash + + openstack address scope delete + [ ...] + +.. _address_scope_delete-address-scope: +.. describe:: + + 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 ] + [--ip-version ] + [--project [--project-domain ]] + [--share | --no-share] + +.. option:: --name + + List only address scopes of given name in output + +.. option:: --ip-version + + List address scopes of given IP version networks (4 or 6) + +.. option:: --project + + List address scopes according to their project (name or ID) + +.. option:: --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 ] + [--share | --no-share] + + +.. option:: --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 to modify (name or ID) + +address scope show +------------------ + +Display address scope details + +.. program:: address scope show +.. code:: bash + + openstack address scope show + + +.. _address_scope_show-address-scope: +.. describe:: + + Address scope to display (name or ID) -- cgit v1.2.1