Merge branch 'upstream' into tizen
[platform/upstream/cryptsetup.git] / man / cryptsetup-refresh.8.adoc
1 = cryptsetup-refresh(8)
2 :doctype: manpage
3 :manmanual: Maintenance Commands
4 :mansource: cryptsetup {release-version}
5 :man-linkstyle: pass:[blue R < >]
6 :COMMON_OPTIONS:
7 :ACTION_REFRESH:
8
9 == Name
10
11 cryptsetup-refresh - refresh parameters of an active mapping
12
13 == SYNOPSIS
14
15 *cryptsetup _refresh_ [<options>] <name>*
16
17 == DESCRIPTION
18
19 Refreshes parameters of active mapping <name>.
20
21 Updates parameters of active device <name> without the need to deactivate
22 the device (and umount filesystem). Currently, it supports parameters
23 refresh on following devices: LUKS1, LUKS2 (including authenticated
24 encryption), plain crypt and loop-AES.
25
26 Mandatory parameters are identical to those of an open action for
27 the respective device type.
28
29 You may change following parameters on all devices
30 --perf-same_cpu_crypt, --perf-submit_from_crypt_cpus,
31 --perf-no_read_workqueue, --perf-no_write_workqueue and
32 --allow-discards.
33
34 Refreshing the device without any optional parameter will refresh the device
35 with default setting (respective to device type).
36
37 *LUKS2 only:*
38
39 The --integrity-no-journal parameter affects only LUKS2 devices with
40 the underlying dm-integrity device.
41
42 Adding option --persistent stores any combination of device parameters
43 above in LUKS2 metadata (only after successful refresh operation).
44
45 The --disable-keyring parameter refreshes a device with volume key passed in
46 dm-crypt driver.
47
48 *<options>* can be [--allow-discards, --perf-same_cpu_crypt, --perf-submit_from_crypt_cpus,
49 --perf-no_read_workqueue, --perf-no_write_workqueue, --header, --disable-keyring,
50 --disable-locks, --persistent, --integrity-no-journal].
51
52 include::man/common_options.adoc[]
53 include::man/common_footer.adoc[]