lustre/doc/lfs-hsm.1

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