cryptsetup-close8
Removes the existing mapping <name> (and the associated key)
Usage
cryptsetup close
[<options>]
<name>
Overview
Removes the existing mapping <name> and wipes the key from kernel memory.
For backward compatibility, there are close command aliases: remove, plainClose, luksClose, loopaesClose, tcryptClose, bitlkClose (all behave the same, device type is determined automatically from the active device).
<options> can be [--deferred, --cancel-deferred, --header, --disable-locks].
Options
--batch-mode, -q
Suppresses all confirmation questions. Use with care!
If the --verify-passphrase option is not specified, this option also switches off the passphrase verification.
-
--cancel-deferred -
Removes a previously configured deferred device removal in the close command.
--debug or --debug-json
Run in debug mode with full diagnostic logs. Debug output lines are always prefixed by #.
If --debug-json is used, additional LUKS2 JSON data structures are printed.
-
--deferred -
Defers device removal in the close command until the last user closes it.
-
--disable-locks -
Disable lock protection for metadata on disk. This option is valid only for LUKS2 and is ignored for other formats.
WARNING: Do not use this option unless you run cryptsetup in a restricted environment where locking is impossible to perform (where /run directory cannot be used).
--header <device or file storing the LUKS header>
Use a detached (separated) metadata device or file where the LUKS header is stored. This option allows one to store the ciphertext and LUKS header on different devices.
For commands that change the LUKS header (e.g., luksAddKey), specify the device or file with the LUKS header directly as the LUKS device.
--help, -?
Show help text and default parameters.
-
--usage -
Show short option help.
--version, -V
Show the program version.
Cryptsetup
Part of cryptsetup project <https://gitlab.com/cryptsetup/cryptsetup/>.
Releases
3 releases since Debian 12 (Bookworm); the text changed 2 times.
--batch-mode until Debian 13 (Trixie);
--debug until Debian 13 (Trixie);
--debug-json until Debian 13 (Trixie);
--help until Debian 13 (Trixie);
--version until Debian 13 (Trixie);
-? until Debian 13 (Trixie);
-V until Debian 13 (Trixie);
-q until Debian 13 (Trixie).