Whamcloud - gitweb
LU-930 doc: update URLs in man pages
[fs/lustre-release.git] / lustre / doc / mount.lustre.8
1 .\" -*- nroff -*-
2 .\" Copyright (c) 2007, 2010, Oracle and/or its affiliates. All rights reserved.
3 .\"
4 .\" Copyright (c) 2012, Whamcloud, Inc.
5 .\"
6 .\" This file may be copied under the terms of the GNU Public License v2.
7 .\"
8 .TH mount.lustre 8 "2008 Mar 15" Lustre "configuration utilities"
9 .SH NAME
10 mount.lustre \- start a Lustre client or target service 
11 .SH SYNOPSIS
12 .br
13 .BI "mount \-t lustre [\-o " options "] " directory
14 .SH DESCRIPTION
15 .B mount.lustre
16 is used to start a Lustre client or target service.  This program should not be
17 called directly; rather it is a helper program invoked through 
18 .BR mount (8)
19 as above.  Lustre clients and targets are stopped by using the 
20 .BR umount (8)
21 command.
22 .br
23
24 There are two forms for the 
25 .I device
26 option, depending on whether a client or a target service is started:
27 .TP
28 .IR <mgsspec> :/ <fsname>
29 mounts the Lustre filesystem named
30 .I fsname
31 on the client by contacting the Management Service at 
32 .IR mgsspec 
33 on the pathname given by
34 .IR directory .
35 The format for
36 .I mgsspec
37 is defined below.  A mounted client filesystem appears in
38 .BR fstab (5)
39 and is usable like any local filesystem and provides a full
40 POSIX-compilant interface.
41 .TP
42 .I disk_device
43 starts the target service defined by the 
44 .I mkfs.lustre
45 command on the physical disk
46 .IR disk_device .  
47 A mounted target service filesystem is only useful for
48 .BR df (1)
49 operations and appears in
50 .BR fstab (5)
51 to show the device is in use.
52 .SH OPTIONS
53 .TP
54 .BI <mgsspec>:= <mgsnode>[:<mgsnode>]
55 The mgs specification may be a colon-separated list of nodes:
56 .TP
57 .BI <mgsnode>:= <mgsnid>[,<mgsnid>]
58 each node may be specified by a comma-separated list of NIDs.
59 .PP
60 In addition to the standard options listed in
61 .BR mount (8),
62 Lustre understands the following
63 .B client-specific
64 options:
65 .TP
66 .BI flock
67 Enable full flock support, coherent across all client nodes.
68 .TP
69 .BI localflock
70 Enable local flock support, using only client-local flock (faster, for applications that require flock but do not run on multiple nodes).
71 .TP
72 .BI noflock
73 Disable flock support entirely.  Applications calling flock will get an error.
74 .TP
75 .BI user_xattr
76 Enable get/set of extended attributes by regular users.  See the
77 .BR attr (5)
78 manual page.
79 .TP
80 .BI nouser_xattr
81 Disable use of extended attributes by regular users.  Root and system processes can still use extended attributes.
82 .TP
83 .BI acl
84 Enable POSIX Access Control List support.  See the
85 .BR acl (5)
86 manual page.
87 .TP
88 .BI noacl
89 Disable Access Control List support.
90 .TP
91 .BI verbose
92 Enable mount/umount console messages.
93 .TP
94 .BI noverbose
95 Disable mount/umount console messages.
96 .TP
97 .BI user_fid2path
98 Enable FID to path translation by regular users.
99 .TP
100 .BI nouser_fid2path
101 Disable FID to path translation by regular users.  Root and process with
102 CAP_DAC_READ_SEARCH can still perform FID to path translation.
103 .PP
104 In addition to the standard mount options and backing disk type
105 (e.g. ext3) options listed in
106 .BR mount (8),
107 Lustre understands the following
108 .B server-specific
109 options:
110 .TP
111 .BI nosvc
112 Only start the MGC (and MGS, if co-located) for a target service, and not the actual service.
113 .TP
114 .BI nomgs
115 Start a MDT with a co-located MGS without starting the MGS.
116 .TP
117 .BI exclude= ostlist
118 Start a client or MDT with a (colon-separated) list of known inactive OSTs.
119 .TP
120 .BI abort_recov
121 Abort client recovery and start the target service immediately.
122 .TP
123 .BI md_stripe_cache_size
124 Sets the stripe cache size for server side disk with a striped raid
125 configuration.
126 .TP
127 .BI recovery_time_soft= timeout
128 Allow 'timeout' seconds for clients to reconnect for recovery after a server
129 crash.  This timeout will be incrementally extended if it is about to expire
130 and the server is still handling new connections from recoverable clients.
131 The default soft recovery timeout is set to 300 seconds (5 minutes).
132 .TP
133 .BI recovery_time_hard= timeout
134 The server will be allowed to incrementally extend its timeout up to a hard
135 maximum of 'timeout' seconds.  The default hard recovery timeout is set to
136 900 seconds (15 minutes).
137 .SH EXAMPLES
138 .TP
139 .B mount -t lustre cfs21@tcp0:/testfs /mnt/myfilesystem
140 Start a client for the Lustre filesystem 'testfs' at the mount point
141 /mnt/myfilesystem. The Management Service is running on a node reachable
142 from this client via the nid cfs21@tcp0.
143 .TP
144 .B mount -t lustre /dev/sda1 /mnt/test/mdt
145 Start the Lustre metadata target service from /dev/sda1 on mountpoint /mnt/test/mdt.
146 .TP
147 .B mount -t lustre -L testfs-MDT0000 -o abort_recov /mnt/test/mdt
148 Start the testfs-MDT0000 service (by using the disk label), but abort the
149 recovery process.
150 .SH BUGS
151 Not very many mount options can be changed with
152 .BR "-o remount" .
153 .SH AVAILABILITY
154 .B mount.lustre
155 is part of the 
156 .BR Lustre (7) 
157 filesystem package.
158 .SH SEE ALSO
159 .BR Lustre (7),
160 .BR mount (8),
161 .BR mkfs.lustre (8),
162 .BR tunefs.lustre (8),
163 .BR lctl (8),
164 .BR lfs (1)