`bm admin kms key`

Description

The bm admin kms key command performs cryptographic key management operations through the Buckit Key Encryption Service (KES).

Use bm admin on Buckit Deployments Only

Buckit does not support using bm admin commands with other S3-compatible services, regardless of their claimed compatibility with Buckit deployments.

Syntax

bm admin kms key create

Creates a new master key on a Key Management System (KMS).

The command has the following syntax:

bm admin kms key create TARGET [KEY_NAME]

The command accepts the following arguments:

TARGET

Specify the alias of a configured Buckit deployment.

The TARGET deployment must include a configured Buckit Key Encryption Service (KES) server.

KEY_NAME: Specify the name of the new master key.

bm admin kms key status

Requests information on a Key Management System (KMS) master key.

The command has the following syntax:

bm admin kms key status TARGET [KEY_NAME]

The command accepts the following arguments:

TARGET

Specify the alias of a configured Buckit deployment.

The TARGET deployment must include a configured Buckit 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 TARGET deployment.

bm admin kms key list

List all Key Management System (KMS) keys for a Buckit instance.

The command has the following syntax:

bm admin kms key list TARGET

The command accepts the following argument:

TARGET

Specify the alias of a configured Buckit deployment.

The TARGET deployment must include a configured Buckit Key Encryption Service (KES) server.