---
name: "gfs_tool"
section: "8"
platform: "linux"
package: "gfs-tools"
version: "3.0.12-3.2+deb7u2"
release: "Debian 7 (Wheezy)"
platforms: ["linux"]
url: "https://new.carta.tech/gfs_tool"
---

# gfs\_tool(8)

interface to gfs ioctl calls

## NAME

gfs\_tool - interface to gfs ioctl calls

## SYNOPSIS

**gfs\_tool** *COMMAND* \[*OPTION*\] \[*PARAMETERS ...*\]

## DESCRIPTION

gfs\_tool is an interface to a variety of the GFS ioctl calls.

- Specifying gfs\_tool -h prints gfs\_tool command line usage (help).

  - Specifying gfs\_tool -V prints the gfs\_tool version information.

  ## COMMANDS

- **clearflag** *Flag* *File1* *File2* *...*

  Clear an attribute flag on a file.

- **counters** *MountPoint* \[-c\] \[-i *interval*\]

  Print out statistics about a filesystem.  If -c is specified, gfs\_tool keeps running printing out the statistics once per second or, if specified, the interval given with the -i option, in seconds.

- **df** *MountPoint* \[-k\]\|\[-H\]

  Print out a space usage summary of a given filesystem.  The information printed is more detailed than a standard "df".  If -k is specified, the output is given in kilobytes (KB).  If -H is specified, the output is given in human readable format (similar to df -h).  If neither -k nor -H are specified, the output is given in file system blocks.

- **freeze** *MountPoint*

  Freeze (quiesce) a GFS cluster.

- **getsb** *MountPoint*

  Print out the superblock of a mounted filesystem.

- **gettune** *MountPoint*

  Print out the current values of the tuning parameters in a running filesystem.

- **jindex** *MountPoint*

  Print out the journal index of a mounted filesystem.

- **layout** *File* *\[buffersize\]*

  Print out on-disk layout information about a file or directory. Buffersize is the size of the buffer (in bytes) that gfs\_tool allocates to store the file's metadata during processing.  It defaults to 4194304 bytes.  If you are printing a very big directory you may need to specify a bigger size.

- **list**

  List the currently mounted GFS filesystems.  Each line represents a filesystem.  The columns represent (in order): 1) A number that is a cookie that represents the mounted filesystem. 2) The name of the device that holds the filesystem (well, the name as the Linux kernel knows it). 3) The lock table field that the filesystem was mounted with.

- **lockdump** *MountPoint* *\[buffersize\]*

  Print out information about the locks this machine holds for a given filesystem. Buffersize is the size of the buffer (in bytes) that gfs\_tool allocates to store the lock data during processing.  It defaults to 4194304 bytes.

- **margs** *arguments*

  This loads arguments into the module what will override the mount options passed with the -o field on the next mount.  See [mount.gfs(8)](/mount.gfs/8.md).

- **reclaim** *File*

  Returns unused on-disk metadata blocks to free blocks.

- **rindex** *MountPoint*

  Print out the resource group index of a mounted filesystem.

- **quota** *MountPoint*

  Print out the quota file of a mounted filesystem.  Also see the "gfs\_quota list" command.

- **sb** *device* **proto** *\[newvalue\]*

  View (and possibly replace) the name of the locking protocol in the file system superblock.  The file system shouldn't be mounted by any client when you do this.

- **sb** *device* **table** *\[newvalue\]*

  View (and possibly replace) the name of the locking table in the file system superblock.  The file system shouldn't be mounted by any client when you do this.

- **sb** *device* **ondisk** *\[newvalue\]*

  View (and possibly replace) the ondisk format number in the file system superblock.  The file system shouldn't be mounted by any client when you do this.  No one should have to use this.

- **sb** *device* **multihost** *\[newvalue\]*

  View (and possibly replace) the multihost format number in the file system superblock.  The file system shouldn't be mounted by any client when you do this.  No one should have to use this.

- **sb** *device* **all**

  Print out the superblock.

- **setflag** *Flag* *File1* *File2* *...*

  Set an attribute flag on a file.  There are four currently supported flags.  They are jdata, directio, inherit\_jdata, and inherit\_directio.

  The *jdata* flag causes all the data written to a regular file to be journaled. The jdata flag can only be set (or cleared) if the file is zero length.

  The *directio* flag causes all I/O to a regular file to be Direct I/O, even if the O\_DIRECT flag isn't used on the open() command.

  The *inherit\_jdata* flag is set on a directory.  It causes all new regular files created in that directory automatically inherit the *jdata* flag.  The *inherit\_jdata* is also inherited by any new subdirectories created in that directory.

  The *inherit\_directio* flag is set on a directory.  It causes all new regular files created in that directory automatically inherit the *directio* flag.  The *inherit\_directio* is also inherited by any new subdirectories created in that directory.

- **settune** *MountPoint* *parameter* *newvalue*

  Set the value of tuning parameter.  Use **gettune** for a listing of  tunable parameters.

- **shrink** *MountPoint*

  Causes any unused inodes to be thrown out of memory.

- **stat** *File*

  Print out extended stat information about a file.

- **unfreeze** *MountPoint*

  Unfreeze a GFS cluster.

- **version**

  Print out the version of GFS that this program goes with.

- **withdraw** *MountPoint*

  Cause GFS to abnormally shutdown a given filesystem on this node.