lustre/doc/lctl-snapshot-create.8

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