Chapter 59. secret


This chapter describes the commands under the secret command.

59.1. secret container create

Usage:

openstack secret container create [-h]

                                       [-f {json,shell,table,value,yaml}]
                                       [-c COLUMN] [--max-width <integer>]
                                       [--fit-width] [--print-empty]
                                       [--noindent] [--prefix PREFIX]
                                       [--name NAME] [--type TYPE]
                                       [--secret SECRET]
Copy to Clipboard Toggle word wrap

Store a container in Barbican.

Expand
Table 59.1. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

--name NAME, -n NAME

A human-friendly name.

--type TYPE

Type of container to create (default: generic).

--secret SECRET, -s SECRET

one secret to store in a container (can be set multiple times). Example: --secret "private_key=https://url.test/v1/secrets/1-2-3-4"

Expand
Table 59.2. 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

Expand
Table 59.3. 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.

Expand
Table 59.4. JSON Formatter
ValueSummary

--noindent

Whether to disable indenting the json

Expand
Table 59.5. shell formatter
ValueSummary

--prefix PREFIX

Add a prefix to all variable names

This command is provided by the python-barbicanclient plugin.

59.2. secret container delete

Usage:

openstack secret container delete [-h] URI
Copy to Clipboard Toggle word wrap

Delete a container by providing its href.

Expand
Table 59.6. Positional Arguments
ValueSummary

URI

The uri reference for the container

Expand
Table 59.7. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

This command is provided by the python-barbicanclient plugin.

59.3. secret container get

Usage:

openstack secret container get [-h] [-f {json,shell,table,value,yaml}]

                                    [-c COLUMN] [--max-width <integer>]
                                    [--fit-width] [--print-empty]
                                    [--noindent] [--prefix PREFIX]
                                    URI
Copy to Clipboard Toggle word wrap

Retrieve a container by providing its URI.

Expand
Table 59.8. Positional Arguments
ValueSummary

URI

The uri reference for the container.

Expand
Table 59.9. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

Expand
Table 59.10. 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

Expand
Table 59.11. 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.

Expand
Table 59.12. JSON Formatter
ValueSummary

--noindent

Whether to disable indenting the json

Expand
Table 59.13. shell formatter
ValueSummary

--prefix PREFIX

Add a prefix to all variable names

This command is provided by the python-barbicanclient plugin.

59.4. secret container list

Usage:

openstack secret container 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]
                                     [--limit LIMIT] [--offset OFFSET]
                                     [--name NAME] [--type TYPE]
Copy to Clipboard Toggle word wrap

List containers.

Expand
Table 59.14. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

--limit LIMIT, -l LIMIT

specify the limit to the number of items to list per page (default: 10; maximum: 100)

--offset OFFSET, -o OFFSET

specify the page offset (default: 0)

--name NAME, -n NAME

Specify the container name (default: none)

--type TYPE, -t TYPE

Specify the type filter for the list (default: none).

Expand
Table 59.15. 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

Expand
Table 59.16. 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.

Expand
Table 59.17. JSON Formatter
ValueSummary

--noindent

Whether to disable indenting the json

Expand
Table 59.18. CSV Formatter
ValueSummary

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

when to include quotes, defaults to nonnumeric

This command is provided by the python-barbicanclient plugin.

59.5. secret delete

Usage:

openstack secret delete [-h] URI
Copy to Clipboard Toggle word wrap

Delete a secret by providing its URI.

Expand
Table 59.19. Positional Arguments
ValueSummary

URI

The uri reference for the secret

Expand
Table 59.20. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

This command is provided by the python-barbicanclient plugin.

59.6. secret get

Usage:

openstack secret get [-h] [-f {json,shell,table,value,yaml}]

                          [-c COLUMN] [--max-width <integer>] [--fit-width]
                          [--print-empty] [--noindent] [--prefix PREFIX]
                          [--decrypt | --payload | --file <filename>]
                          [--payload_content_type PAYLOAD_CONTENT_TYPE]
                          URI
Copy to Clipboard Toggle word wrap

Retrieve a secret by providing its URI.

Expand
Table 59.21. Positional Arguments
ValueSummary

URI

The uri reference for the secret.

Expand
Table 59.22. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

--decrypt, -d

If specified, retrieve the unencrypted secret data.

--payload, -p

If specified, retrieve the unencrypted secret data.

--file <filename>, -F <filename>

if specified, save the payload to a new file with the given filename.

--payload_content_type PAYLOAD_CONTENT_TYPE, -t PAYLOAD_CONTENT_TYPE

the content type of the decrypted secret (default: text/plain).

Expand
Table 59.23. 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

Expand
Table 59.24. 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.

Expand
Table 59.25. JSON Formatter
ValueSummary

--noindent

Whether to disable indenting the json

Expand
Table 59.26. shell formatter
ValueSummary

--prefix PREFIX

Add a prefix to all variable names

This command is provided by the python-barbicanclient plugin.

59.7. secret list

Usage:

openstack secret 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] [--limit LIMIT]
                           [--offset OFFSET] [--name NAME]
                           [--algorithm ALGORITHM] [--bit-length BIT_LENGTH]
                           [--mode MODE] [--secret-type SECRET_TYPE]
Copy to Clipboard Toggle word wrap

List secrets.

Expand
Table 59.27. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

--limit LIMIT, -l LIMIT

specify the limit to the number of items to list per page (default: 10; maximum: 100)

--offset OFFSET, -o OFFSET

specify the page offset (default: 0)

--name NAME, -n NAME

Specify the secret name (default: none)

--algorithm ALGORITHM, -a ALGORITHM

the algorithm filter for the list(default: None).

--bit-length BIT_LENGTH, -b BIT_LENGTH

the bit length filter for the list (default: 0).

--mode MODE, -m MODE

The algorithm mode filter for the list (default: None).

--secret-type SECRET_TYPE, -s SECRET_TYPE

specify the secret type (default: None).

Expand
Table 59.28. 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

Expand
Table 59.29. 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.

Expand
Table 59.30. JSON Formatter
ValueSummary

--noindent

Whether to disable indenting the json

Expand
Table 59.31. CSV Formatter
ValueSummary

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

when to include quotes, defaults to nonnumeric

This command is provided by the python-barbicanclient plugin.

59.8. secret order create

Usage:

openstack secret order create [-h] [-f {json,shell,table,value,yaml}]

                                   [-c COLUMN] [--max-width <integer>]
                                   [--fit-width] [--print-empty]
                                   [--noindent] [--prefix PREFIX]
                                   [--name NAME] [--algorithm ALGORITHM]
                                   [--bit-length BIT_LENGTH] [--mode MODE]
                                   [--payload-content-type PAYLOAD_CONTENT_TYPE]
                                   [--expiration EXPIRATION]
                                   [--request-type REQUEST_TYPE]
                                   [--subject-dn SUBJECT_DN]
                                   [--source-container-ref SOURCE_CONTAINER_REF]
                                   [--ca-id CA_ID] [--profile PROFILE]
                                   [--request-file REQUEST_FILE]
                                   type
Copy to Clipboard Toggle word wrap

Create a new order.

Expand
Table 59.32. Positional Arguments
ValueSummary

type

The type of the order (key, asymmetric, certificate) to create.

Expand
Table 59.33. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

--name NAME, -n NAME

A human-friendly name.

--algorithm ALGORITHM, -a ALGORITHM

the algorithm to be used with the requested key (default: aes).

--bit-length BIT_LENGTH, -b BIT_LENGTH

the bit length of the requested secret key (default: 256).

--mode MODE, -m MODE

The algorithm mode to be used with the requested key (default: cbc).

--payload-content-type PAYLOAD_CONTENT_TYPE, -t PAYLOAD_CONTENT_TYPE

the type/format of the secret to be generated (default: application/octet-stream).

--expiration EXPIRATION, -x EXPIRATION

the expiration time for the secret in ISO 8601 format.

--request-type REQUEST_TYPE

the type of the certificate request.

--subject-dn SUBJECT_DN

the subject of the certificate.

--source-container-ref SOURCE_CONTAINER_REF

the source of the certificate when using stored-key requests.

--ca-id CA_ID

The identifier of the ca to use for the certificate request.

--profile PROFILE

The profile of certificate to use.

--request-file REQUEST_FILE

the file containing the CSR.

Expand
Table 59.34. 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

Expand
Table 59.35. 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.

Expand
Table 59.36. JSON Formatter
ValueSummary

--noindent

Whether to disable indenting the json

Expand
Table 59.37. shell formatter
ValueSummary

--prefix PREFIX

Add a prefix to all variable names

This command is provided by the python-barbicanclient plugin.

59.9. secret order delete

Usage:

openstack secret order delete [-h] URI
Copy to Clipboard Toggle word wrap

Delete an order by providing its href.

Expand
Table 59.38. Positional Arguments
ValueSummary

URI

The uri reference for the order

Expand
Table 59.39. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

This command is provided by the python-barbicanclient plugin.

59.10. secret order get

Usage:

openstack secret order get [-h] [-f {json,shell,table,value,yaml}]

                                [-c COLUMN] [--max-width <integer>]
                                [--fit-width] [--print-empty] [--noindent]
                                [--prefix PREFIX]
                                URI
Copy to Clipboard Toggle word wrap

Retrieve an order by providing its URI.

Expand
Table 59.40. Positional Arguments
ValueSummary

URI

The uri reference order.

Expand
Table 59.41. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

Expand
Table 59.42. 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

Expand
Table 59.43. 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.

Expand
Table 59.44. JSON Formatter
ValueSummary

--noindent

Whether to disable indenting the json

Expand
Table 59.45. shell formatter
ValueSummary

--prefix PREFIX

Add a prefix to all variable names

This command is provided by the python-barbicanclient plugin.

59.11. secret order list

Usage:

openstack secret order 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] [--limit LIMIT]
                                 [--offset OFFSET]
Copy to Clipboard Toggle word wrap

List orders.

Expand
Table 59.46. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

--limit LIMIT, -l LIMIT

specify the limit to the number of items to list per page (default: 10; maximum: 100)

--offset OFFSET, -o OFFSET

specify the page offset (default: 0)

Expand
Table 59.47. 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

Expand
Table 59.48. 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.

Expand
Table 59.49. JSON Formatter
ValueSummary

--noindent

Whether to disable indenting the json

Expand
Table 59.50. CSV Formatter
ValueSummary

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

when to include quotes, defaults to nonnumeric

This command is provided by the python-barbicanclient plugin.

59.12. secret store

Usage:

openstack secret store [-h] [-f {json,shell,table,value,yaml}]

                            [-c COLUMN] [--max-width <integer>]
                            [--fit-width] [--print-empty] [--noindent]
                            [--prefix PREFIX] [--name NAME]
                            [--secret-type SECRET_TYPE]
                            [--payload-content-type PAYLOAD_CONTENT_TYPE]
                            [--payload-content-encoding PAYLOAD_CONTENT_ENCODING]
                            [--algorithm ALGORITHM]
                            [--bit-length BIT_LENGTH] [--mode MODE]
                            [--expiration EXPIRATION]
                            [--payload PAYLOAD | --file <filename>]
Copy to Clipboard Toggle word wrap

Store a secret in Barbican.

Expand
Table 59.51. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

--name NAME, -n NAME

A human-friendly name.

--secret-type SECRET_TYPE, -s SECRET_TYPE

the secret type; must be one of symmetric, public, private, certificate, passphrase, opaque (default)

--payload-content-type PAYLOAD_CONTENT_TYPE, -t PAYLOAD_CONTENT_TYPE

the type/format of the provided secret data; "text/plain" is assumed to be UTF-8; required when

--payload is supplied.

 

--payload-content-encoding PAYLOAD_CONTENT_ENCODING, -e PAYLOAD_CONTENT_ENCODING

required if --payload-content-type is "application /octet-stream".

--algorithm ALGORITHM, -a ALGORITHM

the algorithm (default: aes).

--bit-length BIT_LENGTH, -b BIT_LENGTH

the bit length (default: 256).

--mode MODE, -m MODE

The algorithm mode; used only for reference (default: cbc)

--expiration EXPIRATION, -x EXPIRATION

the expiration time for the secret in ISO 8601 format.

--payload PAYLOAD, -p PAYLOAD

the unencrypted secret data.

--file <filename>, -F <filename>

file containing the secret payload

Expand
Table 59.52. 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

Expand
Table 59.53. 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.

Expand
Table 59.54. JSON Formatter
ValueSummary

--noindent

Whether to disable indenting the json

Expand
Table 59.55. shell formatter
ValueSummary

--prefix PREFIX

Add a prefix to all variable names

This command is provided by the python-barbicanclient plugin.

59.13. secret update

Usage:

openstack secret update [-h] URI payload
Copy to Clipboard Toggle word wrap

Update a secret with no payload in Barbican.

Expand
Table 59.56. Positional Arguments
ValueSummary

URI

The uri reference for the secret.

payload

The unencrypted secret

Expand
Table 59.57. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

This command is provided by the python-barbicanclient plugin.

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