13.2. Platform Management

The chapter is corresponding to the platform configuration level. The commands are used for UserGate device component management.

Parameter

Description

bypass

Commands to view and configure the bypass relay are located at the platform bypass level.

The format of bypass configuring commands is the following:

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

where <relay-number> is the desired relay number; and

           <state> is the relay state. Bypass relay can be in the following states:

  • enable is a global setting that allows to use bypass relay. If the power is off, the relays will be closed. Parameter value is saved in non-volatile memory, i.e., if bypass relay is set to enable, relay remains closed until the opening command executed.

  • disable is a global setting that saved in non-volatile memory, i.e., if bypass relay is set to disable, after the device is restarted, the relays will open during the PMC restart.

  • on intended closure of the bypass relay (traffic goes past the processor). The state is reset after a restart.

  • off intended for opening of the bypass relay (traffic goes through the processor). The state is reset after a restart.

To view the current state, use the following command:

PMC> show bypass

fan

This section is located at the platform fan level. The commands allow configuration of fan mode and monitoring its operation.

There are 2 modes the fan can operate in: automatic and manual. By default, the fan operates in automatic mode. Fan speed is controlled in accordance with the temperature readings. To update the fan mode, use the command:

PMC> set platform fan mode <auto | manual>

The fan speed can be set in manual mode as a percentage:

PMC> set platform fan speed <0 - 100>

To view the current state, use the following command:

PMC> show platform fan

soc

Commands to start or stop processor operation are the following:

PMC> set platform soc <start | stop>

therm

The section allows monitoring of the host processor and board temperature and located at the platform therm level. You can control the maximum temperature value, if the value is exceeded, a temperature failure will occur. To set the value use the following command:

PMC> set platform therm threshold <limit>

where <limit> is the threshold value

To view the current state, use the following command:

PMC> show platform therm

To display the host processor and board temperature values only, use the following command:

PMC> show platform therm value

power

Commands for power supplies monitoring are located at the platform power level. To view the current state of power supplies, use the following command:

PMC> show platform power

The following parameters can be specified:

  • status is power supplies state;

  • measurements are currents and voltages readings.

The following command intended to turn on/off power except the standby one that means PMC continues to work:

PMC> set platform power <on | off>

To display information about all parameters available at this level, use the following command:

PMC> show platform