Introduction to the Command Line Interface

add

Adds a new value to the system.

set

Sets a value in the system.

show

Shows a value or values from the system.

delete

Deletes a value from the system.

save

Saves the configuration changes made since the last save operation.

reboot

Restart the system.

halt

Turns the computer off.

quit

Exits from the CLI.

exit

Exits from the shell.

Start

Starts a transaction. Puts the CLI into transaction mode. All changes made using commands in transaction mode are applied at once or none of the changes are applied based on the way transaction mode is terminated.

commit

Ends transaction by committing changes.

rollback

Ends transaction by discarding changes.

expert

Enter the expert shell. Allows low-level access to the system, including the file system.

ver

Shows the version of the active Gaia image.

revert

Revert the database.

help

Get help on navigating the CLI and some useful commands.

<TAB>

Complete or fetch the keyword. For example

Gaia> set in<TAB>

inactivity-timeout - Set inactivity timeout

interface          - Displays the interface related parameters

Gaia> set in

<SPACE> <TAB>

Show the arguments that the command for that feature accepts. For example:

Gaia> set interface <SPACE> <TAB>

eth0 eth1 lo

Gaia> set interface

<ESC><ESC>

See possible command completions. For example

Gaia> set inter<ESC><ESC>

set interface VALUE ipv4-address VALUE mask-length VALUE

set interface VALUE ipv4-address VALUE subnet-mask VALUE

set interface VALUE ipv6-address VALUE mask-length VALUE

set interface VALUE { comments VALUE mac-addr VALUE mtu VALUE state VALUE speed VALUE duplex VALUE auto-negotiation VALUE }

set interface VALUE { ipv6-autoconfig VALUE }

Gaia> set inter

?

Get help on a feature or keyword. For example

Gaia> set interface <?>

interface: {show/add/delete} interface "interface-name"

Gaia> set interface

UP/DOWN arrow

Browse the command history.

LEFT/RIGHT arrow

Edit command.

Enter

Run a command string. The cursor does not have to be at the end of the line.

You can usually abbreviate the command to the smallest number of unambiguous characters.

↓

Recall previous command.

↑

Recall next command.

history

Show the last 100 commands.

!!

Run the last command.

!nn

Run a specific previous command: The nn command.

!‑nn

Run the nnth previous command. For example, entering !‑3 runs the third from last command.

!str

Run the most recent command that starts with str.

!\?str\?

Run the most recent command containing str. The trailing ? may be omitted if str is followed immediately by a new line.

!!:s/str1/str2

Repeat the last command, replacing str1 with str2.

0

The operation word.

n

The nth word.

^

The first argument; that is, word 1.

$

The last argument.

%

The word matched by the most recent \?str\? search.

p

Print the new command but do not execute

s/str1/str2

Substitute new for the first occurrence of old in the word being referred to.

g

Apply changes over the entire command. Use this modified in conjunction with s, as in gs/str1/str2.

Alt-D

Delete next word.

Alt-F

Go to the next word.

Ctrl-Alt-H

Delete the previous word.

Ctrl-shift_

Repeat the previous word.

Ctrl-A

Move to the beginning of the line.

Ctrl-B

Move to the previous character.

Ctrl-E

Move to the end of the line.

Ctrl-F

Move to the next character.

Ctrl-H

Delete the previous character.

Ctrl-L

Clear the screen and show the current line at the top of the screen.

Ctrl-N

Next history item.

Ctrl-P

Previous history item.

Ctrl-R

Redisplay the current line.

Ctrl-U

Delete the current line.

Description

Use the lock database override and unlock database commands to get exclusive read-write access to the database by taking write privileges to the database away from other administrators logged into the system.

Syntax

• lock database override
• unlock database

Comments

Use these commands with caution. The admin whose write access is revoked does not receive notification.

Description

Configures and shows the state of the configuration lock

Syntax

set config-lock {off | on [timeout <seconds>] override
show {config-lock | config-state}

Parameters

Comments

• set config-lock on override is identical to lock database override
• set config-lock off is identical to unlock database

Note - The open server hardware must support 64-bit for the Edition feature to work.

Description

Use the Edition feature to change the default between 32- and 64-bit versions of Gaia.

Syntax

set edition default {32-bit | 64-bit}

Comments

• Run the command from clish.
• The hardware platform must have at least 6 GB of memory for this to work.
• Remember to reboot the device.

Description

Use these commands to set the CLI environment for a user for a particular session, or permanently.

Syntax

To show the client environment

show clienv {all | config-lock | debug | echo-cmd | on-failure | output | prompt | rows | syntax-check}

To set the client environment

set clienv {config-lock {on | off} | debug {0-6} | echo-cmd {on | off} | on-failure {continue | stop} | output {pretty | structured | xml} | prompt <prompt_string> | rows <row_number> | syntax-check {on | off}}

To save the client environment permanently

save clienv

config-lock {on | off}

Default value of the clish config-lock parameter. If set to on, clish will lock the configuration when invoked, otherwise continue without a configuration lock. When the configuration is locked by clish, no configuration changes are possible in WebUI, until the lock is released.

debug {0-6}

Debug level. Predefined levels are:

• 0 - (Default) Do not debug, display error messages only
• 5 - Show confd requests and responses
• 6 - Show handler invocation parameters and results

echo-cmd {on | off}

If set to on, echoes all commands before executing them, when the command execution is done through the load configuration command. The default is off.

on-failure {continue | stop}

Action performed on failure:

• continue - Show error messages, but continue running commands from a file or a script
• stop - (Default) Stop running commands from a file or a script

output {pretty | structured | xml}

Command line output format. The default is pretty.

prompt <prompt_string>

Command prompt string. A valid prompt string can consist of any printable characters and a combination of these variables:

• %H - Replaced with the Command number
• %I - Replaced with the User ID
• %M - Replaced with the Hostname
• %P - Replaced with the Product I.
• %U - Replaced with the Username

To set the prompt back to the default, use the keyword default.

rows <row_number>

Number of rows to show in your terminal window. If the window size is changed, the number of rows will also change, unless the value is set to 0 (zero).

syntax-check {on | off}

Put the shell into syntax‑check mode. Commands you enter are checked syntactically and are not executed, but values are validated. The default is off.

Description:

Use this command to set the expert password by plain text or MD5 salted hash. Use the MD5 salted hash option when upgrading or restoring using backup scripts.

Syntax:

• set expert-password
• set expert-password hash VALUE

Example:

gw> set expert-password

Enter current expert password:

Enter new expert password:

Enter new expert password (again):

Password is only 5 characters long; it must be at least 6 characters in length.

Enter new expert password:

Enter new expert password (again):

Password is not complex enough; try mixing more different kinds of characters (upper case, lower case, digits, and punctuation).

Enter new expert password:

Enter new expert password (again):

gw> save config

Important - You must run save config to permanently set the new expert password.

Description

Manage user defined (extended) commands in clish. Extended commands include:

1. Built in extended commands. These are mostly for configuration and troubleshooting of Gaia and Check Point products.
2. User defined commands.

You can do role based administration (RBA) with extended commands by assigning extended commands to roles and then assigning the roles to users or user groups.

Syntax

To show all extended commands

show extended commands

To show the path and description of a specified extended command

show command VALUE

To add an extended command

add command VALUE path VALUE description VALUE

To delete an extended command

delete command VALUE

Parameters

Example

To add the free command to the systemDiagnosis role and assign a user with that role:

1. To add the free command, run

   add command free path /usr/bin/free description "Display amount of free and used memory in the system"

2. Save the configuration. Run

   save config

3. Log out of Gaia and log in again.
4. To add the free command to the systemDiagnosis role, run

   add rba role systemDiagnosis domain-type System readwrite-features ext_free

5. To assign user john with the systemDiagnosis role, run

   add rba user john roles systemDiagnosis