1. Manuals
  2. Tumbleweed
  3. nvme-cli
  4. nvme-keys-gen-kxchap(1)

Scroll to navigation

NVME-KEYS-GEN-KXC(1) NVMe Manual NVME-KEYS-GEN-KXC(1)

NAME

nvme-keys-gen-kxchap - Generate a host KX-HMAC-CHAP key

SYNOPSIS

nvme [<global-options>] keys gen-kxchap [--hmac=<hmac-id> | -m <hmac-id>]


                        [--secret=<secret> | -s <secret>]


                        [--key-length=<len> | -l <len>]


                        [--nqn=<host-nqn> | -n <host-nqn>]

DESCRIPTION

Generate a base64-encoded KX-HMAC-CHAP host key in the form: DHHC-1:00:ia6zGodOr4SEG0Zzaw398rpY0wqipUWj4jWjUh4HWUz6aQ2n: and prints it to stdout.

OPTIONS

-m <hmac-id>, --hmac=<hmac-id>

Select a HMAC algorithm to use. Possible values are: 0 - No HMAC algorithm 1 - SHA-256 2 - SHA-384 3 - SHA-512

-s <secret>, --secret=<secret>

Secret value (in hexadecimal) to be used for the key. If none are provided a random value is used.

-l <len>, --key-length=<len>

Length of the resulting key. Possible values are 32, 48, or 64.

-n <hostnqn>, --nqn=<hostnqn>

Host-NQN to be used for the transformation. This parameter is only valid if a non-zero HMAC function has been specified.

GLOBAL OPTIONS

The following options are defined at the top-level nvme command and are available to this subcommand:

--dry-run

Print the command that would be executed, but do not actually execute it.

--no-ioctl-probing

Disable probing for 64-bit IOCTL support.

--no-retries

Disable retry logic on transient errors.

-o <fmt>, --output-format=<fmt>

Set the reporting format to normal, tabular, 'json, or binary. Only one output format may be used at a time.

--output-format-version=<version>

Select the output format version. Version 1 uses the original field naming, while version 2 (default) provides more consistent and script-friendly field names.

--timeout=<ms>

Set the timeout for the command in milliseconds.

-v, --verbose

Increase the level of detail in the output. May be specified multiple times to further increase verbosity.

These options can also be set as machine-wide defaults in nvme-cli.conf(5). A command-line flag always overrides the file.

EXAMPLES

No Examples

NVME

Part of the nvme-user suite

07/31/2026 NVMe