LU-7845 obd: add 'network' client mount option

[fs/lustre-release.git] / lustre / doc / mount.lustre.8

diff --git a/lustre/doc/mount.lustre.8 b/lustre/doc/mount.lustre.8
index 4b613cb..5c309e8 100644 (file)
--- a/lustre/doc/mount.lustre.8
+++ b/lustre/doc/mount.lustre.8
@@ -25,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 .
@@ -88,6 +90,9 @@ manual page.
 .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
@@ -100,6 +105,21 @@ Enable FID to path translation by regular users.
 .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
@@ -114,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
@@ -139,7 +165,18 @@ maximum of 'timeout' seconds.  The default hard recovery timeout is set to
 .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.
@@ -156,7 +193,7 @@ is part of the
 .BR Lustre (7) 
 filesystem package.
 .SH SEE ALSO
-.BR Lustre (7),
+.BR lustre (7),
 .BR mount (8),
 .BR mkfs.lustre (8),
 .BR tunefs.lustre (8),