Whamcloud - gitweb
land b1_5 onto HEAD
[fs/lustre-release.git] / lustre / doc / lfs.1
1 .TH lfs 1 "2003 Oct 29" Lustre "configuration utilities"
2 .SH NAME
3 lfs \- Lustre utility to create a file with specific striping pattern, find the striping pattern of exiting files
4 .SH SYNOPSIS
5 .br
6 .B lfs
7 .br
8 .B lfs find [--atime|-A N] [--mtime|-M N] [--ctime|-C N] [--maxdepth|-D N]
9          \fB[--print0|-P] [--print|-p] [--obd|-O <uuid>] <dir/file>\fR
10 .br
11 .B lfs find [--quiet|-q] [--verbose|-v] [--recursive|-r] <dir|file>
12 .br
13 .B lfs getstripe [--obd|-O <uuid>] [--quiet|-q] [--verbose|-v] 
14               \fB[--recursive|-r] <dir/file>\fR
15 .br
16 .B lfs setstripe <filename> <stripe-size> <start-ost> <stripe-cnt>
17 .br
18 .B lfs quotachown [-i] <filesystem>
19 .br
20 .B lfs quotacheck [-ug] <filesystem>
21 .br
22 .B lfs quotaon [-ugf] <filesystem>
23 .br
24 .B lfs quotaoff [-ug] <filesystem>
25 .br
26 .B lfs setquota [-u|-g] <name> <block-softlimit> <block-hardlimit> 
27              \fB<inode-softlimit> <inode-hardlimit> <filesystem>\fR
28 .br
29 .B lfs quota [-o obd_uuid] [-u|-g] <name> <filesystem>
30 .br
31 .B lfs setstripe <filename> <stripe-size> <start-ost> <stripe-cnt>
32 .br
33 .B lfs check <mds| osts| servers>
34 .br
35 .B lfs df [-i] [-h] [path]
36 .SH DESCRIPTION
37 .B lfs
38 can be used to create a new file with a specific striping pattern, determine the default striping pattern, gather the extended attributes (object numbers and 
39 location) for a specific file. It can be invoked interactively without any 
40 arguments or in a non-interactive mode with one of the arguements supported. 
41 .SH OPTIONS
42 The various options supported by lctl are listed and explained below:
43 .TP
44 .B setstripe 
45 To create a new file with a specific striping pattern
46 .TP
47 .B find 
48 To search the directory tree rooted at the given dir/file name for the files that match the given parameters: \fB--atime\fR (file was last accessed N*24 hours ago), \fB--ctime\fR (file's status was last changed N*24 hours ago), \fB--mtime\fR (file's data was last modified N*24 hours ago), \fB--obd\fR (file has an object on a specific OST). The option \fB--maxdepth\fR allows find to decend at most N levels of directory tree. The options \fB--print\fR and \fB--print0\fR print full file name, followed by a newline and null character correspondingly.  Using one of these options works in the new (filename only) mode.
49 .TP
50 .B find
51 To list the striping info for a given filename or files in a directory or recursively for all files in a directory tree use one of the following options: \fB[--quiet|-q] [--verbose|-v] [--recursive|-r]\fR. If one of these options is given find works in old (obsolete, please use getstripe instead) filename and striping mode.
52 .TP
53 .B getstripe 
54 To list the striping info for given filename or files in a directory or recursively for all files in a directory tree. It can also be used to list the files that have objects on a specific OST.
55 .TP
56 .B quotachown
57 To change files' owner and group on OSTs of the specified filesystem
58 .TP
59 .B quotacheck
60 To scan the specified filesystem for disk usage, and create or update quota files
61 .TP
62 .B quotaon
63 To turn filesystem quotas on
64 .TP
65 .B quotaoff
66 To turn filesystem quotas off
67 .TP
68 .B setquota
69 To set filesystem quotas
70 .TP
71 .B quota
72 To display disk usage and limits
73 .TP
74 .B check 
75 Display the status of MDS or OSTs (as specified in the command) or all the servers (MDS and OSTs)
76 .TP
77 .B osts 
78 List all the OSTs for the filesystem
79 .TP
80 .B df
81 Report filesystem disk space usage or inodes usage of each MDT/OST.
82 .TP
83 .B help 
84 Provides brief help on the various arguments
85 .TP
86 .B exit/quit 
87 Quit the interactive lfs session
88 .SH EXAMPLES
89 .TP
90 .B $ lfs setstripe /mnt/lustre/file1 131072 -1 2
91 This creats a file striped on two OSTs with 128kB on each stripe.
92 .TP
93 .B $ lfs find /mnt/lustre/file1
94 Lists the object allocation of a given file
95 .TP
96 .B $ lfs find /mnt/lustre/
97 Lists the object allocationss of all files in a given directory
98 .TP
99 .B $ lfs find -r /mnt/lustre/
100 Recursively list the objects of all files in a given directory tree
101 .TP
102 .B $ lfs find -r --obd OST2-UUID /mnt/lustre/
103 Recursively list all files in a given directory that have objects on OST2-UUID.
104 .TP
105 .B $ lfs quotachown -i /mnt/lustre
106 Change file owner and group
107 .TP
108 .B $ lfs quotacheck -ug /mnt/lustre
109 Quotacheck for user and group
110 .TP
111 .B $ lfs quotaon -ug /mnt/lustre
112 Turn quotas of user and group on
113 .TP
114 .B $ lfs quotaoff -ug /mnt/lustre
115 Turn quotas of user and group off
116 .TP
117 .B $ lfs setquota -u bob 0 1000000 0 10000 /mnt/lustre
118 Set quotas of user `bob': 1GB block quota and 10,000 file quota
119 .TP
120 .B $ lfs quota -u bob /mnt/lustre
121 List quotas of user `bob'
122 .TP
123 .B $ lfs check servers 
124 Check the status of all servers (MDT, OST)
125 .TP
126 .B $ lfs osts
127 List all the OSTs
128 .TP
129 .B $ lfs df -i 
130 Lists inode consumpton per OST and MDT
131 .SH BUGS
132 None are known.