lustre/doc/lctl-snapshot-modify.8

   1 .TH LCTL-SNAPSHOT_MODIFY 8 2024-08-14 Lustre "Lustre Configuration Utilities"
   2 .SH NAME
   3 lctl-snapshot_modify \- modify Lustre snapshot
   4 .SH SYNOPSIS
   5 .SY "lctl snapshot_modify"
   6 .RB [ -c | --comment
   7 .IR COMMENT ]
   8 .RB { -F | --fsname
   9 .IR FSNAME }
  10 .RB [ -h | --help ]
  11 .RB { -n | --name
  12 .IR SSNAME }
  13 .RB [ -N | --new
  14 .IR NEW_SSNAME ]
  15 .RB [ -r | --rsh
  16 .IR REMOTE_SHELL ]
  17 .YS
  18 .SH DESCRIPTION
  19 Modify the specified snapshot. The tool loads system configuration from
  20 the file
  21 .B /etc/ldev.conf
  22 as described in the
  23 .BR lctl (8)
  24 .B SNAPSHOT
  25 section. Then, the snapshot pieces are modified on every Lustre target
  26 (MGT/MDT/OST).
  27 .SH OPTIONS
  28 .TP
  29 .BR -c ", " --comment \ \fICOMMENT
  30 Add comment (if it had not been specified with
  31 .BR snapshot_create )
  32 or change the comment for the given snapshot.
  33 .TP
  34 .BR -F ", " --fsname \ \fIFSNAME
  35 The filesystem name.
  36 .TP
  37 .BR -h ", " --help
  38 For help information.
  39 .TP
  40 .BR -n ", " --name \ \fISSNAME
  41 The snapshot (to be modified) name must be specified.
  42 .TP
  43 .BR -N ", " --new \ \fINEW_SSNAME
  44 Rename the snapshot to the new name. It follows the general ZFS snapshot name
  45 rules, such as the max length is 256 bytes, cannot conflict with the reserved
  46 names, and so on.
  47 .TP
  48 .BR -r ", " --rsh \ \fIREMOTE_SHELL
  49 Specify a shell to communicate with remote targets. The default value is
  50 .BR ssh .
  51 It is the system admin's duty to guarantee that the specified
  52 .I REMOTE_SHELL
  53 works well among targets without password authentication.
  54 .SH AVAILABILITY
  55 .B lctl-snapshot-modify
  56 is part of the
  57 .BR lustre (7)
  58 filesystem package since release 2.10.0
  59 .\" Added in commit v2_9_54_0-67-gd73849a05e
  60 .SH SEE ALSO
  61 .BR lctl (8),
  62 .BR lctl-barrier (8),
  63 .BR lctl-lcfg (8),
  64 .BR lctl-snapshot-create (8),
  65 .BR lctl-snapshot-destroy (8),
  66 .BR lctl-snapshot-list (8),
  67 .BR lctl-snapshot-mount (8),
  68 .BR lctl-snapshot-umount (8)