lustre/doc/lfs-heat.1

   1 .TH lfs-heat 1 "Feb. 09, 2019" Lustre "Lustre utility"
   2 .SH NAME
   3 .B lfs heat_command
   4 lfs commands used to interact with file heat features
   5 .SH SYNOPSIS
   6 .B lfs heat_get|heat_set
   7 .IR \fR<\fIFILE \fR...>
   8 .br
   9 .SH DESCRIPTION
  10 These are a set of lfs commands used to interact with Lustre file heat feature.
  11 Currently file heat is only stored in memory with file inode, it might be reset
  12 to be zero at any time with the release of the inode due to memory reclaim.
  13 .TP
  14 .B lfs heat_get  \fR<\fIFILE \fR...>
  15 Get file heat on file list.
  16 .TP
  17 .B lfs heat_set [\fB--clear\fR|\fB-c\fR] [\fB--off\fR|\fB-o\fR] [\fB--on\fR|\fB-O\fR] \fR<\fIFILE \fR...>
  18 Set provided file heat flags on file list.
  19 .SH OPTIONS
  20 .TP
  21 .BR --clear | -c
  22 Clear file heat on given files.
  23 .TP
  24 .BR --off | -o
  25 Turn off file heat on given files.
  26 .TP
  27 .BR --on | -O
  28 Turn on file heat on given files.
  29 .SH EXAMPLES
  30 .TP
  31 Turn on file heat support for the Lustre filesystem:
  32 .B $ lctl set_param llite.$FSNAME*.file_heat=1
  33 .TP
  34 Trun off file heat support for the Lustre filesystem:
  35 .B $ lctl set_param llite.$FSNAME*.file_heat=0
  36 .TP
  37 Display current file heat for foo:
  38 .B $ lfs heat_get /mnt/lustre/foo
  39 .br
  40 flags: 0
  41 .br
  42 readsample: 0
  43 .br
  44 writesample: 16
  45 .br
  46 readbyte: 0
  47 .br
  48 writebyte: 16777216
  49 .br
  50
  51 .TP
  52 Clear the file heat for foo:
  53 .B $ lfs heat_set -c /mnt/lustre/foo
  54 .TP
  55 Turn off file heat for foo:
  56 .B $ lfs heat_set -o /mnt/lustre/foo
  57 .TP
  58 Turn on file heat for foo:
  59 .B $ lfs heat_set -O /mnt/lustre/foo
  60 .SH AUTHOR
  61 The
  62 .B lfs heat
  63 command is part of the
  64 .BR Lustre (7)
  65 filesystem.
  66
  67 .SH SEE ALSO
  68 .BR lfs (1)
  69 .BR lustre (7)