Whamcloud - gitweb
[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, 2016, Intel Corporation.
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"
10 mount.lustre \- start a Lustre client or target service 
12 .br
13 .BI "mount \-t lustre [\-o " options "] " directory
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
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>[/<subdir>]
29 mounts the Lustre filesystem named
30 .I fsname
31 (under subdirectory
32 .I subdir
33 if specified) on the client by contacting the Management Service at
34 .IR mgsspec 
35 on the pathname given by
36 .IR directory .
37 The format for
38 .I mgsspec
39 is defined below.  A mounted client filesystem appears in
40 .BR fstab (5)
41 and is usable like any local filesystem and provides a full
42 POSIX-compilant interface.
43 .TP
44 .I disk_device
45 starts the target service defined by the 
46 .I mkfs.lustre
47 command on the physical disk
48 .IR disk_device .  
49 A mounted target service filesystem is only useful for
50 .BR df (1)
51 operations and appears in
52 .BR fstab (5)
53 to show the device is in use.
55 .TP
56 .BI <mgsspec>:= <mgsnode>[:<mgsnode>]
57 The mgs specification may be a colon-separated list of nodes:
58 .TP
59 .BI <mgsnode>:= <mgsnid>[,<mgsnid>]
60 each node may be specified by a comma-separated list of NIDs.
61 .PP
62 In addition to the standard options listed in
63 .BR mount (8),
64 Lustre understands the following
65 .B client-specific
66 options:
67 .TP
68 .BI flock
69 Enable full flock support, coherent across all client nodes.
70 .TP
71 .BI localflock
72 Enable local flock support, using only client-local flock (faster, for applications that require flock but do not run on multiple nodes).
73 .TP
74 .BI noflock
75 Disable flock support entirely.  Applications calling flock will get an error.
76 .TP
77 .BI user_xattr
78 Enable get/set of extended attributes by regular users.  See the
79 .BR attr (5)
80 manual page.
81 .TP
82 .BI nouser_xattr
83 Disable use of extended attributes by regular users.  Root and system processes can still use extended attributes.
84 .TP
85 .BI acl
86 Enable POSIX Access Control List support.  See the
87 .BR acl (5)
88 manual page.
89 .TP
90 .BI noacl
91 Disable Access Control List support.
92 .TP
93 .BI always_ping
94 Force a client to keep pinging even if servers have enabled suppress_pings.
95 .TP
96 .BI verbose
97 Enable mount/umount console messages.
98 .TP
99 .BI noverbose
100 Disable mount/umount console messages.
101 .TP
102 .BI user_fid2path
103 Enable FID to path translation by regular users.
104 .TP
105 .BI nouser_fid2path
106 Disable FID to path translation by regular users.  Root and process with
107 CAP_DAC_READ_SEARCH can still perform FID to path translation.
108 .TP
109 .BI skpath= file|directory
110 Path to a file or directory with the keyfile(s) to load for this mount command.
111 Keys are inserted into the KEY_SPEC_SESSION_KEYRING keyring with a description
112 containing "lustre:" and a suffix which depends on whether the context of the
113 mount command is for an MGS, MDT/OST, or client.
114 This option is only available when built with --enable-gss.
115 .TP
116 .BI network= net
117 Limit connections from the client to be on the network NID specified by 'net'.
118 'net' designates a single network NID, like 'o2ib2' or 'tcp1'.
119 This option can be useful in case of several Lustre client mount
120 points on the same node, with each mount point using a different
121 network. It is also interesting when running Lustre clients from
122 containers, by restricting each container to a specific network.
123 .PP
124 In addition to the standard mount options and backing disk type
125 (e.g. ext3) options listed in
126 .BR mount (8),
127 Lustre understands the following
128 .B server-specific
129 options:
130 .TP
131 .BI nosvc
132 Only start the MGC (and MGS, if co-located) for a target service, and not the actual service.
133 .TP
134 .BI nomgs
135 Start a MDT with a co-located MGS without starting the MGS.
136 .TP
137 .BI noscrub
138 Not trigger OI scrub automatically when detect some inconsistency, unless it is started explicitly.
139 .TP
140 .BI skip_lfsck
141 Not resume the former paused/crashed LFSCK automatically when mount.
142 .TP
143 .BI exclude= ostlist
144 Start a client or MDT with a (colon-separated) list of known inactive OSTs.
145 .TP
146 .BI abort_recov
147 Abort client recovery and start the target service immediately.
148 .TP
149 .BI md_stripe_cache_size
150 Sets the stripe cache size for server side disk with a striped raid
151 configuration.
152 .TP
153 .BI recovery_time_soft= timeout
154 Allow 'timeout' seconds for clients to reconnect for recovery after a server
155 crash.  This timeout will be incrementally extended if it is about to expire
156 and the server is still handling new connections from recoverable clients.
157 The default soft recovery timeout is set to 300 seconds (5 minutes).
158 .TP
159 .BI recovery_time_hard= timeout
160 The server will be allowed to incrementally extend its timeout up to a hard
161 maximum of 'timeout' seconds.  The default hard recovery timeout is set to
162 900 seconds (15 minutes).
164 .TP
165 .B mount -t lustre cfs21@tcp0:/testfs /mnt/myfilesystem
166 Start a client for the Lustre filesystem 'testfs' at the mount point
167 /mnt/myfilesystem. The Management Service is running on a node reachable
168 from this client via the NID cfs21@tcp0.
169 .TP
170 .B mount -t lustre cfs21@tcp0:/testfs/dir /mnt/myfilesystem
171 Like above example, but mount subdirectory 'dir' as fileset.
172 .TP
173 .B mount -t lustre cfs21@tcp0,cfs21ib@o2ib0:cfs22@tcp0,cfs22ib@o2ib0:/testfs/dir /mnt/myfilesystem
174 Like above example, but the Management Service is running on one of the service
175 nodes cfs21 and cfs22, which are two different hosts separated by a colon and
176 served as a failover pair. Lustre tries the first one, and if that fails, it
177 tries the second one. On each service node, the comma-separated NIDs refer to
178 different interfaces on the same host, and the Lustre client chooses the best
179 one for communication based on which network interfaces it has locally.
180 .TP
181 .B mount -t lustre /dev/sda1 /mnt/test/mdt
182 Start the Lustre metadata target service from /dev/sda1 on mountpoint /mnt/test/mdt.
183 .TP
184 .B mount -t lustre -L testfs-MDT0000 -o abort_recov /mnt/test/mdt
185 Start the testfs-MDT0000 service (by using the disk label), but abort the
186 recovery process.
187 .SH BUGS
188 Not very many mount options can be changed with
189 .BR "-o remount" .
191 .B mount.lustre
192 is part of the 
193 .BR Lustre (7) 
194 filesystem package.
196 .BR lustre (7),
197 .BR mount (8),
198 .BR mkfs.lustre (8),
199 .BR tunefs.lustre (8),
200 .BR lctl (8),
201 .BR lfs (1)