Platform Management Controller Command Line Interface
 
Команды управления платформой

 Данному разделу соответствует уровень конфигурации platform. Команды данного уровня позволяют управлять компонентами устройства UserGate.

Настройка работы bypass-реле

Данная функциональность присутствует не на всех устройствах.

Команды управления выполняются на уровне platform bypass. В данном разделе реализовано управление состоянием bypass-реле сетевых портов, а также просмотр текущего состояния реле.

Формат команды установки:

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

где:

<relay-number> — номер конфигурируемого реле.

 <state> — состояние реле. Возможны следующие значения:

  • enable — глобальная настройка; позволяет использовать функцию реле. При отключенном питании реле будут замкнуты. Значение сохраняется в энергонезависимой памяти (если реле установлено в состояние enable, то после перезапуска устройства реле останется замкнутыми, пока не будет отправлена команда на размыкание).

  • disable — глобальная настройка; значение сохраняется в энергонезависимой памяти (если реле установлено в состояние disable, то после перезапуска устройства реле разомкнется в процессе перезапуска PMC).

  • on — замыкание bypass-реле (трафик идёт мимо процессора). Состояние сбрасывается после перезапуска.

  • off — размыкание bypass-реле (трафик идёт через процессор). Состояние сбрасывается после перезапуска.

Примеры команд:

<configure>
PMC# set platform bypass all enable
Enable all bypass relays
PMC# set platform bypass 1 disable
Disable bypass relay 1
PMC# set platform bypass 3 off    
Set bypass relay 3 state OFF
PMC#

Пример вывода команды просмотра состояния:

PMC> show platform bypass
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: ON
        Relay 3: OFF
        Relay 4: ON
PMC>

Мониторинг вентиляторов охлаждения

Данный раздел находится на уровне platform fan. Команды данного раздела позволяют производить мониторинг работы вентилятора охлаждения.

Команда для отображения текущего состояния:

PMC> show platform fan [status|graph|log]

PMC> show platform fan
Fan state:
        Mode:   manual
        Level:  40
        Speed:  6029 RPM
PMC>

Параметры graph и log относятся к выводу телеметрии.

Запуск/остановка хост-процессора, просмотра сохранённых логов

Команда для запуска или остановки процессора:

set platform soc <start|stop>

Команда просмотра статуса процессора:

show platform soc [log|load|frequency|mem]

Параметры load|frequency|mem относятся к выводу телеметрии.

Пример вывода:

PMC> show platform soc
SoC is Running
System time: 08.06.2023 02:47:35
System uptime: 0 day(s), 0 hour(s), 12 minute(s)
Load average: 0.52 0.36 0.31
MemTotal: 61218 MiB
MemFree: 55064 MiB
CPU Frequency: 2200 MHz (Max 2200 MHz)

Формат команды просмотра последнего вывода CPU:

PMC> show platform soc log
NOTICE:  UDIMM M471A1K43EB1-CWE
...
Server is starting, please wait...
Please press Enter to activate this console.
[   15.495488] kmodloader: loading kernel modules from /etc/modules.d/*
[   15.506171] kmodloader: done loading kernel modules from /etc/modules.d/*
[   15.577127] random: crng init done
[   15.580535] random: 4 urandom warning(s) missed due to ratelimiting
[   22.759147] IPv6: ADDRCONF(NETDEV_UP): port0: link is not ready

Управление работой аппаратного ускорителя

Присутствует только на моделях с аппаратным ускорителем (UserGate FG).

Команда для запуска или остановки аппаратного ускорителя:

set platform accelerator <start|stop>

Для просмотра статуса аппаратного ускорителя:

PMC> show platform accelerator

Мониторинг температуры 

Мониторинг температуры хост-процессора и платы производится на уровне platform therm

Для просмотра текущего состояния:

PMC> show platform therm [value|status|graph|log]

Параметры graph и log относятся к выводу телеметрии.

Для просмотра только значений температуры хост-процессора и платы:

PMC> show platform therm value

Пример:

PMC> show platform therm
Temperature:
        Board                 :  58.000 C
        CPU                   :  68.750 C
        ALERT signal         : Inactive PMC>                     
PMC> show platform therm value
Temperature:
        Board:  57.000 C
        CPU:    69.000 C
PMC>

Мониторинг источников питания

Раздел мониторинга источников питания производится на уровне platform power. Для отображения информации о рабочем состоянии источников питания используется команда:

show platform power [status|measurements|graph|log]

Параметры graph и log относятся к выводу телеметрии.

Пример:

PMC> show platform power
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.039V - OK
    SVDD: 1.012V - OK
    XVDD: 1.401V - OK
    DVDD: 3.382V - OK
    OVDD: 1.845V - OK
    GVDD: 1.245V - OK
    FPGA: 3.404V - OK
Currents:
     VDD: 7.006A - OK
    GVDD: 0.473A - OK
PMC>
PMC> show platform power measurements
Voltages:
     VDD: 1.040V - OK
    SVDD: 1.013V - OK
    XVDD: 1.403V - OK
    DVDD: 3.384V - OK
    OVDD: 1.846V - OK
    GVDD: 1.248V - OK
    FPGA: 3.404V - OK
Currents:
     VDD: 7.018A - OK
    GVDD: 0.516A - OK
PMC>

 Команда для включения/отключения всего питания, кроме дежурного, т.е. PMC продолжает работу:

PMC> set platform power <on | off>

Выключение:

PMC> set platform power off
PMC[Netcard]: Power supplies are turned off.
PMC[PWR]: Power supplies are turned off.

Включение:

PMC> set platform power on 
PMC[PWR]: Signal 'V3V3_PG_E' ready
PMC[PWR]: Signal 'KSZ_PG_E' ready
PMC[PWR]: Signal 'OVDD_PG_E' ready
PMC[PWR]: Signal 'USB_5V0_PG_E' ready
PMC[PWR]: Signal 'USB_SVDD_PG_E' ready
Configure Clock Generator (5P49V6901):
...........................OK
PMC[PWR]: Signal 'SVDD_PG_E' ready
PMC[PWR]: Signal 'GVDD_PG_E' ready
PMC[PWR]: Signal 'TA_BB_PG_N_E' ready
PMC[Netcard]: Power supplies started.
Configure Clock Generator (CDCM6208V2):
......OK
Configure Clock Generator (CDCM6208V2):
......OK
Configure Clock Generator (CDCM6208V2):
......OK
PMC[PWR]: Power supplies started.
PMC>

Мониторинг аварий

Данный раздел находится на уровне platform alarm.
В данном разделе PMC CLI есть возможность просмотра и очистки журнала аварий, и управления звуковым сигналом аварии (на старших платформах, начиная с D250).

Вывод журнала аварий:

PMC> show platform alarm log
01.07.2023 14:12:07 [POWER] VDD: Over/Under voltage condition detected
03.07.2023 11:13:14 [POWER] AVDD: Power good signal missing
05.07.2023 09:16:45 [POWER] GVDD: Over current condition detected
10.07.2023 15:16:47 [POWER] Power input 1: Present signal missing
12.07.2023 20:58:32 [POWER] Power input 2: Vin under voltage condition detected
15.07.2023 03:41:27 [POWER] Power input 2: Vout over/under voltage condition detected
15.07.2023 21:14:48 [POWER] Power input 1: Over current condition detected
18.07.2023 10:52:38 [POWER] Power input 2: Over heat condition detected
19.07.2023 02:29:46 [POWER] Power input 1: Fan fault condition detected
19.07.2023 23:09:56 [THERM] FPGA/SoC/PHY: Over heat condition detected
20.07.2023 06:14:31 [THERM] Common: Over heat shutdown occurred
21.07.2023 15:35:27 [THERM] FAN 1: Present signal missing
23.07.2023 21:59:31 [THERM] FAN 2: Wrong direction detected
25.07.2023 16:51:46 [THERM] FAN 3: Over current condition detected
27.07.2023 17:36:17 [THERM] FAN 4: Tachometer signal missing
29.07.2023 12:31:24 [THERM] FAN 5: Tachometer readings do not match the control signal
30.07.2023 10:39:54 [SYS] SoC: Main processor not respond
30.07.2023 19:48:26 [SYS] SoC: Main processor rebooted
31.07.2023 14:51:55 [SYS] SoC: High CPU load detected
31.07.2023 19:25:38 [SYS] SoC: High memory usage detected

Отображение глобального статуса аварии:

PMC# show platform alarm status
Alarm disabled

Очистка журнала аварий:

PMC# delete platform alarm log
Alarm log cleared

Управление звуковым сигналом аварии (доступно не на всех платформах):

PMC# set platform alarm on
Alarm enabled
PMC# set platform alarm off
Alarm disabled

Команды управления настройками пользователей

 Команды управления настройками пользователей доступны на уровне users. В данном разделе возможно создание и удаление пользователей, а также настройка методов авторизации на SSH-сервере. Устройство позволяет завести до 10 пользователей.

По умолчанию всегда есть один пользователь admin с паролем по умолчанию password.

PMC> show users
------------------
User1:
Login: admin
Public key type:
Public key:
Authentication methods: password
------------------
PMC>

Создание пользователя

Для создания пользователя используется следующая команда:

PMC> create users <username>

После создания пользователю необходимо задать пароль или публичный ключ. До задания способа авторизации пользователь не может быть использован.

Пример создания пользователя:

PMC> create users slon
New user slon created
PMC> show users slon
Login: slon
Public key type:
Public key:
Authentication methods: none
PMC>

Настройка метода авторизации

В качестве методов авторизации допускается использование пароля и публичного ключа ECDSA. Для пользователя может быть задан один или сразу оба метода авторизации.

Чтобы отключить один из методов авторизации, удалите ключ или пароль. Используйте команду с действием delete.

Пример:

PMC> set users slon password
Changing password for slon
Enter new password:
Retype new password:
Password for user slon setted
PMC> show users slon
Login: slon
Public key type:
Public key:
Authentication methods: password
PMC>
PMC> set users slon key ecdsa-sha2-nistp256 AAAAE2VjZHNhLXNoYTItbmlzdHAyNTYAAAAIbmlzdHAyNTYAAABBBEs+nzq8LrO0OeniYHTYnTPtbc+CKaLAgvKz+3faiu5qQT7VN1kaPKx1hBV/e3HFzCen3XMVPerkOUEx0q2WrV0=
Public key for user slon setted
PMC>
PMC> show users slon
Login: slon
Public key type: ecdsa-sha2-nistp256
Public key: AAAAE2VjZHNhLXNoYTItbmlzdHAyNTYAAAAIbmlzdHAyNTYAAABBBEs+nzq8LrO0OeniYHTYnTPtbc+CKaLAgvKz+3faiu5qQT7VN1kaPKx1hBV/e3HFzCen3XMVPerkOUEx0q2WrV0=
Authentication methods: password public_key
PMC> PMC> delete users slon password
password for user slon deleted
PMC>PMC> show users slon           
Login: slon
Public key type: ecdsa-sha2-nistp256
Public key: AAAAE2VjZHNhLXNoYTItbmlzdHAyNTYAAAAIbmlzdHAyNTYAAABBBEs+nzq8LrO0OeniYHTYnTPtbc+CKaLAgvKz+3faiu5qQT7VN1kaPKx1hBV/e3HFzCen3XMVPerkOUEx0q2WrV0=
Authentication methods: public_key
PMC>

Удаление пользователя

Для удаления пользователей используется команда delete:

PMC> delete users slon
User slon deleted
PMC> show users
------------------
User1:
Login: admin
Public key type:
Public key:
Authentication methods: password
------------------
PMC>

Команды управления настройками сети

 Команды управления настройками сети доступны на уровне network. В данном разделе доступна установки и просмотр следующих параметров:

  • dhcp — включение/отключение клиента DHCP.

  • ip — статический IP-адрес устройства.

  • netmask — маска сети устройства.

  • gateway — шлюз по умолчанию.

  • vlan — VLAN ID сети устройства.

  • arp — статические и динамические arp записи.

  • ssh-port — порт для входящих подключений SSH сервера.

  • nameserver — адрес DNS сервера.

  • rule — правила доступа к порту MGMT. Управление белыми и черными списками адресов.

Команда просмотра текущего состояния интерфейса:


PMC> show network status
------------------------------------
Network status:
IP address type: static
IP address: 192.168.1.6
Gateway address: 192.168.1.1
Netmask: 255.255.255.0
------------------------------------

Просмотр сетевых настроек:

PMC> show network                               
------------------------------------
Network status:
IP address type: static
IP address: 192.168.1.6
Gateway address: 192.168.1.1
Netmask: 255.255.255.0
------------------------------------
Network settings:
DHCP: off
IP address: 192.168.1.6
Gateway address: 192.168.1.1
Netmask: 255.255.255.0/24
VLAN id: 0
SSH server port: 22
DNS address: 0.0.0.0
URL (for UGOS updating): none
------------------------------------
 Address         HWaddress               Flags
192.168.1.80    34:67:8A:4F:91:10       static
192.168.1.1     50:3E:AA:16:2B:97       dynamic
------------------------------------
Access rules:
------------------------------------
Type: ip range
Start address: 192.168.1.1
End address: 192.168.1.10
Access: Drop
------------------------------------
 
PMC>
PMC> show network arp
Address         HWaddress               Flags
192.168.1.80    34:67:8A:4F:91:10       static
PMC>

После установления значений сетевые настройки применяются и сохраняются в энергонезависимую память.

Для сброса к значениям по умолчанию используется команда delete:

delete network [ip|netmask|gateway|arp|vlan|ssh-port]

При выполнении команды без параметров все сетевые настройки сбрасываются к значениям по умолчанию:

PMC> show network
------------------
IP address: 192.168.1.75
Gateway address: 192.168.1.10
Netmask: 255.255.255.128
VLAN id: 12
SSH server port: 4001
------------------
Address         HWaddress               Flags
192.168.1.80    34:67:8A:4F:91:10       static
------------------
PMC> delete network vlan
Set default vlan complete
PMC>PMC> show network
------------------
IP address: 192.168.1.75
Gateway address: 192.168.1.10
Netmask: 255.255.255.128
VLAN id: 0
SSH server port: 4001
------------------
Address         HWaddress               Flags
192.168.1.80    34:67:8A:4F:91:10       static
------------------
PMC> delete network
Using default configuration
 
PMC> show network
------------------
IP address: 192.168.1.2
Gateway address: 192.168.1.1
Netmask: 255.255.255.0
VLAN id: 0
SSH server port: 22
------------------
Address         HWaddress               Flags
------------------
PMC>
PMC> delete network rule
Access rules cleared successfully

dhcp

По умолчанию DHCP выключен и используется заданный в настройках IP-адрес.

Команда включения DHCP:

PMC> set network dhcp on
DHCP client start complete
PMC>

Посмотреть полученные по DHCP настройки можно следующей командой:

PMC> show network status
------------------------------------
Network status:
IP address type: dhcp
IP address: 192.168.75.238
Gateway address: 192.168.75.1
Netmask: 255.255.255.0
------------------------------------
PMC>

ip

Статический IP-адрес, по умолчанию имеет значение 192.168.1.2.

Пример команды задания IP-адреса:

PMC> set network ip 192.168.1.75
Set ip complete
PMC> show network ip
IP address: 192.168.1.75
PMC>

IP-адрес можно задать с указанием маски подсети:

PMC> set network ip 192.168.75.88/24
Set ip address complete
PMC> set network ip 192.168.75.88 255.255.255.0
Set ip address complete
PMC>

gateway

Шлюз по умолчанию, после сброса настроек имеет значение 192.168.1.1.

Для изменения значения используется следующая команда:

PMC> set network gateway 192.168.1.10
Set gateway complete
PMC> show network gateway
Gateway address: 192.168.1.10
PMC>

nameserver

По умолчанию адрес DNS-сервера не задан и имеет значение 0.0.0.0.

Для изменения значения используется следующая команда:

PMC> set network nameserver 192.168.1.1
Set nameserver complete
PMC>

Для просмотра значения:

PMC> show network nameserver
DNS address: 192.168.1.1
PMC>

vlan

По умолчанию VLAN ID установлен в значение 0.

При этом устройство получает все пакеты и при отправлении не использует VLAN tag.

Если значение vlan установлено в ненулевое значение, все пакеты, приходящие с тегом, отличным от установленного, или без тэга, фильтруются.

При отправке в ethernet-заголовок добавляется установленный tag.

Для изменения значения используется следующая команда:

PMC> set network vlan 12
Set vlan complete
PMC> show network vlan
VLAN id: 12
PMC>

arp

Arp-таблица устройства по умолчанию пустая. При общении с другими узлами сети в неё добавляются динамические записи, которые имеют небольшое время жизни и после перезапуска всегда сбрасываются.

Есть возможность задать статические записи с парами ipaddr/hwaddr. Если IP-адрес назначения присутствует в таблице, при отправке пакета устройство не делает arp-запрос, а сразу подставляет в ethernet-заголовок MAC-адрес из таблицы.

Для добавления статических arp-записей используется команда следующего формата:

set network arp <ip addr> <hw addr>

Для удаления:

delete network arp [ip addr]

При выполнении delete без указания адреса удаляются все записи.

Пример команд:

PMC> set network arp 192.168.1.55 34:67:8A:4F:91:55
PMC> show network arp
Address         HWaddress               Flags
192.168.1.80    34:67:8A:4F:91:10       static
192.168.1.65    34:67:8A:4F:91:43       static
192.168.1.55    34:67:8A:4F:91:55       static
PMC> delete network arp 192.168.1.65
PMC> show network arp
Address         HWaddress               Flags
192.168.1.80    34:67:8A:4F:91:10       static
192.168.1.55    34:67:8A:4F:91:55       static
PMC> delete network arp             
PMC> show network arp
Address         HWaddress               Flags
PMC>

ssh-port

Порт для входящих подключений PMC SSH-сервера. По умолчанию имеет значение 22.

Для изменения значения используется следующая команда:

PMC> set network ssh-port 4001
Set ssh-port complete
PMC> show network ssh-port
SSH server port: 4001
PMC>

rule

Правила доступа к MGMT-порту. Позволяет составлять белые и черные списки IP-адресов для доступа к PMC.

Добавление и удаление правил возможно только в режиме конфигурирования. Правила применяются во время выхода из режима конфигурирования по команде exit.

Примеры добавления правил:

PMC> set network rule allow 192.168.1.1 192.168.1.20
Access rule added successfully
PMC> set network rule drop 192.168.1.5 192.168.1.10
Access rule added successfully

Просмотр правил:

PMC> show network rule
Access rules:
------------------------------------
Type: ip range
Start address: 192.168.1.1
End address: 192.168.1.20
Access: Allow
------------------------------------
Type: ip range
Start address: 192.168.1.5
End address: 192.168.1.10
Access: Drop
------------------------------------
PMC>

Удаление правил:

PMC> delete network rule 192.168.1.1 192.168.1.20
Access rule deleted successfully
PMC>

Команды для работы с заводскими параметрами

Данные параметры устанавливаются один раз — в ходе производственного тестирования. Далее параметры доступны только для чтения.

Для отображения параметров:

PMC> show factory

Укажите параметр, чтобы посмотреть его значение:

  • sn —серийный номер устройства.

  • type —тип устройства.

  • mac — физический адрес (МАС-адрес).

PMC> show factory
Factory-settings:
        Device Type: UGAC-101
        S/N:         UGAC21430000015
        Base MAC:    34:91:6F:00:00:7F
 
PMC>
 
PMC> show factory mac
34:91:6F:00:00:7F
PMC>

Команды execute

В данном разделе доступны следующие команды:

  • autoboot;

  • aux;

  • history;

  • ping;

  • traceroute;

  • reset;

  • update;

  • version;

  • configure;

  • diff;

  • revert;

  • exit.

autoboot

Выполнение этой команды в режиме загрузчика запускает основную прошивку PMC.

loader> autoboot
 
Try to load primary-image:
Reading 16 bytes (0x10) at offset 0x7000000 ... OK (0 KiB/s)
Reading 270664 bytes (0x42148) at offset 0x7000010 ... OK (87 KiB/s)
 
## Starting application at 0x24000000 ...

Выполнение этой команды в режиме PMC запускает хост-процессор и включает aux-режим.
При выполнении команды без параметров запускается основной образ UGOS, при добавлении параметра recovery запускается recovery-образ:

PMC> autoboot
Connected to CPU at speed 115200.
Escape character is '^]'.
 
NOTICE:  UDIMM M471A1K43EB1-CWE  
NOTICE:  Build-in self test passed
 
NOTICE:  8 GB DDR4, 64-bit, CL=15, ECC off
NOTICE:  BL2: v2.4(release):
NOTICE:  BL2: Built : 03:40:29, Dec 30 2021
NOTICE:  BL2: Booting BL31
NOTICE:  BL31: v2.4(release):
NOTICE:  BL31: Built : 03:40:29, Dec 30 2021
NOTICE:  Welcome to ls1088ardb BL31 Phase
 
 
U-Boot 2021.04 (Dec 30 2021 - 03:40:29 +0000), Build: test-p4_ugos_g-380

aux

Подключение к терминалу хост-процессора. Для возвращения в PMC CLI используется комбинация клавиш "Ctrl + ]":

PMC> aux
Connected to CPU at speed 115200.
Escape character is '^]'.
 
UGOS login:
UGOS login: ^]
Disconnected from CPU
 
PMC>

history

Выводит список выполненных ранее команд:

PMC> history
9 history
8 version
7 show network
6 show platform fan
5 show date
4 show factory
3 version
2 aux
1 autoboot
PMC>

ping

Отправка ICMP ECHO-запроса. Выполняется 5 раз с интервалом 1 секунда. В качестве опционального параметра можно задавать размер данных в пакете.
Выполнение команды можно остановить сочетанием клавиш "Сtrl + С":

PMC> ping 192.168.1.1
40 bytes from 192.168.1.1: icmp_seq=1 ttl=64 time=0 ms
40 bytes from 192.168.1.1: icmp_seq=2 ttl=64 time=0 ms
40 bytes from 192.168.1.1: icmp_seq=3 ttl=64 time=0 ms
40 bytes from 192.168.1.1: icmp_seq=4 ttl=64 time=0 ms
40 bytes from 192.168.1.1: icmp_seq=5 ttl=64 time=0 ms
--- 192.168.1.1 ping statistics ---
5 packets transmitted, 5 received, 0% packet loss
rtt min/avg/max = 0/0/0 ms
PMC>
 
PMC>
PMC> ping 192.168.1.1 1400
1408 bytes from 192.168.1.1: icmp_seq=1 ttl=64 time=1 ms
1408 bytes from 192.168.1.1: icmp_seq=2 ttl=64 time=0 ms
1408 bytes from 192.168.1.1: icmp_seq=3 ttl=64 time=0 ms
1408 bytes from 192.168.1.1: icmp_seq=4 ttl=64 time=0 ms
1408 bytes from 192.168.1.1: icmp_seq=5 ttl=64 time=0 ms
--- 192.168.1.1 ping statistics ---
5 packets transmitted, 5 received, 0% packet loss
rtt min/avg/max = 0/0/1 ms
PMC>

traceroute

Проверка маршрута до запрашиваемого IP-адреса:

PMC> traceroute 192.168.70.11
traceroute to 192.168.70.11(192.168.70.11) 30 hops max 32(40) bytes of data
1    192.168.75.1 299 ms 94 ms 4 ms
2    192.168.70.11 0 ms 0 ms 0 ms

reset

Перезапуск устройства:

PMC> reset
 
PMC(Loader) Firmware 1.0 build dev (2021-12-27 - 10:01:23)
 
MCU: dev_id 0x450, rev_id 0x2003
Flash size: 128 KiB
Booting from Flash
Watchdog: Enabled
PMC[PWR]: Power Input 1 in state None
PMC[PWR]: Power Input 2 in state OK
PMC[PWR]: Power supplies are turned off.
Configure Clock Generator (SI5332):
.................OK
PMC[PWR]: Power supplies started.

update

Загрузка во flash-память устройства образов ПО и ключей безопасности. Доступна только в режиме конфигурирования.

Обновление ПО производится командой:

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

Для обновления приватного ключа SSH-сервера используется следующая команда:

update key ssh tftp <address> <filename>

Ключ должен быть предварительно сгенерирован и сохранен в формате .der.

Для генерации ключа можно использовать следующую команду:

openssl ecparam -genkey -name prime256v1 -noout -outform DER -out privatekey.der

version

Вывод текущей версии прошивки PMC:

PMC> version
PMC(Main) Firmware 7.1.0 build 249B (2023-06-07 - 03:55:58)
PMC>

Вывод версии загрузчика:

PMC> version loader
PMC(Loader) Firmware 7.1.3 build 425DEV (2024-08-19 - 23:35:33)
PMC>

configure

Вход в режим конфигурирования. После выполнения этой команды меняется приглашение в консоли и появляется возможность использования команд setdeletecreatediffrevert. Команды непосредственного управления платформой (которые не сохраняются в энергонезависимой памяти) отрабатывают сразу при выполнении команды. Настройки, требующие сохранения, применяются и сохраняются только после команды exit.

PMC> configure
PMC#
PMC# exit        
PMC>

diff

Команда показывает отличия применённой конфигурации и установленной в данный момент в режиме конфигурирования. Доступна только в режиме конфигурирования:

PMC# diff
IP address:
 old: 192.168.75.92 new: 192.168.75.96
Netmask:
 old: 255.255.255.0 new: 255.255.0.0
DHCP:
 old: off new: on
PMC#

revert

Команда сброса временной конфигурации. Доступна только в режиме конфигурирования:

PMC# revert
Temporary configuration revert complete
PMC# diff
Configuration not changed
PMC#

exit

В режиме конфигурирования запуск команды приводит к выходу из режима конфигурирования. Если была изменена конфигурация, команда применяет и сохраняет её:

PMC# set network ip 192.168.75.96
Set ip address complete
PMC# exit
New configuration apply complete
PMC>

В режиме просмотра запуск команды выполняет выход из терминала (в случае SSH — разрывает соединение):

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

Общие сведения

 Для программно-аппаратных комплексов (ПАК) 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).
Пример вывода телеметрии в графическом формате:

Пример вывода телеметрии в текстовом формате:

Можно вывести таблицу или график только за определённый период: minute/hour/day:

PMC> show platform soc mem graph hour