From e8be3b64c1956b58fa0a5b6d460c8bf07085951c Mon Sep 17 00:00:00 2001 From: Steve Martinelli Date: Tue, 6 Jan 2015 01:43:49 -0500 Subject: Command doc: mapping Also tweaked the code for `mapping set` as it was previously using cliff Show instead of cliff Command. Change-Id: I0ea1383a9f2dddf4b2f717b2aa16bbd60ab1720c --- doc/source/command-objects/mapping.rst | 91 ++++++++++++++++++++++++++++++++++ doc/source/commands.rst | 1 + 2 files changed, 92 insertions(+) create mode 100644 doc/source/command-objects/mapping.rst (limited to 'doc/source') 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 + + +.. option:: --rules + + Filename that contains a set of mapping rules (required) + +.. _mapping_create-mapping: +.. describe:: + + New mapping name (must be unique) + +mapping delete +-------------- + +Delete a mapping + +.. program:: mapping delete +.. code:: bash + + os mapping delete + + +.. _mapping_delete-mapping: +.. describe:: + + 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 ] + + +.. option:: --rules + + Filename that contains a new set of mapping rules + +.. _mapping_set-mapping: +.. describe:: + + Mapping to modify + +mapping show +------------ + +Display mapping details + +.. program:: mapping show +.. code:: bash + + os mapping show + + +.. _mapping_show-mapping: +.. describe:: + + Mapping to display diff --git a/doc/source/commands.rst b/doc/source/commands.rst index bb3db187..8976fc02 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 -- cgit v1.2.1