13. Platform Management Controller Command LIne Interface

Platform Management Controller Command Line Interface (PMC CLI) is available for HSC UserGate C150 and X10 to monitor and configure device.

The command structure of the PMC CLI is identical to the command structure of the UserGate NGFW CLI:

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

where <action> is the action to be performed (create, set, show, delete);

           <level> is the configuration level (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 some commands not related to UserGate configuration:

Parameter

Description

help

Display the list of available commands and brief information about them. In addition to the help command, ? can be used.

To display information about the command, use the command with the following structure:

PMC> help <command_name>

or

PMC> ? <command_name>

For example,

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

aux

Switch to the UserGate NGFW CLI. To return to the PMC CLI use the keyboard CTRL + ] shortcut.

autoboot

Execute the autoboot command.

history

View command history.

ping

Ping a specific host. Executing ICMP Echo Request for 5 times with the 1 second interval between packets. Data packet size can be specified optionally.

reset

Restart the UserGate device.

update

Update software components or auxiliary elements.

Elements can be updated are the following:

  • pmc is intended for Platform Management Controller firmware update.

  • pmc-backup is intended for PMC backup image update.

  • boot is an auxiliary software that launches the main image.

  • sys-recovery is an auxiliary software for remote recovery of the device functionality in manual mode, e.g., in case the image was damaged.

The command has the following structure:

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

where <address> is the address of the TFTP server; and

           <filename> is the update filename.

For example, the following command is used for PMC firmware update:

PMC> update firmware pmc tftp <address> <filename>

The SSH private key update command has the following structure:

PMC> update key ssh tftp <address> <filename>

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

version

Display the current version of PMC firmware.