lustre/doc/lfs-hsm.1

   1 .TH LFS-HSM 1 "April 20, 2022" Lustre "Lustre/HSM binding utility"
   2 .SH NAME
   3 hsm_state, hsm_action, hsm_set, hsm_clear \- lfs commands used to interact with HSM features
   4 .SH SYNOPSIS
   5 .B lfs hsm_state
   6 [\fI\,FILE\/\fR]...
   7 .PP
   8 .B lfs hsm_action
   9 [\fI\,FILE\/\fR]...
  10 .PP
  11 .B lfs hsm_set
  12 [\fB\-\-norelease\fR]
  13 [\fB\-\-noarchive\fR]
  14 [\fB\-\-exists\fR]
  15 [\fB\-\-archived\fR]
  16 [\fB\-\-lost\fR]
  17 [\fB\-\-archive-id\fR \fINUM\fR]
  18 [\fI\,FILE\/\fR]...
  19 .PP
  20 .B lfs hsm_clear
  21 [\fB\-\-norelease\fR]
  22 [\fB\-\-noarchive\fR]
  23 [\fB\-\-exists\fR]
  24 [\fB\-\-archived\fR]
  25 [\fB\-\-lost\fR]
  26 [\fI\,FILE\/\fR]...
  27 .PP
  28 .SH DESCRIPTION
  29 These are a set of lfs commands used to interact with Lustre/HSM binding feature.
  30 .TP
  31 .B lfs hsm_state \fR[\fI\,FILE\/\fR]...
  32 Display the current HSM flags and archive ID for provided files.
  33 .TP
  34 .B lfs hsm_action \fR[\fI\,FILE\/\fR]...
  35 Display the in-progress HSM actions for provided files.
  36 .TP
  37 .B lfs hsm_set \fR[\fI\,OPTION\/\fR]... [\fI\,FILE\/\fR]...
  38 Set provided HSM flags on file list.
  39 .TP
  40 .B lfs hsm_clear \fR[\fI\,OPTION\/\fR]... [\fI\,FILE\/\fR]...
  41 Clear the HSM related flags on file list.
  42 .PP
  43 Non-privileged user can only change the following flags:
  44 .B norelease
  45 ,
  46 .B noarchive
  47 and
  48 .B dirty.
  49 .PP
  50 .SH OPTIONS
  51 .TP
  52 .B \\--norelease
  53 File should never be released. File data will stay in Lustre even if a copy exists in HSM backend.
  54 .TP
  55 .B \\--noarchive
  56 File should never be archived. Useful if this is a temporary file, for example.
  57 .TP
  58 .B \\--dirty
  59 File content is not in sync with HSM backend. File should be archived again. (root only)
  60 .TP
  61 .B \\--exists
  62 A file copy exists in HSM backend. Useful mostly for debugging. (root only)
  63 .TP
  64 .B \\--archived
  65 An up-to-date file copy exists in HSM backend. Useful mostly for debugging. (root only)
  66 .TP
  67 .B \\--lost
  68 File copy in HSM backend is not usable anymore and file could not be restored. It should be archived again. (root only)
  69 .TP
  70 .B \\--archive-id \fINUM\fR
  71 Set archive number identifier to value \fINUM\fR. If archive-id is 0 or option is not provided, then default identifier 0 is used and means no identifier change.
  72 .SH EXAMPLES
  73 .TP
  74 .B Display current HSM flag for foo:
  75 $ lfs hsm_state /mnt/lustre/foo
  76
  77 /mnt/lustre/foo: (0x0000000b) exists dirty archived, archive_id: 1
  78
  79 .TP
  80 .B Force a file to be considered as modified in lustre (dirty)
  81 $ lfs hsm_set --dirty /mnt/lustre/motd
  82
  83 .SH AUTHOR
  84 Written by Aurelien Degremont.
  85
  86 .SH KNOWN BUGS
  87 .PP
  88 Please report all bugs to https://jira.whamcloud.com/
  89 .SH SEE ALSO
  90 .BR lfs (1)