lustre/doc/lctl-changelog_register.8

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