diff options
| author | Doug Hellmann <doug@doughellmann.com> | 2017-06-13 15:55:33 -0400 |
|---|---|---|
| committer | Andreas Jaeger <aj@suse.com> | 2017-06-23 11:54:32 +0200 |
| commit | 9599ffe65d9dcd4b3aa780d346eccd1e760890bf (patch) | |
| tree | 9281e521e50b8bed66eca087bc11fa03adf2aed3 /doc/source/command-objects/user.rst | |
| parent | 19c8cabeca1ea3c83da734ab5269318b27eb5634 (diff) | |
| download | python-openstackclient-9599ffe65d9dcd4b3aa780d346eccd1e760890bf.tar.gz | |
reorganize existing documentation according to the new standard layout
Move existing content around based on the doc-migration specification.
Replace :doc: markup with :ref: to have sphinx keep track of where the
files move and generate valid hyperlinks.
Add a few toctrees and index pages for the new directories.
Depends-On: Ia750cb049c0f53a234ea70ce1f2bbbb7a2aa9454
Change-Id: I253ee8f89d3ec40e39310c18bb87ed1d3d5de330
Signed-off-by: Doug Hellmann <doug@doughellmann.com>
Diffstat (limited to 'doc/source/command-objects/user.rst')
| -rw-r--r-- | doc/source/command-objects/user.rst | 223 |
1 files changed, 0 insertions, 223 deletions
diff --git a/doc/source/command-objects/user.rst b/doc/source/command-objects/user.rst deleted file mode 100644 index 632d0e25..00000000 --- a/doc/source/command-objects/user.rst +++ /dev/null @@ -1,223 +0,0 @@ -==== -user -==== - -Identity v2, v3 - -user create ------------ - -Create new user - -.. program:: user create -.. code:: bash - - openstack user create - [--domain <domain>] - [--project <project> [--project-domain <project-domain>]] - [--password <password>] - [--password-prompt] - [--email <email-address>] - [--description <description>] - [--enable | --disable] - [--or-show] - <user-name> - -.. option:: --domain <domain> - - Default domain (name or ID) - - .. versionadded:: 3 - -.. option:: --project <project> - - Default project (name or ID) - -.. option:: --project-domain <project-domain> - - Domain the project belongs to (name or ID). - This can be used in case collisions between project names exist. - -.. option:: --password <password> - - Set user password - -.. option:: --password-prompt - - Prompt interactively for password - -.. option:: --email <email-address> - - Set user email address - -.. option:: --description <description> - - User description - - .. versionadded:: 3 - -.. option:: --enable - - Enable user (default) - -.. option:: --disable - - Disable user - -.. option:: --or-show - - Return existing user - - If the username already exist return the existing user data and do not fail. - -.. describe:: <user-name> - - New user name - -user delete ------------ - -Delete user(s) - -.. program:: user delete -.. code:: bash - - openstack user delete - [--domain <domain>] - <user> [<user> ...] - -.. option:: --domain <domain> - - Domain owning :ref:`\<user\> <user_delete-user>` (name or ID) - - .. versionadded:: 3 - -.. _user_delete-user: -.. describe:: <user> - - User(s) to delete (name or ID) - -user list ---------- - -List users - -.. program:: user list -.. code:: bash - - openstack user list - [--project <project>] - [--domain <domain>] - [--group <group> | --project <project>] - [--long] - -.. option:: --project <project> - - Filter users by `<project>` (name or ID) - -.. option:: --domain <domain> - - Filter users by `<domain>` (name or ID) - - *Identity version 3 only* - -.. option:: --group <group> - - Filter users by `<group>` membership (name or ID) - - *Identity version 3 only* - -.. option:: --long - - List additional fields in output - -user set --------- - -Set user properties - -.. program:: user set -.. code:: bash - - openstack user set - [--name <name>] - [--project <project> [--project-domain <project-domain>]] - [--password <password>] - [--password-prompt] - [--email <email-address>] - [--description <description>] - [--enable|--disable] - <user> - -.. option:: --name <name> - - Set user name - -.. option:: --domain <domain> - - Domain the user belongs to (name or ID). - This can be used in case collisions between user names exist. - - .. versionadded:: 3 - -.. option:: --project <project> - - Set default project (name or ID) - -.. option:: --project-domain <project-domain> - - Domain the project belongs to (name or ID). - This can be used in case collisions between project names exist. - -.. option:: --password <password> - - Set user password - -.. option:: --password-prompt - - Prompt interactively for password - -.. option:: --email <email-address> - - Set user email address - -.. option:: --description <description> - - Set user description - - .. versionadded:: 3 - -.. option:: --enable - - Enable user (default) - -.. option:: --disable - - Disable user - -.. describe:: <user> - - User to modify (name or ID) - -user show ---------- - -Display user details - -.. program:: user show -.. code:: bash - - openstack user show - [--domain <domain>] - <user> - -.. option:: --domain <domain> - - Domain owning :ref:`\<user\> <user_show-user>` (name or ID) - - .. versionadded:: 3 - -.. _user_show-user: -.. describe:: <user> - - User to display (name or ID) |