diff options
Diffstat (limited to 'doc/source')
| -rw-r--r-- | doc/source/command-objects/federation-protocol.rst | 112 | ||||
| -rw-r--r-- | doc/source/commands.rst | 1 |
2 files changed, 113 insertions, 0 deletions
diff --git a/doc/source/command-objects/federation-protocol.rst b/doc/source/command-objects/federation-protocol.rst new file mode 100644 index 00000000..0ed0980a --- /dev/null +++ b/doc/source/command-objects/federation-protocol.rst @@ -0,0 +1,112 @@ +=================== +federation protocol +=================== + +Identity v3 + +`Requires: OS-FEDERATION extension` + +federation protocol create +-------------------------- + +Create new federation protocol + +.. program:: federation protocol create +.. code:: bash + + os federation protocol create + --identity-provider <identity-provider> + --mapping <mapping> + <name> + +.. option:: --identity-provider <identity-provider> + + Identity provider that will support the new federation protocol (name or ID) (required) + +.. option:: --mapping <mapping> + + Mapping that is to be used (name or ID) (required) + +.. describe:: <name> + + New federation protocol name (must be unique per identity provider) + +federation protocol delete +-------------------------- + +Delete a federation protocol + +.. program:: federation protocol delete +.. code:: bash + + os federation protocol delete + --identity-provider <identity-provider> + <federation-protocol> + +.. option:: --identity-provider <identity-provider> + + Identity provider that supports <federation-protocol> (name or ID) (required) + +.. describe:: <federation-protocol> + + Federation protocol to delete (name or ID) + +federation protocol list +------------------------ + +List federation protocols + +.. program:: federation protocol list +.. code:: bash + + os federation protocol list + --identity-provider <identity-provider> + +.. option:: --identity-provider <identity-provider> + + Identity provider to list (name or ID) (required) + +federation protocol set +----------------------- + +Set federation protocol properties + +.. program:: federation protocol set +.. code:: bash + + os federation protocol set + --identity-provider <identity-provider> + [--mapping <mapping>] + <federation-protocol> + +.. option:: --identity-provider <identity-provider> + + Identity provider that supports <federation-protocol> (name or ID) (required) + +.. option:: --mapping <mapping> + + Mapping that is to be used (name or ID) + +.. describe:: <federation-protocol> + + Federation protocol to modify (name or ID) + +federation protocol show +------------------------ + +Display federation protocol details + +.. program:: federation protocol show +.. code:: bash + + os federation protocol show + --identity-provider <identity-provider> + <federation-protocol> + +.. option:: --identity-provider <identity-provider> + + Identity provider that supports <federation-protocol> (name or ID) (required) + +.. describe:: <federation-protocol> + + Federation protocol to display (name or ID) diff --git a/doc/source/commands.rst b/doc/source/commands.rst index cbe46ef7..a09dcb9e 100644 --- a/doc/source/commands.rst +++ b/doc/source/commands.rst @@ -83,6 +83,7 @@ referring to both Compute and Volume quotas. * ``ec2 cedentials``: (**Identity**) AWS EC2-compatible credentials * ``endpoint``: (**Identity**) the base URL used to contact a specific service * ``extension``: (**Compute**, **Identity**, **Volume**) OpenStack server API extensions +* ``federation protocol``: (**Identity**) the underlying protocol used while federating identities * ``flavor``: (**Compute**) predefined server configurations: ram, root disk, etc * ``group``: (**Identity**) a grouping of users * ``host``: Compute - the physical computer running a hypervisor |
