Chapter 2. access


This chapter describes the commands under the access command.

2.1. access rule delete

Delete access rule(s)

Usage:

openstack access rule delete [-h] <access-rule> [<access-rule> ...]
Copy to Clipboard Toggle word wrap

Expand
Table 2.1. Positional arguments
ValueSummary

<access-rule>

Access rule(s) to delete (name or id)

Expand
Table 2.2. Command arguments
ValueSummary

-h, --help

Show this help message and exit

2.2. access rule list

List access rules

Usage:

openstack access rule 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]
                                  [--sort-ascending | --sort-descending]
                                  [--user <user>]
                                  [--user-domain <user-domain>]
Copy to Clipboard Toggle word wrap

Expand
Table 2.3. Command arguments
ValueSummary

-h, --help

Show this help message and exit

--user <user>

User whose access rules to list (name or id)

--user-domain <user-domain>

Domain the user belongs to (name or id). this can be used in case collisions between user names exist.

Expand
Table 2.4. Output formatter options
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 to show multiple columns

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

--sort-ascending

Sort the column(s) in ascending order

--sort-descending

Sort the column(s) in descending order

Expand
Table 2.5. CSV formatter options
ValueSummary

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

When to include quotes, defaults to nonnumeric

Expand
Table 2.6. JSON formatter options
ValueSummary

--noindent

Whether to disable indenting the json

Expand
Table 2.7. Table formatter options
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.

2.3. access rule show

Display access rule details

Usage:

openstack access rule show [-h] [-f {json,shell,table,value,yaml}]
                                  [-c COLUMN] [--noindent] [--prefix PREFIX]
                                  [--max-width <integer>] [--fit-width]
                                  [--print-empty]
                                  <access-rule>
Copy to Clipboard Toggle word wrap

Expand
Table 2.8. Positional arguments
ValueSummary

<access-rule>

Access rule to display (name or id)

Expand
Table 2.9. Command arguments
ValueSummary

-h, --help

Show this help message and exit

Expand
Table 2.10. Output formatter options
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 to show multiple columns

Expand
Table 2.11. JSON formatter options
ValueSummary

--noindent

Whether to disable indenting the json

Expand
Table 2.12. Shell formatter options
ValueSummary

--prefix PREFIX

Add a prefix to all variable names

Expand
Table 2.13. Table formatter options
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.

2.4. access token create

Create an access token

Usage:

openstack access token create [-h] [-f {json,shell,table,value,yaml}]
                                     [-c COLUMN] [--noindent]
                                     [--prefix PREFIX] [--max-width <integer>]
                                     [--fit-width] [--print-empty]
                                     --consumer-key <consumer-key>
                                     --consumer-secret <consumer-secret>
                                     --request-key <request-key>
                                     --request-secret <request-secret>
                                     --verifier <verifier>
Copy to Clipboard Toggle word wrap

Expand
Table 2.14. Command arguments
ValueSummary

-h, --help

Show this help message and exit

--consumer-key <consumer-key>

Consumer key (required)

--consumer-secret <consumer-secret>

Consumer secret (required)

--request-key <request-key>

Request token to exchange for access token (required)

--request-secret <request-secret>

Secret associated with <request-key> (required)

--verifier <verifier>

Verifier associated with <request-key> (required)

Expand
Table 2.15. Output formatter options
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 to show multiple columns

Expand
Table 2.16. JSON formatter options
ValueSummary

--noindent

Whether to disable indenting the json

Expand
Table 2.17. Shell formatter options
ValueSummary

--prefix PREFIX

Add a prefix to all variable names

Expand
Table 2.18. Table formatter options
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.

Back to top
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. Explore our recent updates.

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.

Theme

© 2025 Red Hat