LU-8998 misc: minor clean ups

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

diff --git a/lustre/doc/tunefs.lustre.8 b/lustre/doc/tunefs.lustre.8
index c6e9466..cc84df8 100644 (file)
--- a/lustre/doc/tunefs.lustre.8
+++ b/lustre/doc/tunefs.lustre.8
@@ -1,7 +1,7 @@
 .\" -*- nroff -*-
 .\" Copyright (c) 2007, 2010, Oracle and/or its affiliates. All rights reserved.
 .\"
 .\" -*- nroff -*-
 .\" Copyright (c) 2007, 2010, Oracle and/or its affiliates. All rights reserved.
 .\"

-.\" Copyright (c) 2011, Whamcloud, Inc.
+.\" Copyright (c) 2011, 2016, Intel Corporation.

 .\"
 .\" This file may be copied under the terms of the GNU Public License, v2.
 .\"
 .\"
 .\" This file may be copied under the terms of the GNU Public License, v2.
 .\"


@@ -31,10 +31,14 @@ mounted.
 Set user comment about this disk, ignored by Lustre.
 .TP
 .BI \--dryrun
 Set user comment about this disk, ignored by Lustre.
 .TP
 .BI \--dryrun

-Only print what would be done; does not affect the disk
+Only print what would be done; does not affect the disk.
+.TP
+.BI \--erase-param " param"
+Remove all previously stored instances of the parameter \fIparam\fR. Attempts
+to remove a non-existing parameter appear as successful ones.

 .TP
 .BI \--erase-params
 .TP
 .BI \--erase-params

-Remove all previous parameter info
+Remove all previously stored parameter info.

 .TP
 .BI \--failnode= nid,...  
 Set the NID(s) of a failover partner. This option can be repeated as desired.
 .TP
 .BI \--failnode= nid,...  
 Set the NID(s) of a failover partner. This option can be repeated as desired.


@@ -45,13 +49,13 @@ Set the NID(s) of all service partner. This option treats all nodes as equal
 service nodes. Cannot be used with --failnode.
 .TP
 .BI \--fsname= filesystem_name  
 service nodes. Cannot be used with --failnode.
 .TP
 .BI \--fsname= filesystem_name  

-The Lustre filesystem this service will be part of.  Default is 'lustre'
+The Lustre filesystem this service will be part of.  Default is 'lustre'.

 .TP
 .BI \--index= index
 .TP
 .BI \--index= index

-Force a particular OST or MDT index 
+Force a particular OST or MDT index.

 .TP
 .BI \--mountfsoptions= opts
 .TP
 .BI \--mountfsoptions= opts

-Set  the mount options that will be used when mounting the backing fs.
+Set  the persistent mount options that will be used when Lustre fs.

 WARNING: unlike earlier versions of \fBtunefs.lustre\fR,  this version
 completely replaces the existing mount options with those specified on
 the command line, issuing a warning  on  stderr  if any  of the default
 WARNING: unlike earlier versions of \fBtunefs.lustre\fR,  this version
 completely replaces the existing mount options with those specified on
 the command line, issuing a warning  on  stderr  if any  of the default


@@ -60,17 +64,52 @@ OST: \fIerrors=remount-ro,mballoc,extents\fR;
 MGS/MDT: \fIerrors=remount-ro,user_xattr\fR.
 \fBDO NOT\fR alter the default mount options unless you know what you are doing.
 .TP
 MGS/MDT: \fIerrors=remount-ro,user_xattr\fR.
 \fBDO NOT\fR alter the default mount options unless you know what you are doing.
 .TP

+.BI \--backfs-mount-opts=opts
+Use these options for mounting backing fs while tune.lustre is working.
+.TP

 .BI \--network= net,...
 Network(s) to restrict this ost/mdt to. This option can be repeated as desired.
 .TP
 .BI \--mgs
 .BI \--network= net,...
 Network(s) to restrict this ost/mdt to. This option can be repeated as desired.
 .TP
 .BI \--mgs

-Add a configuration management service to this target
+Add a configuration management service to this target.

 .TP
 .BI \--mgsnode= nid,...  
 Set the NID(s) of the MGS node, required for all targets other than the MGS.
 .TP
 .BI \--nomgs
 .TP
 .BI \--mgsnode= nid,...  
 Set the NID(s) of the MGS node, required for all targets other than the MGS.
 .TP
 .BI \--nomgs

-Remove a configuration management service to this target
+Remove a configuration management service to this target.
+.TP
+.BI \--param " key=value"
+Set permanent parameter
+.I key
+to value
+.IR value .
+This option can be repeated as desired. All previously stored instances of
+.IR key
+are removed, and new instances specified in the command line are added.
+Typical options might include:
+.RS
+.I \--param sys.timeout=40
+.RS
+System obd timeout
+.RE
+.I \--param lov.stripesize=2M
+.RS
+Default stripe size
+.RE
+.I \--param lov.stripecount=2
+.RS
+Default stripe count
+.RE
+.I \--param failover.mode=failout
+.RS
+Return errors instead of waiting for recovery
+.RE
+.RE
+.TP
+.BI \--force-nohostid
+Ignore unset hostid for ZFS import protection. To set hostid either set
+spl_hostid option for spl.ko or set /etc/hostid, see genhostid(1).

 .TP
 .BI \--quiet
 Print less information.
 .TP
 .BI \--quiet
 Print less information.


@@ -85,13 +124,13 @@ No clients should be started until all targets have restarted.
 .br
 Correct order of operations is:
 .br
 .br
 Correct order of operations is:
 .br

-* Unmount all clients of this filesystem
+* Unmount all clients of this filesystem.

 .br
 .br

-* Unmount MDT and all OSTs of this filesystem
+* Unmount MDT and all OSTs of this filesystem.

 .br
 .br

-* Run \fBtunefs.lustre --writeconf <device>\fR on every server
+* Run \fBtunefs.lustre --writeconf <device>\fR on every server.

 .br
 .br

-* Mount MDT and OSTs
+* Mount MDT and OSTs.

 .br
 * Mount clients
 .TP
 .br
 * Mount clients
 .TP


@@ -100,12 +139,16 @@ Enable space accounting on old 2.x devices.
 
 .SH EXAMPLES
 .TP
 
 .SH EXAMPLES
 .TP

-.B tunefs.lustre --erase-param --mgsnode=<new_nid> --writeconf /dev/sda
+.B tunefs.lustre --erase-params --mgsnode=<new_nid> --writeconf /dev/sda

 Change the MGS NID address. (This should be done on every target disk,
 since they should all be contacting the same MGS.)
 .TP
 Change the MGS NID address. (This should be done on every target disk,
 since they should all be contacting the same MGS.)
 .TP

-.B tunefs.lustre --param="failover.node=192.168.0.13@tcp0" /dev/sda
-Add a failover NID location for this target
+.B tunefs.lustre --param "failover.node=192.168.0.13@tcp0" /dev/sda
++Remove all previous failover NID locations for this target, and add a new
++failover NID location for this target.
++.TP
++.B tunefs.lustre --erase-param failover.node /dev/sda
++Remove all failover NID locations for this target.

 .TP
 .B tunefs.lustre --mgs --mdt --fsname=testfs /dev/sda
 Upgrade an old 1.4.X Lustre MDT to 1.6. The new filesystem name is "testfs". 
 .TP
 .B tunefs.lustre --mgs --mdt --fsname=testfs /dev/sda
 Upgrade an old 1.4.X Lustre MDT to 1.6. The new filesystem name is "testfs".