Whamcloud - gitweb
580d921ceb4bdd11c44f9bacff78caf823dccc3c
[fs/lustre-release.git] / lustre / doc / lfs-hsm.1
1 .TH lfs-hsm 1 "November 9, 2012" 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 <FILE> ...
20 .br
21 .SH DESCRIPTION
22 These are a set of lfs commands used to interact with Lustre/HSM binding feature.
23 .TP
24 .B lfs hsm_state <FILE> ...
25 Display the current HSM flags and archive ID for provided files.
26 .TP
27 .B lfs hsm_set <FILE>...
28 Set provided HSM flags on file list.
29 .TP
30 .B lfs hsm_clear <FILE>...
31 Clear the HSM related flags on file list.
32 .TP
33 .B lfs hsm_action <FILE>...
34 Display the in-progress HSM actions for provided files.
35 .PP
36 Non-privileged user can only change the following flags:
37 .B norelease
38 ,
39 .B noarchive
40 and
41 .B dirty.
42 .PP
43 .SH OPTIONS
44 .TP
45 .B \\--norelease
46 File should never be released. File data will stay in Lustre even if a copy exists in HSM backend.
47 .TP
48 .B \\--noarchive
49 File should never be archived. Useful if this is a temporary file, for example.
50 .TP
51 .B \\--dirty
52 File content is not in sync with HSM backend. File should be archived again. (root only)
53 .TP
54 .B \\--exists
55 A file copy exists in HSM backend. Useful mostly for debugging. (root only)
56 .TP
57 .B \\--archived
58 An up-to-date file copy exists in HSM backend. Useful mostly for debugging. (root only)
59 .TP
60 .B \\--lost
61 File copy in HSM backend is not usable anymore and file could not be restored. It should be archived again. (root only)
62 .SH EXAMPLES
63 .TP
64 .B Display current HSM flag for foo:
65 $ lfs hsm_state /mnt/lustre/foo
66
67 /mnt/lustre/foo: (0x0000000b) exists dirty archived, archive_id: 1
68
69 .TP
70 .B Force a file to be considered as modified in lustre (dirty)
71 $ lfs hsm_set --dirty /mnt/lustre/motd
72
73 .SH AUTHOR
74 Written by Aurelien Degremont.
75
76 .SH KNOWN BUGS
77 .PP
78 Please report all bugs to http://jira.whamcloud.com/
79 .SH SEE ALSO
80 .BR lfs (1)