Este contenido no está disponible en el idioma seleccionado.
Chapter 70. secret
This chapter describes the commands under the secret
command.
70.1. secret container create Copiar enlaceEnlace copiado en el portapapeles!
Store a container in Barbican.
Usage:
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 to show multiple columns |
Value | Summary |
---|---|
--noindent | Whether to disable indenting the json |
Value | Summary |
---|---|
--prefix PREFIX | Add a prefix to all variable names |
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 Copiar enlaceEnlace copiado en el portapapeles!
Delete a container by providing its href.
Usage:
openstack secret container delete [-h] URI
openstack secret container delete [-h] URI
Value | Summary |
---|---|
URI | The uri reference for the container |
Value | Summary |
---|---|
-h, --help | Show this help message and exit |
70.3. secret container get Copiar enlaceEnlace copiado en el portapapeles!
Retrieve a container by providing its URI.
Usage:
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 to show multiple columns |
Value | Summary |
---|---|
--noindent | Whether to disable indenting the json |
Value | Summary |
---|---|
--prefix PREFIX | Add a prefix to all variable names |
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 Copiar enlaceEnlace copiado en el portapapeles!
List containers.
Usage:
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 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 |
Value | Summary |
---|---|
--quote {all,minimal,none,nonnumeric} | When to include quotes, defaults to nonnumeric |
Value | Summary |
---|---|
--noindent | Whether to disable indenting the json |
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 Copiar enlaceEnlace copiado en el portapapeles!
Delete a secret by providing its URI.
Usage:
openstack secret delete [-h] URI
openstack secret delete [-h] URI
Value | Summary |
---|---|
URI | The uri reference for the secret |
Value | Summary |
---|---|
-h, --help | Show this help message and exit |
70.6. secret get Copiar enlaceEnlace copiado en el portapapeles!
Retrieve a secret by providing its URI.
Usage:
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 to show multiple columns |
Value | Summary |
---|---|
--noindent | Whether to disable indenting the json |
Value | Summary |
---|---|
--prefix PREFIX | Add a prefix to all variable names |
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 Copiar enlaceEnlace copiado en el portapapeles!
List secrets.
Usage:
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 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 |
Value | Summary |
---|---|
--quote {all,minimal,none,nonnumeric} | When to include quotes, defaults to nonnumeric |
Value | Summary |
---|---|
--noindent | Whether to disable indenting the json |
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 Copiar enlaceEnlace copiado en el portapapeles!
Create a new order.
Usage:
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 to show multiple columns |
Value | Summary |
---|---|
--noindent | Whether to disable indenting the json |
Value | Summary |
---|---|
--prefix PREFIX | Add a prefix to all variable names |
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 Copiar enlaceEnlace copiado en el portapapeles!
Delete an order by providing its href.
Usage:
openstack secret order delete [-h] URI
openstack secret order delete [-h] URI
Value | Summary |
---|---|
URI | The uri reference for the order |
Value | Summary |
---|---|
-h, --help | Show this help message and exit |
70.10. secret order get Copiar enlaceEnlace copiado en el portapapeles!
Retrieve an order by providing its URI.
Usage:
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 get [-h] [-f {json,shell,table,value,yaml}]
[-c COLUMN] [--noindent] [--prefix PREFIX]
[--max-width <integer>] [--fit-width]
[--print-empty]
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 to show multiple columns |
Value | Summary |
---|---|
--noindent | Whether to disable indenting the json |
Value | Summary |
---|---|
--prefix PREFIX | Add a prefix to all variable names |
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 Copiar enlaceEnlace copiado en el portapapeles!
List orders.
Usage:
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 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 |
Value | Summary |
---|---|
--quote {all,minimal,none,nonnumeric} | When to include quotes, defaults to nonnumeric |
Value | Summary |
---|---|
--noindent | Whether to disable indenting the json |
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 Copiar enlaceEnlace copiado en el portapapeles!
Store a secret in Barbican.
Usage:
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 to show multiple columns |
Value | Summary |
---|---|
--noindent | Whether to disable indenting the json |
Value | Summary |
---|---|
--prefix PREFIX | Add a prefix to all variable names |
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 Copiar enlaceEnlace copiado en el portapapeles!
Update a secret with no payload in Barbican.
Usage:
openstack secret update [-h] URI payload
openstack secret update [-h] URI payload
Value | Summary |
---|---|
URI | The uri reference for the secret. |
payload | The unencrypted secret |
Value | Summary |
---|---|
-h, --help | Show this help message and exit |