Platform Management Controller Command Line Interface (PMC CLI)
Для программно-аппаратных комплексов (ПАК) UserGate доступен интерфейс командной строки PMC CLI, предназначенный для мониторинга и управления устройством UserGate. Для входа в PMC CLI необходимо нажать клавишу Enter во время вывода следующей строки в консоли устройства:
Строка приглашения зависит от типа ПО, в котором находится PMC:
Режим загрузчика (PMC-loader) предназначен для обеспечения возможности восстановления работоспособности программно-аппаратного комплекса. Режим загрузчика доступен только при подключении через консольный порт. В загрузчике работает таймер неактивности в CLI. Т.е. если в течение 45 секунд не вводилось никаких команд, то устройство будет перезагружено.
Для доступа в основное ПО PMC нужно ввести логин и пароль. При нажатии "Сtrl + ]" загрузка устройства продолжится в обычном режиме.
По умолчанию логин/пароль в PMC CLI: admin/password. Встроенная помощьПри нажатии клавиши "Tab" на любом этапе ввода команды отображается список возможных вариантов продолжения команды с кратким описанием.
Структура командВсе команды конфигурации в CLI имеют следующую структуру:
где: <action> — действие, которое необходимо выполнить (create, set, show, delete). <level> — уровень конфигурации (cli, platform, network, factory, users). <filter> — идентификатор объекта, к которому происходит обращение. <configuration_info> — значение параметров, которые необходимо применить к объекту <filter>. Пример:
Также существуют команды, которые позволяют выполнить действия, не относящиеся к конфигурации. Эти команды имеют следующую структуру:
где: <util> — действия, не относящиеся к конфигурированию устройства:
<util_parameters> — дополнительные параметры выполняемых действий. После того как пользователь авторизовался в консоли, он попадает в режим просмотра. В этом режиме могут выполнятся команды просмотра состояния и команды запуска некоторых утилит. Команды управления и конфигурирования устройства в данном режиме недоступны. Символ приглашения в командной строке в режиме просмотра: ">".
Отображение (show)Команда show выводит все значения на указанном уровне, и все, что находится глубже. Пример:
Если нужна только информация о температуре:
Если нужны только значения температуры:
Вывод телеметрииПоказания с некоторых датчиков собираются в журналы. Журналы хранятся за последние 60 секунд, 60 минут и 72 часа. Есть два возможных формата вывода такой информации: графический и текстовый. Пример вывода телеметрии в текстовом формате: Можно вывести таблицу или график только за определённый период: minute/hour/day:
В данном разделе доступны следующие команды:
autobootВыполнение этой команды в режиме загрузчика запускает основную прошивку PMC.
Выполнение этой команды в режиме PMC запускает хост-процессор и включает aux-режим.
auxПодключение к терминалу хост-процессора. Для возвращения в PMC CLI используется комбинация клавиш "Ctrl + ]":
historyВыводит список выполненных ранее команд:
pingОтправка ICMP ECHO-запроса. Выполняется 5 раз с интервалом 1 секунда. В качестве опционального параметра можно задавать размер данных в пакете.
tracerouteПроверка маршрута до запрашиваемого IP-адреса:
resetПерезапуск устройства:
updateЗагрузка во flash-память устройства образов ПО и ключей безопасности. Доступна только в режиме конфигурирования. Обновление ПО производится командой:
Для обновления приватного ключа SSH-сервера используется следующая команда:
Ключ должен быть предварительно сгенерирован и сохранен в формате .der. Для генерации ключа можно использовать следующую команду:
versionВывод текущей версии прошивки PMC:
Вывод версии загрузчика:
configureВход в режим конфигурирования. После выполнения этой команды меняется приглашение в консоли и появляется возможность использования команд set, delete, create, diff, revert. Команды непосредственного управления платформой (которые не сохраняются в энергонезависимой памяти) отрабатывают сразу при выполнении команды. Настройки, требующие сохранения, применяются и сохраняются только после команды exit.
diffКоманда показывает отличия применённой конфигурации и установленной в данный момент в режиме конфигурирования. Доступна только в режиме конфигурирования:
revertКоманда сброса временной конфигурации. Доступна только в режиме конфигурирования:
exitВ режиме конфигурирования запуск команды приводит к выходу из режима конфигурирования. Если была изменена конфигурация, команда применяет и сохраняет её:
В режиме просмотра запуск команды выполняет выход из терминала (в случае SSH — разрывает соединение):
Данные параметры устанавливаются один раз — в ходе производственного тестирования. Далее параметры доступны только для чтения. Для отображения параметров:
Укажите параметр, чтобы посмотреть его значение:
Данному разделу соответствует уровень конфигурации platform. Команды данного уровня позволяют управлять компонентами устройства UserGate. Настройка работы bypass-релеДанная функциональность присутствует не на всех устройствах. Команды управления выполняются на уровне platform bypass. В данном разделе реализовано управление состоянием bypass-реле сетевых портов, а также просмотр текущего состояния реле. Формат команды установки:
где: <relay-number> — номер конфигурируемого реле. <state> — состояние реле. Возможны следующие значения:
Примеры команд:
Пример вывода команды просмотра состояния:
Мониторинг вентиляторов охлажденияДанный раздел находится на уровне platform fan. Команды данного раздела позволяют производить мониторинг работы вентилятора охлаждения. Команда для отображения текущего состояния:
Параметры graph и log относятся к выводу телеметрии. Запуск/остановка хост-процессора, просмотра сохранённых логовКоманда для запуска или остановки процессора:
Команда просмотра статуса процессора:
Параметры load|frequency|mem относятся к выводу телеметрии. Пример вывода:
Формат команды просмотра последнего вывода CPU:
Управление работой аппаратного ускорителяПрисутствует только на моделях с аппаратным ускорителем (UserGate FG). Команда для запуска или остановки аппаратного ускорителя:
Для просмотра статуса аппаратного ускорителя:
Мониторинг температурыМониторинг температуры хост-процессора и платы производится на уровне platform therm. Для просмотра текущего состояния:
Параметры graph и log относятся к выводу телеметрии. Для просмотра только значений температуры хост-процессора и платы:
Пример:
Мониторинг источников питанияРаздел мониторинга источников питания производится на уровне platform power. Для отображения информации о рабочем состоянии источников питания используется команда:
Параметры graph и log относятся к выводу телеметрии. Пример:
Команда для включения/отключения всего питания, кроме дежурного, т.е. PMC продолжает работу:
Выключение:
Включение:
Мониторинг аварийДанный раздел находится на уровне platform alarm Вывод журнала аварий:
Отображение глобального статуса аварии:
Очистка журнала аварий:
Управление звуковым сигналом аварии (доступно не на всех платформах):
Команды управления настройками сети доступны на уровне network. В данном разделе доступна установки и просмотр следующих параметров:
Команда просмотра текущего состояния интерфейса:
Просмотр сетевых настроек:
После установления значений сетевые настройки применяются и сохраняются в энергонезависимую память. Для сброса к значениям по умолчанию используется команда delete:
При выполнении команды без параметров все сетевые настройки сбрасываются к значениям по умолчанию:
dhcpПо умолчанию DHCP выключен и используется заданный в настройках IP-адрес. Команда включения DHCP:
Посмотреть полученные по DHCP настройки можно следующей командой:
ipСтатический IP-адрес, по умолчанию имеет значение 192.168.1.2. Пример команды задания IP-адреса:
IP-адрес можно задать с указанием маски подсети:
gatewayШлюз по умолчанию, после сброса настроек имеет значение 192.168.1.1. Для изменения значения используется следующая команда:
nameserverПо умолчанию адрес DNS-сервера не задан и имеет значение 0.0.0.0. Для изменения значения используется следующая команда:
Для просмотра значения:
vlanПо умолчанию VLAN ID установлен в значение 0. При этом устройство получает все пакеты и при отправлении не использует VLAN tag. Если значение vlan установлено в ненулевое значение, все пакеты, приходящие с тегом, отличным от установленного, или без тэга, фильтруются. При отправке в ethernet-заголовок добавляется установленный tag. Для изменения значения используется следующая команда:
arpArp-таблица устройства по умолчанию пустая. При общении с другими узлами сети в неё добавляются динамические записи, которые имеют небольшое время жизни и после перезапуска всегда сбрасываются. Есть возможность задать статические записи с парами ipaddr/hwaddr. Если IP-адрес назначения присутствует в таблице, при отправке пакета устройство не делает arp-запрос, а сразу подставляет в ethernet-заголовок MAC-адрес из таблицы. Для добавления статических arp-записей используется команда следующего формата:
Для удаления:
При выполнении delete без указания адреса удаляются все записи. Пример команд:
ssh-portПорт для входящих подключений PMC SSH-сервера. По умолчанию имеет значение 22. Для изменения значения используется следующая команда:
ruleПравила доступа к MGMT-порту. Позволяет составлять белые и черные списки IP-адресов для доступа к PMC. Добавление и удаление правил возможно только в режиме конфигурирования. Правила применяются во время выхода из режима конфигурирования по команде exit. Примеры добавления правил:
Просмотр правил:
Удаление правил:
Команды управления настройками пользователей доступны на уровне users. В данном разделе возможно создание и удаление пользователей, а также настройка методов авторизации на SSH-сервере. Устройство позволяет завести до 10 пользователей. По умолчанию всегда есть один пользователь admin с паролем по умолчанию password.
Создание пользователяДля создания пользователя используется следующая команда:
После создания пользователю необходимо задать пароль или публичный ключ. До задания способа авторизации пользователь не может быть использован. Пример создания пользователя:
Настройка метода авторизацииВ качестве методов авторизации допускается использование пароля и публичного ключа ECDSA. Для пользователя может быть задан один или сразу оба метода авторизации. Чтобы отключить один из методов авторизации, удалите ключ или пароль. Используйте команду с действием delete. Пример:
Удаление пользователяДля удаления пользователей используется команда delete:
|