lustre/doc/lctl-pcc.8

   1 .TH LCTL-PCC 8 "2019-04-24" Lustre "configuration utilities"
   2 .SH NAME
   3 lctl-pcc \- commands used to interact with PCC features
   4 .SH SYNOPSIS
   5 .B lctl pcc add \fR<\fImntpath\fR> <\fIpccpath\fR> [\fB--param\fR|\fB-p\fR <\fIparam\fR>]
   6 .br
   7 .B lctl pcc del [\fB--keep\fR|\fB-k\fR] <\fImntpath\fR> <\fIpccpath\fR>
   8 .br
   9 .B lctl pcc clear [\fB--keep\fR|\fB-k\fR] <\fImntpath\fR>
  10 .br
  11 .B lctl pcc list <\fImntpath\fR>
  12 .SH DESCRIPTION
  13 .TP
  14 .B lctl pcc add \fR<\fImntpath\fR> <\fIpccpath\fR> [\fB--param\fR|\fB-p\fR <\fIparam\fR>]
  15 Add a PCC backend specified by HSM root path
  16 .IR pccpath
  17 on a Lustre filesystem client instances with the mount point referenced by
  18 .IR mntpath .
  19 The parameter
  20 .IR param
  21 is a string in the form of name-value pairs to config the PCC backend such as
  22 read-write attach id (archive ID) or read-only attach id and auto caching rule.
  23 i.e. for the string "projid={500}&fname={*.h5} rwid=2", the first substring of
  24 the config parameter is the auto caching rule. Where "&" represents the logical
  25 conjunction operator while "," represents the logical disjunction operator. The
  26 example rule means that new files are only auto cached if the project ID is 500
  27 and the suffix of the file name is "h5". "rwid" represents the read-write
  28 attach id (2) which value is same as the archive ID of the copytool agent
  29 running on this PCC node.
  30 In addition to the equal (=) operator, it also supports greater than (>) and
  31 less than (<) comparison operators.
  32 The following rule expressions are supported:
  33 - "projid={100}&size>{1M}&size<{500G}"
  34 - "projid>{100}&projid<{110}"
  35 - "uid<{1500}&uid>{1000}"
  36 Currently each PCC backend only has one rule which is configured when setup PCC
  37 backend on a client. If a user wants to change the rule, the PCC backend needs
  38 to be removed first and then added back with a new rule.
  39 .TP
  40 .B lctl pcc del [\fB--keep\fR|\fB-k\fR] <\fImntpath\fR> <\fIpccpath\fR>
  41 Delete a PCC backend specified by path
  42 .IR pccpath
  43 on a Lustre client referenced by the mount point of
  44 .IR mntpath .
  45 .TP
  46 .B lctl pcc clear [\fB--keep\fR|\fB-k\fR] <\fImntpath\fR>
  47 Remove all PCC backend on a Lustre client referenced by the mount point of
  48 .IR mntpath .
  49 .TP
  50 .B lctl pcc list <\fImntpath\fR>
  51 List all PCC backends on a Lustre client referenced by the mount point of
  52 .IR mntpath .
  53 .SH OPTIONS
  54 .TP
  55 .B --param | -p
  56 Specifies the configuration parameters for a PCC backend.
  57 .TP
  58 .B --keep | -k
  59 By default, when remove a PCC backend from a client, the action is to scan the
  60 PCC backend fs, and then uncache (detach and remove) all scanned PCC copies
  61 from PCC by FIDs. With the option "--keep|-k", the "lctl pcc del|clear" command
  62 just removes the PCC backend from the Lustre client, and retains the data on the
  63 cache. In this way, the PCC-RW backend falls back as a tranditional HSM storage
  64 solution since the copytool is still running at this client.
  65 .TP
  66 .SH SEE ALSO
  67 .BR lfs (1),
  68 .BR lfs-hsm (1),
  69 .BR lfs-pcc (1)