Command line tools

Every command MooseFS installs, grouped by the task it belongs to, together with the manual page that documents it. The manual page holds the syntax and every argument. This page says which manual page to open. The mount options of mfsmount, and the mfsmount.cfg file that presets them, are listed here in full.

Every machine with the packages installed has these manual pages, so man mfsmaster answers there. The same set stands in Man pages, reproduced as the product ships it. Each entry of the Manual page column below opens one of those pages.

The tools that work on files and directories print numbers in the format you ask for. -n prints exact numbers. -h uses binary prefixes (Ki, Mi, Gi). -H uses SI prefixes (k, M, G). -k, -m and -g print plain kibis, mebis and gibis. The environment variable MFSHRFORMAT sets the same thing for every call instead of one. Its values are 0 for exact numbers, 1 or h for binary prefixes, and 2 or H for SI prefixes. 3 or h+ prints exact numbers and binary prefixes together. 4 or H+ does the same with SI prefixes. You get exact numbers when you ask for neither.

Running the cluster

Command	What it does	Manual page
mfsmaster	Start, restart or stop MooseFS master process.	mfsmaster(8)
mfschunkserver	Start, restart or stop MooseFS chunkserver process.	mfschunkserver(8)
mfsmetalogger	Start, restart or stop MooseFS metalogger process.	mfsmetalogger(8)
mfsgui	Start, restart or stop MooseFS GUI server.	mfsgui(8)
mfssupervisor	Tool for controlling the work of MooseFS master process.	mfssupervisor(8)

Mounting a file system

Command	What it does	Manual page
mfsmount, mount.moosefs	Mount MooseFS.	mfsmount(8)
mfsbdev	MooseFS block device daemon/management tool.	mfsbdev(8)

Storage classes and patterns

Command	What it does	Manual page
mfsclonesclass, mfscreatesclass, mfsdeletesclass, mfsimportsclass, mfslistsclass, mfsmodifysclass, mfsrenamesclass, mfsscadmin	MooseFS storage class administration tool.	mfsscadmin(1)
mfscopysclass, mfsgetsclass, mfssclass, mfssetsclass, mfsxchgsclass	MooseFS storage classes management tools.	mfssclass(1)
mfscreatepattern, mfsdeletepattern, mfslistpattern, mfspatadmin	MooseFS patterns administration tool.	mfspatadmin(1)

Trash and archiving

Command	What it does	Manual page
mfscopytrashretention, mfsgettrashretention, mfssettrashretention, mfstrashretention	MooseFS trash retention management tools.	mfstrashretention(1)
mfsarchive, mfschkarchive, mfsclrarchive, mfssetarchive	MooseFS archive storage mode management tools.	mfsarchive(1)

Snapshots

Command	What it does	Manual page
mfsappendchunks, mfsmakesnapshot, mfsrmsnapshot, mfssnapshots	MooseFS snapshot tools.	mfssnapshots(1)

Attributes, access control lists and quotas

Command	What it does	Manual page
mfscopyeattr, mfsdeleattr, mfseattr, mfsgeteattr, mfsseteattr	MooseFS extra attributes management tools.	mfseattr(1)
mfsfacl, mfsgetfacl, mfssetfacl	MooseFS file access control lists (extended attributes) management tools.	mfsfacl(1)
mfscopyquota, mfsdelquota, mfsgetquota, mfsquota, mfssetquota	MooseFS quota management tools.	mfsquota(1)

Information about files and directories

Command	What it does	Manual page
mfscheckfile, mfsdiagtools, mfsdirinfo, mfsfileinfo, mfsfilepaths, mfsfilerepair	MooseFS diagnostic tools.	mfsdiagtools(1)

Monitoring and statistics

Command	What it does	Manual page
mfscli	GUI's counterpart in TXT mode.	mfscli(1)
mfsstatsdump	Dump usage data from master stats file in csv or png format.	mfsstatsdump(8)
mfscsstatsdump	Dump usage data from chunkserver stats file in csv or png format.	mfscsstatsdump(8)
mfsnetdump	Dump network traffic as mfs packets.	mfsnetdump(8)
mfslicinfo PRO (PRO Edition only)	Display MooseFS licence information from one or more master servers.	mfslicinfo(1)

Metadata and chunk files

Command	What it does	Manual page
mfsmetadump	Dump MooseFS metadata info in human readable format.	mfsmetadump(8)
mfsmetadirinfo	Uses MooseFS metadata to calculate precise directory information (similar to mfsdirinfo).	mfsmetadirinfo(8)
mfsmetasearch	Uses MooseFS metadata to find specific files.	mfsmetasearch(8)
mfschunktool	Checks chunk integrity offline.	mfschunktool(8)
mfschunkdbdump	Dumps data stored by a chunkserver in a chunkdb file.	mfschunkdbdump(8)

Locations

Command	What it does	Manual page
mfslocadmin, mfslocationcreate, mfslocationdelete, mfslocationlist, mfslocationmap, mfslocationrename, mfslocationsetdefault, mfslocationstate, mfslocationunmap PRO (PRO Edition only)	MooseFS locations administration tool.	mfslocadmin(1)

Patches

Command	What it does	Manual page
mfsapplypatch, mfscreatepatch, mfsdumppatch, mfspatch PRO (PRO Edition only)	MooseFS patch tools.	mfspatch(1)

Commands that have been replaced

Command	What it does	Manual page
mfscopygoal, mfsgetgoal, mfssetgoal	MooseFS goal management tools DEPRECATED, use mfssclass tools instead.	mfsgoal(1)
mfscopytrashtime, mfsgettrashtime, mfssettrashtime, mfstrashtime	DEPRECATED MooseFS trash time management tools (use mfstrashretention tools instead).	mfstrashtime(1)
mfsmetarestore	Doesn't exist in this version of MooseFS.	mfsmetarestore(8)

Manual pages that cover the set

Manual page	What it covers
mfstools(1)	Perform MooseFS-specific operations.
moosefs(7)	Fault tolerant, highly reliable, near indefinitely scalable, fast distributed file system in User Space.

Mount options

Options of mfsmount. An option is given as -o NAME=VALUE. Several options are separated by commas. A dash in the default column stands for an option that is not set at all.

Option	Default	What it does
-p, --password	not set	Similar to -o mfspassword=PASSWORD, but show prompt and ask user for password.
-n, --nostdopts	not set	Do not add standard MFS mount options: -o allow_other.
-o nonempty	not set	Allow to mount MFS in nonempty directory. Available on FUSE 3, macOS and FreeBSD.
-o mfscfgfile=CFGFILE, -c CFGFILE	not set	Load some mount options from external file (if not specified then use default file: /etc/mfs/mfsmount.cfg or /etc/mfsmount.cfg).
-o mfsdebug	not set	Print some debugging information.
-o mfsmeta, -m, --meta	not set	Mount meta filesystem (trash etc.).
-o mfsflattrash	not set	Use flat trash structure in meta.
-o mfsdelayedinit	not set	Connection with master is done in background - with this option mount can be run without network (good for being run from fstab / init scripts etc.).
-o mfsmkdircopysgid=N	1 on Linux, 0 elsewhere	Sgid bit should be copied during mkdir operation.
-o mfssugidclearmode=SMODE	EXT on Linux, BSD on the BSDs, OSX on macOS and Solaris, NEVER elsewhere	Set sugid clear mode (see below).
-o mfscachemode=CMODE	FBSDAUTO on FreeBSD, AUTO elsewhere	Set cache mode (see below).
-o mfscachefiles	not set	(deprecated) equivalent to -o mfscachemode=YES.
-o mfsreaddirplusminto=SEC	0.0001	Set minimal entry/attributes cache timeout for readdirplus in seconds.
-o mfsattrcacheto=SEC	1.0	Set attributes cache timeout in seconds.
-o mfsxattrcacheto=SEC	30.0	Set extended attributes (xattr) cache timeout in seconds.
-o mfsentrycacheto=SEC	0.0	Set file entry cache timeout in seconds.
-o mfsdirentrycacheto=SEC	1.0	Set directory entry cache timeout in seconds.
-o mfsnegentrycacheto=SEC	0.0	Set negative entry cache timeout in seconds.
-o mfssymlinkcacheto=SEC	300.0	Set symbolic link cache timeout in seconds.
-o mfsgroupscacheto=SEC	300.0	Set supplementary groups cache timeout in seconds.
-o mfsrlimitnofile=N	100000	On startup mfsmount tries to change number of descriptors it can simultaneously open.
-o mfsnice=N	-19	On startup mfsmount tries to change his 'nice' value.
-o mfsmemlock	not set	Try to lock memory. Available where the system can lock a process in memory.
-o mfslimitarenas=N	4	If N>0 then limit glibc malloc arenas. Available where the C library tunes malloc arenas.
-o mfsallowoomkiller	not set	Do not disable out of memory killer. Linux only.
-o mfslogminlevel=LEVEL	INFO	Minimal message level to log ([D]EBUG,[I]NFO,[N]OTICE,[W]ARNING or [E]RROR).
-o mfslogelevateto=LEVEL	NOTICE	Send messages with log level lower than LEVEL to syslog as LEVEL (levels as above).
-o mfsfsyncmintime=SEC	0.0	Force fsync before last file close when file was opened/created at least SEC seconds earlier (always do fsync before close).
-o mfswritecachesize=N	256	Define size of write cache in MiB.
-o mfsreadaheadsize=N	256	Define size of all read ahead buffers in MiB.
-o mfsreadaheadleng=N	1048576	Define amount of bytes to be additionally read.
-o mfsreadaheadtrigger=N	10 * mfsreadaheadleng	Define amount of bytes read sequentially that turns on read ahead.
-o mfserroronlostchunk	not set	When all known chunkservers are connected to the master and the required chunk is missing then immediately finish I/O and return an error.
-o mfserroronnospace	not set	When all known chunkservers are connected to the master and there is no free space then immediately finish I/O and return an error.
-o mfsioretries=N	30	Define number of retries before I/O error is returned.
-o mfstimeout=N	0	Define maximum timeout in seconds before I/O error is returned (which means no timeout).
-o mfslogretry=N	5	Define minimal retry counter on which system will start log I/O messages.
-o mfsmaster=HOST, -H HOST	mfsmaster	Define mfsmaster location.
-o mfsport=PORT, -P PORT	9421	Define mfsmaster port number.
-o mfsbind=IP, -B IP	not set	Define source ip address for connections (chosen automatically by OS).
-o mfsproxy=IP, -L IP	127.0.0.1	Define listen ip address of local master proxy for communication with tools.
-o mfssubfolder=PATH, -S PATH	/	Define subfolder to mount as root.
-o mfspassword=PASSWORD	not set	Authenticate to mfsmaster with given password.
-o mfspassfile=FILENAME	not set	Authenticate to mfsmaster with password from given file.
-o mfsmd5pass=MD5	not set	Authenticate to mfsmaster using directly given md5 (only if mfspassword is not defined).
-o mfspreflabels=LABELEXPR	not set	Specify preferred labels for choosing chunkservers during I/O.
-o mfsnoxattrs	not set	Turn off xattr support.
-o mfsnoposixlocks	not set	Turn off support for global posix locks (lockf + ioctl) - locks will work locally. Needs FUSE 2.6 or newer.
-o mfsnobsdlocks	not set	Turn off support for global BSD locks (flock) - locks will work locally. Needs FUSE 2.9 or newer.

An option that mfsmount does not know is passed on to FUSE and the system, so rw, ro, suid, nosuid, dev, nodev, exec and noexec work as mount(8) describes them.

Cache modes

Values of -o mfscachemode=CMODE.

Mode	Meaning
DIRECT	Forces direct io (bypasses cache).
NO, NONE, NEVER	Always flush data cache on file open (safest but can reduce efficiency).
YES, ALWAYS	Always keep data cache on file open (dangerous).
AUTO	File cache is managed by mfsmaster automatically (should be very safe and efficient).
FBSDAUTO	FreeBSD only: works as AUTO with FUSE protocol 7.23 and newer, and as DIRECT with older FUSE.

Sugid clear modes

Values of -o mfssugidclearmode=SMODE. They say when MooseFS clears the suid and sgid bits of a file whose owner changes. A user other than root who writes to a file or truncates it clears the bits whatever the mode, as on Linux. Under EXT and XFS, suid is cleared always and sgid only when the group execute bit is set. Under every other mode, both bits are cleared.

Mode	Meaning
NEVER	MFS will not change suid and sgid bit on chown.
ALWAYS	Clear suid and sgid on every chown - safest operation.
OSX	Standard behavior in OS X and Solaris (chown made by unprivileged user clear suid and sgid).
BSD	Standard behavior in *BSD systems (like in OSX, but only when something is really changed).
EXT	Standard behavior in most file systems on Linux (directories not changed, others: suid cleared always, sgid only when group exec bit is set).
XFS	Standard behavior in XFS on Linux (like EXT but directories are changed by unprivileged users).

mfsmount.cfg

The file that presets mount options and the mount point. One line is one entry:

Line	What it means
# or ; in the first column	Comment. The line is ignored.
Empty line	Ignored.
Anything else	A mount option, exactly as it would be written after -o on the command line. Several options may stand on one line, separated by commas.
A line starting with /	The mount point to use when the command line names none. Give it once: with several such lines, there is no guarantee which one wins.

mfsmount reads /etc/mfs/mfsmount.cfg, and /etc/mfsmount.cfg when /etc/mfs/mfsmount.cfg is absent. Neither has to exist.

-c FILE, or -o mfscfgfile=FILE, reads that file instead of the default file. A file named this way has to exist: mfsmount stops when that file does not exist.

An option given on the command line wins over the same option in the file.

An example of the file:

nosuid,nodev
mfsmaster=mfsmaster
mfspassword=secret
/mnt/mfs