NAME | SYNOPSIS | DESCRIPTION | OPTIONS | REPORTING BUGS | SEE ALSO | CRYPTSETUP
CRYPTSETUP-LUKSRESUME(8) Maintenance Commands CRYPTSETUP-LUKSRESUME(8)
cryptsetup-luksResume - resume a suspended device and reinstate the key
cryptsetup luksResume [<options>] <name>
Resumes a suspended device and reinstates the encryption key. Prompts interactively for a passphrase if no token is usable (LUKS2 only) or --key-file is not given. <options> can be [--key-file, --keyfile-size, --keyfile-offset, --key-slot, --header, --disable-keyring, --disable-locks, --token-id, --token-only, --token-type, --disable-external-tokens, --type, --tries, --timeout, --verify-passphrase].
--type <device-type> Specifies required device type, for more info read BASIC ACTIONS section in cryptsetup(8). --verify-passphrase, -y When interactively asking for a passphrase, ask for it twice and complain if both inputs do not match. Ignored on input from file or stdin. --key-file, -d name Read the passphrase from file. If the name given is "-", then the passphrase will be read from stdin. In this case, reading will not stop at newline characters. See section NOTES ON PASSPHRASE PROCESSING in cryptsetup(8) for more information. --keyfile-offset value Skip value bytes at the beginning of the key file. --keyfile-size, -l value Read a maximum of value bytes from the key file. The default is to read the whole file up to the compiled-in maximum that can be queried with --help. Supplying more data than the compiled-in maximum aborts the operation. This option is useful to cut trailing newlines, for example. If --keyfile-offset is also given, the size count starts after the offset. --key-slot, -S <0-N> For LUKS operations that add key material, this option allows you to specify which key slot is selected for the new key. The maximum number of key slots depends on the LUKS version. LUKS1 can have up to 8 key slots. LUKS2 can have up to 32 key slots based on key slot area size and key size, but a valid key slot ID can always be between 0 and 31 for LUKS2. --timeout, -t <number of seconds> The number of seconds to wait before timeout on passphrase input via terminal. It is relevant every time a passphrase is asked. It has no effect if used in conjunction with --key-file. This option is useful when the system should not stall if the user does not input a passphrase, e.g. during boot. The default is a value of 0 seconds, which means to wait forever. --tries, -T How often the input of the passphrase shall be retried. The default is 3 tries. --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 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. --disable-external-tokens Disable loading of plugins for external LUKS2 tokens. --disable-locks Disable lock protection for metadata on disk. This option is valid only for LUKS2 and 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). --disable-keyring Do not load volume key in kernel keyring and store it directly in the dm-crypt target instead. This option is supported only for the LUKS2 type. --token-id Specify what token to use. If omitted, all available tokens will be checked before proceeding further with passphrase prompt. --token-only Do not proceed further with action if token based keyslot unlock failed. Without the option, action asks for passphrase to proceed further. --token-type type Restrict tokens eligible for operation to specific token type. Mostly useful when no --token-id is specified. --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. --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. --version, -V Show the program version. --usage Show short option help. --help, -? Show help text and default parameters.
Report bugs at cryptsetup mailing list <firstname.lastname@example.org> or in Issues project section <https://gitlab.com/cryptsetup/cryptsetup/-/issues/new>. Please attach output of the failed command with --debug option added.
Cryptsetup FAQ <https://gitlab.com/cryptsetup/cryptsetup/wikis/FrequentlyAskedQuestions> cryptsetup(8), integritysetup(8) and veritysetup(8)
Part of cryptsetup project <https://gitlab.com/cryptsetup/cryptsetup/>. This page is part of the Cryptsetup ((open-source disk encryption)) project. Information about the project can be found at ⟨https://gitlab.com/cryptsetup/cryptsetup⟩. If you have a bug report for this manual page, send it to email@example.com. This page was obtained from the project's upstream Git repository ⟨https://gitlab.com/cryptsetup/cryptsetup.git⟩ on 2022-12-17. (At that time, the date of the most recent commit that was found in the repository was 2022-12-14.) If you discover any rendering problems in this HTML version of the page, or you believe there is a better or more up-to-date source for the page, or you have corrections or improvements to the information in this COLOPHON (which is not part of the original manual page), send a mail to firstname.lastname@example.org cryptsetup 2.6.1-git 2022-12-14 CRYPTSETUP-LUKSRESUME(8)
Pages that refer to this page: cryptsetup(8)