Документация: ПО Факел — разрабатываемая версия

Режим Администрирования¶

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

После входа в систему интерфейс командной строки находится в режиме Администрирования. Приглашение к вводу команды имеет вид fakel@fakel:~$: имя пользователя, имя хоста, текущий каталог и символ $.

Чтобы перейти в режим Конфигурирования, введите команду configure (см. Вход в режим Конфигурирования). Чтобы завершить сеанс работы с командной строкой, введите команду exit.

Команды configure для работы с узлами CPE описаны в разделе Технология SD-WAN.

Справка и автозаполнение команд¶

Интерфейс CLI предоставляет возможность получения справки по всем поддерживаемым командам посредством ввода символа ?. Символ вводится в любом месте строки: система выводит под заголовком Possible completions: список слов, которыми можно продолжить введенную команду, и краткое описание каждого слова. Строка <Enter> в списке означает, что введенную команду можно выполнить без дополнительных параметров. Значения, которые необходимо ввести самостоятельно, например имя интерфейса, обозначаются в угловых скобках.

Клавиша TAB может быть использована для автозаполнения строки с командами, а также для проверки введенной команды, в случае ввода конфликтующих или неизвестных значений. Если введенному началу слова соответствует один вариант команды, система дополняет слово целиком. Если вариантов несколько, система выводит их список. Если введенному тексту не соответствует ни одна команда, система выводит сообщение об ошибке.

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

fakel@fakel:~$ s[tab]
set   show

После ввода символа s и нажатия клавиши TAB система выводит команды set и show, начинающиеся с этого символа. Для начала sh существует единственный вариант, поэтому система дополняет слово до команды show.

fakel@fakel:~$ show [tab]
Possible completions:
  arp             Show Address Resolution Protocol (ARP) information
  babel           Show Babel routing protocol information
  bfd             Show Bidirectional Forwarding Detection (BFD)
  ...

Любое слово команды можно сократить до однозначного начала. Например, команда sh conf comm равна команде show configuration commands. Если начало слова подходит нескольким командам, система выводит сообщение Ambiguous command с указанием введенного слова и список подходящих вариантов. Если слову не соответствует ни одна команда, выводится сообщение Invalid command с указанием слова. Если для команды необходимы дополнительные слова, выводится сообщение Incomplete command.

Фильтры вывода команд¶

Вывод команды можно передать фильтру, указав после команды символ | и название фильтра. После символа | доступны автозаполнение клавишей TAB и справка по символу ?.

fakel@fakel:~$ show configuration commands | match ntp
fakel@fakel:~$ show configuration commands | count

Система поддерживает следующие фильтры:

Фильтр	Действие	Где доступен
`match <pattern>`	Оставляет в выводе только строки, содержащие совпадение с шаблоном `<pattern>`. Шаблон задается расширенным регулярным выражением. Шаблон с пробелами заключается в кавычки.	Режимы Администрирования и Конфигурирования
`no-match <pattern>`	Удаляет из вывода строки, содержащие совпадение с шаблоном `<pattern>`.	Режимы Администрирования и Конфигурирования
`count`	Выводит количество строк в выводе команды.	Режимы Администрирования и Конфигурирования
`more`	Выводит результат постранично.	Режимы Администрирования и Конфигурирования
`no-more`	Выводит результат без разбиения на страницы.	Режимы Администрирования и Конфигурирования
`strip-private`	Заменяет конфиденциальные данные в выводе на маскирующие значения: пароли, ключи, токены и секреты, имена пользователей, хостов и доменов, MAC- и IP-адреса, номера AS протокола BGP, сведения о местоположении (SNMP, LLDP). Предназначен для вывода конфигурации.	Режимы Администрирования и Конфигурирования
`commands`	Преобразует конфигурацию в набор команд `set`. Если в рабочей конфигурации есть неприменённые изменения, выводится сообщение о необходимости выполнить `commit`.	Только режим Конфигурирования
`json`	Преобразует конфигурацию в формат JSON. Если в рабочей конфигурации есть неприменённые изменения, выводится сообщение о необходимости выполнить `commit`.	Только режим Конфигурирования

Примечание

В режиме Администрирования фильтры commands и json выводят сообщение о том, что они не поддерживаются. Чтобы получить конфигурацию в виде команд или в формате JSON, используйте команды show configuration commands и show configuration json (см. Просмотр активной конфигурации системы).

Постраничный вывод и терминал¶

Вы можете пролистывать выводимую на экран информацию вверх с помощью сочетания клавиш Shift+PageUp и вниз с помощью сочетания клавиш Shift+PageDown.

Вывод команд show и справка по символу ? передаются на экран через программу постраничного просмотра. Когда вывод данных в командной строке в ответ на заданную команду содержит количество строк, превышающее буфер отображаемой на экране информации, выводимая информация будет разделена на части, о чем будет свидетельствовать отображение на экране символа :. Вывод, который помещается на экран, выводится без разбиения на страницы. Последовательные пустые строки в выводе сжимаются в одну. После показа последней страницы просмотр завершается автоматически.

При просмотре вывода данных с разделенной информацией доступны следующие действия:

Использование клавиши q для прекращения вывода.
Использование клавиши SPACE для перехода к следующей странице.
Использование клавиши b для перехода к предыдущей странице.
Использование клавиши ↩ для перемещения выводимой на экран информации на одну строчку вниз.
Использование клавиш ↑ и ↓ для перемещения выводимой информации на одну строчку вверх и на одну строчку вниз соответственно.
Использование клавиш ← и → для перемещения выводимой информации влево и вправо соответственно, в случае если вывод данных в строке содержит количество символов, превышающее буфер отображаемой на экране информации по горизонтали.

Размер экрана, программу постраничного просмотра и поведение клавиши ? изменяют следующие команды. Все они доступны пользователю уровня «Администратор». Настройки действуют в текущем сеансе, кроме настройки клавиши ?, которая сохраняется и действует в новых сеансах.

set terminal length <rows>: Задает высоту терминала в строках и включает постраничный вывод стандартной программой просмотра. Аргумент <rows> — целое число. Значение 0 отключает постраничный вывод.
set terminal width <columns>: Задает ширину терминала в символах. Аргумент <columns> — целое число.
set terminal pager [<program>]: Задает программу постраничного просмотра для вывода команд show. Без аргумента команда возвращает стандартную программу постраничного просмотра. Аргумент <program> — название программы.
set terminal key query-help <state>: Включает или отключает вызов справки символом ?. Аргумент <state> принимает значения enable (включить) и disable (отключить). По умолчанию справка включена. Если справка отключена, символ ? вводится в командную строку как обычный символ. Настройка сохраняется и действует в следующих сеансах; в текущем сеансе она может не вступить в силу.
clear console: Очищает экран терминала.
reset terminal: Возвращает терминал в исходное состояние. Команду используют, если после вывода нечитаемых данных терминал отображает символы некорректно.
set console keymap: Запускает интерактивную настройку раскладки клавиатуры консоли и применяет выбранную раскладку.
set builtin <option>: Передает параметр <option> встроенной команде builtin командной оболочки. Аргумент <option> — параметр команды builtin.

История команд¶

Интерфейс CLI хранит историю введенных команд. Для перемещения по истории используйте клавиши ↑ и ↓, для поиска по истории — сочетание клавиш Ctrl+R (см. Быстрые клавиши). Подстановка команд из истории с помощью символа ! отключена.

Для просмотра истории используйте команду show history. Каждая строка вывода содержит порядковый номер, время ввода и команду.

show history: Выводит всю историю.
show history brief: Выводит последние 20 команд.
show history <count>: Выводит последние <count> команд. Аргумент <count> — целое число.

Команды доступны пользователям уровней «Оператор» и «Администратор».

Вход в режим Конфигурирования¶

Для входа в режим Конфигурирования (см. Режим Конфигурирования) используйте команду configure. Вернуться в режим Администрирования можно командой exit.

Если команда выполнена от имени пользователя root, режим Конфигурирования не включается: система выводит предупреждение. При работе в образе live-ISO система предупреждает, что изменения сохранятся только после установки. Если при загрузке системы конфигурация загрузилась с ошибкой, система предупреждает, что сохранение конфигурации может заменить существующие данные.

Команда configure доступна пользователю уровня «Администратор».

Уровни пользователей¶

Набор доступных команд зависит от уровня пользователя. Команда show login level отображает уровень текущего пользователя, остальные команды группы show login описаны в разделе Управление пользователями.

Пользователь уровня «Оператор» работает в ограниченном режиме:

доступны только команды connect, disconnect, exit, force, monitor, ping, renew, show, telnet и traceroute;
режим Конфигурирования недоступен;
строка содержит одну команду, к которой допускается добавить один фильтр вывода;
из фильтров доступны less (постраничный просмотр), no-more, count, match <pattern> и no-match <pattern>;
перенаправление ввода-вывода и объединение команд символами ;, && и || недопустимы;
подстановка переменных и команд в аргументах команд отключена.

Если команда запрещена, система выводит сообщение Invalid command с названием команды.