summaryrefslogtreecommitdiff
path: root/doc/source/command-objects/mapping.rst
diff options
context:
space:
mode:
authorSteve Martinelli <stevemar@ca.ibm.com>2015-01-06 01:43:49 -0500
committerSteve Martinelli <stevemar@ca.ibm.com>2015-01-08 16:39:06 -0500
commite8be3b64c1956b58fa0a5b6d460c8bf07085951c (patch)
treeb1adffe0b23d4a7b4926ee207d02cb0abe62b5a1 /doc/source/command-objects/mapping.rst
parent6b196d1a17531b56d0a19b95a81a21c6a2ccc625 (diff)
downloadpython-openstackclient-e8be3b64c1956b58fa0a5b6d460c8bf07085951c.tar.gz
Command doc: mapping
Also tweaked the code for `mapping set` as it was previously using cliff Show instead of cliff Command. Change-Id: I0ea1383a9f2dddf4b2f717b2aa16bbd60ab1720c
Diffstat (limited to 'doc/source/command-objects/mapping.rst')
-rw-r--r--doc/source/command-objects/mapping.rst91
1 files changed, 91 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