Chapter 25. credential
This chapter describes the commands under the credential command.
25.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 25.1. Positional Arguments
| Value | Summary |
|---|---|
| <user> | User that owns the credential (name or id) |
| <data> | New credential data |
Table 25.2. Optional Arguments
| Value | Summary |
|---|---|
| -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 25.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 25.4. JSON Formatter
| Value | Summary |
|---|---|
| --noindent | Whether to disable indenting the json |
Table 25.5. Shell Formatter
| Value | Summary |
|---|---|
| a format a UNIX shell can parse (variable="value")--prefix PREFIX | Add a prefix to all variable names |
Table 25.6. Table Formatter
| Value | Summary |
|---|---|
| --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. |
25.2. credential delete
Delete credential(s)
Usage:
openstack credential delete [-h] <credential-id> [<credential-id> ...]
Table 25.7. Positional Arguments
| Value | Summary |
|---|---|
| <credential-id> | Id of credential(s) to delete |
Table 25.8. Optional Arguments
| Value | Summary |
|---|---|
| -h, --help | Show this help message and exit |
25.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 25.9. Optional Arguments
| Value | Summary |
|---|---|
| -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 25.10. 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 25.11. CSV Formatter
| Value | Summary |
|---|---|
| --quote {all,minimal,none,nonnumeric} | When to include quotes, defaults to nonnumeric |
Table 25.12. JSON Formatter
| Value | Summary |
|---|---|
| --noindent | Whether to disable indenting the json |
Table 25.13. Table Formatter
| Value | Summary |
|---|---|
| --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. |
25.4. credential set
Set credential properties
Usage:
openstack credential set [-h] --user <user> --type <type> --data <data>
[--project <project>]
<credential-id>
Table 25.14. Positional Arguments
| Value | Summary |
|---|---|
| <credential-id> | Id of credential to change |
Table 25.15. Optional Arguments
| Value | Summary |
|---|---|
| -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) |
25.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 25.16. Positional Arguments
| Value | Summary |
|---|---|
| <credential-id> | Id of credential to display |
Table 25.17. Optional Arguments
| Value | Summary |
|---|---|
| -h, --help | Show this help message and exit |
Table 25.18. 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 25.19. JSON Formatter
| Value | Summary |
|---|---|
| --noindent | Whether to disable indenting the json |
Table 25.20. Shell Formatter
| Value | Summary |
|---|---|
| a format a UNIX shell can parse (variable="value")--prefix PREFIX | Add a prefix to all variable names |
Table 25.21. Table Formatter
| Value | Summary |
|---|---|
| --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. |
