Chapter 59. secret
This chapter describes the commands under the secret
command.
59.1. secret container create Copy linkLink copied to clipboard!
Usage:
Store a container in Barbican.
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" |
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 |
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. |
Value | Summary |
---|---|
--noindent | Whether to disable indenting the json |
Value | Summary |
---|---|
--prefix PREFIX | Add a prefix to all variable names |
This command is provided by the python-barbicanclient plugin.
59.2. secret container delete Copy linkLink copied to clipboard!
Usage:
openstack secret container delete [-h] URI
openstack secret container delete [-h] URI
Delete a container by providing its href.
Value | Summary |
---|---|
URI | The uri reference for the container |
Value | Summary |
---|---|
-h, --help | Show this help message and exit |
This command is provided by the python-barbicanclient plugin.
59.3. secret container get Copy linkLink copied to clipboard!
Usage:
Retrieve a container by providing its URI.
Value | Summary |
---|---|
URI | The uri reference for the container. |
Value | Summary |
---|---|
-h, --help | Show this help message and exit |
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 |
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. |
Value | Summary |
---|---|
--noindent | Whether to disable indenting the json |
Value | Summary |
---|---|
--prefix PREFIX | Add a prefix to all variable names |
This command is provided by the python-barbicanclient plugin.
59.4. secret container list Copy linkLink copied to clipboard!
Usage:
List containers.
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). |
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 |
--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 |
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. |
Value | Summary |
---|---|
--noindent | Whether to disable indenting the json |
Value | Summary |
---|---|
--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 Copy linkLink copied to clipboard!
Usage:
openstack secret delete [-h] URI
openstack secret delete [-h] URI
Delete a secret by providing its URI.
Value | Summary |
---|---|
URI | The uri reference for the secret |
Value | Summary |
---|---|
-h, --help | Show this help message and exit |
This command is provided by the python-barbicanclient plugin.
59.6. secret get Copy linkLink copied to clipboard!
Usage:
Retrieve a secret by providing its URI.
Value | Summary |
---|---|
URI | The uri reference for the secret. |
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). |
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 |
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. |
Value | Summary |
---|---|
--noindent | Whether to disable indenting the json |
Value | Summary |
---|---|
--prefix PREFIX | Add a prefix to all variable names |
This command is provided by the python-barbicanclient plugin.
59.7. secret list Copy linkLink copied to clipboard!
Usage:
List secrets.
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). |
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 |
--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 |
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. |
Value | Summary |
---|---|
--noindent | Whether to disable indenting the json |
Value | Summary |
---|---|
--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 Copy linkLink copied to clipboard!
Usage:
Create a new order.
Value | Summary |
---|---|
type | The type of the order (key, asymmetric, certificate) to create. |
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. |
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 |
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. |
Value | Summary |
---|---|
--noindent | Whether to disable indenting the json |
Value | Summary |
---|---|
--prefix PREFIX | Add a prefix to all variable names |
This command is provided by the python-barbicanclient plugin.
59.9. secret order delete Copy linkLink copied to clipboard!
Usage:
openstack secret order delete [-h] URI
openstack secret order delete [-h] URI
Delete an order by providing its href.
Value | Summary |
---|---|
URI | The uri reference for the order |
Value | Summary |
---|---|
-h, --help | Show this help message and exit |
This command is provided by the python-barbicanclient plugin.
59.10. secret order get Copy linkLink copied to clipboard!
Usage:
Retrieve an order by providing its URI.
Value | Summary |
---|---|
URI | The uri reference order. |
Value | Summary |
---|---|
-h, --help | Show this help message and exit |
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 |
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. |
Value | Summary |
---|---|
--noindent | Whether to disable indenting the json |
Value | Summary |
---|---|
--prefix PREFIX | Add a prefix to all variable names |
This command is provided by the python-barbicanclient plugin.
59.11. secret order list Copy linkLink copied to clipboard!
Usage:
List orders.
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) |
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 |
--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 |
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. |
Value | Summary |
---|---|
--noindent | Whether to disable indenting the json |
Value | Summary |
---|---|
--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 Copy linkLink copied to clipboard!
Usage:
Store a secret in Barbican.
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 |
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 |
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. |
Value | Summary |
---|---|
--noindent | Whether to disable indenting the json |
Value | Summary |
---|---|
--prefix PREFIX | Add a prefix to all variable names |
This command is provided by the python-barbicanclient plugin.
59.13. secret update Copy linkLink copied to clipboard!
Usage:
openstack secret update [-h] URI payload
openstack secret update [-h] URI payload
Update a secret with no payload in Barbican.
Value | Summary |
---|---|
URI | The uri reference for the secret. |
payload | The unencrypted secret |
Value | Summary |
---|---|
-h, --help | Show this help message and exit |
This command is provided by the python-barbicanclient plugin.