Whamcloud - gitweb
[fs/lustre-release.git] / lustre / doc / lfs.1
1 .TH lfs 1 "2003 Oct 29" Lustre "configuration utilities"
3 lfs \- Lustre utility to create a file with specific striping pattern, find the striping pattern of exiting files
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|dirname> <stripe-size> <start-ost> <stripe-cnt> 
17 .br
18 .B lfs setstripe <filename|dirname> [--size|-s stripe-size] [--index|-i start-ost] [--count|-c stripe-cnt]
19 .br
20 .B lfs setstripe -d <dirname>
21 .br
22 .B lfs quotachown [-i] <filesystem>
23 .br
24 .B lfs quotacheck [-ug] <filesystem>
25 .br
26 .B lfs quotaon [-ugf] <filesystem>
27 .br
28 .B lfs quotaoff [-ug] <filesystem>
29 .br
30 .B lfs setquota [-u|-g] <name> <block-softlimit> <block-hardlimit> 
31              \fB<inode-softlimit> <inode-hardlimit> <filesystem>\fR
32 .br
33 .B lfs quota [-o obd_uuid] [-u|-g] <name> <filesystem>
34 .br
35 .B lfs check <mds| osts| servers>
36 .br
37 .B lfs df [-i] [-h] [path]
39 .B lfs
40 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 
41 location) for a specific file. It can be invoked interactively without any 
42 arguments or in a non-interactive mode with one of the arguements supported. 
44 The various options supported by lctl are listed and explained below:
45 .TP
46 .B setstripe 
47 To create a new file with a specific striping pattern
48 .TP
49 .B find 
50 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.
51 .TP
52 .B find
53 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.
54 .TP
55 .B getstripe 
56 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.
57 .TP
58 .B quotachown
59 To change files' owner and group on OSTs of the specified filesystem
60 .TP
61 .B quotacheck [-ugf] <filesystem>
62 To scan the specified filesystem for disk usage, and create or update quota files. Options specify quota for users (-u) groups (-g) and force (-f)
63 .TP
64 .B quotaon [-ugf] <filesystem>
65 To turn filesystem quotas on. Options specify quota for users (-u) groups (-g) and force (-f)
66 .TP
67 .B quotaoff [-ugf] <filesystem>
68 To turn filesystem quotas off.  Options specify quota for users (-u) groups (-g) and force (-f)
69 .TP
70 .B setquota  [-u|-g] <name> <block-softlimit> <block-hardlimit> <inode-softlimit> <inode-hardlimit> <filesystem>
71 To set filesystem quotas for users or groups. Limits are specific as blocks and inodes, see EXAMPLES
72 .TP
73 .B quota [-o obd_uuid] [-u|-g] <name> <filesystem>
74 To display disk usage and limits, either for the full filesystem, or for objects on a specific obd. A user or group name must be specified.
75 .TP
76 .B check 
77 Display the status of MDS or OSTs (as specified in the command) or all the servers (MDS and OSTs)
78 .TP
79 .B osts 
80 List all the OSTs for the filesystem
81 .TP
82 .B df
83 Report filesystem disk space usage or inodes usage of each MDT/OST.
84 .TP
85 .B help 
86 Provides brief help on the various arguments
87 .TP
88 .B exit/quit 
89 Quit the interactive lfs session
91 .TP
92 .B $ lfs setstripe /mnt/lustre/file1 131072 -1 2
93 This creats a file striped on two OSTs with 128kB on each stripe.
94 .TP
95 .B $ lfs setstripe -d /mnt/lustre/dir
96 This deletes a default stripe pattern on dir. New files will use the default striping pattern created therein.
97 .TP
98 .B $ lfs find /mnt/lustre/file1
99 Lists the object allocation of a given file
100 .TP
101 .B $ lfs find /mnt/lustre/
102 Lists the object allocationss of all files in a given directory
103 .TP
104 .B $ lfs find -r /mnt/lustre/
105 Recursively list the objects of all files in a given directory tree
106 .TP
107 .B $ lfs find -r --obd OST2-UUID /mnt/lustre/
108 Recursively list all files in a given directory that have objects on OST2-UUID.
109 .TP
110 .B $ lfs quotachown -i /mnt/lustre
111 Change file owner and group
112 .TP
113 .B $ lfs quotacheck -ug /mnt/lustre
114 Quotacheck for user and group - will turn on quotas after making the check.
115 .TP
116 .B $ lfs quotaon -ug /mnt/lustre
117 Turn quotas of user and group on
118 .TP
119 .B $ lfs quotaoff -ug /mnt/lustre
120 Turn quotas of user and group off
121 .TP
122 .B $ lfs setquota -u bob 0 1000000 0 10000 /mnt/lustre
123 Set quotas of user `bob': 1GB block quota and 10,000 file quota
124 .TP
125 .B $ lfs quota -u bob /mnt/lustre
126 List quotas of user `bob'
127 .TP
128 .B $ lfs check servers 
129 Check the status of all servers (MDT, OST)
130 .TP
131 .B $ lfs osts
132 List all the OSTs
133 .TP
134 .B $ lfs df -i 
135 Lists inode consumpton per OST and MDT
136 .SH BUGS
137 None are known.