Help us improve your experience.

Let us know what you think.

Do you have time for a two-minute survey?

 
ON THIS PAGE
 

A Quick Tour of Paragon Shell

The following topics can help you get started with the Paragon Shell CLI to perform configuration changes, switch between operational mode and configuration mode, create a user account, and execute some of the basic commands.

CLI Modes

The CLI has two modes:

  • Operational mode—Use this mode to display the status of and information on the Paragon Automation cluster including the version of the software installed. In operational mode, you enter commands to monitor and to troubleshoot the Paragon Automation application. When you log in to a node VM, you are placed in operational mode by default.

    If you are in the Linux root shell, type cli to enter Paragon Shell operational mode.

  • Configuration mode—Use this mode to configure the cluster, SMTP, monitoring, user access, and several application properties. Type configure to enter configuration mode. To implement all configured changes, you must commit the changes.

    The CLI prompt changes from user@node> to user@node#, showing that you are in configuration mode, and a banner appears to indicate the hierarchy level. You can exit configuration mode and return to operational mode in one of the following ways:

    • To commit the configuration and exit:

    • To exit without committing:

    When you exit configuration mode, the CLI prompt changes from user@node# to user@node>, and the banner no longer appears. You can enter or exit configuration mode as many times as you wish without committing your changes.

You can view and execute the commands that are available corresponding to your role and privileges. Currently, we have the super-user and read-only privileges. A superuser, or root user like the system administrator, can view and execute all the supported commands available in Paragon Shell. A user with read-only privileges can execute a limited set of commands. To view the commands available for your user role, type ? and press enter. Table 1 describes the commands you can use to navigate the CLI.

Table 1: Commands to Navigate Paragon Shell

Command

Description

 
?
 Type ? to view the entire list of supported commands available to you. Append ? at the end of a command to view a list of possible options you can use to complete and execute the command.

For example, request paragon backup ? all the options available to back up your Paragon Automation cluster.

You can also press tab to auto-complete a command or show the available options for that command.

 
cli

Type this command in the Linux root shell to enter Paragon Shell.

quit

Exit Paragon Shell or exit from configuration mode. The quit and exit commands are equivalent.

 
exit

Type this command to exit from the Paragon Shell CLI or configuration mode. If you are in the configuration mode, type exit to exit the configuration mode to the operational mode. If you type exit in the Paragon Shell operational mode, you will exit to the Linux root shell.

 
configure

Type this command to enter the configuration mode in Paragon Shell.

Configuration Mode Commands

 
commit

Type this command to commit any configuration updates you make in the configuration mode.

 
commit and quit

Type this command to commit any configuration updates you make and exit the configuration mode.

 
set

Add or edit a configuration.

 
show
show statement-path

Display the current configuration.

 
delete

Delete a configuration.

Display set Commands from the Configuration

In configuration mode, you can display the configuration as a series of configuration mode commands required to re-create the configuration. This is useful if you are not familiar with how to use configuration mode commands or if you want to cut, paste, and edit the displayed configuration.

To display the configuration as a series of configuration mode commands, which are required to re-create the configuration from the top level of the hierarchy as set commands, issue the show configuration mode command with the display set option:

For example:

To display the configuration as set commands and search for text matching a regular expression by filtering output, specify the match option after the pipe ( | ):

For example:

Getting Help About Commands

CLI commands and options can vary by software release, your role, and privileges. Each level of the CLI command hierarchy provides information about available commands. You can type a question mark (?) to get context-relevant help about commands.

If you type the question mark at the command-line prompt, the CLI lists the available commands and options. For example, to view a list of top-level operational mode commands, this is the result:

If you type the question mark after entering the complete name of a command or command option, the CLI lists the available commands and options and then re-displays the command names and options you typed.

If you type the question mark in the middle of a command name, the CLI lists possible command completions that match the letters you have entered so far. It then re-displays the letters that you typed. For example, to list all operational mode commands that start with the letter s, type the following: