Command Reference

gluster Command NAME gluster - Gluster Console Manager (command line interpreter) SYNOPSIS To run the program and display the gluster prompt: gluster To specify a command directly: gluster [COMMANDS] [OPTIONS] DESCRIPTION The Gluster Console Manager is a command line utility for elastic volume management. 'gluster' command enables administrators to perform cloud operations such as creating, expanding, shrinking, rebalancing, and migrating volumes without needing to schedule server downtime. COMMANDS Command Description Volume volume info [all | VOLNAME] Displays information about all volumes, or the specified volume. volume create NEW-VOLNAME [stripe COUNT] [replica COUNT] [transport tcp | rdma | tcp,rdma] NEW-BRICK ... Creates a new volume of the specified type using the specified bricks and transport type (the default transport type is tcp). NOTE: with 3.3.0 release, transport type 'rdma' and 'tcp,rdma' are not fully supported. volume delete VOLNAME Deletes the specified volume. volume start VOLNAME Starts the specified volume. volume stop VOLNAME [force] Stops the specified volume. volume help Displays help for the volume command. Brick volume add-brick VOLNAME [replica N] [stripe N] NEW-BRICK1 ... Adds the specified brick(s) to the given VOLUME. Using add-brick, users can increase the replica/stripe count of the volume, or increase the volume capacity by adding the brick(s) without changing volume type. volume replace-brick VOLNAME (BRICK NEW-BRICK) [start | start force | abort | status | commit | commit force] Used to replace BRICK with NEW-BRICK in a given VOLUME. After replace-brick is complete, the changes to get reflected in volume information, replace-brick 'commit' command is neccessary. volume remove-brick VOLNAME [replica N] BRICK1 ... [start | stop | status | commit | force ] Removes the specified brick(s) from the specified volume. 'remove-brick' command can be used to reduce the replica count of the volume when 'replica N' option is given. To ensure data migration from the removed brick to existing bricks, give 'start' sub-command at the end of the command. After the 'status' command says remove-brick operation is complete, user can 'commit' the changes to volume file. Using 'remove-brick' without 'start' option works similar to 'force' command, which makes the changes to volume configuration without migrating the data. Rebalance volume rebalance VOLNAME start Starts rebalancing of the data on specified volume. volume rebalance VOLNAME stop Stops rebalancing the specified volume. volume rebalance VOLNAME status Displays the rebalance status of the specified volume. Log volume log rotate VOLNAME [BRICK] Rotates the log file for corresponding volume/brick. Debugging volume top VOLNAME {[open|read|write|opendir|readdir [nfs]] |[read-perf|write-perf [nfs|{bs COUNT count COUNT}]]|[clear [nfs]]} [BRICK] [list-cnt COUNT] Shows the operation details on the volume depending on the arguments given. volume profile VOLNAME {start|info|stop} [nfs] Shows the file operation details on each bricks of the volume. volume status [all | VOLNAME] [nfs|shd|BRICK] [detail|clients|mem|inode|fd|callpool] Show details of activity, internal data of the processes (nfs/shd/BRICK) corresponding to one of the next argument given. If now argument is given, this command outputs bare minimum details of the current status (include PID of brick process etc) of volume's bricks. statedump VOLNAME [nfs] [all|mem|iobuf|callpool|priv|fd|inode|history] Command is used to take the statedump of the process, which is used captures most of the internal details. Peer peer probe HOSTNAME Probes the specified peer. peer detach HOSTNAME Detaches the specified peer. peer status Displays the status of peers. peer help Displays help for the peer command. Geo-replication volume geo-replication MASTER SLAVE start Start geo-replication between the hosts specified by MASTER and SLAVE. You can specify a local master volume as :VOLNAME. You can specify a local slave volume as :VOLUME and a local slave directory as /DIRECTORY/SUB-DIRECTORY. You can specify a remote slave volume as DOMAIN::VOLNAME and a remote slave directory as DOMAIN:/DIRECTORY/SUB-DIRECTORY. volume geo-replication MASTER SLAVE stop Stop geo-replication between the hosts specified by MASTER and SLAVE. You can specify a local master volume as :VOLNAME and a local master directory as /DIRECTORY/SUB-DIRECTORY. You can specify a local slave volume as :VOLNAME and a local slave directory as /DIRECTORY/SUB-DIRECTORY. You can specify a remote slave volume as DOMAIN::VOLNAME and a remote slave directory as DOMAIN:/DIRECTORY/SUB-DIRECTORY. volume geo-replication MASTER SLAVE config [options] Configure geo-replication options between the hosts specified by MASTER and SLAVE. gluster-command COMMAND The path where the gluster command is installed. gluster-log-level LOGFILELEVEL The log level for gluster processes. log-file LOGFILE The path to the geo-replication log file. log-level LOGFILELEVEL The log level for geo-replication. remote-gsyncd COMMAND The path where the gsyncd binary is installed on the remote machine. ssh-command COMMAND The ssh command to use to connect to the remote machine (the default is ssh). rsync-command COMMAND The rsync command to use for synchronizing the files (the default is rsync). volume_id= UID The command to delete the existing master UID for the intermediate/slave node. timeout SECONDS The timeout period. sync-jobs N The number of simultaneous files/directories that can be synchronized. ignore-deletes If this option is set to 1, a file deleted on master will not trigger a delete operation on the slave. Hence, the slave will remain as a superset of the master and can be used to recover the master in case of crash and/or accidental delete. Other help Display the command options. quit Exit the gluster command line interface. FILES /var/lib/glusterd/*