Introduction to the Command Line Interface
This chapter introduces the Gaia command line interface. The default Gaia shell is called clish
.
To use the Gaia Clish:
- Connect to the platform using one of these options:
- From SmartConsole.
- Using a command-line connection (SSH, or a console).
- Log in using a user name and password.
Immediately after installation, the default user name and password are admin
and admin
.
To use the Gaia Clish on Security Groups:
To configure Security Groups, use the Gaia gClish (Global Clish):
- Connect to the command line on your Security Group (over SSH, or a console).
- Log in to Gaia Clish.
- Type
gclish
and press Enter.
Notes for Security Groups:
- You use Gaia gClish like Gaia Clish, but the commands are global by default and performed on all the Security Gateway Modules (SGMs), which are part of the security group.
- The Gaia gClish commands are not applied on SGMs that are in status DOWN. If a set command is performed, while an SGM was in status DOWN (either administratively or because of a failure), those commands are not applied on that SGM. The SGM synchronizes its database during its startup process. If the database changed, the SGM reboots itself in order for the changes to apply.
- config-lock is the lock that protects Gaia gClish database. The lock can be held by single SGM for the system. When user attempts to perform gClish
set
operations from a specific SGM, user should make sure that this SGM holds the config-lock.
To see the current config-lock, run: show {config-lock | config-state}
To acquire the config-lock, run: set config-lock on override
- The Gaia gClish traffic runs in Security Group on the Sync interface, on TCP port 1129.
- Similarly to Gaia Clish, Gaia gClish is capable of running extended commands. Run the
show commands extended
command to see the list of the Gaia gClish extended commands. - To run a command on specific set of SGMs, run the
set blade-range
command. This runs all the Gaia gClish embedded commands only on the specified subset of SGMs. Because all SGMs must have identical configuration, we highly recommend you use the set blade-range
command.
Saving Configuration Changes
When you change the OS configuration with in Gaia Clish, changes are applied immediately to the running system only.
To have the changes survive a reboot, you must run the save config
command.