General Information

For UserGate hardware and software systems (HSC), a PMC CLI is available, designed for UserGate device monitoring and management.

PMC CLI command structure is the same as CLI command structure of the main product:

<action> <level> <filter> <configuration_info>

where:

<action>: the action to be performed (create, set, show, delete)

<level>: configuration level (cli, platform, network, factory, users)

<filter> is the identifier of the object being accessed; and

<configuration_info> is the set of parameter values to be applied to the <filter> object.

There are also commands which allow to perform actions not related to configuration.

Name

Description

help

Showing the list of available commands and short information on them. In addition to help, you can use ?.

To get a detailed command description, use the following command:

PMC> help <command_name>

or

PMC> ? <command_name>

Example:

PMC> ? ping ping - send ICMP ECHO_REQUEST to network host Usage: ping <Address> [size]

aux

Opening command line interface (CLI) of the main product. To return to PMC CLI, press "CTRL + ]"

autoboot

Starting autoboot command.

history

Showing command history.

ping

Sending ICMP Echo Request message to network hosts; the message is sent 5 times with 1 second interval. The command has an optional parameter --- size of the packet data.

reset

Resetting the device.

update

Updating software components or supporting elements.

The following components and elements can be updated:

  • pmc: updating Platform Management Controller firmware

  • pmc-backup: updating PMC backup image

  • boot: supporting software responsible for starting the main image

  • sys-recovery: supporting system which allows torestore the operating state of the device remotely and manually, for example, if the main image was corrupted.

The command has the following structure:

PMC> update firmware <pmc | pmc-backup | boot | sys-recovery> tftp <address> <filename>

where:

<address> is the TFTP server address

<filename> is the update file name

For example, to update PMC firmware, use the following command:

PMC> update firmware pmc tftp

To update SSH private key, use the following command:

PMC> update key ssh tftp

Important! The key should be generated in advance and saved in .der format.

version

Showing current version of PMC firmware.

configure

Entering the configuration mode. After running this command the console prompt changes to allow the use of set, delete, create, diff and revert commands. Commands for direct platform management (which are not stored in non-volatile memory) are processed immediately when a command is executed. Parameters which should be saved (at the moment it works for network parameters only) are applied and saved only after "exit" command is executed.

PMC> configure PMC# PMC# exit PMC>

exit

Exiting configuration mode and applying parameters. Or logging out from the terminal.