SupportConsoleDevelopersStart a trialContact

Chapter 53. role

This chapter describes the commands under the role command.

53.1. role add

Add role to project:user

Usage:

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

Table 53.1. Table Formatter
ValueSummary

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

<role>

Role to add to <project>:<user> (name or id)

Table 53.3. Output Formatters
ValueSummary

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

--noindent

Whether to disable indenting the json

Table 53.5. Optional Arguments
ValueSummary

--user <user>

Include <user> (name or id)

-h, --help

Show this help message and exit

--project <project>

Include <project> (name or id)

Table 53.6. Shell Formatter
ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

53.2. role assignment list

List role assignments

Usage:

openstack role assignment 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]
                                      [--user <user>] [--project <project>]
                                      [--names] [--auth-user] [--auth-project]

Table 53.7. Table Formatter
ValueSummary

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

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

When to include quotes, defaults to nonnumeric

Table 53.9. Output Formatters
ValueSummary

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

--noindent

Whether to disable indenting the json

Table 53.11. Optional Arguments
ValueSummary

--auth-project

Only list assignments for the project to which the authenticated user’s token is scoped

--user <user>

User to filter (name or id)

--auth-user

Only list assignments for the authenticated user

--names

Display names instead of ids

-h, --help

Show this help message and exit

--project <project>

Project to filter (name or id)

53.3. role create

Create new role

Usage:

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

Table 53.12. Table Formatter
ValueSummary

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

<name>

New role name

Table 53.14. Output Formatters
ValueSummary

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

--noindent

Whether to disable indenting the json

Table 53.16. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

--or-show

Return existing role

Table 53.17. Shell Formatter
ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

53.4. role delete

Delete role(s)

Usage:

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

Table 53.18. Positional Arguments
ValueSummary

<role>

Role(s) to delete (name or id)

Table 53.19. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

53.5. role list

List roles

Usage:

openstack 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 <user>]

Table 53.20. Table Formatter
ValueSummary

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

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

When to include quotes, defaults to nonnumeric

Table 53.22. Output Formatters
ValueSummary

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

--noindent

Whether to disable indenting the json

Table 53.24. Optional Arguments
ValueSummary

--user <user>

Filter roles by <user> (name or id)

-h, --help

Show this help message and exit

--project <project>

Filter roles by <project> (name or id)

53.6. role remove

Remove role from project : user

Usage:

openstack role remove [-h] --project <project> --user <user> <role>

Table 53.25. Positional Arguments
ValueSummary

<role>

Role to remove (name or id)

Table 53.26. Optional Arguments
ValueSummary

--user <user>

Include <user> (name or id)

-h, --help

Show this help message and exit

--project <project>

Include <project> (name or id)

53.7. role show

Display role details

Usage:

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

Table 53.27. Table Formatter
ValueSummary

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

<role>

Role to display (name or id)

Table 53.29. Output Formatters
ValueSummary

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

--noindent

Whether to disable indenting the json

Table 53.31. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

Table 53.32. Shell Formatter
ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

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.