Platform Management

Configuration level platform is corresponding to this section. Commands at this level allow to manage components of the UserGate device.

Name

Description

bypass

Management commands are performed at the platform bypass level. This section implements managing the state of bypass relays of network ports and viewing the current state and mapping of the relays.

Set command format:

PMC> set platform bypass <relay-number> <state> PMC> set platform bypass all <state>

where:

is the number of the relay which is configured

is the state of the relay. Available values:

  • enable: global setting; it allows to use relay functionality. When the power is off, the relay will be closed. The value is stored in non-volatile memory (if the relay is set to enable, then after the device is restarted the relays will remain closed, until the opening command is sent).

  • disable: global setting; the value is stored in non-volatile memory (if the relay is set to disable, then after the device is restarted the relays will open while PMC is restarted).

  • on: closing of the bypass relay (traffic is bypassing the processor). The state is reset after the device is restarted.

  • off: opening of the bypass relay (traffic is bypassing the processor). The state is reset after the device is restarted.

To view the states of the relay, use the following command:

PMC> show bypass

fan

This section is located at the platform fan level. The commands described in this section allow you to monitor the operation of the cooling fan.

To show the current state, use the following command:

PMC> show platform fan

soc

To start or stop the processor, use the following command:

PMC> set platform soc <start | stop>

To view the status of the processor, use the following command:

PMC> show platform soc

accelerator

The command for monitoring the hardware accelerator (only for models with hardware accelerators).

To view the status of the hardware accelerator, use the following command:

PMC> show platform accelerator

therm

Temperatures of the host processor and of the board are monitored at the platform therm level.

To view the current status, use the following command:

PMC> show platform therm

To view the temperatures of the host processor and the board only, use the following command:

PMC> show platform therm value

power

The section of power source monitoring is located at the platform power level. To view the information on the working state of power sources, use the following command:

PMC> show platform power

The following parameters can also be specified:

  • status: the state of power sources

  • measurements: current and voltage readings.

The next command turns on/off all power except for backup power, i. e. PMC keeps working:

PMC> set platform power <on | off>

To view the information on all parameters available at the given configuration level, use the following command:

PMC> show platform