Using the CLI

The S1 system provides a powerful CLI tool that can help you get more done. It supports auto-completion and interactive help, so you can quickly find the commands you need and get the information you need. By learning how to use the CLI effectively, you can save time and improve your productivity.

Before you begin

• You must download the command line interface (S1-CLI software) to your local machine.

• Use your preconfigured settings, defined during S1 OS installations, to connect to your two-node cluster servers through the CLI.

• Note that all commands and options are case sensitive.

Procedures

• Opening CLI software

  1. At your local terminal, locate the path of S1CLI file and run it.

  2. Follow the displayed instructions:

     • Enter your Relay Name or IP Address.
     • Enter your Username
     • Enter your Password

Interactive help

StorONE CLI supports auto-completion. You can type part of the command and use the TAB key to auto-complete. To get help on any command, use the -h command modifier:
simply run [command-name] -h to view help on the CLI.

Procedures

1. To get help on the applications command and all its subcommands, run:
   applications -h

2. To get help on the applications command and a specific sub-command, such as create, run:
   applications create -h

3. To produce a pdf reference guide for all the commands, run: documentation save

4. To look for a usage example for any command, use the examples generate command. For example, to look for usage example for the applications create command run:
   examples generate --command applications create --count 3

   • The --command modifier is followed by the name of the command
   • The --count modifier is followed by a number that specifies the number of usage examples to display.
   • To specify two examples for each and every commands run:
     examples generate --all --count 2
   • To specify all usage examples for all of the commands
     example generate --all

5. To find information about the version of the S1 software run
   version

6. The search command allows you to look for a command by running a text search. The search command takes one argument (the text search string) and has two optional modifiers

   • The --beforeContext modifier is followed by a number that specifies the number of characters before the match (the default value is 10)
   • The --afterContext modifier is followed by a number that specifies the number of characters after the match (the default value is 10)

7. To look for commands that contain the word pool, run search pool --afterContext 18 --beforeContext 18

8. The ls command provides a short description for all of the initial commands: