Документация: ПО Факел — разрабатываемая версия
Общие сведения¶
Обзор¶
ПО Факел предоставляет администратору широкий спектр команд, выполняемых в эксплуатационном режиме, для получения информации о работе системы.
Интерфейсы USB¶
Ранее последовательные интерфейсы были определены как устройства
ttySx и ttyUSBx, где x - номер экземпляра последовательного
интерфейса. Было установлено, что между загрузками распределение на шине
последовательных USB интерфейсов может отличаться в зависимости от того,
какой драйвер был загружен операционной системой первым. При наличии
последовательных интерфейсов не только для подключения последовательной консоли,
но и для поддержки функциональности интерфейсов
WWAN данная особенность приводила к
возникновению проблем в использовании устройств.
Для того, чтобы решить проблемы с определением устройств в системе, а также с учетом того, что конвертеры из USB в последовательный интерфейс не имеют встроенного на производстве номера, такие конвертеры определяются в системе как непосредственно подключенные к корневому концентратору USB и к шине соответственно. Такое поведение характерно для многих дистрибутивов операционных систем Linux последних версий.
Сведения о системе¶
Команды режима «Администрирование» этого раздела не изменяют конфигурацию и помогают оценить состояние маршрутизатора. Их можно разделить на группы.
Версия и образы ПО. Команды
show version,show version all,show version kernelиshow version frrотображают версию ПО Факел и его компонентов. Командыshow system imageиshow system image detailsотображают установленные на устройстве образы ПО Факел: какой образ загружается по умолчанию, какой работает сейчас, сколько места на диске занимает каждый образ. Образ, который загружается по умолчанию, и тип консоли загрузки задают командыset system image default-bootиset system boot-console(см. Образ и консоль по умолчанию). Командаshow system updatesсравнивает текущую версию с версией, опубликованной на сервере обновлений; она работает, если в конфигурации задан разделsystem update-check(адрес сервера — параметрsystem update-check url), иначе выводит сообщениеsystem update-check not configured.Ресурсы. Команды
show system cpu,show system memory(с формамиdetail,cacheиrouting-daemons),show system storageиshow system uptimeотображают процессоры, использование оперативной памяти, заполнение постоянного хранилища, время работы и среднюю нагрузку. Средняя нагрузка выводится в процентах за 1, 5 и 15 минут.Процессы и соединения. Команды
show system processes(с формамиextensive,summaryиtree) отображают процессы операционной системы, командаshow system routing-daemons— запущенные компоненты подсистемы маршрутизации. Командыshow system connectionsиshow ip portsотображают сетевые соединения, сокеты и прослушиваемые порты самого маршрутизатора (например, сеансы SSH и соединения протоколов маршрутизации); транзитный трафик, который пересылает FVE, в этом выводе не отображается.Журнал ядра. Команда
show system kernel-messagesвыводит сообщения кольцевого буфера ядра операционной системы: сведения об оборудовании, драйверах и ошибках, обнаруженных при загрузке и работе.Плоскость передачи данных. Команды
show system interfaces-rx-modeиshow system adaptive-mode-thresholdsотображают режим приема пакетов интерфейсами FVE и пороги переключения адаптивного режима. Режим задается параметромsystem option interfaces-rx-mode:polling(опрос без ожидания — минимальная задержка, но высокая загрузка процессора; значение по умолчанию),interrupt(ожидание событий — низкая загрузка процессора, но немного большая задержка) илиadaptive(система работает в режиме прерываний, пока нагрузка не превысит порог переключения в режим опроса). Пороги задаются параметрамиsystem option polling-mode-threshold(по умолчанию 4) иsystem option interrupt-mode-threshold(по умолчанию 2) в процентах от 255.Аппаратное ускорение. Команды
show system acceleration qat …отображают устройства Intel QAT (QuickAssist Technology), их состояние, конфигурацию, счетчики и прерывания. Все команды, кромеshow system acceleration qat, работают, если задан разделsystem acceleration qat, иначе выводят сообщениеsystem acceleration qat is not configured.Оборудование. Команды
show hardware …отображают сведения об оборудовании устройства: процессорах (cpu), оперативной памяти (mem), устройствах шин PCI (pci) и USB (usb), накопителях (storage nvme,storage scsi,storage smart <device>— состояние накопителя по данным S.M.A.R.T.) и сведения DMI (dmi) — производитель, модель и серийный номер устройства. По ним проверяют, какое оборудование установлено и определено системой, и состояние накопителей.Датчики. Команда
show environment sensorsвыводит показания датчиков аппаратного мониторинга устройства. Если датчики не обнаружены, команда пытается определить их и загрузить нужные драйверы, а при неудаче выводит сообщениеNo sensors found. Командаshow environment temperatureвыводит текущую температуру устройства. Если ПО Факел работает в виртуальной машине, обе команды выводят сообщениеFakel running under hypervisor, no sensors available.Плановая перезагрузка. Команды
show rebootиshow poweroffпоказывают, запланирована ли перезагрузка или выключение устройства. Перезагрузку и выключение выполняют и планируют командыrebootиpoweroff(см. Перезагрузка и выключение).Отчет для технической поддержки. Команда
show tech-support reportвыводит сводный отчет о системе для обращения в техническую поддержку.
Предупреждение
Отчет show tech-support report содержит конфиденциальные данные: файл конфигурации и рабочую конфигурацию (в том числе ключи и пароли, заданные в конфигурации), адреса, таблицы маршрутизации и правила межсетевого экрана. Перед передачей отчета третьим лицам удалите из него конфиденциальные сведения.
Архив для технической поддержки¶
Архив с диагностическими сведениями для технической поддержки собирают команды режима «Администрирование» группы generate tech-support archive. В архив входят отчет show tech-support report, файлы настроек операционной системы, домашние каталоги пользователей, журналы, временные файлы, аварийные дампы процессов и файлы конфигурации ПО Факел. Команда generate tech-support archive сохраняет архив во временный каталог, команда generate tech-support archive <archive> — в указанный каталог на маршрутизаторе или на удаленный сервер по протоколу SCP или FTP. Путь к архиву команды выводят в сообщении Debug file is generated and located in <file>, ошибку — в сообщении Error during generating a debug file: <error>. Команды доступны только пользователю уровня «Администратор» (см. Уровни пользователей).
Предупреждение
Архив generate tech-support archive содержит конфиденциальные данные: конфигурацию с ключами и паролями, файлы домашних каталогов пользователей и журналы. Передавайте архив только технической поддержке по защищенному каналу. Команда generate tech-support archive upload … загружает архив на внешний сервер, который не относится к технической поддержке ПО Факел; не используйте ее (см. Ограничения).
Архив для поиска потерь пакетов¶
Команда generate interfaces debug-archive собирает в архив сведения, которые помогают найти причину потери пакетов на интерфейсах. В архив входят:
последние записи системного журнала и журнала ядра с момента загрузки;
статистика интерфейсов, прерываний и программных прерываний;
список процессов и прослушиваемых портов;
счетчики и параметры сетевого стека ядра;
до 500 пакетов, захваченных на всех интерфейсах за время до 10 секунд (кроме трафика SSH, порт 22);
для каждого интерфейса — сведения о драйвере, статистика сетевой карты, размеры буферов приема и передачи, параметры объединения прерываний, управления потоком и аппаратной разгрузки.
После сборки команда выводит путь к архиву: Debug file is generated and located in <file>. Если собрать архив не удалось, команда выводит сообщение Error during generating a debug file: <error>. Сведения собираются из ядра Linux и могут не отражать трафик, который пересылает FVE (см. Ограничения). Команда доступна только пользователю уровня «Администратор» (см. Уровни пользователей).
Предупреждение
Архив содержит захваченные пакеты, адреса и записи журналов. Передавайте его только технической поддержке по защищенному каналу.
Периодическое выполнение команды¶
Команды monitor command <command> и monitor command diff <command> выполняют указанную команду режима «Администрирование» каждые 2 секунды и выводят ее результат на весь экран, заменяя предыдущий. Так удобно наблюдать за изменением состояния, например за счетчиками интерфейсов или за состоянием соседей протокола маршрутизации, не вводя команду повторно. Команда monitor command diff <command> дополнительно выделяет в выводе символы, которые изменились с предыдущего выполнения. Чтобы завершить наблюдение, нажмите Ctrl+C.
Список команд¶
Режим «Администрирование»¶
hardware usb¶
Синтаксис:
show hardware usb
Режим: «Администрирование».
Примечание
Если устройство было отключено и подключено повторно,
то ему будут присвоены новые идентификаторы Port, Dev и If.
Пример вывода:
fakel@fakel:~$ show hardware usb
/: Bus 03.Port 1: Dev 1, Class=root_hub, Driver=ehci-pci/2p, 480M
|__ Port 1: Dev 2, If 0, Class=Hub, Driver=hub/4p, 480M
|__ Port 3: Dev 4, If 0, Class=Vendor Specific Class, Driver=qcserial, 480M
|__ Port 3: Dev 4, If 2, Class=Vendor Specific Class, Driver=qcserial, 480M
|__ Port 3: Dev 4, If 3, Class=Vendor Specific Class, Driver=qcserial, 480M
|__ Port 3: Dev 4, If 8, Class=Vendor Specific Class, Driver=qmi_wwan, 480M
/: Bus 02.Port 1: Dev 1, Class=root_hub, Driver=xhci_hcd/2p, 5000M
/: Bus 01.Port 1: Dev 1, Class=root_hub, Driver=xhci_hcd/2p, 480M
|__ Port 1: Dev 2, If 0, Class=Vendor Specific Class, Driver=pl2303, 12M
|__ Port 2: Dev 3, If 0, Class=Hub, Driver=hub/4p, 480M
|__ Port 4: Dev 5, If 2, Class=Vendor Specific Class, Driver=ftdi_sio, 480M
|__ Port 4: Dev 5, If 0, Class=Vendor Specific Class, Driver=ftdi_sio, 480M
|__ Port 4: Dev 5, If 3, Class=Vendor Specific Class, Driver=ftdi_sio, 480M
|__ Port 4: Dev 5, If 1, Class=Vendor Specific Class, Driver=ftdi_sio, 480M
|__ Port 3: Dev 4, If 0, Class=Hub, Driver=hub/4p, 480M
|__ Port 3: Dev 6, If 0, Class=Hub, Driver=hub/4p, 480M
|__ Port 4: Dev 8, If 2, Class=Vendor Specific Class, Driver=ftdi_sio, 480M
|__ Port 4: Dev 8, If 0, Class=Vendor Specific Class, Driver=ftdi_sio, 480M
|__ Port 4: Dev 8, If 3, Class=Vendor Specific Class, Driver=ftdi_sio, 480M
|__ Port 4: Dev 8, If 1, Class=Vendor Specific Class, Driver=ftdi_sio, 480M
|__ Port 4: Dev 7, If 3, Class=Vendor Specific Class, Driver=ftdi_sio, 480M
|__ Port 4: Dev 7, If 1, Class=Vendor Specific Class, Driver=ftdi_sio, 480M
|__ Port 4: Dev 7, If 2, Class=Vendor Specific Class, Driver=ftdi_sio, 480M
|__ Port 4: Dev 7, If 0, Class=Vendor Specific Class, Driver=ftdi_sio, 480M
hardware usb serial¶
usb0b2.4p1.0) может быть использовано при обращении к последовательной консоли.Синтаксис:
show hardware usb serial
Режим: «Администрирование».
Пример вывода:
fakel@fakel$ show hardware usb serial
Device Model Vendor
------ ------ ------
usb0b4p1.0 FT232R_USB_UART Future Technology Devices International, Ltd
usb0b4p1.1 FT232R_USB_UART Future Technology Devices International, Ltd
usb0b4p1.2 FT232R_USB_UART Future Technology Devices International, Ltd
version¶
Синтаксис:
show version
Режим: «Администрирование».
Пример вывода:
Version: Fakel release-1.0.2
Release: 1
Built by: root@runner-9ksjjge3s-project-61-concurrent-0
Built on: Wed 24 Jan 2024 07:23 UTC
Build UUID: bea28a60-5a08-4a17-b61c-d52bdff1d262
Build commit ID: 2aaec83cfe645a
Architecture: x86_64
Boot via: installed image
System type: bare metal
Hardware vendor: newplatforms
Hardware model: NP-1008i
Hardware S/N: SC21B001231009F9
Hardware UUID: Unknown
Copyright: IT Route, LLC
version kernel¶
Синтаксис:
show version kernel
Режим: «Администрирование».
Пример вывода:
fakel@fakel:~$ show version kernel
6.1.82-amd64-fakel
version frr¶
Синтаксис:
show version frr
Режим: «Администрирование».
Пример вывода:
fakel@fakel:~$ show version frr
FRRouting 9.1 (infra-gw-01) on Linux(6.1.82-amd64-fakel).
Copyright 1996-2005 Kunihiro Ishiguro, et al.
version all¶
Синтаксис:
show version all
Режим: «Администрирование».
system image¶
Default boot) и признак работающего образа (столбец Running).Синтаксис:
show system image
Режим: «Администрирование».
system image details¶
Синтаксис:
show system image details
Режим: «Администрирование».
system updates¶
system update-check не настроен, выводит сообщение system update-check not configured; если версию на сервере получить не удалось — Update not found.Синтаксис:
show system updates
Режим: «Администрирование».
system cpu¶
Синтаксис:
show system cpu
Режим: «Администрирование».
system memory¶
Total), доступно (Free) и используется (Used).Синтаксис:
show system memory
Режим: «Администрирование».
system memory cache¶
Синтаксис:
show system memory cache
Режим: «Администрирование».
system memory detail¶
Синтаксис:
show system memory detail
Режим: «Администрирование».
system memory routing-daemons¶
Синтаксис:
show system memory routing-daemons
Режим: «Администрирование».
system storage¶
Storage statistics are not available.Синтаксис:
show system storage
Режим: «Администрирование».
system uptime¶
Синтаксис:
show system uptime
Режим: «Администрирование».
system processes¶
Синтаксис:
show system processes
Режим: «Администрирование».
system processes extensive¶
Синтаксис:
show system processes extensive
Режим: «Администрирование».
system processes summary¶
show system uptime).Синтаксис:
show system processes summary
Режим: «Администрирование».
system processes tree¶
Синтаксис:
show system processes tree
Режим: «Администрирование».
system routing-daemons¶
Синтаксис:
show system routing-daemons
Режим: «Администрирование».
system connections¶
Синтаксис:
show system connections
Режим: «Администрирование».
system connections tcp¶
Синтаксис:
show system connections tcp
Режим: «Администрирование».
system connections tcp all¶
Синтаксис:
show system connections tcp all
Режим: «Администрирование».
system connections tcp numeric¶
Синтаксис:
show system connections tcp numeric
Режим: «Администрирование».
system connections udp¶
Синтаксис:
show system connections udp
Режим: «Администрирование».
system connections udp numeric¶
Синтаксис:
show system connections udp numeric
Режим: «Администрирование».
system kernel-messages¶
Синтаксис:
show system kernel-messages
Режим: «Администрирование».
system interfaces-rx-mode¶
Синтаксис:
show system interfaces-rx-mode
Режим: «Администрирование».
system adaptive-mode-thresholds¶
Синтаксис:
show system adaptive-mode-thresholds
Режим: «Администрирование».
system acceleration qat¶
No QAT device found.Синтаксис:
show system acceleration qat
Режим: «Администрирование».
system acceleration qat status¶
Синтаксис:
show system acceleration qat status
Режим: «Администрирование».
system acceleration qat interrupts¶
Синтаксис:
show system acceleration qat interrupts
Режим: «Администрирование».
system acceleration qat device <device> config¶
Синтаксис:
show system acceleration qat device
<device>config
Аргументы:
<device>— имя устройства Intel QAT. Формат: строка.
Режим: «Администрирование».
system acceleration qat device <device> flows¶
Синтаксис:
show system acceleration qat device
<device>flows
Аргументы:
<device>— имя устройства Intel QAT. Формат: строка.
Режим: «Администрирование».
show reboot¶
Reboot is scheduled с датой и временем, если запланировано выключение — Poweroff is scheduled, иначе — Reboot or poweroff is not scheduled.Синтаксис:
show reboot
Режим: «Администрирование».
tech-support report¶
Синтаксис:
show tech-support report
Режим: «Администрирование».
show poweroff¶
Poweroff is scheduled с датой и временем, если запланирована перезагрузка — Reboot is scheduled, иначе — Reboot or poweroff is not scheduled.Синтаксис:
show poweroff
Режим: «Администрирование».
ip ports¶
Синтаксис:
show ip ports
Режим: «Администрирование».
hardware cpu¶
Синтаксис:
show hardware cpu
Режим: «Администрирование».
hardware cpu detail¶
Синтаксис:
show hardware cpu detail
Режим: «Администрирование».
hardware cpu summary¶
Синтаксис:
show hardware cpu summary
Режим: «Администрирование».
hardware dmi¶
Синтаксис:
show hardware dmi
Режим: «Администрирование».
hardware mem¶
Синтаксис:
show hardware mem
Режим: «Администрирование».
hardware pci¶
Синтаксис:
show hardware pci
Режим: «Администрирование».
hardware pci detail¶
Синтаксис:
show hardware pci detail
Режим: «Администрирование».
hardware storage nvme¶
Синтаксис:
show hardware storage nvme
Режим: «Администрирование».
hardware storage scsi¶
Синтаксис:
show hardware storage scsi
Режим: «Администрирование».
hardware storage scsi detail¶
Синтаксис:
show hardware storage scsi detail
Режим: «Администрирование».
hardware storage smart <device>¶
Синтаксис:
show hardware storage smart
<device>
Аргументы:
<device>— имя дискового устройства (например,sdaилиnvme0n1).
Режим: «Администрирование».
hardware usb detail¶
Синтаксис:
show hardware usb detail
Режим: «Администрирование».
environment sensors¶
No sensors found; если ПО Факел работает в виртуальной машине — Fakel running under hypervisor, no sensors available.Синтаксис:
show environment sensors
Режим: «Администрирование».
environment temperature¶
Fakel running under hypervisor, no sensors available.Синтаксис:
show environment temperature
Режим: «Администрирование».
generate tech-support archive¶
Debug file is generated and located in <file>.Синтаксис:
generate tech-support archive
Режим: «Администрирование».
Уровень привилегий: «Администратор».
generate tech-support archive <archive>¶
Синтаксис:
generate tech-support archive
<archive>
Аргументы:
<archive>— каталог на маршрутизаторе, в который сохраняется архив, или адрес удаленного сервера в форматеscp://<user>:<password>@<host>илиftp://<user>:<password>@<host>.
Режим: «Администрирование».
Уровень привилегий: «Администратор».
generate tech-support archive upload user <user> ticket <ticket>¶
Синтаксис:
generate tech-support archive upload user
<user>ticket<ticket>
Аргументы:
<user>— имя пользователя портала поддержки. Формат: строка;<ticket>— номер заявки. Формат: строка.
Режим: «Администрирование».
Уровень привилегий: «Администратор».
monitor command <command>¶
Синтаксис:
monitor command
<command>
Аргументы:
<command>— команда режима «Администрирование» с аргументами, напримерshow interfaces.
Режим: «Администрирование».
monitor command diff <command>¶
Синтаксис:
monitor command diff
<command>
Аргументы:
<command>— команда режима «Администрирование» с аргументами, напримерshow interfaces.
Режим: «Администрирование».
generate interfaces debug-archive¶
Синтаксис:
generate interfaces debug-archive
Режим: «Администрирование».
Уровень привилегий: «Администратор».