Для программно-аппаратных комплексов (ПАК) UserGate, оснащенных модулем управления PMC (Platform Management Controller), доступен интерфейс командной строки PMC CLI. С помощью команд интерфейса можно просматривать состояние элементов аппаратной платформы, осуществлять мониторинг работы платформы, управлять ее настройками и доступом к ней.

Подключиться к PMC можно через консольный порт или порт MGMT, расположенные на панели устройства UserGate. Подробнее о наличии модуля PMC в устройстве и типах имеющихся портов для подключения смотрите в документации на аппаратные платформы в разделе Аппаратные платформы.

PMC CLI имеет два основных режима работы — режим загрузчика и режим основного ПО PMC.

Для входа в PMC CLI необходимо нажать клавишу Enter во время вывода следующей строки в консоли устройства:

Hit 'Enter' key to stop autoboot:  3

Режим загрузчика (PMC-loader) предназначен для обеспечения возможности восстановления работоспособности программно-аппаратного комплекса. Режим загрузчика доступен только при подключении через консольный порт.

Строка приглашения в режиме загрузчика имеет вид:

loader>

В загрузчике работает таймер неактивности в CLI. Т.е. если в течение 45 секунд не вводилось никаких команд, то устройство будет перезагружено.

Для доступа в режим основного ПО PMC нужно ввести логин и пароль. При нажатии "Сtrl + ]" загрузка устройства продолжится в обычном режиме:

Press '^]' for autoboot and connect to aux
PMC login:

После трёх неудачных попыток входа, перед каждой следующей попыткой вводится обязательный 10-секундный тайм-аут. Во время тайм-аута можно сбросить настройки PMC к первоначальным с использованием комбинации клавиш "Ctrl + e".

PMC login: 111
Password:
You have exceeded the number of attempts, 10 seconds timeout...
 
All configuration will be cleared and device will be reset. Continue? (y/n):

По умолчанию логин/пароль в PMC CLI: admin/password.

В режиме основного ПО PMC существует два внутренних режима — режим просмотра и режим конфигурирования.

После того как пользователь авторизовался в консоли, он попадает в режим просмотра PMC CLI. В этом режиме могут выполнятся команды просмотра состояния и команды запуска некоторых утилит. Команды управления и конфигурирования устройства в этом режиме недоступны.

Символ приглашения в командной строке в режиме просмотра PMC CLI имеет вид: ">".

PMC>

Для перехода режим конфигурирования устройства PMC CLI используется команда configure. В режиме конфигурирования символ приглашения в командной строке меняется на: "#".

PMC> configure
PMC#
PMC# exit        
PMC>

Встроенная помощь

При нажатии клавиши "Tab" на любом этапе ввода команды отображается список возможных вариантов продолжения команды с кратким описанием.
Примеры:

PMC>
+ history         Display the history list
+ ftest           Factory autotest support
+ reset           Reset peripheral sub-system or board
+ autoboot        Run autoboot command
+ traceroute      Print the route to network host using ICMP
+ aux             AUX terminal support
+ version         Show version
+ show            Show parameter
+ exit            Logout/Save config and exit
+ configure       Configuration mode
+ debug           Debug mode
+ ping            Send ICMP ECHO_REQUEST to network host

PMC> au     
+ autoboot        Display the history list
+ aux             Factory autotest support

PMC# show           
+ network         Network-settings sub-system
+ date            pmc date and time settings
+ uptime          pmc uptime
+ users           Users-settings sub-system
+ factory         Factory-settings sub-system (Type, S/N, MAC)
+ platform        Platform-settings sub-system

PMC# show network s
+ ssh             SSH server settings
+ settings        Network settings
+ status          Network status

Структура команд

Все команды конфигурации в CLI имеют следующую структуру:

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

где:

<action> — действие, которое необходимо выполнить (create, set, show, delete).

<level> — уровень конфигурации (cli, platform, network, factory, users).

<filter> — идентификатор объекта, к которому происходит обращение.

<configuration_info> — значение параметров, которые необходимо применить к объекту <filter>.

Пример:

PMC> set network gateway 192.168.1.1

Также существуют команды, которые позволяют выполнить действия, не относящиеся к конфигурации. Эти команды имеют следующую структуру:

<util> <util_parameters>

где:

<util> — действия, не относящиеся к конфигурированию устройства:

util_parameters> — дополнительные параметры выполняемых действий.

Пример:

PMC> ping 192.168.1.1

Отображение (show)

Команда show выводит все значения на указанном уровне, и все, что находится глубже.

Пример:

PMC> show platform
------------------
Bypass map:
        Relay 1: port0 <-> port1
        Relay 2: port2 <-> port3
        Relay 3: port4 <-> port5
        Relay 4: port6 <-> port7
Bypass state:
        Relay 1: DISABLED
        Relay 2: DISABLED
        Relay 3: DISABLED
        Relay 4: DISABLED
------------------
Fan state:
        Mode:   auto
        Level:  255
        Speed:  0 RPM
------------------
SoC is Stopped
------------------
Power control signals:
    LS1084_IO_PWR: Enabled
    M2_PWR:     Enabled
    CORE_PWR:   Enabled
    DDR4_PWR:   Enabled
Power Inputs:
    POW_IN1:    None
    POW_IN2:    OK
PG signals:
    LS1084_IO_PWR_PG_E: OK
    CORE_PWR_PG_E:      OK
    DDR4_PWR_PG_E:      OK
    M2_PWR_PG_E:        OK
    USB_PWR_PG_E:       OK
    FPGA_PWR_PG_E:      OK
Voltages:
     VDD: 1.030V - OK
    SVDD: 1.018V - OK
    XVDD: 1.414V - OK
    DVDD: 3.378V - OK
    OVDD: 1.843V - OK
    GVDD: 1.257V - OK
    FPGA: 3.434V - OK
Currents:
     VDD: 2.668A - OK
    GVDD: 0.195A - OK
------------------
Temperature:
        Board                :  41.000 C
        CPU                   :  44.500 C
        ALERT signal         : Inactive
------------------

Если нужна только информация о температуре:

PMC> show platform therm
Temperature:        
        Board                :  41.000 C
        CPU                   :  44.500 C
        ALERT signal         : Inactive

Если нужны только значения температуры:

PMC> show platform therm value
 
Temperature:
        Board:  41.000 C
        CPU:    43.500 C

Вывод телеметрии

Показания с некоторых датчиков собираются в журналы. Журналы хранятся за последние 60 секунд, 60 минут и 72 часа. Есть два возможных формата вывода такой информации: графический (graph) и текстовый (log).
Пример вывода телеметрии в графическом формате: