diff options
Diffstat (limited to 'doc/admin-guide/en-US/admin_commandref.xml')
| -rw-r--r-- | doc/admin-guide/en-US/admin_commandref.xml | 334 |
1 files changed, 334 insertions, 0 deletions
diff --git a/doc/admin-guide/en-US/admin_commandref.xml b/doc/admin-guide/en-US/admin_commandref.xml new file mode 100644 index 00000000000..df4c78f4869 --- /dev/null +++ b/doc/admin-guide/en-US/admin_commandref.xml @@ -0,0 +1,334 @@ +<?xml version='1.0' encoding='UTF-8'?> +<!-- This document was created with Syntext Serna Free. --><!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "docbookV4.5/docbookx.dtd" []> +<chapter id="chap-Administration_Guide-Com_Ref"> + <title>Command Reference </title> + <para>This section describes the available commands and includes the +following section: +</para> + <itemizedlist> + <listitem> + <para>gluster Command +</para> + <para>Gluster Console Manager (command line interpreter) +</para> + </listitem> + <listitem> + <para>glusterd Daemon +</para> + <para>Gluster elastic volume management daemon +</para> + </listitem> + </itemizedlist> + <section> + <title>gluster Command </title> + <para><emphasis role="bold">NAME</emphasis> +</para> + <para>gluster - Gluster Console Manager (command line interpreter) +</para> + <para><emphasis role="bold">SYNOPSIS</emphasis> +</para> + <para>To run the program and display the gluster prompt: +</para> + <para><emphasis role="bold">gluster</emphasis> +</para> + <para>To specify a command directly: +gluster [COMMANDS] [OPTIONS] +</para> + <para><emphasis role="bold">DESCRIPTION</emphasis> +</para> + <para>The Gluster Console Manager is a command line utility for elastic volume management. You can run +the gluster command on any export server. The command enables administrators to perform cloud +operations such as creating, expanding, shrinking, rebalancing, and migrating volumes without +needing to schedule server downtime. +</para> + <para><emphasis role="bold">COMMANDS</emphasis> +</para> + <para><informaltable frame="none"> + <tgroup cols="3"> + <colspec colnum="1" colname="c0" colsep="0"/> + <colspec colnum="2" colname="cgen1" colsep="0"/> + <colspec colnum="3" colname="c1" colsep="0"/> + <thead> + <row> + <entry>Command</entry> + <entry namest="cgen1" nameend="c1">Description</entry> + </row> + </thead> + <tbody> + <row> + <entry namest="c0" nameend="c1" align="left"> + <emphasis role="bold">Volume</emphasis> + </entry> + </row> + <row> + <entry>volume info [all | VOLNAME]</entry> + <entry namest="cgen1" nameend="c1">Displays information about all volumes, or the specified volume.</entry> + </row> + <row> + <entry>volume create NEW-VOLNAME [stripe COUNT] [replica COUNT] [transport tcp | rdma | tcp,rdma] NEW-BRICK ...</entry> + <entry namest="cgen1" nameend="c1">Creates a new volume of the specified type using the specified bricks and transport type (the default transport type is tcp).</entry> + </row> + <row> + <entry>volume delete VOLNAME</entry> + <entry namest="cgen1" nameend="c1">Deletes the specified volume.</entry> + </row> + <row> + <entry>volume start VOLNAME </entry> + <entry namest="cgen1" nameend="c1">Starts the specified volume.</entry> + </row> + <row> + <entry>volume stop VOLNAME [force] </entry> + <entry namest="cgen1" nameend="c1">Stops the specified volume. </entry> + </row> + <row> + <entry>volume rename VOLNAME NEW-VOLNAME </entry> + <entry namest="cgen1" nameend="c1">Renames the specified volume.</entry> + </row> + <row> + <entry>volume help </entry> + <entry namest="cgen1" nameend="c1">Displays help for the volume command.</entry> + </row> + <row> + <entry namest="c0" nameend="c1" align="left"> + <emphasis role="bold">Brick</emphasis> + </entry> + </row> + <row> + <entry>volume add-brick VOLNAME NEW-BRICK ... </entry> + <entry namest="cgen1" nameend="c1">Adds the specified brick to the specified volume.</entry> + </row> + <row> + <entry>volume replace-brick VOLNAME (BRICK NEW-BRICK) start | pause | abort | status </entry> + <entry namest="cgen1" nameend="c1">Replaces the specified brick.</entry> + </row> + <row> + <entry>volume remove-brick VOLNAME [(replica COUNT)|(stripe COUNT)] BRICK ... </entry> + <entry namest="cgen1" nameend="c1">Removes the specified brick from the specified volume.</entry> + </row> + <row> + <entry namest="c0" nameend="c1" align="left"> + <emphasis role="bold">Rebalance</emphasis> + </entry> + </row> + <row> + <entry>volume rebalance VOLNAME start</entry> + <entry namest="cgen1" nameend="c1">Starts rebalancing the specified volume.</entry> + </row> + <row> + <entry>volume rebalance VOLNAME stop </entry> + <entry namest="cgen1" nameend="c1">Stops rebalancing the specified volume. </entry> + </row> + <row> + <entry>volume rebalance VOLNAME status </entry> + <entry namest="cgen1" nameend="c1">Displays the rebalance status of the specified volume.</entry> + </row> + <row> + <entry namest="c0" nameend="c1" align="left"> + <emphasis role="bold">Log</emphasis> + </entry> + </row> + <row> + <entry>volume log filename VOLNAME [BRICK] DIRECTORY </entry> + <entry namest="cgen1" nameend="c1">Sets the log directory for the corresponding volume/brick. </entry> + </row> + <row> + <entry>volume log rotate VOLNAME [BRICK] </entry> + <entry namest="cgen1" nameend="c1">Rotates the log file for corresponding volume/brick.</entry> + </row> + <row> + <entry>volume log locate VOLNAME [BRICK] </entry> + <entry namest="cgen1" nameend="c1">Locates the log file for corresponding volume/brick. </entry> + </row> + <row> + <entry namest="c0" nameend="c1" align="left"> + <emphasis role="bold">Peer</emphasis> + </entry> + </row> + <row> + <entry>peer probe HOSTNAME </entry> + <entry namest="cgen1" nameend="c1">Probes the specified peer. </entry> + </row> + <row> + <entry>peer detach HOSTNAME </entry> + <entry namest="cgen1" nameend="c1">Detaches the specified peer. </entry> + </row> + <row> + <entry>peer status </entry> + <entry namest="cgen1" nameend="c1">Displays the status of peers. </entry> + </row> + <row> + <entry>peer help </entry> + <entry namest="cgen1" nameend="c1">Displays help for the peer command.</entry> + </row> + <row> + <entry namest="c0" nameend="c1" align="left"> + <emphasis role="bold">Geo-replication</emphasis> + </entry> + </row> + <row> + <entry>volume geo-replication MASTER SLAVE start</entry> + <entry namest="cgen1" nameend="c1"> + <para>Start geo-replication between the hosts specified by MASTER and SLAVE. You can specify a local master volume as :VOLNAME.</para> + <para>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.</para> + </entry> + </row> + <row> + <entry>volume geo-replication MASTER SLAVE stop</entry> + <entry namest="cgen1" nameend="c1"> + <para>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.</para> + <para>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. +</para> + </entry> + </row> + <row> + <entry morerows="10">volume geo-replication MASTER SLAVE config [options]</entry> + <entry/> + <entry>Configure geo-replication options between the hosts specified by MASTER and SLAVE. </entry> + </row> + <row> + <entry>gluster-command COMMAND</entry> + <entry>The path where the gluster command is installed.</entry> + </row> + <row> + <entry>gluster-log-level LOGFILELEVEL</entry> + <entry>The log level for gluster processes.</entry> + </row> + <row> + <entry>log-file LOGFILE</entry> + <entry>The path to the geo-replication log file.</entry> + </row> + <row> + <entry>log-level LOGFILELEVEL</entry> + <entry>The log level for geo-replication.</entry> + </row> + <row> + <entry>remote-gsyncd COMMAND</entry> + <entry>The path where the gsyncd binary is installed on the remote machine.</entry> + </row> + <row> + <entry>ssh-command COMMAND</entry> + <entry>The ssh command to use to connect to the remote machine (the default is ssh).</entry> + </row> + <row> + <entry>rsync-command COMMAND</entry> + <entry>The rsync command to use for synchronizing the files (the default is rsync).</entry> + </row> + <row> + <entry>volume_id= UID</entry> + <entry>The command to delete the existing master UID for the intermediate/slave node.</entry> + </row> + <row> + <entry>timeout SECONDS</entry> + <entry>The timeout period.</entry> + </row> + <row> + <entry>sync-jobs N</entry> + <entry>The number of simultaneous files/directories that can be synchronized.</entry> + </row> + <row> + <entry/> + <entry>ignore-deletes</entry> + <entry>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.</entry> + </row> + <row> + <entry namest="c0" nameend="c1" align="left"> + <emphasis role="bold">Other</emphasis> + </entry> + </row> + <row> + <entry>help</entry> + <entry/> + <entry>Display the command options.</entry> + </row> + <row> + <entry>quit</entry> + <entry/> + <entry>Exit the gluster command line interface.</entry> + </row> + </tbody> + </tgroup> + </informaltable></para> + <para><emphasis role="bold">FILES</emphasis> + +</para> + <para>/etc/glusterd/* +</para> + <para><emphasis role="bold">SEE ALSO </emphasis></para> + <para>fusermount(1), mount.glusterfs(8), glusterfs-volgen(8), glusterfs(8), glusterd(8)</para> + </section> + <section> + <title>glusterd Daemon </title> + <para><emphasis role="bold">NAME</emphasis> +</para> + <para>glusterd - Gluster elastic volume management daemon</para> + <para><emphasis role="bold">SYNOPSIS</emphasis> +</para> + <para>glusterd [OPTION...] +</para> + <para><emphasis role="bold">DESCRIPTION</emphasis> +</para> + <para>The glusterd daemon is used for elastic volume management. The daemon must be run on all export servers. +</para> + <para><emphasis role="bold">OPTIONS</emphasis> +</para> + <para><informaltable frame="none"> + <tgroup cols="2"> + <colspec colnum="1" colname="c0" colsep="0"/> + <colspec colnum="2" colname="c1" colsep="0"/> + <thead> + <row> + <entry>Option</entry> + <entry>Description</entry> + </row> + </thead> + <tbody> + <row> + <entry namest="c0" nameend="c1" align="left"> + <emphasis role="bold">Basic</emphasis> + </entry> + </row> + <row> + <entry>-l=LOGFILE, --log-file=LOGFILE</entry> + <entry>Files to use for logging (the default is /usr/local/var/log/glusterfs/glusterfs.log).</entry> + </row> + <row> + <entry>-L=LOGLEVEL, --log-level=LOGLEVEL</entry> + <entry>Logging severity. Valid options are TRACE, DEBUG, INFO, WARNING, ERROR and CRITICAL (the default is INFO). </entry> + </row> + <row> + <entry>--debug</entry> + <entry>Runs the program in debug mode. This option sets --no-daemon, --log-level to DEBUG, and --log-file to console.</entry> + </row> + <row> + <entry>-N, --no-daemon</entry> + <entry>Runs the program in the foreground.</entry> + </row> + <row> + <entry namest="c0" nameend="c1" align="left"> + <emphasis role="bold">Miscellaneous</emphasis> + </entry> + </row> + <row> + <entry>-?, --help</entry> + <entry>Displays this help.</entry> + </row> + <row> + <entry>--usage</entry> + <entry>Displays a short usage message.</entry> + </row> + <row> + <entry>-V, --version</entry> + <entry>Prints the program version.</entry> + </row> + </tbody> + </tgroup> + </informaltable></para> + <para><emphasis role="bold">FILES</emphasis> + +</para> + <para>/etc/glusterd/* +</para> + <para><emphasis role="bold">SEE ALSO </emphasis></para> + <para>fusermount(1), mount.glusterfs(8), glusterfs-volgen(8), glusterfs(8), gluster(8)</para> + </section> +</chapter> |