mkfs.lustre.8

lustre 1.6.5 source code

.\" -*- nroff -*-
.\" Copyright 2006 by Cluster File Systems, Inc.  All Rights Reserved.
.\" Copyright 2008 by Sun Microsystems.  All Rights Reserved.
.\" This file may be copied under the terms of the GNU Public License, v2.
.\"
.TH mkfs.lustre 8 "2008 Mar 15" Lustre "configuration utilities"
.SH NAME
mkfs.lustre \- format a disk for a Lustre service
.SH SYNOPSIS
.br
.BR mkfs.lustre { --ost | --mdt | --mgs }
.I [options] 
.I device
.br
.B <target_type>
is one of
.TP
.BI \--ost
object storage target
.TP
.BI \--mdt
metadata storage target
.TP
.BI \--mgs
configuration management service - one per site.  This service can be
combined with one 
.BI \--mdt
service by specifying both types
.SH DESCRIPTION
.B mkfs.lustre
is used to format a disk device for use as part of a Lustre
filesystem. After formatting, a disk can be mounted to start the Lustre
service defined by this command.

.SH OPTIONS
.TP
.BI \--backfstype= fstype
Force a particular format for the backing fs (ext3, ldiskfs)
.TP
.BI \--comment= comment
Set user comment about this disk, ignored by Lustre.
.TP
.BI \--device-size= KB
Set device size for loop devices
.TP
.BI \--dryrun
Only print what would be done; does not affect the disk
.TP
.BI \--failnode= nid,...  
Set the NID(s) of a failover partner. This option can be repeated as desired.
.TP
.BI \--fsname= filesystem_name  
The Lustre filesystem this service will be part of.  The maximum
filesystem_name length is 8 characters. Default is 'lustre'
.TP
.BI \--index= index
Force a particular OST or MDT index 
.TP
.BI \--mkfsoptions= opts
Format options for the backing fs. For example, ext3 options could be set here.
.TP
.BI \--mountfsoptions= opts
Set permanent mount options, equivalent to setting in /etc/fstab
.TP
.BI \--mgsnode= nid,...  
Set the NID(s) of the MGS node, required for all targets other than the MGS.
.TP
.BI \--param " key=value"
Set permanent parameter 
.I key 
to value 
.IR value .
This option can be repeated as desired.  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 \--quiet
Print less information.
.TP
.BI \--reformat 
Reformat an existing Lustre disk
.TP
.BI \--stripe-count-hint= stripes
Used for optizing MDT inode size
.TP
.BI \--verbose
Print more information.

.SH EXAMPLES
.TP
.B mkfs.lustre --fsname=testfs --mdt --mgs /dev/sda1
Combined MGS and MDT for filesystem 'testfs' on node e.g. cfs21
.TP
.B mkfs.lustre --fsname=testfs --ost --mgsnode=cfs21@tcp0 /dev/sdb
OST for filesystem 'testfs' on any node using the above MGS.
.TP
.B mkfs.lustre --mgs /dev/sda1
Standalone MGS on e.g. node cfs22
.TP
.B mkfs.lustre --fsname=myfs1 --mdt --mgsnode=cfs22@tcp0 /dev/sda2
MDT for filesystem 'myfs1' on any node, using the above MGS

.SH BUGS
Please report all bugs to Sun Microsystems via http://bugzilla.lustre.org/
.SH AVAILABILITY
.B mkfs.lustre
is part of the 
.BR Lustre (7) 
filesystem package and is available from Sun Microsystems via
.br
http://downloads.lustre.org/
.SH SEE ALSO
.BR lustre (7),
.BR mount.lustre (8),
.BR tunefs.lustre (8),
.BR lctl (8),
.BR lfs (1)