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