Whamcloud - gitweb
LU-9303 doc: man pages for snapshot components
[fs/lustre-release.git] / lustre / doc / lctl-snapshot-create.8
1 .TH lctl-snapshot-create 8 "2017 Apr 13" Lustre "create Lustre snapshot"
2 .SH SYNOPSIS
3 .TP
4 .B lctl snapshot_create \fR[-b | --barrier [on | off]] [-c | --comment comment]
5               {-F | --fsname fsname} [-h | --help] {-n | --name ssname}
6               [-r | --rsh remote_shell] [-t | --timeout timeout]
7 .br
8 .SH DESCRIPTION
9 Create snapshot with the given name. 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 created on every Lustre target
16 (MGT/MDT/OST).
17 .SH OPTIONS
18 .TP
19 .BR -b ", " --barrier " [" on | off ]
20 Set write barrier on all MDTs before creating the snapshot. The default value is
21 .BR on .
22 If you are confident about the system consistency, or not require the full
23 consistency and want to avoid blocking applications when creating the snapshot,
24 then you can specify barrier
25 .BR off .
26 That will save your time of creating the snapshot. If the barrier is
27 .IR on ,
28 then the timeout of the barrier can be specified via
29 .B -t
30 option as described in the subsequent section.
31 .TP
32 .BR  -c ", " --comment " "\fIcomment
33 Add an optional comment to the
34 .B snapshot_create
35 request. The comment can include anything to describe what the snapshot is for
36 or for a reminder. The comment can be shown via
37 .BR snapshot_list .
38 .TP
39 .BR  -F ", " --fsname " "\fIfsname
40 The filesystem name.
41 .TP
42 .BR  -h ", " --help
43 For help information.
44 .TP
45 .BR  -n ", " --name " "\fIssname
46 The snapshot's name must be specified. It follows the general ZFS snapshot name
47 rules, such as the max length is 256 bytes, cannot conflict with the reserved
48 names, and so on.
49 .TP
50 .BR  -r ", " --rsh " "\fIremote_shell
51 Specify a shell to communicate with remote targets. The default value is
52 .BR ssh .
53 It is the system admin's duty to guarantee that the specified
54 .I remote_shell
55 works well among targets without password authentication.
56 .TP
57 .BR  -t ", " --timeout " "\fItimeout
58 If write barrier is
59 .BR on ,
60 then the
61 .I timeout
62 specifies the write barrier's lifetime in second. The default vaule is 30.
63
64 .SH AVAILABILITY
65 .B lctl-snapshot-create
66 is part of the
67 .BR lustre (7)
68 filesystem package.
69 .SH SEE ALSO
70 .BR lctl (8),
71 .BR lctl-lcfg (8),
72 .BR lctl-barrier (8),
73 .BR lctl-snapshot-destroy (8),
74 .BR lctl-snapshot-modify (8),
75 .BR lctl-snapshot-list (8),
76 .BR lctl-snapshot-mount (8),
77 .BR lctl-snapshot-umount (8)