Справочник команд (CLI)#

В Angie ADC доступно два интерфейса командной строки (CLI), позволяющих управлять настройками Angie ADC:

  • СLI на порту 2222 (новая версия; рекомендуемый интерфейс для большинства операций, кроме настройки VRRP и HTTPS);

  • СLI на порту 2022 (старая версия).

Ниже приведен список команд в алфавитном порядке для новой версии СLI (на порту 2222). Список команд будет пополняться в ближайших релизах.

См. также инструкцию по запуску командной строки.

Синтаксис#

command option0 {option1|option2|...|option N} [option3] [{option4|option5|...|option M}] [option6 <user-input1>] [<user-input2>] <user-input3>

Параметры:

  • command — команда;

  • option0 — обязательный параметр;

  • {option1|option2|...|option N} — выбор из списка обязательных параметров;

  • [option3] — необязательный параметр;

  • [{option4|option5|...|option M}] — выбор из списка необязательных параметров;

  • [option6 <user-input1>] — необязательный параметр с пользовательским аргументом;

  • [<user-input2>] — необязательный пользовательский аргумент;

  • <user-input3> — обязательный пользовательский аргумент.

Возможности:

  • автодополнение команд по TAB;

  • поддержка истории команд;

  • подсказки по синтаксису команд по нажатию ?;

  • поддержка цветовой схемы;

  • поддержка сокращенных команд.

Поддерживаемые команды#

Команда

Задача

cert-config

Управление сертификатами

exit или Ctrl+Z

Выход из контекста

firewall

Управление правилами брандмауэра

ip

Выполнение команды ip

modules

Просмотр информации о динамических модулях

ping

Выполнение команды ping

pingc

Выполнение команды ping в cicso-style

quit или Ctrl+Q

Завершение сессии

settings

Просмотр и изменение настроек

show

Выполнение команды show

system

Управление системой

transfer

Работа с директорией transfer

vtysh

Выполнение команды vtysh

?

Список доступных команд

cert-config#

Контекст cert-config позволяет управлять сертификатами, используемыми Angie ADC.

Поддерживаемые команды:

cert-config

Вход в контекст

info

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

list

Вывод списка сертификатов traffic Angie ADC

match

Сопоставление пары ключ-сертификат

tls-upload

Контекст загрузки сертификатов и ключей Angie ADC

tls-use

Контекст копирования сертификатов и ключей Angie ADC из директории transfer

info#

Просмотр информации о сертификате.

Синтаксис: info {management | traffic [name <filename>]}.

Параметры:

  • management — просмотр информации о сертификате для управления Angie ADC;

  • traffic — просмотр информации о сертификате для передачи данных Angie ADC;

  • name <filename> — имя сертификата.

Пример:

(cert-config)$$ info traffic name site1.crt
Certificate:
    Data:
        Version: 3 (0x2)
        Serial Number: 1 (0x1)
        Signature Algorithm: sha1WithRSAEncryption
        Issuer: C = RU, ST = Moscow, O = Angie, OU = EVO, CN = Root CA
        Validity
            Not Before: Feb 18 12:23:08 2025 GMT
            Not After : Feb 18 12:23:08 2027 GMT
        Subject: CN = Demo Certificate, ST = Moscow, C = RU, O = Angie, OU = EVO
        Subject Public Key Info:
            Public Key Algorithm: rsaEncryption
                Public-Key: (4096 bit)
                Modulus:
...
(cert-config)$$

list#

Вывод списка сертификатов traffic Angie ADC.

Синтаксис: list.

Пример:

(cert-config)$$ list
cp.crt   : invalid
cp.key   : invalid
site1.crt: certificate
site1.key: key

Параметры:

  • invalid — сертификат или ключ не прошли проверку;

  • certificate — сертификат;

  • key — ключ.

match#

Сопоставление пары ключ-сертификат.

Синтаксис: match <certificate> <key>.

Параметры:

  • <certificate> — имя файла сертификата;

  • <key> — имя файла ключа.

Пример:

(cert-config)$$ match site1.crt site1.key
Certificate and key match
(cert-config)$$ match site1.crt site2.key
Certificate and key DO NOT match
(cert-config)$$

tls-upload#

Контекст загрузки сертификатов и ключей Angie ADC.

Поддерживаемые команды:

management

Загрузка сертификата и ключа для управления Angie ADC

tls-upload

Вход в контекст

traffic

Загрузка сертификатов и ключей для передачи данных Angie ADC

management#

Загрузка сертификата и ключа для управления Angie ADC.

Синтаксис: management {crt|key} [name <filename>].

Параметры:

  • crt — загрузка сертификата;

  • key — загрузка ключа;

  • name <filename> — имя сохраняемого файла (игнорируется для команды management).

Для загрузки сертификата или ключа необходимо вставить текст сертификата или ключа в строку, затем вставить пустую строку или написать END в новой строке.

Пример:

(cert-config-tls-upload)$$ management crt
Warning: filename will be ignored for management certificate
Insert the certificate line by line at the end of the input, add an empty line or enter END
-----BEGIN CERTIFICATE-----
MIIF9TCCA92gAwIBAgIBATANBgkqhkiG9w0BAQUFADBOMQswCQYDVQQGEwJSVTEP
...
Z7SIEeCr84fIlxFMpRxNGZhJQ67xWLwQmjVcphi037Wpx+6dmQRtp8Q=
-----END CERTIFICATE-----
END
Successfully wrote to /etc/angie/crt/cp.crt
(cert-config-tls-upload)$$

При загрузке ключа и сертификата проверяется их корректность. В случае некорректного значения сертификат или ключ не будет сохранен:

Пример вывода:

(cert-config-tls-upload)$$ management crt
Warning: filename will be ignored for management certificate
Insert the certificate line by line at the end of the input, add an empty line or enter END
simple cert

Validation error: Invalid certificate format
(cert-config-tls-upload)$$

traffic#

Загрузка сертификатов и ключей для передачи данных Angie ADC.

Синтаксис: traffic {crt|key} [name <filename>].

Параметры:

  • crt — загрузка сертификата;

  • key — загрузка ключа;

  • name <filename> — имя сохраняемого файла (если отсутствует, то будет использовано имя cp.crt для сертификата и cp.key для ключа).

Для загрузки сертификата или ключа необходимо вставить текст сертификата или ключа в строку, затем вставить пустую строку или написать END в новой строке.

Пример загрузки сертификата с именем:

(cert-config-tls-upload)$$ traffic crt name site1.crt
Insert the certificate line by line at the end of the input, add an empty line or enter END
-----BEGIN CERTIFICATE-----
MIIF9TCCA92gAwIBAgIBATANBgkqhkiG9w0BAQUFADBOMQswCQYDVQQGEwJSVTEP
...
Z7SIEeCr84fIlxFMpRxNGZhJQ67xWLwQmjVcphi037Wpx+6dmQRtp8Q=
-----END CERTIFICATE-----

Successfully wrote to /etc/angie-lb/crt/site1.crt

При загрузке ключа и сертификата проверяется их корректность. В случае некорректного значения сертификат или ключ не будет сохранен.

tls-use#

Контекст копирования сертификатов и ключей Angie ADC из директории transfer.

Поддерживаемые команды:

management

Копирование сертификата и ключа для управления Angie ADC из директории transfer

tls-use

Вход в контекст

traffic

Копирование сертификатов и ключей для передачи данных Angie ADC из директории transfer

management#

Копирование сертификата и ключа для управления Angie ADC из директории transfer.

Синтаксис: management {crt|key} <source_filename> [name <destination_filename>].

Параметры:

  • crt — копирование сертификата;

  • key — копирование ключа;

  • <source-filename> — имя файла в директории transfer;

  • name <destination-filename> — имя сохраняемого файла (игнорируется для команды management).

Пример:

(cert-config-tls-use)$$ management crt cert1.crt
Warning: filename will be ignored for management certificate
Successfully wrote to /etc/angie/crt/cp.crt
(cert-config-tls-use)$$

При копировании сертификата или ключа проверяется их корректность. В случае некорректного значения сертификат или ключ не будет сохранен.

traffic#

Копирование сертификатов и ключей для передачи данных Angie ADC из директории transfer.

Синтаксис: traffic {crt|key} <source_filename> [name <destination_filename>].

Параметры:

  • crt — копирование сертификата;

  • key — копирование ключа;

  • <source-filename> — имя файла в директории transfer;

  • name <destination-filename> — имя сохраняемого файла (если отсутствует, то будет использовано имя cp.crt для сертификата и cp.key для ключа).

Пример копирования сертификата с именем:

(cert-config-tls-use)$$ traffic crt cert1.crt name site1.crt
Successfully wrote to /etc/angie-lb/crt/site1.crt
(cert-config-tls-use)$$

При копировании ключа и сертификата проверяется их корректность. В случае некорректного значения сертификат или ключ не будет сохранен.

exit#

Выполнение команды exit (выход из контекста).

firewall#

Контекст firewall позволяет управлять правилами брандмауэра Angie ADC.

Поддерживаемые команды:

firewall

Вход в контекст

list

Вывод списка правил брандмауэра Angie ADC

no open

Закрытие порта в брандмауэре Angie ADC

open

Открытие порта в брандмауэре Angie ADC

save

Сохранение правил брандмауэра Angie ADC

list#

Вывод списка правил брандмауэра Angie ADC.

Синтаксис: list {ip|ip6}.

Параметры:

  • ip — вывод списка правил для IPv4;

  • ip6 — вывод списка правил для IPv6.

Пример вывода:

(firewall)$$ list ip
tcp 9999 enp0s2
(firewall)$$

no open#

Закрытие порта в брандмауэре Angie ADC.

Синтаксис: no open {ip|ip6} {tcp|udp} <port> <interface>.

Параметры:

  • ip — порт для IPv4;

  • ip6 — порт для IPv6;

  • tcp — порт для протокола TCP;

  • udp — порт для протокола UDP;

  • <port> — номер порта;

  • <interface> — интерфейс.

Пример:

(firewall)$$ no open ip tcp 9999 enp0s2
Port 9999/tcp successfully closed on interface enp0s2
(firewall)$$

open#

Открытие порта в брандмауэре Angie ADC.

Синтаксис: open {ip|ip6} {tcp|udp} <port> <interface>.

Параметры:

  • ip — порт для IPv4;

  • ip6 — порт для IPv6;

  • tcp — порт для протокола TCP;

  • udp — порт для протокола UDP;

  • <port> — номер порта;

  • <interface> — интерфейс.

Пример:

(firewall)$$ open ip tcp 9999 enp0s2
Port 9999/tcp successfully opened on interface enp0s2
(firewall)$$

Примечание

При настройке конфигурации не занимайте следующие порты (эти порты используются внутренними сервисами Angie ADC):

TCP: 22, 25, 53, 2022, 2222, 2601, 2602, 2603, 2604, 2605, 2606, 2615, 2616, 2617, 2619, 2623, 3000, 3050, 3051, 3053, 3081, 3101, 3111, 5432, 8080, 9090, 9898

UDP: 53, 323, 3784, 3785, 4784

save#

Сохранение правил брандмауэра Angie ADC.

Синтаксис: save.

ip#

Выполнение команды ip.

modules#

Контекст modules позволяет просматривать информацию о динамических модулях Angie ADC.

info

Получение информации о динамическом модуле Angie ADC

list

Получение списка доступных динамических модулей Angie ADC

modules

Вход в контекст

info#

Получение информации о динамическом модуле Angie ADC.

Синтаксис: info <module>.

Параметры:

  • <module> — имя модуля.

list#

Получение списка доступных динамических модулей Angie ADC.

Синтаксис: list.

ping#

Выполнение команды ping.

Синтаксис: ping [-c <count>] [-n] <hostname>

Параметры:

  • -c <count> — количество пакетов (по умолчанию бесконечно);

  • -n — не резолвить имя хоста;

  • <hostname> — имя хоста или IP-адрес.

pingc#

Выполнение команды ping в cisco-style.

Синтаксис: pingc {ip|ip6} <hostname> [count <n>]

Параметры:

  • ip — выполнение пинга через ipv4;

  • ip6 — выполнение пинга через ipv6;

  • <hostname> — имя хоста или IP-адрес;

  • count <n> — количество пакетов (по умолчанию 4).

quit#

Выполнение команды quit (завершение сессии).

settings#

Контекст settings позволяет просматривать и изменять настройки Angie ADC.

Поддерживаемые команды:

angie

Включение режима отладки

nf_conntrack

Управление размером таблицы коннектов

no angie

Отключение режима отладки

no nf_conntrack

Сброс настроек таблицы коннектов

reload

Перезагрузка элементов Angie ADC

settings

Вход в контекст

angie#

Включение режима отладки.

Cинтаксис: angie debug.

nf_conntrack#

Управление размером таблицы коннектов.

Cинтаксис: nf_conntrack max <size>.

Параметры:

  • <size> — размер таблицы коннектов.

no angie#

Отключение режима отладки angie.

Cинтаксис: no angie debug.

no nf_conntrack#

Сброс настроек таблицы коннектов.

Cинтаксис: no nf_conntrack [max <size>].

reload#

Перезагрузка элементов Angie ADC.

Cинтаксис: reload {angie|prometheus}.

Параметры:

  • angie — перезагрузка angie-mgmt;

  • prometheus — перезагрузка prometheus.

show#

Выполнение команды show.

system#

Контекст system для управления системой Angie ADC.

Поддерживаемые команды:

reboot

Перезагрузка системы Angie ADC

stat

Просмотр статистики системы Angie ADC

system

Вход в контекст

upgrade

Обновление Angie ADC

version

Просмотр версии Angie ADC

reboot#

Перезагрузка системы Angie ADC.

Синтаксис: reboot [force]

Параметры:

  • force — принудительная перезагрузка.

stat#

Просмотр статистики системы Angie ADC.

Синтаксис: stat [count <n>] [delay <m>]

Параметры:

  • count <n> — количество обновлений статистики;

  • delay <m> — задержка между обновлениями статистики в секундах.

upgrade#

Обновление Angie ADC.

Синтаксис: upgrade <filename>

Параметры:

  • <filename> — имя файла.

version#

Просмотр версии Angie ADC.

Синтаксис: version [detail]

Параметры:

  • detail — подробный вывод версии.

transfer#

Контекст transfer для работы с директорией transfer.

Поддерживаемые команды:

ls

Получение списка файлов в директории transfer

rm

Удаление файла в директории transfer

transfer

Вход в контекст

view

Просмотр содержимого файла в директории transfer

ls#

Получение списка файлов в директории transfer.

Синтаксис: ls.

rm#

Удаление файла в директории transfer. Синтаксис: rm <filename>.

Параметры:

  • <filename> — имя файла.

view#

Просмотр содержимого файла в директории transfer.

Синтаксис: view <filename> [page].

Параметры:

  • <filename> — имя файла;

  • page — вывод записей в режиме постраничного просмотра.

vtysh#

Выполнение команды vtysh.

?#

Выполнение команды ? (список доступных команд контекста).