diff options
| author | Steve Martinelli <s.martinelli@gmail.com> | 2017-08-17 12:17:39 -0400 |
|---|---|---|
| committer | Steve Martinelli <s.martinelli@gmail.com> | 2017-10-06 00:57:04 +0000 |
| commit | 0d94a76d956c0322e9c4607fb5ce824f7653f038 (patch) | |
| tree | 5044ef180d214ce9a161739c5a6d748970e94766 /doc/source/cli/command-objects/mapping.rst | |
| parent | a87bd58fb4de5dc5f99193b88d2a3f8bd1338c52 (diff) | |
| download | python-openstackclient-0d94a76d956c0322e9c4607fb5ce824f7653f038.tar.gz | |
auto-generate docs for v3 identity resources
skipped shared v2/v3 identity resources.
Change-Id: I9e1fb5dee5506780fd79a0cbfbde059d0ccd1489
Diffstat (limited to 'doc/source/cli/command-objects/mapping.rst')
| -rw-r--r-- | doc/source/cli/command-objects/mapping.rst | 95 |
1 files changed, 13 insertions, 82 deletions
diff --git a/doc/source/cli/command-objects/mapping.rst b/doc/source/cli/command-objects/mapping.rst index 1f657ed2..73dbbc8d 100644 --- a/doc/source/cli/command-objects/mapping.rst +++ b/doc/source/cli/command-objects/mapping.rst @@ -2,90 +2,21 @@ mapping ======= -Identity v3 +A **mapping** is used by the Identity service's OS-FEDERATION +extension. It is used by **federation protocols** and **identity providers**. +Applicable to Identity v3. -`Requires: OS-FEDERATION extension` +.. autoprogram-cliff:: openstack.identity.v3 + :command: mapping create -mapping create --------------- +.. autoprogram-cliff:: openstack.identity.v3 + :command: mapping delete -Create new mapping +.. autoprogram-cliff:: openstack.identity.v3 + :command: mapping list -.. program:: mapping create -.. code:: bash +.. autoprogram-cliff:: openstack.identity.v3 + :command: mapping set - openstack 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 mapping(s) - -.. program:: mapping delete -.. code:: bash - - openstack mapping delete - <mapping> [<mapping> ...] - -.. _mapping_delete-mapping: -.. describe:: <mapping> - - Mapping(s) to delete - -mapping list ------------- - -List mappings - -.. program:: mapping list -.. code:: bash - - openstack mapping list - -mapping set ------------ - -Set mapping properties - -.. program:: mapping set -.. code:: bash - - openstack 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 - - openstack mapping show - <mapping> - -.. _mapping_show-mapping: -.. describe:: <mapping> - - Mapping to display +.. autoprogram-cliff:: openstack.identity.v3 + :command: mapping show |