lustre/doc/lfs-pcc.1

   1 .TH LFS-PCC 1 2019-04-15 "Lustre" "Lustre Utilities"
   2 .SH NAME
   3 lfs pcc commands used to interact with PCC features.
   4 .SH SYNOPSIS
   5 .B lfs pcc attach <\fB--id\fR|\fB-i\fR NUM>  <\fIfile \fR...>
   6 .br
   7 .B lfs pcc detach <\fIfile \fR...>
   8 .br
   9 .B lfs pcc detach_fid <\fImntpath\fR> <\fIfid \fR...>
  10 .br
  11 .B lfs pcc state <\fIfile \fR...>
  12 .SH DESCRIPTION
  13 .TP
  14 .B lfs pcc attach <\fB--id\fR|\fB-i\fR NUM>  <\fIfile \fR...>
  15 Attach given files on the persistent client cache.
  16 .TP
  17 .B lfs pcc detach <\fIfile \fR...>
  18 Detach given files from the persistent client cache.
  19 .TP
  20 .B lfs pcc detach_fid <\fImntpath\fR> <\fIfid \fR...>
  21 Detach files from the persistent client cache by FID(s).
  22 .TP
  23 .B lfs pcc state <\fIfile \fR...>
  24 Display the PCC state for given files.
  25 .TP
  26 .SH OPTIONS
  27 .TP
  28 .B --id | -i
  29 For RW-PCC, it is HSM ARCHIVE ID to choose which backend for cache files.
  30 .TP
  31 Before using RW-PCC, you need to configure HSM root and Archive ID mapping properly:
  32 .TP
  33 .B lfs pcc add $MNTPATH $PCCPATH "$ARCHIVE_ID $PROJID"
  34 Add one PCC backend to the Lustre client, you need to specify hsm root,
  35 archive ID, and project ID. On this client any subsequently created
  36 files with this project ID will be persistently cached automatically.
  37 .TP
  38 .B lfs pcc del $MNTPATH $PCCPATH
  39  Delete one PCC backend
  40 .TP
  41 .B lfs pcc clear $MNTPATH
  42  Clear and remove all PCC backends for the client.
  43 .TP
  44 .SH EXAMPLES
  45 .TP
  46 .B # lctl set_param mdt.$FSNAME-MDT0000.hsm_control=enabled
  47 Enable HSM on the appropriate MDT.
  48 .TP
  49 .B # lhsmtool_posix --daemon --hsm-root /mnt/pcc/ --archive=1 /mnt/lustre
  50 Launch one copytool on client node to connect cache storage.
  51 .TP
  52 .B # lfs pcc add /mnt/lustre /mnt/pcc \ "1\ 1"
  53 Add HSM root and Archive ID mapping for RW-PCC.
  54 .TP
  55 .B $ lfs pcc attach -i 1 /mnt/lustre/file
  56 Attach an existing file into PCC and migrate data from lustre to Cache Device,
  57 any I/O to the Lustre file will direct to the RW-PCC copy.
  58 .TP
  59 .B $ lfs pcc detach /mnt/lustre/file
  60 Detach the file from RW-PCC, IO to the file will come to Lustre after this command.
  61 .TP
  62 .B $ lfs pcc state /mnt/lustre/file
  63 .br
  64 file: /mnt/lustre/file, type: readwrite, PCC file: /mnt/pcc/0004/0000/0bd1/0000/0002/0000/0x200000bd1:0x4:0x0, user number: 1, flags: 6
  65 .br
  66 Display the PCC state of the file "/mnt/lustre/file".
  67 .TP
  68 .SH SEE ALSO
  69 .BR lfs (1),
  70 .BR lfs-hsm (1),
  71 .BR lctl-pcc (8)