Chapter 70. user

70.1. user create

Create new user

Usage:

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

Table 70.1. Table Formatter
Value	Summary
--print-empty	Print empty table if there is no data to show.
--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

Table 70.2. Positional Arguments
Value	Summary
<name>	New user name

Table 70.3. Output Formatters
Value	Summary
output formatter options-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 70.4. JSON Formatter
Value	Summary
--noindent	Whether to disable indenting the json

Table 70.5. Optional Arguments
Value	Summary
--enable	Enable user (default)
--or-show	Return existing user
--password <password>	Set user password
--email <email-address>	Set user email address
--password-prompt	Prompt interactively for password
-h, --help	Show this help message and exit
--disable	Disable user
--project <project>	Default project (name or id)

Table 70.6. Shell Formatter
Value	Summary
a format a UNIX shell can parse (variable="value")--prefix PREFIX	Add a prefix to all variable names

70.2. user delete

Delete user(s)

Usage:

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

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

Table 70.8. Optional Arguments
Value	Summary
-h, --help	Show this help message and exit

70.3. user list

List users

Usage:

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

Table 70.9. Table Formatter
Value	Summary
--print-empty	Print empty table if there is no data to show.
--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

Table 70.10. CSV Formatter
Value	Summary
--quote {all,minimal,none,nonnumeric}	When to include quotes, defaults to nonnumeric

Table 70.11. Output Formatters
Value	Summary
output formatter options-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 70.12. JSON Formatter
Value	Summary
--noindent	Whether to disable indenting the json

Table 70.13. Optional Arguments
Value	Summary
-h, --help	Show this help message and exit
--project <project>	Filter users by project (name or id)
--long	List additional fields in output

70.4. user role list

List user-role assignments

Usage:

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

Table 70.14. Table Formatter
Value	Summary
--print-empty	Print empty table if there is no data to show.
--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

Table 70.15. Positional Arguments
Value	Summary
<user>	User to list (name or id)

Table 70.16. CSV Formatter
Value	Summary
--quote {all,minimal,none,nonnumeric}	When to include quotes, defaults to nonnumeric

Table 70.17. Output Formatters
Value	Summary
output formatter options-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 70.18. JSON Formatter
Value	Summary
--noindent	Whether to disable indenting the json

Table 70.19. Optional Arguments
Value	Summary
-h, --help	Show this help message and exit
--project <project>	Filter users by <project> (name or id)

70.5. user set

Set user properties

Usage:

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

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

Table 70.21. Optional Arguments
Value	Summary
--password <user-password>	Set user password
--enable	Enable user (default)
--name <name>	Set user name
--email <email-address>	Set user email address
--password-prompt	Prompt interactively for password
-h, --help	Show this help message and exit
--disable	Disable user
--project <project>	Set default project (name or id)

70.6. user show

Display user details

Usage:

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

Table 70.22. Table Formatter
Value	Summary
--print-empty	Print empty table if there is no data to show.
--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

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

Table 70.24. Output Formatters
Value	Summary
output formatter options-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 70.25. JSON Formatter
Value	Summary
--noindent	Whether to disable indenting the json

Table 70.26. Optional Arguments
Value	Summary
-h, --help	Show this help message and exit

Table 70.27. Shell Formatter
Value	Summary
a format a UNIX shell can parse (variable="value")--prefix PREFIX	Add a prefix to all variable names

70.1. user create

70.2. user delete

70.3. user list

70.4. user role list

70.5. user set

70.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