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