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

NAME

6       cryptsetup-luksSuspend - suspends an active device and wipes the key
7

SYNOPSIS

9       cryptsetup luksSuspend [<options>] <name>
10

DESCRIPTION

12       Suspends an active device (all IO operations will block and accesses to
13       the device will wait indefinitely) and wipes the encryption key from
14       kernel memory. Needs kernel 2.6.19 or later.
15
16       After this operation, you have to use luksResume to reinstate the
17       encryption key and unblock the device or close to remove the mapped
18       device.
19
20       <options> can be [--header, --disable-locks].
21
22       WARNING: Never suspend the device on which the cryptsetup binary
23       resides.
24

OPTIONS

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

REPORTING BUGS

66       Report bugs at cryptsetup mailing list <cryptsetup@lists.linux.dev> or
67       in Issues project section
68       <https://gitlab.com/cryptsetup/cryptsetup/-/issues/new>.
69
70       Please attach output of the failed command with --debug option added.
71

SEE ALSO

73       Cryptsetup FAQ
74       <https://gitlab.com/cryptsetup/cryptsetup/wikis/FrequentlyAskedQuestions>
75
76       cryptsetup(8), integritysetup(8) and veritysetup(8)
77

CRYPTSETUP

79       Part of cryptsetup project <https://gitlab.com/cryptsetup/cryptsetup/>.
80
81
82
83cryptsetup 2.5.0                  2022-07-28         CRYPTSETUP-LUKSSUSPEND(8)
Impressum