Whamcloud - gitweb
9993971569f1296647c50b68ffcf51a026a80635
[fs/lustre-release.git] / lustre / doc / tunefs.lustre.8
1 .\" -*- nroff -*-
2 .\" Copyright 2008 by Sun Microsystems, Inc.  All Rights Reserved.
3 .\" This file may be copied under the terms of the GNU Public License, v2.
4 .\"
5 .TH tunefs.lustre 8 "2008 Mar 15" Lustre "configuration utilities"
6 .SH NAME
7 tunefs.lustre \- modify the Lustre configuration information on a disk
8 .SH SYNOPSIS
9 .br
10 .B tunefs.lustre
11 [options] 
12 .I device
13 .br
14 .SH DESCRIPTION
15 .B tunefs.lustre
16 is used to modify the configuration information on a Lustre target
17 disk. This includes upgrading old (pre-Lustre 1.6) disks.  This does not
18 reformat the disk or erase the target information, but modifying the
19 configuration information can result in an unusable filesystem.  You have
20 been warned.
21 .br
22 Changes made here will affect a filesystem only when the target is next
23 mounted.
24
25 .SH OPTIONS
26 .TP
27 .BI \--comment= comment
28 Set user comment about this disk, ignored by Lustre.
29 .TP
30 .BI \--dryrun
31 Only print what would be done; does not affect the disk
32 .TP
33 .BI \--erase-params
34 Remove all previous parameter info
35 .TP
36 .BI \--failnode= nid,...  
37 Set the NID(s) of a failover partner. This option can be repeated as desired.
38 .TP
39 .BI \--fsname= filesystem_name  
40 The Lustre filesystem this service will be part of.  Default is 'lustre'
41 .TP
42 .BI \--index= index
43 Force a particular OST or MDT index 
44 .TP
45 .BI \--mountfsoptions= opts
46 Set  the mount options that will be used when mounting the backing fs.
47 WARNING: unlike earlier versions of \fBtunefs.lustre\fR,  this version
48 completely replaces the existing mount options with those specified on
49 the command line, issuing a warning  on  stderr  if any  of the default
50 mount options are omitted.  The defaults for ldiskfs  are
51 OST: \fIerrors=remount-ro,mballoc,extents\fR;
52 MGS/MDT: \fIerrors=remount-ro,iopen_nopriv,user_xattr\fR.
53 \fBDO NOT\fR alter the default mount options unless you know what you are doing.
54 .TP
55 .BI \--mgs
56 Add a configuration management service to this target
57 .TP
58 .BI \--mgsnode= nid,...  
59 Set the NID(s) of the MGS node, required for all targets other than the MGS.
60 .TP
61 .BI \--nomgs
62 Remove a configuration management service to this target
63 .TP
64 .BI \--quiet
65 Print less information.
66 .TP
67 .BI \--verbose
68 Print more information.
69 .TP
70 .BI \--writeconf
71 Erase all config logs for the filesystem that this MDT is part of, and
72 regenerate them.  This is very dangerous.  All clients and servers should
73 be stopped.
74 All targets must then be restarted to regenerate the logs.  
75 No clients should be started until all targets have restarted.
76 In general this should be executed on the MDT only, not the OSTs.
77
78 .SH EXAMPLES
79 .TP
80 .B tunefs.lustre --erase-param --mgsnode=<new_nid> --writeconf /dev/sda
81 Change the MGS NID address. (This should be done on every target disk,
82 since they should all be contacting the same MGS.)
83 .TP
84 .B tunefs.lustre --param="failover.node=192.168.0.13@tcp0" /dev/sda
85 Add a failover NID location for this target
86 .TP
87 .B tunefs.lustre --mgs --mdt --fsname=testfs /dev/sda
88 Upgrade an old 1.4.X Lustre MDT to 1.6. The new filesystem name is "testfs". 
89 .TP
90 .B tunefs.lustre --writeconf --mgs --mdt --fsname=testfs /dev/sda1
91 Upgrade an old 1.4.X Lustre MDT to 1.6, and start with brand-new 1.6
92 configuration logs. All old servers and clients must be stopped.
93
94 .SH BUGS
95 Please report all bugs to Sun Microsystems using http://bugzilla.lustre.org/
96 .SH AVAILABILITY
97 .B tunefs.lustre
98 is part of the 
99 .BR Lustre (7) 
100 filesystem package and is available from Sun Microsystems, Inc via
101 .br
102 http://downloads.lustre.org
103 .SH SEE ALSO
104 .BR lustre (7),
105 .BR mkfs.lustre (8),
106 .BR mount.lustre (8),
107 .BR lctl (8),
108 .BR lfs (1)