Chapter 84. user

84.1. user create

Create new user

Usage:

openstack user create [-h] [-f {json,shell,table,value,yaml}]
                             [-c COLUMN] [--noindent] [--prefix PREFIX]
                             [--max-width <integer>] [--fit-width]
                             [--print-empty] [--domain <domain>]
                             [--project <project>]
                             [--project-domain <project-domain>]
                             [--password <password>] [--password-prompt]
                             [--email <email-address>]
                             [--description <description>]
                             [--enable | --disable] [--or-show]
                             <name>

Table 84.1. Positional arguments
Value	Summary
<name>	New user name

Table 84.2. Command arguments
Value	Summary
-h, --help	Show this help message and exit
--domain <domain>	Default domain (name or id)
--project <project>	Default project (name or id)
--project-domain <project-domain>	Domain the project belongs to (name or id). this can be used in case collisions between project names exist.
--password <password>	Set user password
--password-prompt	Prompt interactively for password
--email <email-address>	Set user email address
--description <description>	User description
--enable	Enable user (default)
--disable	Disable user
--or-show	Return existing user

Table 84.3. Output formatter options
Value	Summary
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}	The output format, defaults to table
-c COLUMN, --column COLUMN	Specify the column(s) to include, can be repeated

Table 84.4. JSON formatter options
Value	Summary
--noindent	Whether to disable indenting the json

Table 84.5. Shell formatter options
Value	Summary
--prefix PREFIX	Add a prefix to all variable names

Table 84.6. Table formatter options
Value	Summary
--max-width <integer>	Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.
--fit-width	Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable
--print-empty	Print empty table if there is no data to show.

84.2. user delete

Delete user(s)

Usage:

openstack user delete [-h] [--domain <domain>] <user> [<user> ...]

Table 84.7. Positional arguments
Value	Summary
<user>	User(s) to delete (name or id)

Table 84.8. Command arguments
Value	Summary
-h, --help	Show this help message and exit
--domain <domain>	Domain owning <user> (name or id)

84.3. user list

List users

Usage:

openstack user list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN]
                           [--quote {all,minimal,none,nonnumeric}]
                           [--noindent] [--max-width <integer>] [--fit-width]
                           [--print-empty] [--sort-column SORT_COLUMN]
                           [--domain <domain>]
                           [--group <group> | --project <project>] [--long]

Table 84.9. Command arguments
Value	Summary
-h, --help	Show this help message and exit
--domain <domain>	Filter users by <domain> (name or id)
--group <group>	Filter users by <group> membership (name or id)
--project <project>	Filter users by <project> (name or id)
--long	List additional fields in output

Table 84.10. Output formatter options
Value	Summary
-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}	The output format, defaults to table
-c COLUMN, --column COLUMN	Specify the column(s) to include, can be repeated
--sort-column SORT_COLUMN	Specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated

Table 84.11. CSV formatter options
Value	Summary
--quote {all,minimal,none,nonnumeric}	When to include quotes, defaults to nonnumeric

Table 84.12. JSON formatter options
Value	Summary
--noindent	Whether to disable indenting the json

Table 84.13. Table formatter options
Value	Summary
--max-width <integer>	Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.
--fit-width	Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable
--print-empty	Print empty table if there is no data to show.

84.4. user password set

Change current user password

Usage:

openstack user password set [-h] [--password <new-password>]
                                   [--original-password <original-password>]

Table 84.14. Command arguments
Value	Summary
-h, --help	Show this help message and exit
--password <new-password>	New user password
--original-password <original-password>	Original user password

84.5. user set

Set user properties

Usage:

openstack user set [-h] [--name <name>] [--domain <domain>]
                          [--project <project>]
                          [--project-domain <project-domain>]
                          [--password <password>] [--password-prompt]
                          [--email <email-address>]
                          [--description <description>] [--enable | --disable]
                          <user>

Table 84.15. Positional arguments
Value	Summary
<user>	User to modify (name or id)

Table 84.16. Command arguments
Value	Summary
-h, --help	Show this help message and exit
--name <name>	Set user name
--domain <domain>	Domain the user belongs to (name or id). this can be used in case collisions between user names exist.
--project <project>	Set default project (name or id)
--project-domain <project-domain>	Domain the project belongs to (name or id). this can be used in case collisions between project names exist.
--password <password>	Set user password
--password-prompt	Prompt interactively for password
--email <email-address>	Set user email address
--description <description>	Set user description
--enable	Enable user (default)
--disable	Disable user

84.6. user show

Display user details

Usage:

openstack user show [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN]
                           [--noindent] [--prefix PREFIX]
                           [--max-width <integer>] [--fit-width]
                           [--print-empty] [--domain <domain>]
                           <user>

Table 84.17. Positional arguments
Value	Summary
<user>	User to display (name or id)

Table 84.18. Command arguments
Value	Summary
-h, --help	Show this help message and exit
--domain <domain>	Domain owning <user> (name or id)

Table 84.19. Output formatter options
Value	Summary
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}	The output format, defaults to table
-c COLUMN, --column COLUMN	Specify the column(s) to include, can be repeated

Table 84.20. JSON formatter options
Value	Summary
--noindent	Whether to disable indenting the json

Table 84.21. Shell formatter options
Value	Summary
--prefix PREFIX	Add a prefix to all variable names

Table 84.22. Table formatter options
Value	Summary
--max-width <integer>	Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.
--fit-width	Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable
--print-empty	Print empty table if there is no data to show.

84.1. user create

84.2. user delete

84.3. user list

84.4. user password set

84.5. user set

84.6. user show

Learn

Try, buy, & sell

Communities

About Red Hat Documentation

Making open source more inclusive

About Red Hat

Red Hat legal and privacy links

Red Hat legal and privacy links