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