1CRYPTSETUP-CLOSE(8)          Maintenance Commands          CRYPTSETUP-CLOSE(8)
2
3
4

NAME

6       cryptsetup-close - removes the existing mapping <name> (and the
7       associated key)
8

SYNOPSIS

10       cryptsetup close [<options>] <name>
11

DESCRIPTION

13       Removes the existing mapping <name> and wipes the key from kernel
14       memory.
15
16       For backward compatibility, there are close command aliases: remove,
17       plainClose, luksClose, loopaesClose, tcryptClose, bitlkClose (all
18       behave exactly the same, device type is determined automatically from
19       the active device).
20
21       <options> can be [--deferred, --cancel-deferred, --header,
22       --disable-locks].
23

OPTIONS

25       --header <device or file storing the LUKS header>
26           Use a detached (separated) metadata device or file where the LUKS
27           header is stored. This option allows one to store ciphertext and
28           LUKS header on different devices.
29
30           For commands that change the LUKS header (e.g. luksAddKey), specify
31           the device or file with the LUKS header directly as the LUKS
32           device.
33
34       --deferred
35           Defers device removal in close command until the last user closes
36           it.
37
38       --cancel-deferred
39           Removes a previously configured deferred device removal in close
40           command.
41
42       --disable-locks
43           Disable lock protection for metadata on disk. This option is valid
44           only for LUKS2 and ignored for other formats.
45
46           WARNING: Do not use this option unless you run cryptsetup in a
47           restricted environment where locking is impossible to perform
48           (where /run directory cannot be used).
49
50       --batch-mode, -q
51           Suppresses all confirmation questions. Use with care!
52
53           If the --verify-passphrase option is not specified, this option
54           also switches off the passphrase verification.
55
56       --debug or --debug-json
57           Run in debug mode with full diagnostic logs. Debug output lines are
58           always prefixed by #.
59
60           If --debug-json is used, additional LUKS2 JSON data structures are
61           printed.
62
63       --version, -V
64           Show the program version.
65
66       --usage
67           Show short option help.
68
69       --help, -?
70           Show help text and default parameters.
71

REPORTING BUGS

73       Report bugs at cryptsetup mailing list <cryptsetup@lists.linux.dev> or
74       in Issues project section
75       <https://gitlab.com/cryptsetup/cryptsetup/-/issues/new>.
76
77       Please attach output of the failed command with --debug option added.
78

SEE ALSO

80       Cryptsetup FAQ
81       <https://gitlab.com/cryptsetup/cryptsetup/wikis/FrequentlyAskedQuestions>
82
83       cryptsetup(8), integritysetup(8) and veritysetup(8)
84

CRYPTSETUP

86       Part of cryptsetup project <https://gitlab.com/cryptsetup/cryptsetup/>.
87
88
89
90cryptsetup 2.6.1                  2023-02-10               CRYPTSETUP-CLOSE(8)
Impressum