Whamcloud - gitweb
LU-5170 utils: Add support for --list-commands option
[fs/lustre-release.git] / lustre / doc / tunefs.lustre.8
1 .\" -*- nroff -*-
2 .\" Copyright (c) 2007, 2010, Oracle and/or its affiliates. All rights reserved.
3 .\"
4 .\" Copyright (c) 2011, 2016, Intel Corporation.
5 .\"
6 .\" This file may be copied under the terms of the GNU Public License, v2.
7 .\"
8 .TH tunefs.lustre 8 "2008 Mar 15" Lustre "configuration utilities"
9 .SH NAME
10 tunefs.lustre \- modify the Lustre configuration information on a disk
11 .SH SYNOPSIS
12 .br
13 .B tunefs.lustre
14 [options] 
15 .I device
16 .br
17 .SH DESCRIPTION
18 .B tunefs.lustre
19 is used to modify the configuration information on a Lustre target
20 disk. This includes upgrading old (pre-Lustre 1.6) disks.  This does not
21 reformat the disk or erase the target information, but modifying the
22 configuration information can result in an unusable filesystem.  You have
23 been warned.
24 .br
25 Changes made here will affect a filesystem only when the target is next
26 mounted.
27
28 .SH OPTIONS
29 .TP
30 .BI \--comment= comment
31 Set user comment about this disk, ignored by Lustre.
32 .TP
33 .BI \--dryrun
34 Only print what would be done; does not affect the disk
35 .TP
36 .BI \--erase-params
37 Remove all previous parameter info
38 .TP
39 .BI \--failnode= nid,...  
40 Set the NID(s) of a failover partner. This option can be repeated as desired.
41 Cannot be used with --servicenode.
42 .TP
43 .BI \--servicenode= nid,....
44 Set the NID(s) of all service partner. This option treats all nodes as equal
45 service nodes. Cannot be used with --failnode.
46 .TP
47 .BI \--fsname= filesystem_name  
48 The Lustre filesystem this service will be part of.  Default is 'lustre'
49 .TP
50 .BI \--index= index
51 Force a particular OST or MDT index 
52 .TP
53 .BI \--mountfsoptions= opts
54 Set  the persistent mount options that will be used when Lustre fs.
55 WARNING: unlike earlier versions of \fBtunefs.lustre\fR,  this version
56 completely replaces the existing mount options with those specified on
57 the command line, issuing a warning  on  stderr  if any  of the default
58 mount options are omitted.  The defaults for ldiskfs  are
59 OST: \fIerrors=remount-ro,mballoc,extents\fR;
60 MGS/MDT: \fIerrors=remount-ro,user_xattr\fR.
61 \fBDO NOT\fR alter the default mount options unless you know what you are doing.
62 .TP
63 .BI \--backfs-mount-opts=opts
64 Use these options for mounting backing fs while tune.lustre is working.
65 .TP
66 .BI \--network= net,...
67 Network(s) to restrict this ost/mdt to. This option can be repeated as desired.
68 .TP
69 .BI \--mgs
70 Add a configuration management service to this target
71 .TP
72 .BI \--mgsnode= nid,...  
73 Set the NID(s) of the MGS node, required for all targets other than the MGS.
74 .TP
75 .BI \--nomgs
76 Remove a configuration management service to this target
77 .TP
78 .BI \--force-nohostid
79 Ignore unset hostid for ZFS import protection. To set hostid either set
80 spl_hostid option for spl.ko or set /etc/hostid, see genhostid(1).
81 .TP
82 .BI \--quiet
83 Print less information.
84 .TP
85 .BI \--verbose
86 Print more information.
87 .TP
88 .BI \--writeconf
89 Erase the configuration logs for the filesystem that this server is part of, and regenerate them. This is very dangerous.  All clients must be unmounted and servers for this filesystem should be stopped.  
90 All targets (OSTs/MDTs) must then be restarted to regenerate the logs. 
91 No clients should be started until all targets have restarted.
92 .br
93 Correct order of operations is:
94 .br
95 * Unmount all clients of this filesystem
96 .br
97 * Unmount MDT and all OSTs of this filesystem
98 .br
99 * Run \fBtunefs.lustre --writeconf <device>\fR on every server
100 .br
101 * Mount MDT and OSTs
102 .br
103 * Mount clients
104 .TP
105 .BI \--quota
106 Enable space accounting on old 2.x devices.
107
108 .SH EXAMPLES
109 .TP
110 .B tunefs.lustre --erase-param --mgsnode=<new_nid> --writeconf /dev/sda
111 Change the MGS NID address. (This should be done on every target disk,
112 since they should all be contacting the same MGS.)
113 .TP
114 .B tunefs.lustre --param="failover.node=192.168.0.13@tcp0" /dev/sda
115 Add a failover NID location for this target
116 .TP
117 .B tunefs.lustre --mgs --mdt --fsname=testfs /dev/sda
118 Upgrade an old 1.4.X Lustre MDT to 1.6. The new filesystem name is "testfs". 
119 .TP
120 .B tunefs.lustre --writeconf --mgs --mdt --fsname=testfs /dev/sda1
121 Upgrade an old 1.4.X Lustre MDT to 1.6, and start with brand-new 1.6
122 configuration logs. All old servers and clients must be stopped.
123
124 .SH AVAILABILITY
125 .B tunefs.lustre
126 is part of the 
127 .BR Lustre (7) 
128 filesystem package.
129 .SH SEE ALSO
130 .BR lustre (7),
131 .BR mkfs.lustre (8),
132 .BR mount.lustre (8),
133 .BR lctl (8),
134 .BR lfs (1)