NVME-TLS-KEY(1)

📦
version 3.2 · 10 versions
, in arch rolling

🌸 NAME 🌸

nvme-tls-key — manage NVMe TLS PSKs, but bestie… it's deprecated 😭

Hiiii and welcome to the nvme-tls-key(1) page from the NVMe Manual! ✨ This is the deprecated command bestie, and it's lowkey just an alias now.

🦋 SYNOPSIS 🦋

       nvme [<global-options>] tls-key [--keyring=<name> | -k <name>]
                               [--keytype=<type> | -t <type>]
                               [--keyfile=<file> | -f <file>]
                               [--import | -i] [--export | -e]
                               [--revoke=<description> | -r <description>]

💅 DESCRIPTION 💅

Ok so this one is deprecated — it's kept for scripts written against nvme-cli versions older than 3.0. Exactly one of --import, --export, or --revoke must be given. Based on which mode is selected, this alias translates the command into the equivalent new keys plugin subcommand and forwards to it:

  • --import translates to nvme-keys-import(1), forwarding --keyring and --keyfile.
  • --export translates to nvme-keys-export(1), forwarding --keyring and --keyfile.
  • --revoke=<description> translates to nvme-keys-revoke(1), forwarding --keyring and --keytype, with <description> passed as --identity.

Only the options relevant to the selected mode are meaningful; e.g. --keytype has no effect with --import or --export since the new import/export subcommands no longer take a key type. This command does not derive or insert a TLS PSK from a configured PSK — use nvme-keys-gen-tls-psk(1) or nvme-keys-insert-tls-psk(1) for that.

New scripts should call nvme keys import, nvme keys export, or nvme keys revoke directly instead. This alias prints a deprecation warning on stderr and may be removed in a future release.

🚨 bestie warning: this is the deprecated alias. It prints a deprecation warning on stderr and may be removed in a future release. The new nvme keys ... commands are the main character now, periodt.

✨ OPTIONS ✨

  • -k <name>, --keyring=<name> — name of the keyring to import into, export from, or revoke from. Default is .nvme.
  • -t <type>, --keytype=<type> — type of the key to revoke. Only used with --revoke. Default is psk.
  • -f <file>, --keyfile=<file> — file to read the keys from (--import) or write the keys to (--export) instead of stdin/stdout.
  • -i, --import — import keys in bulk; see nvme-keys-import(1).
  • -e, --export — export all keys from the keyring; see nvme-keys-export(1).
  • -r <description>, --revoke=<description> — revoke the key stored under <description> from the keyring; see nvme-keys-revoke(1).

🌈 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. Other versions are rejected.
  • --quiet — suppress informational messages. Errors are still reported, and --quiet cancels any --verbose for the library log level.
  • --set-options=<key=value>[,<key=value>...] — set libnvme library options for this invocation. Supported keys are force-4k, mi-probe-enabled, test-base-dir and test-sysfs-dir.
  • --timeout=<ms> — set the timeout for the command in milliseconds. infinite or -1 waits without a time limit (0xffffffff).
  • -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 🎀

Literally No Examples. The original page says No Examples, so no invented examples here, bestie. 😭

👑 NVME 👑

Part of the nvme-user suite. 💜

🫶 SEE ALSO 🫶

nvme-keys-import(1), nvme-keys-export(1), nvme-keys-revoke(1)

mwah 💋 this page is from NVMe, dated 10/30/2026, and it's the NVME-TLS-KEY(1) page. byeee, go call nvme keys directly 🫶✨

📦 where this page comes from