/domain/<DOMAIN>/notifier/ - команды управления настройками службы уведомлений по электронной почте или Jabber
В данном разделе описываются команды для управления настройками службы уведомлений.
Для администратора виртуальной АТС команды выполняются на уровне виртуальной АТС в разделе domain/<DOMAIN>/notifier/ и применяются только для определенной виртуальной АТС.
<DOMAIN> - имя виртуальной АТС.
Таблица 1. Значения параметров по умолчанию для службы нотификации
| Параметр | Значение по умолчанию | Описание |
|---|---|---|
| "noreply@eltex.loc" | Адрес электронной почты, с которого будут отправляться уведомления | |
| email_buffer_limit | 50 | Количество сообщений, накапливаемых в буфере, для отправки на электронную почту |
| email_enable | false | Состояние работы службы уведомлений по электронной почте: - true - отправка разрешена; - false - отправка запрещена |
| email_password | "ylperon" | Пароль для подключения к электронной почте |
| email_port | 25 | Номер порта SMTP-сервера |
| email_protection_connection | none | Защита соединения при передаче email-сообщений: - none - не используется; - ssl_tls - защита соединения по протоколу SSL/TLS; - starttls - защита соединения STARTTLS. |
| email_resend_count_max | 5 | Количество попыток отправки email-сообщения при неуспешной передаче |
| email_resend_timer | 30 | Период времени перед повторной отправкой уведомления, если предыдущее было не доставлено, в секундах. Значение "0" - повторная отправка отключена |
| email_server | "mail.eltex.loc" | Адрес сервера электронной почты |
| email_username | "noreply@eltex.loc" | Имя пользователя для подключения к электронной почте |
| jabber_buffer_limit | 50 | Количество сообщений, которое может быть накоплено в буфере для отправки через Jabber |
| jabber_enable | false | Состояние работы службы уведомлений по Jabber: - true - отправка разрешена; - false - отправка запрещена |
| jabber_password | "ylperon" | Пароль для подключения к Jabber-аккаунту |
| jabber_port | 5222 | Номер порта Jabber-сервера |
| jabber_reconnect_timer | 10 | Время повторного установления соединения до сервера, если связь была потеряна, в секундах |
| jabber_version | 0.0 | Версия Jabber-сервера |
| jid | "ecss-10@jabber.eltex.loc" | Аккаунт Jabber ID |
clean
Данной командой осуществляется установка параметров по умолчанию для параметров службы уведомлений.
Путь команды:
/domain/<DOMAIN>/notifier/clean
Синтаксис::
clean [<KEY>] [--force]
Параметры:
<KEY> - название параметра, значение которого нужно установить по умолчанию. Опциональный параметр. Если параметр не указывать, то все значения будут установлены по умолчанию. Список параметров приведен в таблице 1.
--force - выполнение команды без запроса подтверждения.
Пример:
admin@[ds1@ecss1]:/$ domain/biysk.local/notifier/clean [clean] You are going to clean all customized properties in the domain "biysk.local". Are you sure?: yes/no ?> yes Properties values successfully restored [exec at: 13.03.2019 14:59:35, exec time: 3s 92ms, nodes: core1@ecss2]
info
Команда просмотра текущих настроек службы уведомлений.
Путь команды:
/domain/<DOMAIN>/notifier/info
Синтаксис:
info [<KEY>]
Параметры:
<KEY> - название параметра, опциональный параметр, список приведен в таблице 1.
Если в профиле безопасности (/system/security/profile/) параметр show_password_at_cli = off, то в выводе пароль скрывается, и вместо него показываются ********
Пример:
admin@mycelium1@ecss1:/$ domain/biysk.local/notifier/info ┌───────────────────────────┬───────────┬────────────────────────┐ │ Property │ Domain │ Value │ ├───────────────────────────┼───────────┼────────────────────────┤ │email │biysk.local│ecss10biysk@mail.ru │ │email_buffer_limit │biysk.local│50 │ │email_enable │biysk.local│true │ │email_password │biysk.local│********** │ │email_port │biysk.local│465 │ │email_protection_connection│biysk.local│ssl_tls │ │email_resend_count_max │biysk.local│5 │ │email_resend_timer │biysk.local│30 │ │email_server │biysk.local│smtp.mail.ru │ │email_username │biysk.local│ecss10biysk@mail.ru │ │jabber_buffer_limit │biysk.local│50 │ │jabber_enable │biysk.local│false │ │jabber_password │biysk.local│ylperon │ │jabber_port │biysk.local│5222 │ │jabber_reconnect_timer │biysk.local│10 │ │jabber_version │biysk.local│0.0 │ │jid │biysk.local│ecss-10@jabber.eltex.loc│ └───────────────────────────┴───────────┴────────────────────────┘ [exec at: 18.02.2021 15:07:30, exec time: 28ms, nodes: md1@ecss1 v.3.14.7.594]
set
Командной выполняется настройка параметров службы уведомлений.
Путь команды:
/domain/<DOMAIN>/notifier/set
Синтаксис:
set <KEY> <VALUE>
Параметры:
<KEY> - имя параметра, значение которого необходимо настроить, список приведен в таблице 1;
<VALUE> - значение параметра, описание приведено в таблице 1.
Пароль проверяется на соответствие требованиям, установленным в профиле безопасности (/system/security/profile/), параметр restrictions.
Пример:
admin@mycelium1@ecss1:/$ domain/biysk.local/notifier/set jabber_version 1.0 Property "jabber_version" successfully changed from: 0.0 to 1.0. [exec at: 18.02.2021 15:08:04, exec time: 120ms, nodes: md1@ecss1 v.3.14.7.594]
send_test_msg
Команда для отправки тестового сообщения.
Путь команды:
/domain/<DOMAIN>/notifier/send_test_msg
Синтаксис:
send_test_msg <TO> <ID> [<Message>]
Параметры:
<TO> - получатель тестового сообщения:
- email - электронная почта;
- jabber - jabber-клиент;
<ID> - адрес электронной почты или номер jabber;
<Message> - текст сообщения.
Пример:
admin@mycelium1@ecss1:/$ domain/biysk.local/notifier/send_test_msg email asz@sibnet.ru Test_domain_msg Send test message successfully [exec at: 18.02.2021 15:06:57, exec time: 1s 32ms, nodes: core1@ecss1 v.3.14.7.594]
status
Команда просмотра статуса службы уведомлений.
Путь команды:
/domain/<DOMAIN>/notifier/status
Синтаксис:
status [email | jabber]
Параметры:
- email - электронная почта;
- jabber - jabber-клиент;
Пример:
admin@mycelium1@ecss1:/$ domain/biysk.local/notifier/status jabber server not started email server started [exec at: 18.02.2021 15:16:38, exec time: 641ms, nodes: md1@ecss1 v.3.14.7.594]