Whamcloud - gitweb
LU-3289 gss: Add option for loading keys during mount
[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) 2011, 2012, 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"
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>[/<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.
54 .SH OPTIONS
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 .PP
116 In addition to the standard mount options and backing disk type
117 (e.g. ext3) options listed in
118 .BR mount (8),
119 Lustre understands the following
120 .B server-specific
121 options:
122 .TP
123 .BI nosvc
124 Only start the MGC (and MGS, if co-located) for a target service, and not the actual service.
125 .TP
126 .BI nomgs
127 Start a MDT with a co-located MGS without starting the MGS.
128 .TP
129 .BI noscrub
130 Not trigger OI scrub automatically when detect some inconsistency, unless it is started explicitly.
131 .TP
132 .BI skip_lfsck
133 Not resume the former paused/crashed LFSCK automatically when mount.
134 .TP
135 .BI exclude= ostlist
136 Start a client or MDT with a (colon-separated) list of known inactive OSTs.
137 .TP
138 .BI abort_recov
139 Abort client recovery and start the target service immediately.
140 .TP
141 .BI md_stripe_cache_size
142 Sets the stripe cache size for server side disk with a striped raid
143 configuration.
144 .TP
145 .BI recovery_time_soft= timeout
146 Allow 'timeout' seconds for clients to reconnect for recovery after a server
147 crash.  This timeout will be incrementally extended if it is about to expire
148 and the server is still handling new connections from recoverable clients.
149 The default soft recovery timeout is set to 300 seconds (5 minutes).
150 .TP
151 .BI recovery_time_hard= timeout
152 The server will be allowed to incrementally extend its timeout up to a hard
153 maximum of 'timeout' seconds.  The default hard recovery timeout is set to
154 900 seconds (15 minutes).
155 .SH EXAMPLES
156 .TP
157 .B mount -t lustre cfs21@tcp0:/testfs /mnt/myfilesystem
158 Start a client for the Lustre filesystem 'testfs' at the mount point
159 /mnt/myfilesystem. The Management Service is running on a node reachable
160 from this client via the nid cfs21@tcp0.
161 .TP
162 .B mount -t lustre cfs21@tcp0:/testfs/dir /mnt/myfilesystem
163 Like above example, but mount subdirectory 'dir' as fileset.
164 .TP
165 .B mount -t lustre /dev/sda1 /mnt/test/mdt
166 Start the Lustre metadata target service from /dev/sda1 on mountpoint /mnt/test/mdt.
167 .TP
168 .B mount -t lustre -L testfs-MDT0000 -o abort_recov /mnt/test/mdt
169 Start the testfs-MDT0000 service (by using the disk label), but abort the
170 recovery process.
171 .SH BUGS
172 Not very many mount options can be changed with
173 .BR "-o remount" .
174 .SH AVAILABILITY
175 .B mount.lustre
176 is part of the 
177 .BR Lustre (7) 
178 filesystem package.
179 .SH SEE ALSO
180 .BR lustre (7),
181 .BR mount (8),
182 .BR mkfs.lustre (8),
183 .BR tunefs.lustre (8),
184 .BR lctl (8),
185 .BR lfs (1)