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