Reference
This section of documentation provides a high level overview of the Key Manager binary minkms and its associated commands, parameters, and syntaxes.
You can use the minkms help to view in-shell help information for any given command.
The following tables list the available minkms commands.
For usage, run minkms help <command>
| Command |
Description |
minkms server |
Entry point for starting key manager server. |
minkms env |
Prints the environment data for the key manager server. |
minkms identity |
Generate or re-compute an identity for use with authentication to the key manager. |
minkms pprof |
Profile KMS server performance. |
minkms logs |
Print KMS server logs. |
minkms help |
Print help information. |
minkms edit |
Edit the cluster configuration. |
minkms backup |
Backup the cluster state. |
minkms restore |
Restore the cluster state from a backup. |
| Command |
Description |
minkms add |
Add a node to a cluster. |
minkms rm |
Remove a node from a cluster. |
minkms ls |
List cluster nodes. |
minkms stat |
Print cluster status information. |
| Command |
Description |
minkms keygen |
Generate a new data key. |
minkms decrypt |
Decrypt an encrypted message. |
minkms add-key |
Create a new key or key version. |
minkms ls-key |
List keys or key versions. |
minkms stat-key |
Print key status information. |
minkms rm-key |
Remove a key or key version. |
| Command |
Description |
minkms add-enclave |
Create a new enclave. |
minkms rm-enclave |
Remove a enclave. |
minkms ls-enclave |
List enclaves. |
| Command |
Description |
minkms add-identity |
Create a new identity. |
minkms get-identity |
Print an identity. |
minkms rm-identity |
Remove an identity. |
minkms ls-identity |
List identities. |
| Command |
Description |
minkms add-policy |
Create or overwrite a policy. |
minkms rm-policy |
Remove a policy. |
minkms ls-policy |
List policies. |
minkms stat-policy |
Print policy status information. |
minkms get-policy |
Print a policy. |
minkms set-policy |
Assign a policy to an identity. |