12.4. Configuration mode

<action>

The following actions are available in the configuration mode:

• execute: execute commands not related to UserGate configuration (ping, date, traceroute, etc.). The command is available regardless of the configuration level (<level>).

• set: edit all objects and enable various parameters, e.g. radmin.

• end: go one level up.

• show: display current values. You can use this at any configuration level. Displays everything from the current level down.

• edit: go to a configuration level. The configuration level is displayed above the command line.

• top: go back to the topmost configuration level.

• exit: exit the configuration mode.

• export: export a configuration.

• import: import a configuration.

• create: create new objects.

• delete: delete an object or a parameter from the parameter list.

For example, to view information about all interfaces, run the following command:

Admin@UGOS# show network interface

To go to the network interface level, use the following command:

Admin@UGOS# edit network interface

The current level will be displayed above the command line:

[ network interface ]
Admin@UGOS#

After you go to the network interface level, use the show command to show all interfaces without specifying a level:

[ network interface ] 
Admin@UGOS# show

<level>

Levels in the command line follow the UserGate web interface

• security-policy corresponds to the Security policies section of the Web interface.

• network corresponds to the Network section of the Web interface.

• settings corresponds to the UserGate section of the Web interface.

• global-portal corresponds to the Global portal section of the Web interface.

• network-policy corresponds to the Network policies section of the Web interface.

• vpn corresponds to the VPN section of the Web interface.

• users corresponds to the Users and devices section of the Web interface.

<filter>

ID of the object which is being accessed. Objects are identified by their name. If there are objects with identical names or it is more convenient to identify objects by another parameter, specify <configuration_info> in parentheses (this is discussed later in the section). This will find an object matching all the fields specified in parentheses.

For example, you need to display information about the port0 interface on another cluster node. The command

Admin@UGOS# show network interface adapter port0

will display information about the interface port0 on the current UserGate node. To preview information about the port0 interface on another node (named another_node for instance), you need to explicitly specify the node name in parentheses:

Admin@UGOS# show network interface adapter ( node-name another_nodename interface port0 )

Important! Parentheses should be separated by spaces on both sides.

<configuration_info>

Set of parameter-argument pairs. Parameter is the name of the field for which you need to set the argument. Arguments can be single-valued or multi-valued.

A single argument is a value of the parameter. If the string contains spaces, use quotation marks.

For example, to create a group named VPN users:

Admin@UGOS# create users group "VPN users"

Multiple arguments are used to set multiple values of a parameter; include them in square brackets and separated by spaces.

For example, you want to add user1 and user2 to the "VPN users" group. Then you need to set [ user1 user2 ] as the argument for the users parameter:

Admin@UGOS# set users group "VPN users" users [ user1 user2 ]

Important! Square brackets should be separated by spaces on both sides.