lustre/doc/lctl-changelog_register.8

   1 .TH LCTL-CHANGELOG_REGISTER 8 "2021-06-18" Lustre "configuration utilities"
   2 .SH NAME
   3 lctl-changelog_register \- register a new changelog user for particular device.
   4 .SH SYNOPSIS
   5 .B lctl changelog_register
   6 .RB [ --help | -h ]
   7 .RB [ --mask | -m
   8 .IR MASK ]
   9 .RB [ --nameonly | -n ]
  10 .RB [ --user | -u
  11 .IR USERNAME ]
  12 .br
  13 .SH DESCRIPTION
  14 This command is used to register a new changelog user on selected device. New
  15 user may set specific \fImask\fR and/or specific unique \fIusername\fR.
  16 Changelog entries will not be purged beyond any registered users' set point.
  17 See also \fBlfs changelog_clear\fR.
  18 .br
  19 .SH OPTIONS
  20 .TP
  21 .BR --help | -h
  22 Output brief command usage help.
  23 .TP
  24 .BR --mask | -m\ \fI MASK
  25 Sets per-user changelog \fImask\fR. Mask is specified as set of keywords
  26 in form [+|-]\fImask1\fR[<,|+|->\fImask2\fR...]. Masks are separated by comma
  27 or '+' to indicate a mask to be added and by '-' to indicate mask to be
  28 removed. If mask list is started with '+' or '-' then masks are relative
  29 to the default changelog mask, otherwise mask is absolute. Possible mask
  30 keywords are:
  31 .BR mark ", " creat ", " mkdir ", " hlink ", " slink ", " mknod ", "
  32 .BR unlnk ", " rmdir ", " renme ", " rnmto ", " open ", " close ", "
  33 .BR lyout ", " trunc ", " sattr ", " xattr ", " hsm ", " mtime ", "
  34 .BR ctime ", " atime ", " migrt ", " flrw ", " resync ", " gxatr ", " nopen .
  35 The default changelog mask consists of all masks excluding:
  36 ``atime, open, gxatr, nopen''. Both uppercase and lowercase are accepted for
  37 keywords.
  38 .TP
  39 .BR --nameonly | -n
  40 The output format modifier. If set then command outputs just changelog user
  41 name in format 'cl<\fIID\fR>[-<\fIusername\fR>]. Where \fIID\fR stands for
  42 assigned changelog user \fBID\fR.
  43 .TP
  44 .BR --user | -u \ \fI USERNAME
  45 Specific username assigment. Unique name can be assigned to a new changelog
  46 user. Name must start with a letter and consist of letters, digits, '-' and
  47 \'_' symbols with total length limited by 15 symbols.
  48 .SH EXAMPLES
  49 .TP
  50 Simple changelog user register on device \fBtestfs-MDT0000\fR:
  51 .br
  52 # lctl --device testfs-MDT0000 changelog_register
  53 .br
  54 testfs-MDT0000: Registered changelog userid 'cl1'
  55 .TP
  56 Register changelog user with specific name \fBtestname\fR:
  57 .br
  58 # lctl --device testfs-MDT0000 changelog_register -u testname
  59 .br
  60 lustre-MDT0000: Registered changelog userid 'cl1-testname'
  61 .TP
  62 Register changelog user with specific mask:
  63 .br
  64 # lctl --device testfs-MDT0000 changelog_register -m +open,atime,-hlink
  65 .br
  66 lustre-MDT0000: Registered changelog userid 'cl1'
  67 .TP
  68 Register changelog user with terse output:
  69 .br
  70 # lctl --device testfs-MDT0000 changelog_register -n
  71 .br
  72 cl1
  73
  74 .SH AVAILABILITY
  75 .B lctl changelog_register
  76 is a subcommand of
  77 .BR lctl (8)
  78 and is distributed as part of the
  79 .BR lustre (7)
  80 filesystem package.
  81 .SH SEE ALSO
  82 .BR lctl (8),
  83 .BR lctl-changelog_deregister (8)
  84