Platform Management Controller Command Line Interface
 
Общие сведения

Для программно-аппаратных комплексов (ПАК) UserGate доступен PMC CLI, предназначенный для мониторинга и управления устройством UserGate.

Структура команд PMC CLI идентична структуре команд CLI основного продукта:

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

где:

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

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

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

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

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

Наименование

Описание

aux

Переход в интерфейс командной строки (CLI) основного продукта. Для возвращения в PMC CLI используется комбинация клавиш «CTRL + ]»

autoboot

Запуск команды автозагрузки.

history

Вывод истории команд.

ping

Отправка сообщение ICMP Echo Request к хостам сети; выполняется 5 раз с интервалом в 1 секунду. В качестве опционального параметра можно задать размер данных в пакете.

reset

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

update

Обновление компонентов программного обеспечения (ПО) или вспомогательных элементов.

Для обновления доступны:

  • pmc — обновление прошивки Platform Management Controller.

  • pmc-backup — обновление резервного образа PMC.

  • boot — вспомогательное ПО, занимающееся запуском основного образа.

  • sys-recovery — вспомогательная система, позволяющая удалённо в ручном режиме восстановить работоспособность устройства, например, если основной образ был повреждён.

Команда имеет следующую структуру:

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

где:

<address> - адрес сервера TFTP.

<filename> - название файла обновления.

Например, команда обновления прошивки PMC:

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

Обновление приватного ключа SSH:

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

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

version

Отображение текущей версии:

  • version — отображение текущей версии прошивки PMC;

  • version loader — отображение версии загрузчика;

  • version ncpmc — отображение версии прошивки ускорителя (для модели FG).

configure

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

PMC> configure
PMC#
PMC# exit        
PMC>

exit

Выход из режима конфигурирования и применение настроек. Или logout из терминала.

Управление платформой

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

Наименование

Описание

bypass

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

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

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 реле (трафик идёт через процессор). Состояние сбрасывается после перезапуска.

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

PMC> show bypass

fan

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

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

PMC> show platform fan

soc

Для запуска или остановки процессора необходимо выполнить команду:

PMC> set platform soc <start | stop>

Для просмотра статуса процессора:

PMC> show platform soc

accelerator

Команда мониторинга работы аппаратного ускорителя (присутствует только на моделях с аппаратным ускорителем).

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

PMC> show platform accelerator

therm

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

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

PMC> show platform therm

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

PMC> show platform therm value

power

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

PMC> show platform power

Также доступно указание следующих параметров:

  • status – состояние источников питания.

  • measurements – показания токов и напряжений.

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

PMC> set platform power <on | off>

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

PMC> show platform

Управление настройками сети

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

Наименование

Описание

dhcp

Включение выключение DHCP клиента.

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

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

PMC> set network dhcp on

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

PMC> show network status

ip

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

Для выставления IP-адреса используется команда:

PMC> set network ip <IP_adrress>

Чтобы отобразить IP-адрес устройства:

PMC> show network ip

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

PMC> delete network ip

netmask

Маска подсети; значение по умолчанию: 255.255.255.0.

Команда изменения значения маски подсети:

PMC> set network netmask <netmask_value>

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

PMC> show network netmask

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

PMC> delete network netmask

gateway

Шлюз по умолчанию; значение по умолчанию: 192.168.1.1.

Команда для изменения значения шлюза по умолчанию:

PMC> set network gateway <gateway_address>

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

PMC> show network gateway

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

PMC> delete network gateway

vlan

Идентификатор VLAN; значение по умолчанию – 0. Устройство получает все пакеты и при отправке не использует VLAN Tag. Если значение отлично от 0, то все пакеты, приходящие с тегом, отличным от выставленного, или без тега, фильтруются. При отправке в Ethernet-заголовок добавляется указанное значение параметра.

Для изменения значения:

PMC> set network vlan <VLANID_value>

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

PMC> show network vlan

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

PMC> delete network vlan

arp

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

Существует возможность добавления статических ARP-записей. При добавлении необходимо указать IP и MAC. Если IP-адрес назначения присутствует в таблице, то при отправке пакета устройство не делает ARP-запрос, а сразу подставляет в Ethernet-заголовок MAC-адрес из таблицы.

Для добавления статических ARP-записей:

PMC> network arp <IP_address> <HW_address>

Чтобы отобразить таблицу ARP:

PMC> show network arp

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

PMC> delete network arp

Помимо очистки всей таблицы доступно удаление отдельной записи ARP; для удаления необходимо указать IP-адрес:

PMC> delete network arp <IP_address>

ssh-port

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

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

PMC> set network ssh-port <port_number>

Чтобы отобразить текущее значение параметра:

PMC> show network ssh-port

Чтобы вернуть значение параметра по умолчанию:

PMC> delete network ssh-port

nameserver

Адрес DNS сервера.

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

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

PMC> set network nameserver <IP-address>

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

PMC> show network nameserver

rule

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

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

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

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

PMC> delete network rule <IP-addresses>

Чтобы отобразить значения всех параметров уровня network

PMC> show network

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

С использованием действия delete производится сброс параметров до значений по умолчанию (всех параметров или конкретного):

PMC> delete network

Работа с заводскими параметрами

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

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

PMC> show factory

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

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

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

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

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

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

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

PMC> create users <username>

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

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

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

Чтобы задать авторизацию по паролю:

PMC> set users <username> password <password_value>

Для задания авторизации по публичному ключу ECDSA:

PMC> set users <username> key <public_key_type> <public_key>

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

PMC> delete users <username> <password | key>

Для просмотра информации пользователях (всех или определённого); отображаются логин, метод авторизации, публичный ключ:

PMC> show users
PMC> show users <username>
Работа в режиме загрузчика

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

ПримечаниеРежим загрузчика доступен только при подключении через консольный порт.

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

Hit 'Enter' key to stop autoboot: 3

Строка приглашения будет выглядеть следующим образом:

loader>

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

В данном режиме набор доступных команд ограничен. Доступны следующие команды:

  • настройка сети без сохранения параметров;

  • просмотр версии и factory-параметров;

  • отображение уровней напряжений, температуры;

  • обновление ПО.