В данном разделе описываются команды для управления настройками службы уведомлений по электронной почте или Jabber на уровне системы.

Для администратора системы команды выполняются на уровне системы в разделе /system/notifier/.
Для администратора виртуальной АТС команды выполняются на уровне виртуальной АТС в разделе /domain/<DOMAIN>/notifier/ и применяются только для определенной виртуальной АТС.

<CLUSTER> - имя кластера с ролью медиатор.
<DOMAIN> - имя виртуальной АТС.

Таблица 1 - Описание параметров службы уведомлений

ПараметрЗначение по умолчаниюОписание
email"noreply@eltex.loc"Адрес электронной почты, с которого будут отправляться уведомления
email_buffer_limit50Количество сообщений, накапливаемых в буфере, для отправки на электронную почту
email_enablefalseСостояние работы службы уведомлений по электронной почте:
- true - отправка разрешена;
- false - отправка запрещена
email_password"ylperon"Пароль для подключения к электронной почте
email_portdefaultНомер порта SMTP-сервера
значение по умолчание зависит от режима защиты соединения:
- 25 - без защиты;
- 465 - для SSL/TLS;
- 587 - для STARTTLS.
email_protection_connectionnoneЗащита соединения при передаче email-сообщений:
- none - не используется;
- ssl_tls - защита соединения по протоколу SSL/TLS;
- starttls - защита соединения STARTTLS.
email_resend_count_max5Количество попыток отправки email-сообщения при неуспешной передаче
email_resend_timer30Период времени перед повторной отправкой уведомления, если предыдущее было не доставлено, в секундах. Значение "0" - повторная отправка отключена
email_server"mail.eltex.loc"Адрес сервера электронной почты
email_username"noreply@eltex.loc"Имя пользователя для подключения к электронной почте
jabber_buffer_limit50Количество сообщений, которое может быть накоплено в буфере для отправки через Jabber
jabber_enablefalseСостояние работы службы уведомлений по Jabber:
- true - отправка разрешена;
- false - отправка запрещена
jabber_password"ylperon"Пароль для подключения к Jabber-аккаунту
jabber_port5222Номер порта Jabber-сервера
jabber_version0.0Версия XMPP протокола, который поддерживается Jabber-сервером
jabber_reconnect_timer10Время повторного установления соединения до сервера, если связь была потеряна, в секундах
jid"ecss-10@jabber.eltex.loc"Аккаунт Jabber ID


clean

Данной командой осуществляется установка параметров по умолчанию для параметров службы уведомлений.

Путь команды:

/system/notifier/clean

Синтаксис:

clean [* | <Domain> [<Field>]] [--force]

Параметры:

<Field> - название параметра, значение которого нужно установить по умолчанию. Опциональный параметр. Если параметр не указывать, то все значения будут установлены по умолчанию. Список параметров приведен в таблице 1.

--force - выполнить команду без запроса подтверждения.

Пример:

admin@mycelium1@ecss1:/$ system/notifier/clean * email_buffer_limit 
Property email_buffer_limit values successfully restored

[exec at: 28.05.2019 14:00:53, exec time: 277ms, nodes: md1@ecss2

info

Команда просмотра текущих настроек службы уведомлений.

Путь команды:

/system/notifier/info

Синтаксис

info [* | <Domain> [<Field>]]

Параметры:

<Field> - название параметра, опциональный параметр, список приведен в таблице 1. * -просмотр по всем доменам.

Пример:

admin@mycelium1@ecss1:/$ system/notifier/info         
┌───────────────────────────┬───────────┬────────────────────────┐
│         Property          │  Domain   │         Value          │
├───────────────────────────┼───────────┼────────────────────────┤
│email                      │           │noreply@eltex.loc       │
│email                      │biysk.local│ecss10biysk@mail.ru     │
│email_buffer_limit         │           │50                      │
│email_enable               │           │false                   │
│email_enable               │biysk.local│true                    │
│email_password             │           │ylperon                 │
│email_password             │biysk.local│ssw4Mail                │
│email_port                 │           │default                 │
│email_port                 │biysk.local│465                     │
│email_protection_connection│           │none                    │
│email_protection_connection│biysk.local│ssl_tls                 │
│email_resend_count_max     │           │5                       │
│email_resend_timer         │           │30                      │
│email_server               │           │notifier.smtp.ecss      │
│email_server               │biysk.local│smtp.mail.ru            │
│email_username             │           │noreply@eltex.loc       │
│email_username             │biysk.local│ecss10biysk@mail.ru     │
│jabber_buffer_limit        │           │50                      │
│jabber_enable              │           │false                   │
│jabber_password            │           │ylperon                 │
│jabber_port                │           │5222                    │
│jabber_reconnect_timer     │           │10                      │
│jabber_version             │           │0.0                     │
│jid                        │           │ecss-10@jabber.eltex.loc│
└───────────────────────────┴───────────┴────────────────────────┘

[exec at: 28.05.2019 13:47:06, exec time: 12ms, nodes: md1@ecss1]

set

Командной выполняется настройка параметров службы уведомлений.

Путь команды:

/system/notifier/set

Синтаксис:

set * | <Domain> <Field> <Value>

Параметры:

<Field> - имя параметра, значение которого необходимо настроить, список приведен в таблице 1;
<VALUE> - значение параметра, описание приведено в таблице 1.

Пример:

Включение уведомлений по email для всех доменов

admin@mycelium1@ecss1:/$ system/notifier/set * email_enable true
Property "email_enable" successfully changed from: 
false
   to
true.

[exec at: 28.05.2019 13:49:08, exec time: 288ms, nodes: core1@ecss1

send_test_msg

Команда для отправки тестового сообщения.

Путь команды:

/system/notifier/send_test_msg

Синтаксис:

send_test email | jabber <To>

Параметры:

<TO> - получатель тестового сообщения:

  • email - электронная почта;
  • jabber - jabber-клиент.

Пример:

admin@mycelium1@ecss1:/$ system/notifier/send_test_msg email asz@sibnet.ru           
Send test message successfully

[exec at: 28.05.2019 13:56:53, exec time: 909ms, nodes: md1@ecss2]

status

Команда проверки статуса сервера

Путь команды:

/system/notifier/status

Синтаксис:

status [email | jabber]

Параметры:

  • email - сервер электронной почты;
  • jabber - jabber-сервер.

Пример:

admin@mycelium1@ecss1:/$ system/notifier/status       
jabber server not started
email server started

[exec at: 28.05.2019 13:59:07, exec time: 767ms, nodes: core1@ecss1