28e415fd8c
mc [RELEASE.2023-08-29T22-55-06Z](https://github.com/minio/mc/releases/tag/RELEASE.2023-08-29T22-55-06Z) has changes that impact the docs: - Adds `list` command to `mc admin kms key` - Adds new group of `scanner` event types There is no issue to track this release.
2.5 KiB
mc admin kms key
minio
Table of Contents
mc admin kms key
Description
The mc admin kms key command performs cryptographic key
management operations through the MinIO Key Encryption Service
(KES).
Use mc admin on MinIO Deployments Only
Return to this section as part of the KES documentation. There's a lot here that only makes sense once we can link to KES overview + config.
Syntax
create
Creates a new master key on a Key Management System (KMS).
The command has the following syntax:
mc admin kms key create TARGET [KEY_NAME]The command accepts the following arguments:
TARGET
Specify the alias <mc alias> of a configured MinIO
deployment.
The TARGET deployment must include a
configured MinIO Key Encryption Service (KES) server.
KEY_NAME
Specify the name of the new master key.
status
Requests information on a Key Management System (KMS) master key.
The command has the following syntax:
mc admin kms key status TARGET [KEY_NAME]The command accepts the following arguments:
TARGET
Specify the alias <mc alias> of a configured MinIO
deployment.
The TARGET deployment must include a
configured MinIO Key Encryption Service (KES) server.
KEY_NAME
Specify the name of a master key on the KMS.
Omit this argument to return the default master key on the ~mc admin kms key status TARGET deployment.
list
List all Key Management System (KMS) keys for a MinIO instance.
The command has the following syntax:
mc admin kms key list TARGETThe command accepts the following argument:
TARGET
Specify the alias <mc alias> of a configured MinIO
deployment.
The TARGET deployment must include a
configured MinIO Key Encryption Service (KES) server.