Red Hat Training

A Red Hat training course is available for Red Hat Gluster Storage

2.4. Interacting with the CLI

The CLI is an interactive shell for controlling your Red Hat Storage Console from the command line. Type the required command and any additional parameters.

Example 2.1. Entering a shell command

[RHSC shell (connected)]# show cluster --name desktop_clusters
To support the construction of command and parameter combinations, the CLI includes the functionality to list and automatically complete commands and parameters by pressing the TAB key twice, similar to the bash shell.

Example 2.2. Listing and automatic completion of commands and parameters

Press TAB twice at a blank prompt to list all available commands. 
[RHSC shell (connected)]# TAB TAB
EOF       connect       exit       info       shell
action    console       file       list       show
add       disconnect    help       ping       status
clear     echo          history    remove     update
Choose a command and press TAB twice to view the next set of available parameters for the command. For the show command, this lists all resources. 
show TAB TAB
brick      glustervolume      network      role
cluster    group              nic          statistic
domain     hook               permission   tag
event      host               permit       user
Pressing TAB twice also completes commands and parameters. 
[RHSC shell (connected)]# show cluster TAB TAB
id         name           
[RHSC shell (connected)]# show cluster naTAB TAB
[RHSC shell (connected)]# show cluster --name
Note that pressing TAB twice also automatically formats na to the --name parameter, including the prefix. If the incomplete parameter matches multiple parameters, pressing TAB twice lists all those parameters.
The CLI provides functions for running Linux commands using either the shell command or the bang (!) character.

Example 2.3. Running Linux shell commands

Use the shell command: 
[RHSC shell (connected)]# shell ls -la
Or use the bang (!) character: 
[RHSC shell (connected)]# !ls -la
Similar to the Linux shell, the CLI can pipe data to other commands and sources.

Example 2.4. Piping CLI commands

Pipe CLI data to a Linux shell command: 
[RHSC shell (connected)]# list clusters --show-all | grep "Example"
name                      : Example1
name                      : Example2
name                      : ExampleEngineering
description               : An Example description
name                      : BestExampleCluster
Pipe CLI data to a file: 
[RHSC shell (connected)]# list clusters --show-all > cluster_List.txt
The CLI also contains an online help system to provide descriptions and syntax for each command via the help command.

Example 2.5. Using online help for the show command

[RHSC shell (connected)]# help show