Whamcloud - gitweb
b=16432
[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 permanent mount options, equivalent to setting in /etc/fstab
47 .TP
48 .BI \--mgs
49 Add a configuration management service to this target
50 .TP
51 .BI \--mgsnode= nid,...  
52 Set the NID(s) of the MGS node, required for all targets other than the MGS.
53 .TP
54 .BI \--nomgs
55 Remove a configuration management service to this target
56 .TP
57 .BI \--quiet
58 Print less information.
59 .TP
60 .BI \--verbose
61 Print more information.
62 .TP
63 .BI \--writeconf
64 Erase all config logs for the filesystem that this MDT is part of, and
65 regenerate them.  This is very dangerous.  All clients and servers should
66 be stopped.
67 All targets must then be restarted to regenerate the logs.  
68 No clients should be started until all targets have restarted.
69 In general this should be executed on the MDT only, not the OSTs.
70
71 .SH EXAMPLES
72 .TP
73 .B tunefs.lustre --erase-param --mgsnode=<new_nid> --writeconf /dev/sda
74 Change the MGS NID address. (This should be done on every target disk,
75 since they should all be contacting the same MGS.)
76 .TP
77 .B tunefs.lustre --param="failover.node=192.168.0.13@tcp0" /dev/sda
78 Add a failover NID location for this target
79 .TP
80 .B tunefs.lustre --mgs --mdt --fsname=testfs /dev/sda
81 Upgrade an old 1.4.X Lustre MDT to 1.6. The new filesystem name is "testfs". 
82 .TP
83 .B tunefs.lustre --writeconf --mgs --mdt --fsname=testfs /dev/sda1
84 Upgrade an old 1.4.X Lustre MDT to 1.6, and start with brand-new 1.6
85 configuration logs. All old servers and clients must be stopped.
86
87 .SH BUGS
88 Please report all bugs to Sun Microsystems using http://bugzilla.lustre.org/
89 .SH AVAILABILITY
90 .B tunefs.lustre
91 is part of the 
92 .BR Lustre (7) 
93 filesystem package and is available from Sun Microsystems, Inc via
94 .br
95 http://downloads.lustre.org
96 .SH SEE ALSO
97 .BR lustre (7),
98 .BR mkfs.lustre (8),
99 .BR mount.lustre (8),
100 .BR lctl (8),
101 .BR lfs (1)