Chapter 63. secret
Chapter 63. secret This chapter describes the commands under the secret command. 63.1. secret consumer create Create a consumer for a secret. Usage: Table 63.1. Positional arguments Value Summary URI The uri reference for the secret Table 63.2. Command arguments Value Summary -h, --help Show this help message and exit --service-type-name SERVICE_TYPE_NAME, -s SERVICE_TYPE_NAME The service that will consume the secret --resource-type RESOURCE_TYPE, -t RESOURCE_TYPE The type of resource that will consume the secret --resource-id RESOURCE_ID, -i RESOURCE_ID The id of the resource that will consume the secret 63.2. secret consumer delete Delete a consumer from a secret. Usage: Table 63.3. Positional arguments Value Summary URI The uri reference for the secret Table 63.4. Command arguments Value Summary -h, --help Show this help message and exit --service-type-name SERVICE_TYPE_NAME, -s SERVICE_TYPE_NAME The service that is consuming the secret --resource-type RESOURCE_TYPE, -t RESOURCE_TYPE The type of resource that is consuming the secret --resource-id RESOURCE_ID, -i RESOURCE_ID The id of the resource that is consuming the secret 63.3. secret consumer list List consumers of a secret. Usage: Table 63.5. Positional arguments Value Summary URI The uri reference for the secret Table 63.6. 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 63.7. 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 63.8. CSV formatter options Value Summary --quote {all,minimal,none,nonnumeric} When to include quotes, defaults to nonnumeric Table 63.9. JSON formatter options Value Summary --noindent Whether to disable indenting the json Table 63.10. 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. 63.4. secret container create Store a container in Barbican. Usage: Table 63.11. 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 63.12. 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 63.13. JSON formatter options Value Summary --noindent Whether to disable indenting the json Table 63.14. Shell formatter options Value Summary --prefix PREFIX Add a prefix to all variable names Table 63.15. 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. 63.5. secret container delete Delete a container by providing its href. Usage: Table 63.16. Positional arguments Value Summary URI The uri reference for the container Table 63.17. Command arguments Value Summary -h, --help Show this help message and exit 63.6. secret container get Retrieve a container by providing its URI. Usage: Table 63.18. Positional arguments Value Summary URI The uri reference for the container. Table 63.19. Command arguments Value Summary -h, --help Show this help message and exit Table 63.20. 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 63.21. JSON formatter options Value Summary --noindent Whether to disable indenting the json Table 63.22. Shell formatter options Value Summary --prefix PREFIX Add a prefix to all variable names Table 63.23. 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. 63.7. secret container list List containers. Usage: Table 63.24. 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 63.25. 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 63.26. CSV formatter options Value Summary --quote {all,minimal,none,nonnumeric} When to include quotes, defaults to nonnumeric Table 63.27. JSON formatter options Value Summary --noindent Whether to disable indenting the json Table 63.28. 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. 63.8. secret delete Delete a secret by providing its URI. Usage: Table 63.29. Positional arguments Value Summary URI The uri reference for the secret Table 63.30. Command arguments Value Summary -h, --help Show this help message and exit --force, -f If specified, forces the deletion of secrets that have consumers. 63.9. secret get Retrieve a secret by providing its URI. Usage: Table 63.31. Positional arguments Value Summary URI The uri reference for the secret. Table 63.32. 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 63.33. 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 63.34. JSON formatter options Value Summary --noindent Whether to disable indenting the json Table 63.35. Shell formatter options Value Summary --prefix PREFIX Add a prefix to all variable names Table 63.36. 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. 63.10. secret list List secrets. Usage: Table 63.37. 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 63.38. 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 63.39. CSV formatter options Value Summary --quote {all,minimal,none,nonnumeric} When to include quotes, defaults to nonnumeric Table 63.40. JSON formatter options Value Summary --noindent Whether to disable indenting the json Table 63.41. 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. 63.11. secret order create Create a new order. Usage: Table 63.42. Positional arguments Value Summary type The type of the order (key, asymmetric, certificate) to create. Table 63.43. 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 63.44. 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 63.45. JSON formatter options Value Summary --noindent Whether to disable indenting the json Table 63.46. Shell formatter options Value Summary --prefix PREFIX Add a prefix to all variable names Table 63.47. 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. 63.12. secret order delete Delete an order by providing its href. Usage: Table 63.48. Positional arguments Value Summary URI The uri reference for the order Table 63.49. Command arguments Value Summary -h, --help Show this help message and exit 63.13. secret order get Retrieve an order by providing its URI. Usage: Table 63.50. Positional arguments Value Summary URI The uri reference order. Table 63.51. Command arguments Value Summary -h, --help Show this help message and exit Table 63.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 63.53. JSON formatter options Value Summary --noindent Whether to disable indenting the json Table 63.54. Shell formatter options Value Summary --prefix PREFIX Add a prefix to all variable names Table 63.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. 63.14. secret order list List orders. Usage: Table 63.56. 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 63.57. 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 63.58. CSV formatter options Value Summary --quote {all,minimal,none,nonnumeric} When to include quotes, defaults to nonnumeric Table 63.59. JSON formatter options Value Summary --noindent Whether to disable indenting the json Table 63.60. 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. 63.15. secret store Store a secret in Barbican. Usage: Table 63.61. 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 63.62. 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 63.63. JSON formatter options Value Summary --noindent Whether to disable indenting the json Table 63.64. Shell formatter options Value Summary --prefix PREFIX Add a prefix to all variable names Table 63.65. 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. 63.16. secret update Update a secret with no payload in Barbican. Usage: Table 63.66. Positional arguments Value Summary URI The uri reference for the secret. payload The unencrypted secret Table 63.67. Command arguments Value Summary -h, --help Show this help message and exit
openstack secret consumer create [-h] --service-type-name SERVICE_TYPE_NAME --resource-type RESOURCE_TYPE --resource-id RESOURCE_ID URI openstack secret consumer delete [-h] --service-type-name SERVICE_TYPE_NAME --resource-type RESOURCE_TYPE --resource-id RESOURCE_ID URI openstack secret consumer 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] URI 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] [--force] 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