python-openstackclient/doc/source/command-objects/ec2-credentials.rst
Kevin_Zheng 9663424c74 change os in command example to openstack
In the current doc, the command examples are like
"os server create" but the acutal command should
be started with "openstack" instead of "os", it
is misleading to first time users.

Change-Id: Ic7686257725e1aa8e4e0d65a712eff1c079927a8
2016-12-20 09:03:29 +08:00

139 lines
3.3 KiB
ReStructuredText

===============
ec2 credentials
===============
Identity v2
ec2 credentials create
----------------------
Create EC2 credentials
.. program:: ec2 credentials create
.. code-block:: bash
openstack ec2 credentials create
[--project <project>]
[--user <user>]
[--user-domain <user-domain>]
[--project-domain <project-domain>]
.. option:: --project <project>
Create credentials in project (name or ID; default: current authenticated project)
.. option:: --user <user>
Create credentials for user (name or ID; default: current authenticated user)
.. option:: --user-domain <user-domain>
Domain the user belongs to (name or ID). This can be
used in case collisions between user names exist.
.. versionadded:: 3
.. option:: --project-domain <project-domain>
Domain the project belongs to (name or ID). This can be
used in case collisions between user names exist.
.. versionadded:: 3
The :option:`--project` and :option:`--user` options are typically only
useful for admin users, but may be allowed for other users depending on
the policy of the cloud and the roles granted to the user.
ec2 credentials delete
----------------------
Delete EC2 credentials
.. program:: ec2 credentials delete
.. code-block:: bash
openstack ec2 credentials delete
[--user <user>]
[--user-domain <user-domain>]
<access-key> [<access-key> ...]
.. option:: --user <user>
Delete credentials for user (name or ID)
.. option:: --user-domain <user-domain>
Select user from a specific domain (name or ID)
This can be used in case collisions between user names exist.
.. versionadded:: 3
.. _ec2_credentials_delete-access-key:
.. describe:: access-key
Credentials access key(s)
The :option:`--user` option is typically only useful for admin users, but
may be allowed for other users depending on the policy of the cloud and
the roles granted to the user.
ec2 credentials list
--------------------
List EC2 credentials
.. program:: ec2 credentials list
.. code-block:: bash
openstack ec2 credentials list
[--user <user>]
[--user-domain <user-domain>]
.. option:: --user <user>
Filter list by <user> (name or ID)
.. option:: --user-domain <user-domain>
Select user from a specific domain (name or ID)
This can be used in case collisions between user names exist.
.. versionadded:: 3
The :option:`--user` option is typically only useful for admin users, but
may be allowed for other users depending on the policy of the cloud and
the roles granted to the user.
ec2 credentials show
--------------------
Display EC2 credentials details
.. program:: ec2 credentials show
.. code-block:: bash
openstack ec2 credentials show
[--user <user>]
[--user-domain <user-domain>]
<access-key>
.. option:: --user <user>
Show credentials for user (name or ID)
.. option:: --user-domain <user-domain>
Select user from a specific domain (name or ID)
This can be used in case collisions between user names exist.
.. versionadded:: 3
.. _ec2_credentials_show-access-key:
.. describe:: access-key
Credentials access key
The :option:`--user` option is typically only useful for admin users, but
may be allowed for other users depending on the policy of the cloud and
the roles granted to the user.