<a id="adc-cli-commands"></a>

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

Рекомендуемый интерфейс для всех операций кроме настройки VRRP — СLI на порту 2222.

#### IMPORTANT
Настройка VRRP поддерживается только через CLI на порту 2022 (подробнее
см. [VRRP-маршрутизация](https://angie.software//adc/docs/routing/vrrp/index.md#adc-vrrp)).

Возможности: автодополнение команд по `TAB`; поддержка истории команд;
подсказки по синтаксису команд по нажатию `?`;
поддержка цветовой схемы;
поддержка сокращенных команд.

<a id="angie-adc-cli"></a>

<a id="adc-starting-cli"></a>

### Запуск СLI на порту 2222

При запуске Angie ADC интерфейс командной строки Angie ADC
будет доступен по SSH-протоколу на порту 2222.
Доступ осуществляется с помощью SSH-клиента.

Чтобы запустить интерфейс командной строки (CLI), выполните следующие действия:

1. Подключитесь к SSH-серверу:
   ```console
   ssh -p 2222 user@localhost
   ```
2. После подключения сервер запроcит пароль для авторизации. Введите пароль:
   ```console
   user@localhost's password:
   #
   ```

   Если авторизация прошла успешно, откроется терминал Angie ADC.
   Справка доступна по `?`.
3. Для настройки протоколов BGP, OSPF и BFD дополнительно
   перейдите в настройки **vtysh**:
   ```console
   vtysh
   ```

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

### Запуск СLI на порту 2022

При запуске Angie ADC интерфейс командной строки Angie ADC
будет доступен по SSH-протоколу на порту 2022.
Доступ осуществляется с помощью SSH-клиента.

Чтобы запустить интерфейс командной строки (CLI), выполните следующие действия:

1. Подключитесь к SSH-серверу:
   ```console
   ssh -p 2022 user@localhost
   ```
2. После подключения сервер запроcит пароль для авторизации. Введите пароль:
   ```console
   user@localhost's password:
   #
   ```

   Если авторизация прошла успешно, откроется терминал Angie ADC.
   Справка доступна по `?`.
3. Для настройки протоколов BGP, OSPF и BFD дополнительно
   перейдите в настройки **vtysh**:
   ```console
   vtysh
   ```

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

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

Ниже приведен список команд в алфавитном порядке для новой версии CLI (на порту 2222).

Основные команды:

| 1. [cert-config](#adc-cli-cert-config)        | Управление сертификатами                                                                                                                                                                                           |
|-----------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| [disable](#adc-cli-cert-config-disable)       | Отключение TLS                                                                                                                                                                                                     |
| [enable](#adc-cli-cert-config-enable)         | Включение TLS                                                                                                                                                                                                      |
| [info](#adc-cli-cert-config-info)             | Просмотр информации о сертификате                                                                                                                                                                                  |
| [list](#adc-cli-cert-config-list)             | Вывод списка сертификатов `traffic` Angie ADC                                                                                                                                                                      |
| [match](#adc-cli-cert-config-match)           | Сопоставление пары `ключ-сертификат`                                                                                                                                                                               |
| [tls-upload](#adc-cli-cert-config-tls-upload) | Контекст загрузки сертификатов и ключей Angie ADC                                                                                                                                                                  |
| [tls-use](#adc-cli-cert-config-tls-use)       | Контекст копирования сертификатов и ключей Angie ADC из директории `transfer`                                                                                                                                      |
| 1. [configuration](#adc-cli-config)           | Переход в режим настройки Angie ADC                                                                                                                                                                                |
| [commit](#adc-cli-config-commit)              | Применение конфигурации-кандидата вместо текущей конфигурации.                                                                                                                                                     |
| [end](#adc-cli-config-end)                    | Выход из режима настройки `configuration`.                                                                                                                                                                         |
| [rollback](#adc-cli-config-rollback)          | Отмена всех изменений в конфигурации-кандидате.                                                                                                                                                                    |
| [set](#adc-cli-config-set)                    | Изменение текущей конфигурации: добавление строки (создает конфигурацию-кандидат):<br/><br/>- системные настройки: hostname / interface / ntp / sysctl / timezone;<br/>- настройки маршрутизации: ip route / rule. |
| [show](#adc-cli-config-show)                  | Просмотр текущей конфигурации и конфигурации-кандидата.                                                                                                                                                            |
| [unset](#adc-cli-config-unset)                | Изменение текущей конфигурации: удаление строки (создает конфигурацию-кандидат).                                                                                                                                   |
| 1. [diagnostics](#adc-cli-diagnostics)        | Сетевая диагностика                                                                                                                                                                                                |
| [arping](#adc-cli-diagnostics-arping)         | Отправка ARP-запросов сетевым хостам.                                                                                                                                                                              |
| [diag](#adc-cli-diagnostics-diag)             | Общая диагностика системы.                                                                                                                                                                                         |
| [nslookup](#adc-cli-diagnostics-nslookup)     | Выполнение DNS-запросов.                                                                                                                                                                                           |
| [ping](#adc-cli-diagnostics-ping)             | Выполнение команды `ping`.                                                                                                                                                                                         |
| [pingc](#adc-cli-diagnostics-pingc)           | Выполнение команды `ping` в стиле Cisco.                                                                                                                                                                           |
| [ss](#adc-cli-diagnostics-ss)                 | Просмотр информации о сетевых соединениях, портах и статистике сетевых сокетов.                                                                                                                                    |
| [ssldump](#adc-cli-diagnostics-ssldump)       | Анализ SSL/TLS-трафика.                                                                                                                                                                                            |
| [tcpdump](#adc-cli-diagnostics-tcpdump)       | Анализ сетевого трафика.                                                                                                                                                                                           |
| [traceroute](#adc-cli-diagnostics-traceroute) | Трассировка маршрута следования пакетов.                                                                                                                                                                           |
| 1. [firewall](#adc-cli-firewall)              | Управление правилами брандмауэра                                                                                                                                                                                   |
| [list](#adc-cli-firewall-list)                | Вывод списка правил брандмауэра Angie ADC                                                                                                                                                                          |
| [no open](#adc-cli-firewall-no-open)          | Закрытие порта в брандмауэре Angie ADC                                                                                                                                                                             |
| [open](#adc-cli-firewall-open)                | Открытие порта в брандмауэре Angie ADC                                                                                                                                                                             |
| [save](#adc-cli-firewall-save)                | Сохранение правил брандмауэра Angie ADC                                                                                                                                                                            |
| 1. [ip](#adc-cli-ip)                          | Стандартное управление сетевыми интерфейсами,<br/>маршрутами, адресами и правилами IP-трафика в Linux                                                                                                              |
| 1. [logs](#adc-cli-logs)                      | Просмотр журналов                                                                                                                                                                                                  |
| [adc-gslb](#adc-cli-logs-gslb)                | События модуля GSLB (глобальная балансировка)                                                                                                                                                                      |
| [adc-server](#adc-cli-logs-server)            | События модуля, обеспечивающего<br/>выполнение всего предоставляемого функционала Angie ADC (входная точка)                                                                                                        |
| [adc-system](#adc-cli-logs-system)            | События модуля, отвечающего за выполнение системных команд Angie ADC                                                                                                                                               |
| [adc-tracker](#adc-cli-logs-tracker)          | События модуля, отвечающего за RHI-функционал                                                                                                                                                                      |
| [kern](#adc-cli-logs-kern)                    | События ядра                                                                                                                                                                                                       |
| [lb](#adc-cli-logs-lb)                        | События модуля балансировщика нагрузки                                                                                                                                                                             |
| [mgmt](#adc-cli-logs-mgmt)                    | События модуля, отвечающего за управление Angie ADC                                                                                                                                                                |
| [session-store](#adc-cli-logs-session-store)  | События модуля, отвечающего за хранение sticky-сессий в паре высокой доступности                                                                                                                                   |
| [upgrade](#adc-cli-logs-upgrade)              | События обновления Angie ADC                                                                                                                                                                                       |
| 1. [modules](#adc-cli-modules)                | Просмотр информации о динамических модулях                                                                                                                                                                         |
| [info](#adc-cli-modules-info)                 | Получение информации о динамическом модуле Angie ADC                                                                                                                                                               |
| [list](#adc-cli-modules-list)                 | Получение списка доступных динамических модулей Angie ADC                                                                                                                                                          |
| 1. [ps](#adc-cli-ps)                          | Отображение информации о процессах, запущенных в системе                                                                                                                                                           |
| 1. [settings](#adc-cli-settings)              | Просмотр и изменение системных настроек Angie ADC (NTP, отладка, настройка времени и т. д.)                                                                                                                        |
| [angie](#adc-cli-settings-angie)              | Включение режима отладки                                                                                                                                                                                           |
| [no angie](#adc-cli-settings-no-angie)        | Отключение режима отладки                                                                                                                                                                                          |
| [reload](#adc-cli-settings-reload)            | Перезагрузка элементов Angie ADC                                                                                                                                                                                   |
| [sysctl](#adc-cli-settings-sysctl)            | Просмотр параметров ядра Linux в реальном времени                                                                                                                                                                  |
| [syslog](#adc-cli-settings-syslog)            | Управление syslog/Logstash-серверами логирования.                                                                                                                                                                  |
| 1. [system](#adc-cli-system)                  | Перезагрузка и обновление Angie ADC                                                                                                                                                                                |
| [ntp](#adc-cli-system-ntp)                    | Просмотр статуса NTP                                                                                                                                                                                               |
| [reboot](#adc-cli-system-reboot)              | Перезагрузка системы Angie ADC                                                                                                                                                                                     |
| [stat](#adc-cli-system-stat)                  | Просмотр статистики системы Angie ADC                                                                                                                                                                              |
| [time](#adc-cli-system-time)                  | Просмотр и установка системного времени                                                                                                                                                                            |
| [timezone](#adc-cli-system-timezone)          | Просмотр часового пояса системы                                                                                                                                                                                    |
| [upgrade](#adc-cli-system-upgrade)            | Обновление Angie ADC                                                                                                                                                                                               |
| [version](#adc-cli-system-version)            | Просмотр версии Angie ADC                                                                                                                                                                                          |
| 1. [transfer](#adc-cli-transfer)              | Работа с директорией `transfer`                                                                                                                                                                                    |
| [edit](#adc-cli-transfer-edit)                | Редактирование файла в текущей директории.                                                                                                                                                                         |
| [ls](#adc-cli-transfer-ls)                    | Получение списка файлов в директории `transfer`                                                                                                                                                                    |
| [rm](#adc-cli-transfer-rm)                    | Удаление файла в директории `transfer`                                                                                                                                                                             |
| [view](#adc-cli-transfer-view)                | Просмотр содержимого файла в директории `transfer`                                                                                                                                                                 |
| 1. [vtysh](#adc-cli-vtysh)                    | Переход к настройкам маршрутизации по протоколам BGP и OSPF                                                                                                                                                        |

Служебные команды:

| `exit` или `Ctrl`+`Z`   | Выход из контекста       |
|-------------------------|--------------------------|
| `quit` или `Ctrl`+`Q`   | Завершение сессии        |
| `show`                  | Вывод текущего состояния |
| `?`                     | Список доступных команд  |

## Синтаксис

```none
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>`                    | обязательный пользовательский аргумент                |

<a id="adc-cli-cert-config"></a>

## cert-config

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

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

| `cert-config`                                 | Вход в контекст                                                               |
|-----------------------------------------------|-------------------------------------------------------------------------------|
| [disable](#adc-cli-cert-config-disable)       | Отключение TLS                                                                |
| [enable](#adc-cli-cert-config-enable)         | Включение TLS                                                                 |
| [info](#adc-cli-cert-config-info)             | Просмотр информации о сертификате                                             |
| [list](#adc-cli-cert-config-list)             | Вывод списка сертификатов `traffic` Angie ADC                                 |
| [match](#adc-cli-cert-config-match)           | Сопоставление пары `ключ-сертификат`                                          |
| [tls-upload](#adc-cli-cert-config-tls-upload) | Контекст загрузки сертификатов и ключей Angie ADC                             |
| [tls-use](#adc-cli-cert-config-tls-use)       | Контекст копирования сертификатов и ключей Angie ADC из директории `transfer` |

<a id="adc-cli-cert-config-disable"></a>

### disable

Выключает управление TLS-сертификатами.

Синтаксис: `disable management`.

<a id="adc-cli-cert-config-enable"></a>

### enable

Включает управление TLS-сертификатами.

Синтаксис: `enable management`.

<a id="adc-cli-cert-config-info"></a>

### info

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

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

Параметры:

- `management` — просмотр информации о сертификате для управления Angie ADC;
- `traffic` — просмотр информации о сертификате для передачи данных Angie ADC;
- `name <filename>`  — имя сертификата.

Пример:

```none
(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)$$
```

<a id="adc-cli-cert-config-list"></a>

### list

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

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

Пример:

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

Параметры:

- `invalid` — сертификат или ключ не прошли проверку;
- `certificate` — сертификат;
- `key` — ключ.

<a id="adc-cli-cert-config-match"></a>

### match

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

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

Параметры:

- `<certificate>` — имя файла сертификата;
- `<key>` — имя файла ключа.

Пример:

```none
(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)$$
```

<a id="adc-cli-cert-config-tls-upload"></a>

### 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` в новой строке.

Пример:

```none
(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)$$
```

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

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

```none
(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` в новой строке.

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

```none
(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
```

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

<a id="adc-cli-cert-config-tls-use"></a>

### 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`).

Пример:

```none
(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` для ключа).

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

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

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

<a id="adc-cli-config"></a>

## configuration

Режим настройки Angie ADC.
В этом режиме можно изменять текущую конфигурацию Angie ADC.

Чтобы внести изменения:

1. Задайте необходимые параметры с помощью команд `set` (добавляет строку) и `unset` (удаляет строку).
2. Сравните текущую конфигурацию и конфигурацию-кандидат с помощью команды `show`.
3. Примените изменения с помощью команды `commit`.

#### IMPORTANT
Изменения будут применены только после выполнения команды `commit`.

Если необходимо, вы можете откатить всю конфигурацию-кандидат с помощью команды `rollback` до ее сохранения.

Пример:

```none
$$ configuration
## set system interface enp0s2 type dhcp
## show
-> Current configuration
set system interface enp0s2 type static
set system interface enp0s2 ip address 10.21.20.31/22
set system interface enp0s2 ip gateway 10.21.20.1
set system interface enp0s2 ip dns 8.8.8.8
set system interface enp0s2 ip dns 1.1.1.1

-> Candidate configuration
set system interface enp0s2 type dhcp
## commit
```

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

| `configuration`                      | Вход в режим настройки                                                             |
|--------------------------------------|------------------------------------------------------------------------------------|
| [commit](#adc-cli-config-commit)     | Применение конфигурации-кандидата вместо текущей конфигурации.                     |
| [end](#adc-cli-config-end)           | Выход из режима настройки `configuration`.                                         |
| [rollback](#adc-cli-config-rollback) | Отменяет все изменения в конфигурации-кандидате.                                   |
| [set](#adc-cli-config-set)           | Изменение текущей конфигурации: добавление строки (создает конфигурацию-кандидат). |
| [show](#adc-cli-config-show)         | Просмотр текущей конфигурации и конфигурации-кандидата.                            |
| [unset](#adc-cli-config-unset)       | Изменение текущей конфигурации: удаление строки (создает конфигурацию-кандидат).   |

<a id="adc-cli-config-commit"></a>

### commit

Применение конфигурации-кандидата в качестве активной конфигурации.

<a id="adc-cli-config-end"></a>

### end

Выход из режима `configuration`.

<a id="adc-cli-config-rollback"></a>

### rollback

Отменяет все изменения в конфигурации-кандидате.

<a id="adc-cli-config-set"></a>

### set

Переход к изменению текущей конфигурации Angie ADC.

#### IMPORTANT
Будет создана конфигурациия-кандидат.
Изменения будут применены только после выполнения команды `commit`.

Синтаксис: `set system <system_input> | ip <ip_input>`, где:

- `system <system_input>` — изменение параметров конфигурации (hostname / interface / ntp / sysctl / timezone);
- `ip <ip_input>` — настройка маршрутов и правил IP-трафика (route / rule).

Возможные варианты `<system_input>`:

- `set system hostname <name>` — установка имени хоста для Angie ADC.
- `set system interface <name> {ip <keyword> <value> | type {static | dhcp}}` — настройка интерфейса.
  - Возможные значения для `<keyword>`:
    - `address`  — установка IP-адреса для интерфейса.
    - `gateway` — установка шлюза для интерфейса.
    - `dns` — установка DNS-адреса для интерфейса.
    - `searches` — установка доменов поиска для интерфейса (до 10 доменов).
  - `type static` — используется по умолчанию.
    Этот параметр можно не указывать указывать явно.
  - `type dhcp` — удаляет все IP-параметры интерфейса
    и включает режим автоматического получения настроек с DHCP-сервера.
- `set system ntp enable | ntp server <name> [minpoll <value>] [maxpoll <value>]`

  Параметры:
  - `enable` — включение службы NTP-синхронизации.
  - `server <name>` — добавление нового NTP-сервера.
  - `minpoll <value>` — минимальный интервал опроса как степень двойки
    (от 4 до 17, по умолчанию: 6), необязательный параметр.
  - `maxpoll <value>` — максимальный интервал опроса как степень двойки
    (от 4 до 17, по умолчанию: 10), необязательный параметр.
- `set system sysctl <variable> <value>`
  — настройка параметров ядра Linux
  (`variable` — настраиваемый параметр, `value` — его значение).
- `set system timezone <value>`

  Часовой пояс определяет смещение локального времени относительно UTC.
  Изменение часового пояса не изменяет системное время (Unix timestamp),
  а только влияет на его отображение.
  Часовой пояс должен быть указан в формате IANA Time Zone Database
  (например, `Europe/Moscow`)
  или в виде аббревиатуры (например, `UTC`, `EST`, `PST`).

Примеры:

```none
$$ configuration
## set system hostname adc-home
## set system interface enp0s2 ip address 10.21.20.39/22
## set system interface enp0s2 ip gateway 10.21.20.1
## set system interface enp0s2 ip dns 8.8.8.8
## set system interface enp0s2 ip searches angie.software.ru
## set system sysctl net.ipv4.ip_forward 1
## set system sysctl net.core.somaxconn 1024
## set system ntp server pool.ntp.org minpoll 4 maxpoll 17
## set system timezone Europe/Moscow
```

Возможные варианты `<ip_input>`:

- `rule from <address> table <value>` — установка правила.
- `route <address> {nexthop <address> | interface <name>} [table <value>] [type local]`
  — установка маршрута. Минимально необходимо задать адрес и `nexthop` или `interface`,
  остальные параметры (таблица маршрутизации и тип маршрута) опциональны.

Пример:

```none
$$ configuration
## set ip rule from 0.0.0.0/0 table 100
## set ip route 0.0.0.0/0 nexthop 10.90.90.90
```

<a id="adc-cli-config-show"></a>

### show

Просмотр текущей конфигурации и конфигурации-кандидата.

<a id="adc-cli-config-unset"></a>

### unset

Переход к изменению текущей конфигурации Angie ADC.
Удаляет параметр из конфигурации-кандидата.

#### IMPORTANT
Будет создана конфигурациия-кандидат.
Изменения будут применены только после выполнения команды `commit`.

Пример:

```none
$$ configuration
## unset ip rule from 0.0.0.0/0 table 100
## show
-> Current configuration
set system interface enp0s2 type static
set system interface enp0s2 ip address 10.21.20.31/22
set ip rule from 0.0.0.0/0 table 100

-> Candidate configuration
set system interface enp0s2 type static
set system interface enp0s2 ip address 10.21.20.31/22
 ## commit
```

<a id="adc-cli-diagnostics"></a>

## diagnostics

Контекст `diagnostics` позволяет проводить диагностику сети
и анализировать сетевой трафик.

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

| `diagnostics`                                 | Вход в контекст                                                                 |
|-----------------------------------------------|---------------------------------------------------------------------------------|
| [arping](#adc-cli-diagnostics-arping)         | Отправка ARP-запросов сетевым хостам.                                           |
| [diag](#adc-cli-diagnostics-diag)             | Общая диагностика системы.                                                      |
| [nslookup](#adc-cli-diagnostics-nslookup)     | Выполнение DNS-запросов.                                                        |
| [ping](#adc-cli-diagnostics-ping)             | Выполнение команды `ping`.                                                      |
| [pingc](#adc-cli-diagnostics-pingc)           | Выполнение команды `ping` в стиле Cisco.                                        |
| [ss](#adc-cli-diagnostics-ss)                 | Просмотр информации о сетевых соединениях, портах и статистике сетевых сокетов. |
| [ssldump](#adc-cli-diagnostics-ssldump)       | Анализ SSL/TLS-трафика.                                                         |
| [tcpdump](#adc-cli-diagnostics-tcpdump)       | Анализ сетевого трафика.                                                        |
| [traceroute](#adc-cli-diagnostics-traceroute) | Трассировка маршрута следования пакетов.                                        |

<a id="adc-cli-diagnostics-arping"></a>

### arping

Отправка ARP-запросов сетевым хостам.

Синтаксис: `arping [-c <count>] [-w <deadline>] [-t <interval>] [-if <interface>] [-src <source>] [-d] [-u] [-a] [-f] [-b] [-q] <target>`

Параметры:

- `-c <count>` — количество ARP-запросов для отправки перед завершением команды;
- `-w <deadline>` — максимальное время ожидания ответа в секундах;
- `-t <interval>` — интервал между отправкой запросов в секундах;
- `-if <interface>` — сетевой интерфейс, через который отправлять запросы;
- `-src <source>` — исходный IP-адрес для использования в запросах;
- `-d` — режим обнаружения дубликатов адресов;
- `-u` — режим незапрошенного ARP: отправка ARP-пакетов без ожидания ответа (для обновления ARP-кэша);
- `-a` — режим ответа ARP: команда будет отвечать на входящие ARP-запросы;
- `-f` — завершить выполнение при получении первого ответа;
- `-b` — широковещательный режим: отправка запросов на широковещательный адрес;
- `-q` — тихий режим: минимальный вывод информации;
- `<target>` — IP-адрес или имя хоста, к которому отправляются ARP-запросы (обязательный параметр).

Примеры:

- `(diagnostics)$$ arping 192.168.1.1` — проверка доступности хоста.
- `(diagnostics)$$ arping -c 5 -w 10 192.168.1.100` — отправка до 5 ARP-запросов и ожидание ответа не более 10 секунд.
- `(diagnostics)$$ arping -d 192.168.1.50` — проверка на дублирование адреса.
- `(diagnostics)$$ arping -u -if eth0 192.168.1.1` — незапрошенный ARP для обновления кэша.

<a id="adc-cli-diagnostics-diag"></a>

### diag

Выполнение общей диагностики. Собираются системные метрики, конфигурация системы
и системный журнал за последние 24 часа. Информация сохраняется
в файл `diag_<timestamp>.log`, например в папке `/var/transfer`.

Синтаксис: `diag`

<a id="adc-cli-diagnostics-nslookup"></a>

### nslookup

Выполнение DNS-запросов.

#### Разовый запрос

Синтаксис: `nslookup <host>`

Примеры:

- `(diagnostics)$$ nslookup example.com` — прямой DNS-запрос.
- `(diagnostics)$$ nslookup 93.184.216.34` — обратный DNS-запрос (PTR).

#### Интерактивный режим

В интерактивном режиме можно выполнять множественные DNS-запросы.

Переход в интерактивный режим: `(diagnostics)$$ nslookup`

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

- `host [<server>]`
  — поиск информации о хосте с использованием текущего сервера по умолчанию или указанного сервера.
- `server <domain>`
  — изменение сервера по умолчанию.
  Для поиска информации о домене используется текущий сервер.
- `lserver <domain>`
  — изменение сервера по умолчанию.
  Для поиска информации о домене используется начальный сервер (тот, с которым запущен nslookup).
- `set keyword[=value]`
  — изменение параметров конфигурации, где `keyword` — имя параметра,
  `value` — значение (если поддерживается).

  Возможные варианты:
  - `set all` — вывод всех текущих настроек.
  - `set class=value` — изменение класса запроса.

    Доступные значения:
    - `IN` — класс Internet (по умолчанию);
    - `CH` — класс Chaos;
    - `HS` — класс Hesiod;
    - `ANY` — подстановочный знак.
  - `set [no]debug` — включение или выключение отображения полного пакета ответа.
    По умолчанию `nodebug`.
  - `set [no]d2` — включение или выключение режима отладки.
    По умолчанию `nod2`.
  - `set domain=<name>` — установка списка поиска доменов по умолчанию.
  - `set [no]search` — если запрос содержит хотя бы одну точку,
    но не заканчивается точкой, добавляет имена доменов из списка поиска доменов
    к запросу до получения ответа. По умолчанию `search`.
  - `set port=<value>` — изменение порта TCP/UDP-сервера имен
    (по умолчанию 53).
  - `set querytype=<value>` — изменение типа запроса информации.
    По умолчанию A, затем AAAA.
  - `set type=<value>` — изменение типа запроса информации.
    По умолчанию A, затем AAAA.
  - `set [no]recurse` — включение или выключение рекурсивных запросов.
    По умолчанию `recurse`.
  - `set ndots=<number>` — установка количества точек (разделителей меток) в домене,
    при котором поиск отключается. Абсолютные имена всегда останавливают поиск.
  - `set retry=<number>` — установка количества повторных попыток.
  - `set timeout=<number>` — изменение начального интервала ожидания ответа (в секундах).
  - `set[no]vc` — указывает, должен ли использоваться виртуальный канал
    при отправке запросов к серверу. По умолчанию `novc`.
  - `set [no]fail` — использовать ли следующий сервер имен,
    при ошибке на первом сервере. По умолчанию `nofail`.

<a id="adc-cli-diagnostics-ping"></a>

### ping

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

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

Параметры:

- `-c <count>` — количество пакетов (по умолчанию бесконечно);
- `-n` — не резолвить имя хоста;
- `<hostname>` — имя хоста или IP-адрес.

<a id="adc-cli-diagnostics-pingc"></a>

### pingc

Выполнение команды `ping` в стиле Cisco.

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

Параметры:

- `ip` — выполнение пинга через ipv4;
- `ip6` — выполнение пинга через ipv6;
- `<hostname>` — имя хоста или IP-адрес;
- `count <n>` — количество пакетов (по умолчанию 4).

<a id="adc-cli-diagnostics-ss"></a>

### ss

Позволяет получать детальную информацию о TCP/UDP-соединениях,
открытых портах, процессах, использующих сеть, и статистике сетевых интерфейсов.

Синтаксис: `ss [-t] [-u] [-l] [-p] [-a] [-n] [-r] [-s] [-e] [-i] [-4] [-6] [-o] [-m] [-h] [<expression>]`

#### Параметры

- `-t` — отображение только TCP-соединений.
- `-u` — отображение только UDP-соединений.
- `-l` — отображение только прослушивающих сокетов.
- `-p` — отображение процесса (PID и имя программы), использующего сокет.
- `-a` — отображение всех сокетов: как установленных соединений, так и прослушивающих.
- `-n` — выводить только IP-адреса и номера портов.
- `-r` — разрешать IP-адреса и порты в имена (обратное `-n`).
- `-s` — отображение краткой статистики по протоколам (количество соединений, пакетов и т.д.).
- `-e` — расширенный вывод статистики с дополнительной информацией о соединениях.
- `-i` — отображение информации о сетевых интерфейсах.
- `-4` — отображение только IPv4-соединений.
- `-6` — отображение только IPv6-соединений.
- `-o` — отображение таймеров сокетов в выводе.
- `-m` — отображение использования памяти сокетами.
- `-h` — не отображать заголовки таблицы.
- `<expression>` — фильтрация результатов по `state`
  и по заданным критериям, оформляется кавычками `""`.

#### Примеры

Примеры:

- `(diagnostics)$$ ss -tulpn` — все TCP/UDP-соединения с процессами и портами.
- `(diagnostics)$$ ss -tlnp` — TCP-соединения в состоянии LISTEN.
- `(diagnostics)$$ ss "state listening"` — только прослушивающие соединения.
- `(diagnostics)$$ ss "dport = 80"` — соединения на порт 80.
- `(diagnostics)$$ ss "sport >= 1024"` — соединения с портом источника >= 1024.
- `(diagnostics)$$ ss "dst 192.168.1.1"` — соединения к хосту 192.168.1.1.
- `(diagnostics)$$ ss "src 10.0.0.0/8"` — соединения из сети 10.0.0.0/8.
- `(diagnostics)$$ ss "state established dport = 443"` — соединения, установленные  на порт 443.
- `(diagnostics)$$ ss "fwmark = 0x01/0x03"` — соединения с определенной меткой fwmark.
- `(diagnostics)$$ ss -s` — статистика по протоколам.

#### Фильтрация по state

- `state all` — все состояния.
- `state connected` — все соединенные состояния.
- `state synchronized` — синхронизированные состояния.
- `state bucket` — состояния ожидания.
- `state big` — все возможные состояния.
- `state established` — установленное соединение.
- `state syn-sent` — отправлен SYN.
- `state syn-recv` — получен SYN.
- `state fin-wait-1` — ожидание первого FIN.
- `state fin-wait-2` — ожидание второго FIN.
- `state time-wait` — ожидание закрытия.
- `state closed` — закрытое соединение.
- `state close-wait` — ожидание закрытия.
- `state last-ack` — последний ACK.
- `state listening` — прослушивание.
- `state closing` — закрытие соединения.

#### Фильтрация по критериям

Фильтрация сокетов на основе определенных критериев.
Выражение состоит из серии предикатов, объединенных логическими операторами.

Логические операторы (в порядке возрастания приоритета):

| `or, |, ||`   | логическое ИЛИ   |
|---------------|------------------|
| `and, &, &&`  | логическое И     |
| `not, !`      | логическое НЕ    |

Если между последовательными предикатами нет оператора, предполагается неявный оператор `and`.
Подвыражения можно группировать с помощью скобок "(" и ")".

Предикаты:

| `dst HOST | src HOST | dst=HOST | src=HOST`   | Проверка соответствия адреса назначения или источника хосту HOST.<br/>HOST может быть IP-адресом, именем хоста или сетью в формате CIDR.                                                                  |
|-----------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `dport OP PORT | sport OP PORT`               | Сравнение порта назначения или источника с PORT.<br/>OP (оператор) может быть следующим:<br/>`<`, `<=`, `=`, `==`, `!=`, `>=`, `>`<br/>Например: `dport = 80`, `sport >= 1024`, `dport < 8080`.           |
| `dev DEVICE | dev=DEVICE | dev!=DEVICE`       | Совпадение по устройству (интерфейсу), которое использует соединение.<br/>DEVICE может быть именем устройства или индексом интерфейса.                                                                    |
| `fwmark MASK | fwmark=MASK | fwmark!=MASK`    | Совпадение по значению fwmark для соединения.<br/>MASK может быть конкретным значением метки или значением с маской битов.<br/>Например: `fwmark=0x01`, `fwmark=0x01/0x03` (проверка двух младших битов). |
| `cgroup PATH | cgroup=PATH | cgroup!=PATH`    | Совпадение, если соединение является частью `cgroup` по указанному пути.                                                                                                                                  |
| `cautobound`                                  | Совпадение, если порт или путь исходного адреса был автоматически выделен<br/>(а не явно указан).                                                                                                         |

Операторы сравнения (все эквивалентны):

| `=, ==, eq`   | равно            |
|---------------|------------------|
| `!=, ne, neq` | не равно         |
| `>, gt`       | больше           |
| `<, lt`       | меньше           |
| `>=, ge, geq` | больше или равно |
| `<=, le, leq` | меньше или равно |
| `!, not`      | отрицание        |
| `|, ||, or`   | логическое ИЛИ   |
| `&, &&, and`  | логическое И     |

Если оператор не указан, предполагается оператор `=`.

<a id="adc-cli-diagnostics-ssldump"></a>

### ssldump

Анализ SSL/TLS-трафика. Показывает содержимое SSL/TLS-пакетов, включая информацию о рукопожатии (handshake),
сертификатах, используемых шифрах и зашифрованные данные.
Результаты сохраняются в файлы `ssl_capture_<timestamp>.txt` и `ssl_capture_<timestamp>.pcap`.

Синтаксис: `ssldump [-i <interface>] [-n] [-e] [-h] [<expression>]`

Параметры:

- `-i <interface>` — сетевой интерфейс для захвата SSL/TLS-трафика.
- `-n` — показывать только IP-адреса (не выполнять разрешение доменных имен).
- `-e` — показывать время в читаемом формате вместо Unix timestamp.
- `-h` — показывать полные SSL-заголовки пакетов для детального анализа.
- `<expression>` — фильтр захвата, оформляется кавычками `""`.
  Синтаксис выражений фильтров см. документацию pcap-filter.

Примеры:

- `(diagnostics)$$ ssldump -i eth0` — захват всего SSL-трафика на eth0.
- `(diagnostics)$$ ssldump -i eth0 "host example.com"` — SSL-трафик для/от example.com.
- `(diagnostics)$$ ssldump -i eth0 "port 443"` — SSL-трафик на порт 443.
- `(diagnostics)$$ ssldump -h -i eth0 "tcp and port 443"` — полные заголовки SSL-пакетов.

<a id="adc-cli-diagnostics-tcpdump"></a>

### tcpdump

Анализ сетевого трафика в реальном времени.

Синтаксис: `tcpdump [-i <interface>] [-c <count>] [-w <file>] [-v] [-vv] [-vvv] [-n] [-nn] [-x] [-e] [<expression>]`

Параметры:

- `-i <interface>` — указание сетевого интерфейса для захвата трафика
  (по умолчанию используется первый доступный интерфейс).
  Если интерфейс не указан, то команда будет использовать все доступные интерфейсы.
- `-c <count>` — количество пакетов для захвата перед автоматическим завершением команды.
- `-w <file>` — запись захваченных пакетов в файл в формате pcap.
- `-v` — подробный вывод: отображение дополнительной информации о пакетах.
- `-vv` — очень подробный вывод: расширенная информация о пакетах.
- `-vvv` — максимально подробный вывод: максимальный уровень детализации.
- `-n` — не выполнять разрешение доменных имен (DNS lookup): отображать только IP-адреса.
- `-nn` — не выполнять разрешение доменных имен и портов: отображать только IP-адреса и номера портов.
- `-x` — вывод пакетов в шестнадцатеричном формате для детального анализа содержимого.
- `-e` — отображение информации о канальном уровне (Ethernet-заголовки): MAC-адреса, тип фрейма и т.д.
- `<expression>` — фильтр захвата для ограничения типа перехватываемых пакетов, оформляется кавычками `""`.
  Синтаксис выражений фильтров см. документацию pcap-filter.

Примеры:

- `(diagnostics)$$ tcpdump -i eth0` — захват всего трафика на eth0.
- `(diagnostics)$$ tcpdump -i eth0 "host 192.168.1.1"` — трафик только для/от хоста 192.168.1.1.
- `(diagnostics)$$ tcpdump -i eth0 port 80` — трафик на порт 80 (HTTP).
- `(diagnostics)$$ tcpdump -i eth0 "tcp and port 443"` — TCP-трафик на порт 443 (HTTPS).
- `(diagnostics)$$ tcpdump -w capture.pcap -c 100` — записать 100 пакетов в файл.

<a id="adc-cli-diagnostics-traceroute"></a>

### traceroute

Трассировка маршрута следования пакетов до указанного сетевого узла.

Синтаксис: `traceroute [-i] [-t] [-u] [-4] [-6] [-n] [-d] [-m <max_hops>] [-q <nqueries>] [-p <port>] [-w <waittime>] [-if <interface>] [-s <source>] <target>`

Параметры:

- `-i` — ICMP-режим для трассировки (режим по умолчанию).
- `-t` — TCP-режим: отправка TCP-пакетов вместо ICMP.
- `-u` — UDP-режим: отправка UDP-пакетов.
- `-4` — принудительное использование IPv4.
- `-6` — принудительное использование IPv6.
- `-n` — не выполнять разрешение доменных имен: показывать только IP-адреса.
- `-d` — включение отладочной информации в вывод.
- `-m <max_hops>` — максимальное количество промежуточных узлов (hops) для проверки (по умолчанию 30).
- `-q <nqueries>` — количество запросов, отправляемых на каждый промежуточный узел (по умолчанию 3).
- `-p <port>` — указание порта для использования в TCP/UDP-режимах.
- `-w <waittime>` — время ожидания ответа от каждого узла в секундах (по умолчанию 3).
- `-if <interface>` — указание сетевого интерфейса для отправки пакетов.
- `-s <source>` — указание исходного IP-адреса для отправки пакетов.
- `<target>` — целевой IP-адрес или доменное имя узла, до которого выполняется трассировка (обязательный параметр).

Примеры:

- `(diagnostics)$$ traceroute -n -w 2 192.168.1.1` — трассировка без DNS, время ожидания 2 секунды.
- `(diagnostics)$$ traceroute -t -p 80 example.com` — TCP-трассировка на порт 80.

<a id="adc-cli-firewall"></a>

## firewall

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

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

| `firewall`                           | Вход в контекст                           |
|--------------------------------------|-------------------------------------------|
| [list](#adc-cli-firewall-list)       | Вывод списка правил брандмауэра Angie ADC |
| [no open](#adc-cli-firewall-no-open) | Закрытие порта в брандмауэре Angie ADC    |
| [open](#adc-cli-firewall-open)       | Открытие порта в брандмауэре Angie ADC    |
| [save](#adc-cli-firewall-save)       | Сохранение правил брандмауэра Angie ADC   |

<a id="adc-cli-firewall-list"></a>

### list

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

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

Параметры:

- `ip` — вывод списка правил для IPv4;
- `ip6` — вывод списка правил для IPv6.

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

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

<a id="adc-cli-firewall-no-open"></a>

### no open

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

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

Параметры:

- `ip` — порт для IPv4;
- `ip6` — порт для IPv6;
- `tcp` — порт для протокола TCP;
- `udp` — порт для протокола UDP;
- `<port>` — номер порта;
- `<interface>` — интерфейс.

Пример:

```none
(firewall)$$ no open ip tcp 9999 enp0s2
Port 9999/tcp successfully closed on interface enp0s2
(firewall)$$ save
rules saved successfully
```

#### IMPORTANT
Изменения будут применены только после выполнения команды `save`.

<a id="adc-cli-firewall-open"></a>

### open

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

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

Параметры:

- `ip` — порт для IPv4;
- `ip6` — порт для IPv6;
- `tcp` — порт для протокола TCP;
- `udp` — порт для протокола UDP;
- `<port>` — номер порта;
- `<interface>` — интерфейс.

Пример:

```none
(firewall)$$ open ip tcp 9999 enp0s2
Port 9999/tcp successfully opened on interface enp0s2
(firewall)$$ save
rules saved successfully
```

#### IMPORTANT
Изменения будут применены только после выполнения команды `save`.

#### NOTE
При настройке конфигурации не занимайте следующие порты (эти порты используются внутренними сервисами 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, 161, 323, 3784, 3785, 4784

<a id="adc-cli-firewall-save"></a>

### save

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

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

<a id="adc-cli-ip"></a>

## ip

Стандартное управление сетевыми интерфейсами, маршрутами, адресами и правилами IP-трафика в Linux.

#### IMPORTANT
При перезагрузке Angie ADC настройки, выполненные через `ip`, не сохраняются.
Для настройки системы рекомендуется использовать режим [configuration](#adc-cli-config).

<a id="adc-cli-logs"></a>

## logs

Контекст `logs` позволяет просматривать журналы событий Angie ADC.
Используйте эти команды для получения диагностической информации
при обращении в службу технической поддержки.

| [adc-gslb](#adc-cli-logs-gslb)               | События модуля GSLB (глобальная балансировка)                                                               |
|----------------------------------------------|-------------------------------------------------------------------------------------------------------------|
| [adc-server](#adc-cli-logs-server)           | События модуля, обеспечивающего<br/>выполнение всего предоставляемого функционала Angie ADC (входная точка) |
| [adc-system](#adc-cli-logs-system)           | События модуля, отвечающего за выполнение системных команд Angie ADC                                        |
| [adc-tracker](#adc-cli-logs-tracker)         | События модуля, отвечающего за RHI-функционал                                                               |
| [kern](#adc-cli-logs-kern)                   | События ядра                                                                                                |
| [lb](#adc-cli-logs-lb)                       | События модуля балансировщика нагрузки                                                                      |
| `logs`                                       | Вход в контекст                                                                                             |
| [mgmt](#adc-cli-logs-mgmt)                   | События модуля, отвечающего за управление Angie ADC                                                         |
| [session-store](#adc-cli-logs-session-store) | События модуля, отвечающего за хранение sticky-сессий в паре высокой доступности                            |
| [upgrade](#adc-cli-logs-upgrade)             | События обновления Angie ADC                                                                                |

<a id="adc-cli-logs-gslb"></a>

### adc-gslb

События модуля GSLB (глобальная балансировка).

Синтаксис: `adc-gslb [{page|transfer}]`.

Параметры:

- `page` — вывод записей в режиме постраничного просмотра;
- `transfer` — копирование записей в директорию `transfer`.

<a id="adc-cli-logs-server"></a>

### adc-server

События модуля, обеспечивающего выполнение
всего предоставляемого функционала Angie ADC (входная точка).

Синтаксис: `adc-server [{page|transfer}]`.

Параметры:

- `page` — вывод записей в режиме постраничного просмотра;
- `transfer` — копирование записей в директорию `transfer`.

<a id="adc-cli-logs-system"></a>

### adc-system

События модуля, отвечающего за выполнение системных команд Angie ADC.

Синтаксис: `adc-system [{page|transfer}]`.

Параметры:

- `page` — вывод записей в режиме постраничного просмотра;
- `transfer` — копирование записей в директорию `transfer`.

<a id="adc-cli-logs-tracker"></a>

### adc-tracker

События модуля, отвечающего за RHI-функционал.

Синтаксис: `adc-tracker [{page|transfer}]`.

Параметры:

- `page` — вывод записей в режиме постраничного просмотра;
- `transfer` — копирование записей в директорию `transfer`.

<a id="adc-cli-logs-kern"></a>

### kern

События ядра.

Синтаксис: `kern [{follow|page|transfer}]`.

Параметры:

- `follow` — вывод записей в режиме реального времени;
- `page` — вывод записей в режиме постраничного просмотра;
- `transfer` — копирование записей в директорию `transfer`.

<a id="adc-cli-logs-lb"></a>

### lb

События модуля балансировщика нагрузки.

Синтаксис: `lb {access|error} [{follow|page|transfer}]`.

Параметры:

- `access` — вывод записей журнала запросов;
- `error` — вывод записей журнала ошибок;
- `follow` — вывод записей в режиме реального времени;
- `page` — вывод записей в режиме постраничного просмотра;
- `transfer` — копирование записей в директорию `transfer`.

<a id="adc-cli-logs-mgmt"></a>

### mgmt

События модуля, отвечающего за управление Angie ADC.

Синтаксис: `mgmt {access|error} [{follow|page|transfer}]`.

Параметры:

- `access` — вывод записей журнала запросов;
- `error` — вывод записей журнала ошибок;
- `follow` — вывод записей в режиме реального времени;
- `page` — вывод записей в режиме постраничного просмотра;
- `transfer` — копирование записей в директорию `transfer`.

<a id="adc-cli-logs-session-store"></a>

### session-store

События модуля, отвечающего за хранение sticky-сессий в паре высокой доступности.

Синтаксис: `session-store [{follow|page|transfer}]`.

Параметры:

- `follow` — вывод записей в режиме реального времени;
- `page` — вывод записей в режиме постраничного просмотра;
- `transfer` — копирование записей в директорию `transfer`.

<a id="adc-cli-logs-upgrade"></a>

### upgrade

События обновления Angie ADC.

Синтаксис: `upgrade [{follow|page|transfer}]`.

Параметры:

- `follow` — вывод записей в режиме реального времени;
- `page` — вывод записей в режиме постраничного просмотра;
- `transfer` — копирование записей в директорию `transfer`.

### Фильтрация вывода

Вывод записей поддерживает фильтрацию через pipe. Допускается
использование нескольких фильтров в виде:

```none
command | filter1 | filter2 | ... | filterN
```

Поддерживаются следующие фильтры:

- `grep` — фильтрация по подстроке;
- `exclude` — исключение строк, содержащих указанную подстроку;
- `include` — вывод только строк, содержащих указанную подстроку;
- `head` — вывод первых N строк;
- `tail` — вывод последних N строк.

#### grep

Синтаксис: `grep -i -o -v <pattern>`

Параметры:

- `-i` — игнорировать регистр;
- `-o` — показать только совпавшую часть вместо всей строки;
- `-v` — инвертировать результат;
- `<pattern>` — подстрока для поиска.

Пример:

```none
(logs)$$ lb access | grep GET
127.0.0.1 - - [29/Aug/2025:14:34:03 +0300] "GET /metrics HTTP/1.1" 200 1800 "-" "Prometheus/" "-"
(logs)$$ lb access | grep -v GET
2025/08/29 10:19:42 [notice] 976#976: signal 29 (SIGIO) received
(logs)$$ lb access | grep -i get
127.0.0.1 - - [29/Aug/2025:14:34:03 +0300] "GET /metrics HTTP/1.1" 200 1800 "-" "Prometheus/" "-"
(logs)$$ lb access | grep -o GET
GET
```

#### include

Синоним `grep <pattern>`.

Синтаксис: `include <pattern>`.

Параметры:

- `<pattern>` — подстрока для поиска.

Пример:

```none
(logs)$$ lb access | include GET
127.0.0.1 - - [29/Aug/2025:14:34:03 +0300] "GET /metrics HTTP/1.1" 200 1800 "-" "Prometheus/" "-"
```

#### exclude

Синоним `grep -v <pattern>`.

Синтаксис: `exclude <pattern>`.

Параметры:

- `<pattern>` — подстрока для поиска.

Пример:

```none
(logs)$$ lb error | exclude exit
2025/08/29 10:19:42 [notice] 976#976: signal 29 (SIGIO) received
```

#### head

Вывод первых N строк.

Синтаксис: `head <n>`.

Параметры:

- `<n>` — количество строк.

Пример:

```none
(logs)$$ lb access | head 2
127.0.0.1 - - [28/Aug/2025:14:53:48 +0300] "GET /metrics HTTP/1.1" 200 1798 "-" "Prometheus/" "-"
127.0.0.1 - - [28/Aug/2025:14:53:58 +0300] "GET /metrics HTTP/1.1" 200 1798 "-" "Prometheus/" "-"
```

#### tail

Вывод последних N строк.

Синтаксис: `tail <n>`.

Параметры:

- `<n>` — количество строк.

Пример:

```none
(logs)$$ lb access | tail 2
127.0.0.1 - - [28/Aug/2025:14:53:48 +0300] "GET /metrics HTTP/1.1" 200 1798 "-" "Prometheus/" "-"
127.0.0.1 - - [28/Aug/2025:14:53:58 +0300] "GET /metrics HTTP/1.1" 200 1798 "-" "Prometheus/" "-"
```

<a id="adc-cli-modules"></a>

## modules

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

| [info](#adc-cli-modules-info)   | Получение информации о динамическом модуле Angie ADC      |
|---------------------------------|-----------------------------------------------------------|
| [list](#adc-cli-modules-list)   | Получение списка доступных динамических модулей Angie ADC |
| `modules`                       | Вход в контекст                                           |

<a id="adc-cli-modules-info"></a>

### info

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

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

Параметры:

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

<a id="adc-cli-modules-list"></a>

### list

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

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

<a id="adc-cli-ps"></a>

## ps

Отображение информации о запущенных процессах в системе.
Показывает список активных процессов с различной степенью детализации в зависимости от используемых параметров.

Синтаксис: `ps [-f] [-p <pid>] [-o <format>] [-c <command>] [-s <sortspec>] [-t] [-w] [-h]`.

Параметры:

- `-f` — полный формат вывода: отображение расширенной информации о процессах.
- `-p <pid>` — отображение информации только о процессе с указанным PID (Process ID).
- `-o <format>` — пользовательский формат вывода. Формат задается как список полей, разделенных запятыми (например: pid,cmd,mem). Доступные поля описаны ниже.
- `-c <command>` — поиск и отображение процессов по имени команды (фильтрация по имени процесса).
- `-s <sortspec>` — сортировка вывода по указанным полям (например, по использованию CPU, памяти).
- `-t` — отображение процессов в древовидной структуре: показывает родительско-дочерние связи между процессами.
- `-w` — широкий вывод: позволяет отображать полные команды без обрезания.
- `-h` — не показывать заголовки столбцов в выводе.

Примеры:

- `$$ ps` — список процессов текущего пользователя.
- `$$ ps -p 1234` — информация о процессе с PID 1234.
- `$$ ps -c angie` — поиск процессов angie.
- `$$ ps -o pid,ppid,cmd,mem` — пользовательский формат вывода.

Форматы для параметра `-o`:

| Ключ   | Полное имя   | Описание                                                    |
|--------|--------------|-------------------------------------------------------------|
| `c`    | cmd          | Простое имя исполняемого файла                              |
| `C`    | pcpu         | Использование CPU (в процентах)                             |
| `f`    | flags        | Флаги как в длинном формате (поле F)                        |
| `g`    | pgrp         | Идентификатор группы процессов                              |
| `G`    | tpgid        | Идентификатор группы процессов управляющего терминала       |
| `j`    | cutime       | Совокупное пользовательское время                           |
| `J`    | cstime       | Совокупное системное время                                  |
| `k`    | utime        | Пользовательское время                                      |
| `m`    | min_flt      | Количество малых ошибок страниц (minor page faults)         |
| `M`    | maj_flt      | Количество больших ошибок страниц (major page faults)       |
| `n`    | cmin_flt     | Совокупные малые ошибки страниц                             |
| `N`    | cmaj_flt     | Совокупные большие ошибки страниц                           |
| `o`    | session      | Идентификатор сессии                                        |
| `p`    | pid          | Идентификатор процесса                                      |
| `P`    | ppid         | Идентификатор родительского процесса                        |
| `r`    | rss          | Размер резидентного набора (resident set size) в килобайтах |
| `R`    | resident     | Резидентные страницы                                        |
| `s`    | size         | Размер памяти в килобайтах                                  |
| `S`    | share        | Количество разделяемых страниц                              |
| `t`    | tty          | Номер устройства управляющего терминала                     |
| `T`    | start_time   | Время запуска процесса                                      |
| `U`    | uid          | Числовой идентификатор пользователя                         |
| `u`    | user         | Имя пользователя                                            |
| `v`    | vsize        | Общий размер виртуальной памяти в килобайтах                |
| `y`    | priority     | Приоритет планировщика ядра                                 |

Примеры:

- `$$ ps -o pid,cmd` — отобразить только PID и команду.
- `$$ ps -o user,pid,pcpu,pmem,cmd` — пользователь, PID, CPU, память, команда.
- `$$ ps -o pid,ppid,cmd,start_time` — PID, PPID, команда, время запуска.

<a id="adc-cli-settings"></a>

## settings

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

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

| [angie](#adc-cli-settings-angie)       | Включение режима отладки                          |
|----------------------------------------|---------------------------------------------------|
| [no angie](#adc-cli-settings-no-angie) | Отключение режима отладки                         |
| [reload](#adc-cli-settings-reload)     | Перезагрузка элементов Angie ADC                  |
| `settings`                             | Вход в контекст                                   |
| [sysctl](#adc-cli-settings-sysctl)     | Просмотр параметров ядра Linux в реальном времени |
| [syslog](#adc-cli-settings-syslog)     | Управление syslog-серверами                       |

<a id="adc-cli-settings-angie"></a>

### angie

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

Синтаксис: `angie debug`.

<a id="adc-cli-settings-no-angie"></a>

### no angie

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

Синтаксис: `no angie debug`.

<a id="adc-cli-settings-reload"></a>

### reload

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

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

Параметры:

- `angie` — перезагрузка `angie-mgmt`.
- `prometheus` — перезагрузка `prometheus`.

<a id="adc-cli-settings-sysctl"></a>

### sysctl

Просмотр конкретного параметра ядра Linux или всех параметров в реальном времени.

Синтаксис: `sysctl show {<variable> | all}`.

<a id="adc-cli-settings-syslog"></a>

### syslog

Настройка и управление удаленными серверами для экспорта событий Angie ADC по syslog-протоколу.

Синтаксис: `syslog {add <input> | del <uuid> | disable <uuid> | enable <uuid> | list | test | update}`.

Параметры:

- `add` — добавление нового syslog-сервера.

  Синтаксис: `syslog add <name> <host> <port> <tcp | udp> [<levels>]`

  Параметры:
  - `name` — имя сервера.
  - `host` — IP-адрес или доменное имя сервера.
  - `port` — номер порта (по умолчанию 514).
  - `tcp | udp` — используемый транспортный протокол (по умолчанию udp).
  - `levels` — уровни критичности событий от 0 до 7
    (если не указано, будут включены все уровни):
    - `0` — Emergency: только события, приводящие
      к аварийной ситуации и полному отказу системы.
    - `1` — Alert: критические ошибки безопасности
      или выход из строя важных сервисов.
    - `2` — Critical: серьезные проблемы,
      которые требуют немедленного исправления.
    - `3` — Error: ошибки, влияющие на работу системы,
      но не приводящие к ее остановке.
    - `4` — Warning: предупреждения о возможных проблемах.
    - `5` — Notice: уведомления о событиях.
    - `6` — Informational: информационные сообщения.
    - `7` — Debug: включение событий отладки.

  Примеры:
  - `syslog add rsyslog1 10.0.2.2 514 udp`
  - `syslog add rsyslog1 10.0.2.2 514 udp 1 2 3`
- `del` — удаление syslog-сервера по UUID.

  Синтаксис: `syslog del <uuid>`
- `disable` — выключение syslog-сервера по UUID.

  Синтаксис: `syslog disable <uuid>`
- `enable` — включение syslog-сервера по UUID.

  Синтаксис: `syslog enable <uuid>`
- `list` — просмотр списка настроенных syslog-серверов.

  Синтаксис: `syslog list`
- `test` — проверка доступности syslog-сервера.

  Синтаксис: `syslog test <host> <port> <tcp|udp>`

  Параметры:
  - `host` — IP-адрес или доменное имя сервера.
  - `port` — номер порта.
  - `tcp | udp` — используемый транспортный протокол.
- `update` — изменение параметров syslog-сервера.
  Можно менять только одно поле за раз.

  Синтаксис: `syslog update <uuid> {name <name> | host <host> | port <port> | protocol <tcp|udp> | levels: [0..7]}`

  Параметры:
  - `name` — имя syslog-сервера.
  - `host` — IP-адрес или доменное имя syslog-сервера.
  - `port` — номер порта.
  - `tcp | udp` — транспортный протокол.
  - `levels` — уровень критичности событий от 0 до 7
    (если не указано, будут включены все уровни):
    - `0` — Emergency: только события, приводящие
      к аварийной ситуации и полному отказу системы.
    - `1` — Alert: критические ошибки безопасности
      или выход из строя важных сервисов.
    - `2` — Critical: серьезные проблемы,
      которые требуют немедленного исправления.
    - `3` — Error: ошибки, влияющие на работу системы,
      но не приводящие к ее остановке.
    - `4` — Warning: предупреждения о возможных проблемах.
    - `5` — Notice: уведомления о событиях.
    - `6` — Informational: информационные сообщения.
    - `7` — Debug: включение событий отладки.

    Примеры:
    - `syslog update <uuid> levels 1 3` — выставляет только указанные уровни критичности событий.
    - `syslog update <uuid> levels` — выставляет все уровни критичности событий.

<a id="adc-cli-system"></a>

## system

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

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

| [ntp](#adc-cli-system-ntp)           | Просмотр статуса NTP                    |
|--------------------------------------|-----------------------------------------|
| [reboot](#adc-cli-system-reboot)     | Перезагрузка системы Angie ADC          |
| [stat](#adc-cli-system-stat)         | Просмотр статистики системы Angie ADC   |
| `system`                             | Вход в контекст                         |
| [time](#adc-cli-system-time)         | Просмотр и установка системного времени |
| [timezone](#adc-cli-system-timezone) | Просмотр часового пояса системы         |
| [upgrade](#adc-cli-system-upgrade)   | Обновление Angie ADC                    |
| [version](#adc-cli-system-version)   | Просмотр версии Angie ADC               |

<a id="adc-cli-system-ntp"></a>

### ntp

Просмотр статуса NTP.

Синтаксис: `ntp`

Примеры:

```none
$$ system
(system)$$ ntp
enabled: False
source: None
synchronised: False
time_utc: 2026-01-21 10:40:42
time_local: 2026-01-21 13:40:42
timezone: Europe/Moscow
```

#### NOTE
Настройка NTP проводится через меню конфигурации ([configuration](#adc-cli-config)).

<a id="adc-cli-system-reboot"></a>

### reboot

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

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

Параметры:

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

<a id="adc-cli-system-stat"></a>

### stat

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

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

Параметры:

- `count <n>` — количество обновлений статистики;
- `delay <m>` — задержка между обновлениями статистики в секундах.

<a id="adc-cli-system-time"></a>

### time

Просмотр и установка системного времени.

Синтаксис: `time {set <YYYY-MM-DD HH:MM:SS>}`.

Подкоманды:

- `set <YYYY-MM-DD HH:MM:SS>` — установка системного времени в указанном формате.

Примеры:

- `(system)$$ time` — показать текущее время.
- `(system)$$ time set 2025-01-15 14:30:00` — установить время на 15 января 2025, 14:30:00.

<a id="adc-cli-system-timezone"></a>

### timezone

Просмотр часового пояса системы.
Часовой пояс определяет смещение локального времени относительно UTC.

Синтаксис: `timezone`.

Примеры:

- `(system)$$ timezone` — показать текущий часовой пояс.

#### NOTE
Настройка timezone проводится через меню конфигурации ([configuration](#adc-cli-config)).

<a id="adc-cli-system-upgrade"></a>

### upgrade

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

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

Параметры:

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

<a id="adc-cli-system-version"></a>

### version

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

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

Параметры:

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

<a id="adc-cli-transfer"></a>

## transfer

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

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

| [edit](#adc-cli-transfer-edit)   | Редактирование файла в текущей директории.         |
|----------------------------------|----------------------------------------------------|
| [ls](#adc-cli-transfer-ls)       | Получение списка файлов в директории `transfer`    |
| [rm](#adc-cli-transfer-rm)       | Удаление файла в директории `transfer`             |
| `transfer`                       | Вход в контекст                                    |
| [view](#adc-cli-transfer-view)   | Просмотр содержимого файла в директории `transfer` |

<a id="adc-cli-transfer-edit"></a>

### edit

Позволяет редактировать файлы в текущей директории.

Синтаксис: `edit [<filename>]`.

Параметры:

- `<filename>` — имя файла, который необходимо отредактировать (обязательный параметр).

<a id="adc-cli-transfer-ls"></a>

### ls

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

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

<a id="adc-cli-transfer-rm"></a>

### rm

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

Синтаксис: `rm <filename>`.

Параметры:

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

<a id="adc-cli-transfer-view"></a>

### view

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

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

Параметры:

- `<filename>` — имя файла;
- `page` — вывод записей в режиме постраничного просмотра.

<a id="adc-cli-vtysh"></a>

## vtysh

Переход к настройкам маршрутизации по протоколам BGP и OSPF.

Синтаксис: `vtysh`.

Подробнее о настройке BGP и OSPF см. [BGP-маршрутизация](https://angie.software//adc/docs/routing/routing_bgp/index.md#adc-bgp) и [OSPF-маршрутизация](https://angie.software//adc/docs/routing/routing_ospf/index.md#adc-routing-ospf).
