CLI

The Key Manager minkms server process provides the following commands when invoked through a CLI or terminal:

Cluster or host management

Command Description
minkms server Start a KMS server.
minkms env Print KMS environment variables.
minkms pprof Profile KMS server performance.
minkms logs Print KMS server logs.
minkms help Print help information.
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.
minkms edit Edit the cluster configuration.
minkms backup Backup the cluster state.
minkms restore Restore the cluster state from a backup.

Enclave management

Command Description
minkms add-enclave Create a new enclave.
minkms rm-enclave Remove an enclave.
minkms ls-enclave List enclaves.

Encryption key management

Command Description
minkms add-key Create a new key or key version.
minkms rm-key Remove a key or key version.
minkms ls-key List keys or key versions.
minkms stat-key Print key status information.
minkms keygen Generate a new data key.
minkms decrypt Decrypt an encrypted message.

Policy management

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.

Identity management

Command Description
minkms identity Generate or re-compute an identity.
minkms add-identity Create a new identity.
minkms rm-identity Remove an identity.
minkms ls-identity List identities.
minkms get-identity Print an identity.
All Rights Reserved 2024-Present, MinIO, Inc.