Whamcloud - gitweb
New RC 2.16.0-RC5
[fs/lustre-release.git] / lustre / doc / lctl-snapshot-modify.8
1 .TH LCTL-SNAPSHOT_MODIFY 8 "2017-05-13" Lustre "configuration utilities"
2 .SH NAME
3 lctl-snapshot_modify \- modify Lustre snapshot
4 .SH SYNOPSIS
5 .TP
6 .B lctl snapshot_modify \fR[-c | --comment comment] {-F | --fsname fsname}
7               [-h | --help] {-n | --name ssname} [-N | --new new_ssname]
8               [-r | --rsh remote_shell]
9 .br
10 .SH DESCRIPTION
11 Modify the specified snapshot. The tool loads system configuration from
12 the file
13 .B /etc/ldev.conf
14 as described in the
15 .BR lctl (8)
16 .B SNAPSHOT
17 section. Then, the snapshot pieces are modified on every Lustre target
18 (MGT/MDT/OST).
19 .SH OPTIONS
20 .TP
21 .BR  -c ", " --comment " "\fIcomment
22 Add comment (if it had not been specified with
23 .BR snapshot_create )
24 or change the comment for the given snapshot.
25 .TP
26 .BR  -F ", " --fsname " "\fIfsname
27 The filesystem name.
28 .TP
29 .BR  -h ", " --help
30 For help information.
31 .TP
32 .BR  -n ", " --name " "\fIssname
33 The snapshot (to be modified) name must be specified.
34 .TP
35 .BR  -N ", " --new " "\fInew_ssname
36 Rename the snapshot to the new name. It follows the general ZFS snapshot name
37 rules, such as the max length is 256 bytes, cannot conflict with the reserved
38 names, and so on.
39 .TP
40 .BR  -r ", " --rsh " "\fIremote_shell
41 Specify a shell to communicate with remote targets. The default value is
42 .BR ssh .
43 It is the system admin's duty to guarantee that the specified
44 .I remote_shell
45 works well among targets without password authentication.
46
47 .SH AVAILABILITY
48 .B lctl-snapshot-modify
49 is part of the
50 .BR lustre (7)
51 filesystem package.
52 .SH SEE ALSO
53 .BR lctl (8),
54 .BR lctl-lcfg (8),
55 .BR lctl-barrier (8),
56 .BR lctl-snapshot-create (8),
57 .BR lctl-snapshot-destroy (8),
58 .BR lctl-snapshot-list (8),
59 .BR lctl-snapshot-mount (8),
60 .BR lctl-snapshot-umount (8)