dsetool managekmip expirekey
Expires encryption/decryption keys on a Key Management Interoperability Protocol (KMIP) server. Database stops using the key for encryption at the specified time and continues to use the expired key to decrypt existing data. Data re-keying is not required. Use this command to satisfy security policies that require periodically switching the encryption key.
DataStax recommends following best practices for key management permission policies. For more information, see Expire an encryption key.
Synopsis
dsetool managekmip expirekey <kmip_group_name> <kmip_key_id> [>]
Syntax legend
| Syntax conventions | Description |
|---|---|
Italic, bold, or |
Syntax diagrams and code samples use one or more of these styles to mark placeholders for variable values. Replace placeholders with a valid option or your own user-defined value. In CQL statements, angle brackets are required to enclose data types in a set, list, map, or tuple.
Separate the data types with a comma.
For example: In Search CQL statements, angle brackets are used to identify the entity and literal value to overwrite the XML element in the schema and |
|
Square brackets surround optional command arguments. Do not type the square brackets. |
|
Parentheses identify a group to choose from. Do not type the parentheses. |
|
A pipe separates alternative elements. Type any one of the elements. Do not type the pipe. |
|
Indicates that you can repeat the syntax element as often as required. |
|
Single quotation marks must surround literal strings in CQL statements.
Use single quotation marks to preserve upper case.
+
For Search CQL only: Single quotation marks surround an entire XML schema declaration, such as |
|
Map collection.
Curly braces enclose maps ( |
|
Ends a CQL statement. |
|
Separate command line options from command arguments with two hyphens. This syntax is useful when arguments might be mistaken for command line options. |
- kmip_groupname
-
The user-defined name of the KMIP group that is configured in the
kmip_hostssection ofdse.yaml. - kmip_key_id
-
The key id on the KMIP provider.
- date_time
-
After the specified
date_time, new data will not be encrypted with the key. Data can be decrypted with the key after this expire date/time. Format of datetime isYYYY-MM-DD HH:MM:SS:T. For example, use2016-04-13 20:05:00:0to expire the encryption key at 8:05 p.m. on 13 April 2016.
Examples
Immediately expire an encryption key
dsetool managekmip expirekey kmipgrouptwo 02-540
Encryption for new data is prevented, but decryption with the key is still allowed. Because the expire date/time is not specified, the key is expired immediately.
Expire an encryption key at a specific date and time
dsetool managekmip expirekey kmipgrouptwo 02-540 2017-04-13 20:05:00:0