Chapter 70. secret This chapter describes the commands under the secret command. 70.1. secret container create Store a container in Barbican. Usage: Table 70.1. Command arguments Value Summary -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" Table 70.2. Output formatter options Value Summary -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 Table 70.3. JSON formatter options Value Summary --noindent Whether to disable indenting the json Table 70.4. Shell formatter options Value Summary --prefix PREFIX Add a prefix to all variable names Table 70.5. Table formatter options 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. 70.2. secret container delete Delete a container by providing its href. Usage: Table 70.6. Positional arguments Value Summary URI The uri reference for the container Table 70.7. Command arguments Value Summary -h, --help Show this help message and exit 70.3. secret container get Retrieve a container by providing its URI. Usage: Table 70.8. Positional arguments Value Summary URI The uri reference for the container. Table 70.9. Command arguments Value Summary -h, --help Show this help message and exit Table 70.10. Output formatter options Value Summary -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 Table 70.11. JSON formatter options Value Summary --noindent Whether to disable indenting the json Table 70.12. Shell formatter options Value Summary --prefix PREFIX Add a prefix to all variable names Table 70.13. Table formatter options 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. 70.4. secret container list List containers. Usage: Table 70.14. Command arguments Value Summary -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). Table 70.15. Output formatter options Value Summary -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 Table 70.16. CSV formatter options Value Summary --quote {all,minimal,none,nonnumeric} When to include quotes, defaults to nonnumeric Table 70.17. JSON formatter options Value Summary --noindent Whether to disable indenting the json Table 70.18. Table formatter options 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. 70.5. secret delete Delete a secret by providing its URI. Usage: Table 70.19. Positional arguments Value Summary URI The uri reference for the secret Table 70.20. Command arguments Value Summary -h, --help Show this help message and exit 70.6. secret get Retrieve a secret by providing its URI. Usage: Table 70.21. Positional arguments Value Summary URI The uri reference for the secret. Table 70.22. Command arguments Value Summary -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). Table 70.23. Output formatter options Value Summary -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 Table 70.24. JSON formatter options Value Summary --noindent Whether to disable indenting the json Table 70.25. Shell formatter options Value Summary --prefix PREFIX Add a prefix to all variable names Table 70.26. Table formatter options 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. 70.7. secret list List secrets. Usage: Table 70.27. Command arguments Value Summary -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). Table 70.28. Output formatter options Value Summary -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 Table 70.29. CSV formatter options Value Summary --quote {all,minimal,none,nonnumeric} When to include quotes, defaults to nonnumeric Table 70.30. JSON formatter options Value Summary --noindent Whether to disable indenting the json Table 70.31. Table formatter options 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. 70.8. secret order create Create a new order. Usage: Table 70.32. Positional arguments Value Summary type The type of the order (key, asymmetric, certificate) to create. Table 70.33. Command arguments Value Summary -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. Table 70.34. Output formatter options Value Summary -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 Table 70.35. JSON formatter options Value Summary --noindent Whether to disable indenting the json Table 70.36. Shell formatter options Value Summary --prefix PREFIX Add a prefix to all variable names Table 70.37. Table formatter options 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. 70.9. secret order delete Delete an order by providing its href. Usage: Table 70.38. Positional arguments Value Summary URI The uri reference for the order Table 70.39. Command arguments Value Summary -h, --help Show this help message and exit 70.10. secret order get Retrieve an order by providing its URI. Usage: Table 70.40. Positional arguments Value Summary URI The uri reference order. Table 70.41. Command arguments Value Summary -h, --help Show this help message and exit Table 70.42. Output formatter options Value Summary -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 Table 70.43. JSON formatter options Value Summary --noindent Whether to disable indenting the json Table 70.44. Shell formatter options Value Summary --prefix PREFIX Add a prefix to all variable names Table 70.45. Table formatter options 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. 70.11. secret order list List orders. Usage: Table 70.46. Command arguments Value Summary -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) Table 70.47. Output formatter options Value Summary -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 Table 70.48. CSV formatter options Value Summary --quote {all,minimal,none,nonnumeric} When to include quotes, defaults to nonnumeric Table 70.49. JSON formatter options Value Summary --noindent Whether to disable indenting the json Table 70.50. Table formatter options 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. 70.12. secret store Store a secret in Barbican. Usage: Table 70.51. Command arguments Value Summary -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 Table 70.52. Output formatter options Value Summary -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 Table 70.53. JSON formatter options Value Summary --noindent Whether to disable indenting the json Table 70.54. Shell formatter options Value Summary --prefix PREFIX Add a prefix to all variable names Table 70.55. Table formatter options 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. 70.13. secret update Update a secret with no payload in Barbican. Usage: Table 70.56. Positional arguments Value Summary URI The uri reference for the secret. payload The unencrypted secret Table 70.57. Command arguments Value Summary -h, --help Show this help message and exit

Commands:
openstack secret container create [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] [--name NAME] [--type TYPE] [--secret SECRET]
openstack secret container delete [-h] URI
openstack secret container get [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] URI
openstack secret container 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] [--limit LIMIT] [--offset OFFSET] [--name NAME] [--type TYPE]
openstack secret delete [-h] URI
openstack secret get [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] [--decrypt | --payload | --file <filename>] [--payload_content_type PAYLOAD_CONTENT_TYPE] URI
openstack secret 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] [--limit LIMIT] [--offset OFFSET] [--name NAME] [--algorithm ALGORITHM] [--bit-length BIT_LENGTH] [--mode MODE] [--secret-type SECRET_TYPE]
openstack secret order create [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] [--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
openstack secret order delete [-h] URI
openstack secret order get [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] URI
openstack secret order 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] [--limit LIMIT] [--offset OFFSET]
openstack secret store [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] [--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>]
openstack secret update [-h] URI payload