Chapter 23. credential


This chapter describes the commands under the credential command.

23.1. credential create

Create new credential

Usage:

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

Table 23.1. Positional arguments
ValueSummary

<user>

User that owns the credential (name or id)

<data>

New credential data

Table 23.2. Command arguments
ValueSummary

-h, --help

Show this help message and exit

--type <type>

New credential type: cert, ec2, totp and so on

--project <project>

Project which limits the scope of the credential (name or ID)

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

Table 23.4. JSON formatter options
ValueSummary

--noindent

Whether to disable indenting the json

Table 23.5. Shell formatter options
ValueSummary

--prefix PREFIX

Add a prefix to all variable names

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

23.2. credential delete

Delete credential(s)

Usage:

openstack credential delete [-h] <credential-id> [<credential-id> ...]

Table 23.7. Positional arguments
ValueSummary

<credential-id>

Id of credential(s) to delete

Table 23.8. Command arguments
ValueSummary

-h, --help

Show this help message and exit

23.3. credential list

List credentials

Usage:

openstack credential 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] [--user <user>]
                                 [--user-domain <user-domain>] [--type <type>]

Table 23.9. Command arguments
ValueSummary

-h, --help

Show this help message and exit

--user <user>

Filter credentials by <user> (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.

--type <type>

Filter credentials by type: cert, ec2, totp and so on

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

--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 23.11. CSV formatter options
ValueSummary

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

When to include quotes, defaults to nonnumeric

Table 23.12. JSON formatter options
ValueSummary

--noindent

Whether to disable indenting the json

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

23.4. credential set

Set credential properties

Usage:

openstack credential set [-h] --user <user> --type <type> --data <data>
                                [--project <project>]
                                <credential-id>

Table 23.14. Positional arguments
ValueSummary

<credential-id>

Id of credential to change

Table 23.15. Command arguments
ValueSummary

-h, --help

Show this help message and exit

--user <user>

User that owns the credential (name or id)

--type <type>

New credential type: cert, ec2, totp and so on

--data <data>

New credential data

--project <project>

Project which limits the scope of the credential (name or ID)

23.5. credential show

Display credential details

Usage:

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

Table 23.16. Positional arguments
ValueSummary

<credential-id>

Id of credential to display

Table 23.17. Command arguments
ValueSummary

-h, --help

Show this help message and exit

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

Table 23.19. JSON formatter options
ValueSummary

--noindent

Whether to disable indenting the json

Table 23.20. Shell formatter options
ValueSummary

--prefix PREFIX

Add a prefix to all variable names

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

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.