doc/admin-guide/en-US/admin_console.xml


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28

<?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>
  <title>Using the Gluster Console Manager – Command Line Utility</title>
  <para>The Gluster Console Manager is a single command line utility that  simplifies configuration and management of your storage environment. The Gluster Console Manager is similar to the LVM (Logical Volume Manager) CLI or ZFS Command Line Interface, but across multiple storage servers. You can use the Gluster Console Manager online, while volumes are mounted and active. Gluster automatically synchronizes volume configuration information across all Gluster servers.</para>
  <para>Using the Gluster Console Manager, you can create new volumes, start volumes, and stop volumes, as required. You can also add bricks to volumes, remove bricks from existing volumes, as well as change translator settings, among other operations.</para>
  <para>You can also use the commands to create scripts for automation, as well as use the commands as an API to allow integration with third-party applications. </para>
  <para><emphasis role="bold">Running the Gluster Console Manager</emphasis></para>
  <para>You can run the Gluster Console Manager on any GlusterFS server either by invoking the commands  or by running the Gluster CLI in interactive mode. You can also use the gluster command remotely using SSH.  </para>
  <itemizedlist>
    <listitem>
      <para>To run commands directly: </para>
      <para><command> # gluster peer <replaceable>command</replaceable></command></para>
      <para>For example:</para>
      <para><command> # gluster peer status </command></para>
    </listitem>
    <listitem>
      <para>To run the Gluster Console Manager in interactive mode </para>
      <para><command># gluster</command></para>
      <para>You can execute gluster commands from the Console Manager prompt:</para>
      <para><command> gluster&gt; <replaceable>command</replaceable></command> </para>
      <para>For example, to view the status of the peer server:</para>
      <para># <command>gluster </command></para>
      <para><command>gluster &gt; peer status </command></para>
      <para>Display the status of the peer.</para>
    </listitem>
  </itemizedlist>
</chapter>