summaryrefslogtreecommitdiff
path: root/doc/source
diff options
context:
space:
mode:
authorJenkins <jenkins@review.openstack.org>2015-01-08 23:06:13 +0000
committerGerrit Code Review <review@openstack.org>2015-01-08 23:06:13 +0000
commit0af779a91beba970535bcb90d5d15c75bd07ec94 (patch)
treee7038d6574b87d8446f32414fd3dbdb00611c318 /doc/source
parentc1f28bf7ca6d628029dfb53cd2d545fa26d18cf1 (diff)
parente8be3b64c1956b58fa0a5b6d460c8bf07085951c (diff)
downloadpython-openstackclient-0af779a91beba970535bcb90d5d15c75bd07ec94.tar.gz
Merge "Command doc: mapping"
Diffstat (limited to 'doc/source')
-rw-r--r--doc/source/command-objects/mapping.rst91
-rw-r--r--doc/source/commands.rst1
2 files changed, 92 insertions, 0 deletions
diff --git a/doc/source/command-objects/mapping.rst b/doc/source/command-objects/mapping.rst
new file mode 100644
index 00000000..5c7535bd
--- /dev/null
+++ b/doc/source/command-objects/mapping.rst
@@ -0,0 +1,91 @@
+=======
+mapping
+=======
+
+Identity v3
+
+`Requires: OS-FEDERATION extension`
+
+mapping create
+--------------
+
+Create new mapping
+
+.. program:: mapping create
+.. code:: bash
+
+ os mapping create
+ --rules <filename>
+ <name>
+
+.. option:: --rules <filename>
+
+ Filename that contains a set of mapping rules (required)
+
+.. _mapping_create-mapping:
+.. describe:: <name>
+
+ New mapping name (must be unique)
+
+mapping delete
+--------------
+
+Delete a mapping
+
+.. program:: mapping delete
+.. code:: bash
+
+ os mapping delete
+ <mapping>
+
+.. _mapping_delete-mapping:
+.. describe:: <mapping>
+
+ Mapping to delete
+
+mapping list
+------------
+
+List mappings
+
+.. program:: mapping list
+.. code:: bash
+
+ os mapping list
+
+mapping set
+-----------
+
+Set mapping properties
+
+.. program:: mapping set
+.. code:: bash
+
+ os mapping set
+ [--rules <filename>]
+ <mapping>
+
+.. option:: --rules <filename>
+
+ Filename that contains a new set of mapping rules
+
+.. _mapping_set-mapping:
+.. describe:: <mapping>
+
+ Mapping to modify
+
+mapping show
+------------
+
+Display mapping details
+
+.. program:: mapping show
+.. code:: bash
+
+ os mapping show
+ <mapping>
+
+.. _mapping_show-mapping:
+.. describe:: <mapping>
+
+ Mapping to display
diff --git a/doc/source/commands.rst b/doc/source/commands.rst
index 5c5df7f9..1184e3c4 100644
--- a/doc/source/commands.rst
+++ b/doc/source/commands.rst
@@ -93,6 +93,7 @@ referring to both Compute and Volume quotas.
* ``ip floating``: Compute, Network - a public IP address that can be mapped to a server
* ``keypair``: (**Compute**) an SSH public key
* ``limits``: (**Compute**, **Volume**) resource usage limits
+* ``mapping``: (**Identity**) a definition to translate identity provider attributes to Identity concepts
* ``module``: internal - installed Python modules in the OSC process
* ``network``: Network - a virtual network for connecting servers and other resources
* ``object``: (**Object Store**) a single file in the Object Store