Whamcloud - gitweb
LU-9132 utils: tuning max_sectors_kb on mount
[fs/lustre-release.git] / lustre / doc / mount.lustre.8
index 5e67b56..fd9a6b5 100644 (file)
@@ -1,5 +1,8 @@
 .\" -*- nroff -*-
-.\" Copyright 2008 by Sun Microsystems.  All Rights Reserved.
+.\" Copyright (c) 2007, 2010, Oracle and/or its affiliates. All rights reserved.
+.\"
+.\" Copyright (c) 2012, 2016, Intel Corporation.
+.\"
 .\" This file may be copied under the terms of the GNU Public License v2.
 .\"
 .TH mount.lustre 8 "2008 Mar 15" Lustre "configuration utilities"
@@ -22,10 +25,12 @@ There are two forms for the
 .I device
 option, depending on whether a client or a target service is started:
 .TP
-.IR <mgsspec> :/ <fsname>
+.IR <mgsspec> :/ <fsname>[/<subdir>]
 mounts the Lustre filesystem named
 .I fsname
-on the client by contacting the Management Service at 
+(under subdirectory
+.I subdir
+if specified) on the client by contacting the Management Service at
 .IR mgsspec 
 on the pathname given by
 .IR directory .
@@ -84,6 +89,37 @@ manual page.
 .TP
 .BI noacl
 Disable Access Control List support.
+.TP
+.BI always_ping
+Force a client to keep pinging even if servers have enabled suppress_pings.
+.TP
+.BI verbose
+Enable mount/umount console messages.
+.TP
+.BI noverbose
+Disable mount/umount console messages.
+.TP
+.BI user_fid2path
+Enable FID to path translation by regular users.
+.TP
+.BI nouser_fid2path
+Disable FID to path translation by regular users.  Root and process with
+CAP_DAC_READ_SEARCH can still perform FID to path translation.
+.TP
+.BI skpath= file|directory
+Path to a file or directory with the keyfile(s) to load for this mount command.
+Keys are inserted into the KEY_SPEC_SESSION_KEYRING keyring with a description
+containing "lustre:" and a suffix which depends on whether the context of the
+mount command is for an MGS, MDT/OST, or client.
+This option is only available when built with --enable-gss.
+.TP
+.BI network= net
+Limit connections from the client to be on the network NID specified by 'net'.
+'net' designates a single network NID, like 'o2ib2' or 'tcp1'.
+This option can be useful in case of several Lustre client mount
+points on the same node, with each mount point using a different
+network. It is also interesting when running Lustre clients from
+containers, by restricting each container to a specific network.
 .PP
 In addition to the standard mount options and backing disk type
 (e.g. ext3) options listed in
@@ -98,6 +134,12 @@ Only start the MGC (and MGS, if co-located) for a target service, and not the ac
 .BI nomgs
 Start a MDT with a co-located MGS without starting the MGS.
 .TP
+.BI noscrub
+Not trigger OI scrub automatically when detect some inconsistency, unless it is started explicitly.
+.TP
+.BI skip_lfsck
+Not resume the former paused/crashed LFSCK automatically when mount.
+.TP
 .BI exclude= ostlist
 Start a client or MDT with a (colon-separated) list of known inactive OSTs.
 .TP
@@ -107,12 +149,43 @@ Abort client recovery and start the target service immediately.
 .BI md_stripe_cache_size
 Sets the stripe cache size for server side disk with a striped raid
 configuration.
+.TP
+.BI max_sectors_kb
+Automatically Sets the block device parameter of 'max_sectors_kb' for the
+MDT or OST target. When max_sectors_kb isn't specified, that parameter for
+block device will be set to same as it's own 'max_hw_sectors_kb' (up to a
+maximum of 16M), this is default behavior suited for most users. When
+max_sectors_kb is specified as zero, the old parameter value will be kept.
+When max_sectors_kb is specified as a positive number, the parameter will
+be set to this number arbitrarily.
+.TP
+.BI recovery_time_soft= timeout
+Allow 'timeout' seconds for clients to reconnect for recovery after a server
+crash.  This timeout will be incrementally extended if it is about to expire
+and the server is still handling new connections from recoverable clients.
+The default soft recovery timeout is set to 300 seconds (5 minutes).
+.TP
+.BI recovery_time_hard= timeout
+The server will be allowed to incrementally extend its timeout up to a hard
+maximum of 'timeout' seconds.  The default hard recovery timeout is set to
+900 seconds (15 minutes).
 .SH EXAMPLES
 .TP
 .B mount -t lustre cfs21@tcp0:/testfs /mnt/myfilesystem
 Start a client for the Lustre filesystem 'testfs' at the mount point
 /mnt/myfilesystem. The Management Service is running on a node reachable
-from this client via the nid cfs21@tcp0.
+from this client via the NID cfs21@tcp0.
+.TP
+.B mount -t lustre cfs21@tcp0:/testfs/dir /mnt/myfilesystem
+Like above example, but mount subdirectory 'dir' as fileset.
+.TP
+.B mount -t lustre cfs21@tcp0,cfs21ib@o2ib0:cfs22@tcp0,cfs22ib@o2ib0:/testfs/dir /mnt/myfilesystem
+Like above example, but the Management Service is running on one of the service
+nodes cfs21 and cfs22, which are two different hosts separated by a colon and
+served as a failover pair. Lustre tries the first one, and if that fails, it
+tries the second one. On each service node, the comma-separated NIDs refer to
+different interfaces on the same host, and the Lustre client chooses the best
+one for communication based on which network interfaces it has locally.
 .TP
 .B mount -t lustre /dev/sda1 /mnt/test/mdt
 Start the Lustre metadata target service from /dev/sda1 on mountpoint /mnt/test/mdt.
@@ -120,31 +193,16 @@ Start the Lustre metadata target service from /dev/sda1 on mountpoint /mnt/test/
 .B mount -t lustre -L testfs-MDT0000 -o abort_recov /mnt/test/mdt
 Start the testfs-MDT0000 service (by using the disk label), but abort the
 recovery process.
-.SH NOTES
-If the Service Tags tool (from the sun-servicetag package) can be found in
-/opt/sun/servicetag/bin/stclient an inventory service tag will be created
-reflecting the Lustre service being provided.  If this tool cannot be found
-.B mount.lustre
-will silently ignore it and no service tag is created.  The
-.BR stclient (1)
-tool only creates the local service tag.  No information is sent to the asset
-management system until you run the Registration Client to collect the tags
-and then upload them to the inventory system using your inventory system account.
-See https://inventory.sun.com/ for more details on a web-based, free, IT asset
-management system.
 .SH BUGS
 Not very many mount options can be changed with
 .BR "-o remount" .
-Please report all bugs to Sun Microsystems using http://bugzilla.lustre.org/
 .SH AVAILABILITY
 .B mount.lustre
 is part of the 
 .BR Lustre (7) 
-filesystem package and is available from Sun Microsystems, Inc.
-.br
-http://downloads.lustre.org
+filesystem package.
 .SH SEE ALSO
-.BR Lustre (7),
+.BR lustre (7),
 .BR mount (8),
 .BR mkfs.lustre (8),
 .BR tunefs.lustre (8),