Интерфейс командной строки

Доступ к интерфейсу командной строки системы ARMA Стена возможно получить при подключении к устройству:

через HDMI или VGA разъём;

через консольный порт;

удаленно при помощи сеанса SSH.

При подключении через консольный порт (RS-232) используются следующие параметры:

скорость: 9600 бит/с;

без контроля четности (No parity);

8 бит данных (8 data bits);

1 стоповый бит (1 stop bits).

Интерфейс командной строки (CLI) предоставляет возможность получения справочной информации по всем поддерживаемым командам путём ввода символа «?».

Клавиша TAB может использоваться для автоматического заполнения строки командами, а также для проверки правильности введённой команды в случае наличия конфликтующих или неизвестных значений. При вводе в командной строке значения «sh» и последующем нажатии клавиши TAB система предложит вариант команды «show». Повторное нажатие клавиши TAB приведёт к выводу на экран всех возможных дополнительных команд и параметров, связанных с командой «show»:

admin@ngfwos:~$ s[pressTAB]
set    show    suricata

admin@ngfwos:~$ show [tab]
Possible completions:
    arp             Show Address Resolution Protocol (ARP) information
    bridge          Show bridging information
    cluster         Show clustering information
    configuration   Show running configuration
    conntrack       Show conntrack entries in the conntrack table
    conntrack-sync  Show connection syncing information
    date            Show system date and time
    dhcp            Show Dynamic Host Configuration Protocol (DHCP) information
    dhcpv6          Show status related to DHCPv6
    disk            Show status of disk device
    dns             Show Domain Name Server (DNS) information
    file            Show files for a particular image
    firewall        Show firewall information
    flow-accounting Show flow accounting statistics
    hardware        Show system hardware details
    history         show command history
    host            Show host information
    incoming        Show ethernet input-policy information
: q

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

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

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

Для прекращения вывода данных используется клавиша «q».

Для перехода к следующей странице используется клавиша «SPACE».

Для перехода к предыдущей странице используется клавиша «b».

Для перемещения выводимой на экран информации на одну строчку вниз используется клавиша «ENTER».

Для перемещения выводимой информации на одну строчку вверх и на одну строчку вниз используются клавиши «⇧» и «⇩» соответственно.

Для перемещения выводимой информации влево и вправо используются клавиши «⇦» и «⇨» соответственно, если вывод данных в строке содержит количество символов, превышающее буфер отображаемой на экране информации по горизонтали.

В ARMA Стена используются следующие режимы работы:

«эксплуатационный режим» – позволяет осуществлять мониторинг состояния системы и служб, а также выполнять операции с файлами;

«конфигурационный режим» – позволяет вносить изменения в конфигурацию ARMA Стена.

После авторизации в системе ARMA Стена пользователь автоматически попадает в эксплуатационный режим. Для доступа к настройкам системы необходимо выполнить переход в конфигурационный режим с помощью команды «configure».

Для возврата из конфигурационного режима в эксплуатационный режим используется команда «exit». Если были внесены изменения в конфигурацию, их необходимо зафиксировать с помощью команды «commit» или отменить с помощью команды «discard» (или «exit discard»), прежде чем выйти в эксплуатационный режим.

Выполнение команды «exit» в эксплуатационном режиме приводит к выходу текущей УЗ из системы ARMA Стена.

Действующую в данный момент конфигурацию возможно сохранить в файл при помощи команды «save» в конфигурационном режиме. По умолчанию, конфигурация сохраняется в файл «config.boot» расположенном в каталоге «/config/». При инициализации системы происходит автоматическая загрузка конфигурации из файла «/config/config.boot». В связи с этим, после завершения настройки всех требуемых сервисов, необходимо выполнить сохранение текущей конфигурации в указанный файл для обеспечения корректной загрузки параметров при следующем запуске устройства. Рекомендуется выполнять регулярное сохранение конфигурации после внесения любых изменений в настройки системы.

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

имя учетной записи пользователя под которой выполнен вход в систему;

имя узла системы, на который выполнен вход;

текущий режим интерфейса командной строки;

текущий уровень в иерархии конфигурации (только для режима настройки).

В таблице «Запрос на ввод команд» приведены некоторые примеры запросов на ввод команд и их значения.

Таблица «Запрос на ввод команд»

Вид запроса

Описание запроса

admin@ngfwos:~$

Пользователь: admin

Имя узла: ngfwos

Режим работы: эксплуатационный режим

[edit]

admin@ngfwos#

Пользователь: admin

Имя узла: ngfwos

Режим работы: конфигурационный режим

Уровень в иерархии конфигурации: [edit] (верхний уровень)

Эксплуатационный режим

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

Основные команды эксплуатационного режима представлены в таблице «Команды эксплуатационного режима»

Таблица «Команды эксплуатационного режима»

Команда

Краткое описание

add

Добавить объект в службу

clear

Очистить информацию о системе

clone

Клонировать объект

configure

Войти в конфигурационный режим

connect

Установить соединение

copy

Копировать объект

delete

Удалить объект

disconnect

Разорвать соединение

exit

Выход из системы

force

Принудительное выполнение операции

format

Форматировать устройство

generate

Сгенерировать объект/ключ

import

Импортировать объект

install

Установить новую систему

monitor

Мониторинг системной информации

mtr

Проследить путь Traceroute и ping к цели

ping

Отправка эхо-запроса ICMP

poweroff

Выключить систему

reboot

Перезагрузить систему

release

Освободить указанную переменную

rename

Переименовать объект

renew

Обновить указанную переменную

reset

Сброс службы

restart

Перезапустить отдельную службу

set

Установить новую систему

show

Показать информацию о системе

suricata

Работает с правилами suricata

telnet

Telnet к узлу

traceroute

Трассировка сетевого пути к узлу

update

Обновление данных для службы

wake-on-lan

Отправка пакета Wake-On-LAN (WOL)

Конфигурационный режим

Конфигурационный режим предназначен для внесения и фиксации изменений конфигурации, а также сохранения конфигурационных файлов.

Для перехода из эксплуатационного режима в конфигурационный режим необходимо ввести команду «configure».

admin@ngfwos:~$ configure
[edit]
admin@ngfwos#

Подтверждением входа в конфигурационный режим является отображение символа «#» в командной строке.

Примечание

Наличие символов «admin@ngfwos:~$» в примерах кода указывает на то, что команду следует вводить в эксплуатационном режиме.

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

«set» – добавить значение параметра конфигурации, например, назначить IP-адрес для интерфейса «eth1».

[edit]
admin@ngfwos# set interfaces ethernet eth1 address 192.168.22.1/24

«delete» – удалить значение параметра конфигурации. При этом также удаляются все подуровни ниже текущего уровня, указанного в команде. При удалении записи элемент также примет значение по умолчанию, если таковое существует. Например, удалить IP-адрес для интерфейса «eth1».

[edit]
admin@ngfwos# delete interfaces ethernet eth1 address

«edit» – перейти к другому уровню редактирования конфигурации. Все команды, выполняемые в режиме конфигурации, связаны с определённым уровнем иерархической структуры, который задаётся администратором при вводе команд. В режиме конфигурации можно вносить изменения в настройки операционной системы с самого верхнего уровня иерархической структуры, однако в таком случае цепочка команд при ручном вводе будет достаточно длинной. Изменение уровня иерархической структуры позволяет сократить длину используемых команд и упростить настройку конфигурации операционной системы.

Например:
[edit]
admin@ngfwos# edit interfaces ethernet eth1
[edit interfaces ethernet eth1]
admin@ngfwos# set address 192.168.22.1/24
admin@ngfwos# set description "LAN"
Пример выше демонстрирует работу команды «edit». После ввода команды «edit interfaces ethernet eth1» система переходит на уровень иерархической структуры конфигурации, связанный с цепочкой команд «interfaces ethernet eth1». Все команды, будут выполняться в отношение данного уровня.

Для возвращения на самый верхний уровень иерархической структуры используются команды: «top» или «exit».

Для перемещения на один уровень иерархической структуры вверх используется команда «up».

«commit» – зафиксировать изменения, внесённые в конфигурацию.

После фиксации изменений «рабочая» конфигурация становится «активной».

Возможно добавить сообщении о фиксации с помощью команды:
commit comment <message>.
Примечание

При выходе из конфигурационного режима без предварительного выполнения команды «commit» настройки не будут применены.

«commit-confirm» – зафиксировать изменения конфигурации и по истечении 10 минут автоматически перезагрузить систему с использованием предыдущей сохранённой конфигурации.

Для подтверждения выполнения команды следует ввести «y» на запрос:
commit-confirm will automatically reboot in 10 minutes unless changes are confirmed.
Proceed ? [Y/n]
Примечание

Возможно дополнить команду указанием исчисляемого в минутах промежутка времени до перезагрузки системы, например «commit-confirm 25».

«save» – сохранить активную конфигурацию в файл config.boot:

[edit]
save
Примечание

В случае попытки перезагрузки или выключения системы ARMA Стена без предварительного сохранения изменённых настроек конфигурации, будет выведено следующее предупреждение:
Warning: there are unsaved configuration changes!
Run 'save' command if you do not want to lose those changes after reboot/shutdown.

«exit» – выйти из конфигурационного режима в эксплуатационный режим. Также команда может использоваться для перехода из какого-либо уровня редактирования конфигурации.

[edit interfaces ethernet eth1]
admin@ngfwos# exit
[edit]
admin@ngfwos# exit
exit
admin@ngfwos:~$
Примечание

Команда «exit» не применится для выхода из конфигурационного режима в случае наличия в конфигурации незафиксированных изменений.
[edit]
admin@ngfwos# exit
Cannot exit: configuration modified.
Use 'exit discard' to discard the changes and exit.
В случае выхода из конфигурационного режима без сохранения внесенных настроек системы выведет предупреждение и перейдёт в эксплуатационный режим:
[edit]
admin@ngfwos# exit
Warning: configuration changes have not been saved.
exit
admin@ngfwos:~$

«exit discard» – выйти из конфигурационного режима без сохранения изменений.
«run» – выполнить команду эксплуатационного режима без предварительного выхода из конфигурационного режима.

[edit]
admin@ngfwos# run show system commit

Команда «show», используемая в режиме конфигурации, позволяет отобразить рабочую конфигурацию с указанием «+» добавленных, «>» изменённых и «–» удалённых строк.
[edit] admin@ngfwos# show
Для команды возможно указать дополнительные параметры вывода информации о конфигурации системы ARMA Стена:
- show | commands - вывести конфигурацию системы в виде команд set.
  
  Примечание
  
  Для вывода информации обо всех выполненных командах «set» используется команда «run show configuration commands» в конфигурационном режиме или «show configuration commands» в эксплуатационном режиме.
- show | json - вывести конфигурацию системы в формате json.
- show | strip-private - скрытия конфиденциальных данных при выводе конфигурацию системы. При использовании данной команды происходит фильтрация выходных данных команды show, в результате чего удаляются или скрываются конфиденциальные данные, такие как пароли, ключи шифрования и другая чувствительная информация. Это может быть полезно, например, при необходимости предоставить техническую поддержку или сообществу доступ к логам или конфигурации устройства для устранения неполадок, при этом сохраняя конфиденциальность данных.
- show | count - вывести количество строк в конфигурационном файле системы.
- show | match <pattern> - выводить только строки, которые соответствуют указанному шаблону <pattern>.
- show | no-match <pattern> - выводить только строки, которые не соответствуют заданному шаблону <pattern>.
- show | more - разбить вывод на страницы.
- show | no-more - не разбивать вывод на страницы.