SupportConsoleDevelopersStart a trialContact

Chapter 86. user

This chapter describes the commands under the user command.

86.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 86.1. Positional Arguments
ValueSummary

<name>

New user name

Table 86.2. Optional Arguments
ValueSummary

-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 86.3. Output Formatters
ValueSummary

-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 86.4. JSON Formatter
ValueSummary

--noindent

Whether to disable indenting the json

Table 86.5. Shell Formatter
ValueSummary

--prefix PREFIX

Add a prefix to all variable names

Table 86.6. Table Formatter
ValueSummary

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

86.2. user delete

Delete user(s)

Usage:

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

Table 86.7. Positional Arguments
ValueSummary

<user>

User(s) to delete (name or id)

Table 86.8. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

--domain <domain>

Domain owning <user> (name or id)

86.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 86.9. Optional Arguments
ValueSummary

-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 86.10. Output Formatters
ValueSummary

-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 86.11. CSV Formatter
ValueSummary

--quote {all,minimal,none,nonnumeric}

When to include quotes, defaults to nonnumeric

Table 86.12. JSON Formatter
ValueSummary

--noindent

Whether to disable indenting the json

Table 86.13. Table Formatter
ValueSummary

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

86.4. user password set

Change current user password

Usage:

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

Table 86.14. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

--password <new-password>

New user password

--original-password <original-password>

Original user password

86.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 86.15. Positional Arguments
ValueSummary

<user>

User to modify (name or id)

Table 86.16. Optional Arguments
ValueSummary

-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

86.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 86.17. Positional Arguments
ValueSummary

<user>

User to display (name or id)

Table 86.18. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

--domain <domain>

Domain owning <user> (name or id)

Table 86.19. Output Formatters
ValueSummary

-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 86.20. JSON Formatter
ValueSummary

--noindent

Whether to disable indenting the json

Table 86.21. Shell Formatter
ValueSummary

--prefix PREFIX

Add a prefix to all variable names

Table 86.22. Table Formatter
ValueSummary

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

Red Hat logoGithubRedditYoutubeTwitter

Learn

Try, buy, & sell

Communities

About Red Hat Documentation

We help Red Hat users innovate and achieve their goals with our products and services with content they can trust.

Making open source more inclusive

Red Hat is committed to replacing problematic language in our code, documentation, and web properties. For more details, see the Red Hat Blog.

About Red Hat

We deliver hardened solutions that make it easier for enterprises to work across platforms and environments, from the core datacenter to the network edge.

© 2024 Red Hat, Inc.