|
Интерфейс командной строки PMC
В программно-аппаратных комплексах (ПАК) UserGate, оснащенных модулем управления PMC (Platform Management Controller), доступен интерфейс командной строки PMC CLI. С помощью команд интерфейса вы можете просматривать состояние аппаратной платформы, настраивать параметры и режимы работы компонентов платформы, управлять доступом к платформе, восстанавливать работоспособность устройства. О наличии модуля PMC на устройстве и типах портов для подключения — в документации на аппаратные платформы. Подключение к PMC CLIК интерфейсу командной строки PMC можно подключиться с помощью терминала через консольный порт устройства или удаленно с помощью протокола SSH. Для подключения через консольный порт: 1. Подключите компьютер к устройству с помощью консольного кабеля. 2. Запустите программу — эмулятор терминала, например Putty для Windows или minicom для Linux. Установите подключение через последовательный порт, указав параметры подключения: 115200, 8 n 1. 3. Во время загрузки устройства нажмите Enter, когда в консоли появится строка Hit 'Enter' key to stop autoboot: 3. 4. Введите логин и пароль для доступа в интерфейс. ПримечаниеПо умолчанию логин и пароль в PMC CLI — admin и password. В версии 7.5.0 и выше логин и пароль по умолчанию — Admin и usergate.
Пользователь с новыми логином и паролем по умолчанию станет активным, если из энергонезависимой памяти будут удалены все ранее созданные пользователи.
Если нажать комбинацию клавиш Сtrl + ], загрузка устройства продолжится в обычном режиме. После трех неудачных попыток входа вводится обязательный 10-секундный тайм-аут перед каждой следующей попыткой. Во время тайм-аута можно сбросить настройки PMC до первоначальных, нажав комбинацию клавиш Ctrl+e.
Для подключения с помощью протокола SSH: 1. Запустите на компьютере SSH-терминал, например SSH для Linux или Putty для Windows. 2. Укажите IP-адрес устройства, порт для подключения (по умолчанию — порт 22, в версии 7.5.0 и выше — 2220), имя пользователя (по умолчанию — admin, в версии 7.5.0 и выше — Admin). Пример команды подключения для Linux: ssh Admin@<IP-address> -p 2220. 3. Войдите в CLI, используя пароль пользователя, указанного на предыдущем шаге. На интерфейс командной строки PMC можно переключиться из интерфейса UGOS CLI:
Режимы работы PMC CLIPMC CLI имеет два режима работы: режим просмотра и режим конфигурирования. После авторизации пользователь попадает в режим просмотра. В этом режиме могут выполняться команды просмотра состояния устройства и команды мониторинга сетевого окружения. Символ приглашения командной строки в режиме просмотра имеет вид:
Подробнее о командах, доступных в режиме просмотра, — в разделе «Режим просмотра PMC CLI». Для переключения на режим конфигурирования используется команда configure. В режиме конфигурирования символ приглашения в командной строке меняется на: #. Вернуться в режим просмотра можно с помощью команды exit.
В режиме конфигурирования помимо команд режима просмотра доступны команды управления компонентами платформы и настройки параметров устройства. ПримечаниеКоманды непосредственного управления платформой, которые не требуют сохранения параметров в энергонезависимой памяти, срабатывают сразу при запуске в режиме конфигурирования. Параметры, требующие сохранения, применяются и сохраняются в энергонезависимой памяти только при выходе из режима конфигурирования с помощью команды exit.
Подробнее о командах, доступных в режиме конфигурирования, — в разделе «Режим конфигурирования PMC CLI». Формат командКоманды действий, не относящихся к конфигурации устройства, имеют следующий формат:
<util> — действия, не относящиеся к конфигурированию PMC:
<util_parameters> — дополнительные параметры выполняемых действий. Пример:
Команды конфигурации в PMC CLI имеют следующий формат:
Пример:
Горячие клавишиВ интерфейсе командной строки PMC вы можете использовать следующие горячие клавиши:
PMC loaderPMC loader (загрузчик) предназначен для восстановления работоспособности программно-аппаратного комплекса. В режим загрузчика можно войти только при подключении через консольный порт, нажав клавишу Enter во время вывода строки в консоли устройства: (loader) Hit 'Enter' key to stop autoboot: 1. Строка приглашения в режиме загрузчика имеет вид:
Загрузчик не обращается к энергонезависимой памяти, поэтому все параметры конфигурации в режиме загрузчика будут установлены по умолчанию. Если в режиме загрузчика необходим доступ к внешним сетевым ресурсам, например к TFTP-серверу для скачивания образа ПО командой update, установите актуальный IP-адрес вашего устройства с помощью команды set network ip. Подробнее о командах настройки сетевых параметров — в разделе «Управление сетевыми параметрами». В загрузчике работает таймер неактивности: если в течение 45 секунд не вводилось никаких команд, устройство будет перезагружено. В режиме просмотра PMC CLI вы можете:
Чтобы посмотреть полный список команд, доступных в режиме просмотра PMC CLI, нажмите клавишу Tab.
auxКоманда для переключения на интерфейс UGOS CLI, если на платформе уже загружен образ UGOS. Для возвращения в PMC CLI используйте комбинацию клавиш Ctrl + ].
autobootКоманда для запуска UGOS и включение aux-режима (переход в UGOS CLI).
ПримечаниеВыполнение этой команды в режиме загрузчика запускает основную прошивку PMC.
configureКоманда для перехода в режим конфигурирования. После выполнения этой команды меняется символ приглашения в консоли и появляется возможность конфигурирования параметров аппаратной платформы.
exitКоманда для выхода из терминала (в случае SSH — разрыва соединения).
historyКоманда для вывода списка выполненных ранее команд.
pingКоманда для отправки ICMP ECHO-запроса. Выполняется пять раз с интервалом 1 сек. Опционально можно задавать размер данных в пакете. Вы можете остановить выполнение команды, нажав комбинацию клавиш Сtrl + С.
resetКоманда для перезапуска устройства.
showКоманда для просмотра состояния и параметров устройства.
При запуске команды укажите параметры для просмотра.
Вывод телеметрииПоказания некоторых датчиков собираются в журналы. Хранятся журналы за последние 60 секунд, 60 минут и 72 часа. Есть два возможных формата вывода такой информации: графический (graph) и текстовый (log). Пример вывода телеметрии в графическом формате: Пример вывода телеметрии в текстовом формате: Данные в виде таблицы или графика можно вывести за определенный период: minute, hour, day:
tcpdumpЗахват и вывод в консоль пакетов сетевого трафика. Вы можете остановить выполнение команды, нажав комбинацию клавиш Сtrl + С.
tracerouteПроверка маршрута до запрашиваемого IP-адреса:
versionПросмотр версии основного ПО PMC и версии загрузчика.
В режиме конфигурирования PMC CLI помимо команд режима просмотра доступны команды управления компонентами платформы и настройки параметров устройства. ПримечаниеКоманды непосредственного управления платформой, которые не требуют сохранения параметров в энергонезависимой памяти, срабатывают сразу при запуске. Параметры, требующие сохранения, применяются и сохраняются в энергонезависимой памяти только после выполнения команды exit.
Просмотр заводских параметровС помощью команды show factory вы можете посмотреть тип и серийный номер аппаратной платформы, исходный MAC-адрес интерфейса управления.
Управление системным временем, датой и часовым поясомВы можете посмотреть установленное системное время, дату и часовой пояс с помощью команды:
Для установки времени, даты или часового пояса используйте команду:
Где:
Управление платформойС помощью команд уровня конфигурации platform вы можете управлять различными компонентами аппаратных платформ UserGate. Настройка работы байпас-релеКоманды управления режимами работы байпас-реле находятся на уровне platform bypass. Функция байпас-реле поддерживается не на всех аппаратных платформах. О наличии сетевых интерфейсов с поддержкой режима байпас читайте в документации на аппаратные платформы. Для установки режима работы байпас-реле используйте команду:
<relay-number> — номер настраиваемого реле. <state> — состояние реле. Возможны следующие значения:
Примеры команд:
Для просмотра состояния байпас-реле используйте команду:
Управление вентиляторами охлажденияКоманды управления вентиляторами охлаждения находятся на уровне platform fan. С помощью команд этого уровня вы можете управлять режимами работы вентиляторов охлаждения и просматривать их текущее состояние. Функция управления вентиляторами поддерживается не на всех аппаратных платформах. Вентиляторы могут работать в двух режимах: автоматическом и ручном. Установить режим работы вентиляторов можно с помощью команды:
По умолчанию вентиляторы работают в автоматическом режиме. Скорость вращения вентиляторов контролируется процессором в зависимости от текущих температурных показателей. В ручном режиме можно установить скорость вращения вентилятора в процентах:
Если на платформе больше одного вентилятора, в ручном режиме можно управлять скоростью вращения каждого вентилятора по отдельности. Параметры работы вентилятора охлаждения сохраняются в энергонезависимой памяти и не сбрасываются после перезагрузки устройства. Примеры команд управления вентиляторами охлаждения:
На некоторых аппаратных платформах есть возможность установки системы охлаждения разного направления. Направление работы вентиляторов определяется автоматически после удаления предыдущего значения:
Для просмотра состояния вентилятора охлаждения используйте команду:
Пример команды просмотра состояния вентилятора охлаждения:
Параметры команды graph и log относятся к выводу телеметрии. Подробнее о примерах вывода телеметрии — в описании команды просмотра. Управление процессоромКоманды управления процессором находятся на уровне platform soc. С помощью команд этого уровня вы можете останавливать или запускать основной процессор и просматривать его текущее состояние. Остановить или запустить процессор можно с помощью команды:
Посмотреть статус процессора можно с помощью команды:
Параметры load, frequency, mem относятся к выводу телеметрии. Подробнее о примерах вывода телеметрии — в описании команды просмотра. Пример выполнения команды просмотра состояния процессора:
Пример команды просмотра последнего вывода процессора:
Мониторинг температурыКоманды мониторинга температуры процессора и платы находятся на уровне platform therm. С помощью команд этого уровня вы можете просматривать текущие значения температуры и аварийные сообщения. Для просмотра текущего состояния и аварийных сообщений используйте команду:
Параметры graph и log относятся к выводу телеметрии. Подробнее о примерах вывода телеметрии — в описании команды просмотра. Примеры использования команд мониторинга температуры:
Мониторинг источников питанияКоманды мониторинга источников питания находятся на уровне platform power. Для отображения информации о рабочем состоянии источников питания используйте команду:
Параметры graph и log относятся к выводу телеметрии. Подробнее о примерах вывода телеметрии — в описании команды просмотра. Пример использования команды:
Для включения или отключения всего питания платформы, кроме дежурного (PMC продолжит работу), используйте команду:
Пример команды отключения питания:
Пример команды включения питания:
Мониторинг аварийКоманды мониторинга аварий находятся на уровне platform alarm. С помощью команд этого уровня вы можете просматривать и очищать журнал аварий, управлять звуковым сигналом аварии (доступно не на всех платформах). Пример команды просмотра аварийных сообщений:
Для отображения глобального статуса мониторинга аварий используйте команду:
Для очистки журнала аварийных сообщений используйте команду:
Для управления звуковым сигналом аварии используйте команду:
Управление сетевыми параметрамиКоманды управления сетевыми параметрами находятся на уровне network. С помощью команд этого уровня вы можете настраивать и просматривать следующие параметры:
Для просмотра сетевых параметров используйте команду:
Пример команды просмотра всех сетевых параметров:
Пример команды просмотра состояния интерфейса управления:
Пример команды просмотра ARP-таблицы:
Для установки значений сетевых параметров используйте команду:
Для сброса сетевых параметров до значений по умолчанию используйте команду:
При выполнении команды без параметров все сетевые настройки сбрасываются до значений по умолчанию. dhcpИзначально режим DHCP отключен, в интерфейсе управления используется заданный по умолчанию IP-адрес (192.168.1.2). Для включения режима DHCP используйте команду:
Посмотреть полученные по DHCP сетевые параметры можно с помощью команды:
ipПо умолчанию интерфейс управления имеет следующий статический IP-адрес: 192.168.1.2. Установить другой статический IP-адрес можно с помощью команды:
При установке IP-адреса вы можете указать маску подсети:
gatewayШлюз по умолчанию имеет IP-адрес 192.168.1.1. Изменить IP-адрес шлюза можно с помощью команды:
nameserverПо умолчанию IP-адрес DNS-сервера не задан и имеет значение 0.0.0.0. Установить IP-адрес DNS-сервера можно с помощью команды:
vlanПо умолчанию значение vlan id — 0. Устройство получает все пакеты и при отправлении не использует VLAN tag. Если значение vlan id не равно 0, все приходящие пакеты c другим тегом или без тега будут отброшены. При отправке пакетов в ethernet-заголовок добавляется установленный тег. Изменить значение vlan id можно с помощью команды:
arpARP-таблица устройства по умолчанию пуста. При взаимодействии с другими узлами сети в нее добавляются динамические записи, которые имеют небольшое время жизни. После перезапуска такие записи всегда сбрасываются. Вы можете задать статические записи ARP-таблицы с указанием соответствия IP-адресов и MAC-адресов. Если IP-адрес назначения присутствует в таблице, при отправке пакета устройство не делает ARP-запрос, а сразу подставляет в ethernet-заголовок MAC-адрес из таблицы. Добавить статические ARP-записи можно с помощью команды:
Удалить статические ARP-записи можно с помощью команды:
При выполнении команды delete без указания адреса будут удалены все записи. Пример использования команд:
hostnameУстройству может быть назначено имя. По умолчанию параметр hostname имеет значение none. Чтобы установить новое значение параметра hostname используйте команду: PMC# set network hostname <name> Для просмотра имени устройства используйте команду:
sshПорт для входящих подключений PMC SSH-сервера. По умолчанию имеет значение 22 (в версии 7.5.0 и выше — 2220). Вы можете изменить адрес порта с помощью команды:
ruleПравила доступа к интерфейсу управления устройством. Вы можете составлять белые и черные списки IP-адресов для контроля доступа к PMC. Правила доступа применяются и записываются в память при выходе из режима конфигурирования по команде exit. Примеры добавления правил:
Для просмотра правил используйте команду:
Для удаления правил используйте команду:
interfaceВключение или отключение интерфейса управления (MGMT). Для включения интерфейса используйте команду:
По умолчанию интерфейс MGMT включен. statsОтображение статистики принятых и переданных данных. Для отображения статистики используйте команду:
Для сброса собранной статистики используйте команду:
Управление пользователямиКоманды управления пользователями находятся на уровне users. С помощью команд этого уровня вы можете создавать и удалять пользователей, настраивать методы авторизации для доступа к платформе, просматривать параметры созданных пользователей. В PMC CLI можно создать до 10 пользователей. По умолчанию на устройстве создан один пользователь admin с паролем password. В версии 7.5.0 и выше — Admin с паролем usergate. Для просмотра параметров созданных пользователей используйте команду:
Создание пользователейДля создания нового пользователя используйте команду:
Пример создания пользователя:
Настройка метода авторизацииСозданному пользователю необходимо задать пароль или публичный ключ для авторизации на устройстве. До задания способа авторизации имя пользователя не может быть использовано для входа на устройство. В качестве методов авторизации допускается использование пароля и публичного ключа ECDSA. Для пользователя может быть задан один или сразу оба метода авторизации. Чтобы отключить один из методов авторизации, удалите ключ или пароль. Для удаления параметров авторизации используйте команду delete. Пример настройки методов авторизации пользователя:
Удаление пользователейДля удаления пользователей используйте команду delete:
Execute-командыРяд команд режима конфигурирования PMC CLI предназначен для управления конфигурацией:
diffКоманда показывает отличия примененной на устройстве конфигурации и конфигурации, настроенной в данный момент в режиме конфигурирования. Пример использования команды:
exitЗапуск команды в режиме конфигурирования приводит к переходу в режим просмотра. Если в режиме конфигурирования была изменена конфигурация устройства, команда exit применяет обновленные параметры и сохраняет их в энергонезависимой памяти. Пример использования команды в режиме конфигурирования:
revertКоманда сброса измененной конфигурации. Пример использования команды:
updateЗагрузка во флеш-память устройства образов ПО и ключей безопасности для SSH-сервера. Для обновления ПО используйте команду:
Для платформы UserGate FG можно обновить прошивки Netcard PMC (ncpmc) и образа FPGA (fpga). После обновления ncpmc необходимо выполнить перезагрузку PMC. Пример использования команды обновления прошивки PMC:
Для обновления закрытого ключа SSH-сервера используйте команду:
Ключ должен быть предварительно создан и сохранен в DER-формате. Пример создания ключа с помощью утилиты openssl:
В режиме конфигурации PMC CLI также доступны команды из режима просмотра:
Подробнее о назначении этих команд и примерах их использования — в разделе «Режим просмотра PMC CLI». |