summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorHuanxuan Ao <huanxuan.ao@easystack.cn>2016-05-07 16:00:19 +0800
committerHuanxuan Ao <huanxuan.ao@easystack.cn>2016-05-11 10:08:35 +0800
commit98bee08e0ff9bd0eae185265d20ee3b40a12efd4 (patch)
tree0922977c3eb295061552822629e6665f09b1bf61 /doc
parent4639148b1dc059efab0d00a886e3f05f547a439f (diff)
downloadpython-openstackclient-98bee08e0ff9bd0eae185265d20ee3b40a12efd4.tar.gz
Implement "address scope create" command
This patch supports creating a new address scope, with --ip-version,--project,--project-domain and --share or --no-share options. Change-Id: I37c73391a41ac239dd72d55dbc0adbebd7701f4a Partial-Bug: #1566269
Diffstat (limited to 'doc')
-rw-r--r--doc/source/command-objects/address-scope.rst48
-rw-r--r--doc/source/commands.rst1
2 files changed, 49 insertions, 0 deletions
diff --git a/doc/source/command-objects/address-scope.rst b/doc/source/command-objects/address-scope.rst
new file mode 100644
index 00000000..d7eac283
--- /dev/null
+++ b/doc/source/command-objects/address-scope.rst
@@ -0,0 +1,48 @@
+=============
+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
diff --git a/doc/source/commands.rst b/doc/source/commands.rst
index f71fbccb..bccd6cb1 100644
--- a/doc/source/commands.rst
+++ b/doc/source/commands.rst
@@ -70,6 +70,7 @@ the API resources will be merged, as in the ``quota`` object that has options
referring to both Compute and Volume quotas.
* ``access token``: (**Identity**) long-lived OAuth-based token
+* ``address scope``: (**Network**) a scope of IPv4 or IPv6 addresses
* ``aggregate``: (**Compute**) a grouping of compute hosts
* ``availability zone``: (**Compute**, **Network**, **Volume**) a logical partition of hosts or block storage or network services
* ``backup``: (**Volume**) a volume copy