Данный раздел является руководством по процессу конфигурирования службы отправки предупреждений на электронную почту (далее email).
Настройка выполняется через интерфейс командной строки CLI (CoCon).
Описание команд приведено в Части 3 Система управления ECSS-10, в разделе Команды для настройки параметров сообщений о предупреждениях по электронной почте, Команды управления настройками службы уведомлений по электронной почте или Jabber.

Настройка параметров подключения к серверу электронной почты

1. Установка адреса сервера электронной почты.

для администратора системы:

/cluster/mediator/<CLUSTER>/notifier/set <DOMAIN> email_server <VALUE>

для оператора виртуальной АТС:

/domain/<DOMAIN>/notifier/set email_server <VALUE>

где

<CLUSTER> - имя кластера с ролью MEDIATOR;
<DOMAIN> - имя виртуальной АТС;
<VALUE> - название хоста или IP-адрес SMTP-сервера.

Пример

Установка параметров для сервера mail.eltex-co.ru с авторизацией:

admin@[mycelium1@ecss1]:/$ domain/test.domain/notifier/set email_server mail.eltex.loc
Property "email_server" successfully changed from: 
"notifier.smtp.ecss" 
   to
"mail.eltex.loc".

2. Установка порта сервера электронной почты.

для администратора системы:

/cluster/mediator/<CLUSTER>/notifier/set <DOMAIN> email_port <VALUE>

для оператора виртуальной АТС:

/domain/<DOMAIN>/notifier/set email_port <VALUE>

где
<CLUSTER> - имя кластера с ролью MEDIATOR;
<DOMAIN> - имя виртуальной АТС;
<VALUE> - транспортный порт SMTP-сервера.

Пример

Настройка порта:

admin@[mycelium1@ecss1]:/$ domain/test.domain/notifier/set email_port 13030   
Property "email_port" successfully changed from: 
default (25)
   to
13030.

3. Установка криптографического протокола TLS, SSL.

для администратора системы:

/cluster/mediator/<CLUSTER>/notifier/set <DOMAIN> email_protection_connection <VALUE>

для оператора виртуальной АТС:

/domain/<DOMAIN>/notifier/set email_protection_connection <VALUE>

где <CLUSTER> - имя кластера с ролью MEDIATOR;
<DOMAIN> - имя виртуальной АТС;
<VALUE> - назначаемый протокол, принимает значения:

ssl_tls - защита соединения по протоколу SSL/TLS;
starttls - защита соединения STARTTLS;
none - не использовать защищенное соединение.

Пример

Включение поддержки TLS/SSL:

admin@[mycelium1@ecss1]:/$ cluster/mediator/md1/notifier/set test.domain email_protection_connection ssl_tls 
Property "email_protection_connection" successfully changed from: 
none
   to
ssl_tls.

4. Установка имени пользователя для доступа к SMTP-серверу.

для администратора системы:

/cluster/mediator/<CLUSTER>/notifier/set <DOMAIN> email_username <VALUE>

для оператора виртуальной АТС:

/domain/<DOMAIN>/notifier/set email_username <VALUE>

где
<CLUSTER> - имя кластера с ролью MEDIATOR;
<DOMAIN> - имя виртуальной АТС;
<VALUE> - имя пользователя для подключение к электронной почте.

Пример

Установка имени пользователя для авторизации:

admin@[mycelium1@ecss1]:/$ cluster/mediator/md1/notifier/set test.domain email_username noreply@eltex.loc
Property "email_username" successfully changed from: 
"email_username" 
   to
"noreply@eltex.loc".

5. Установка пароля для доступа к SMTP-серверу.

для администратора системы:

/cluster/mediator/<CLUSTER>/notifier/set <DOMAIN> email_password <VALUE>

для оператора виртуальной АТС:

/domain/<DOMAIN>/notifier/set email_password <VALUE>

где
<CLUSTER> - имя кластера с ролью MEDIATOR;
<DOMAIN> - имя виртуальной АТС;
<VALUE> - пароль для авторизации на SMTP-сервере.

Пример

Установка пароля для авторизации:

admin@[mycelium1@ecss1]:/$ cluster/mediator/md1/notifier/set test.domain email_password passwd
Property "email_password" successfully changed from: 
"ylperon" 
   to
"passwd".

Настройка формата писем, отправляемых службой

1. Установка адреса электронной почты отправителя.

для администратора системы:

/cluster/mediator/<CLUSTER>/notifier/set <DOMAIN> email <VALUE>

для оператора виртуальной АТС:

/domain/<DOMAIN>/notifier/set email <VALUE>

где

<CLUSTER> - имя кластера с ролью MEDIATOR;
<DOMAIN> - имя виртуальной АТС;
<VALUE> - адрес электронной почты отправителя.

Пример:

Установка адреса отправителя:

admin@[mycelium1@ecss1]:/$ cluster/mediator/md1/notifier/set test.domain email noreply@eltex.loc
Property "email" successfully changed from: 
"default@eltex.loc" 
   to
"noreply@eltex.loc".

2. Настройка формата для темы почтового сообщения.

для администратора системы:

/cluster/mediator/<CLUSTER>/alarms/notifiers/email/set <DOMAIN> subject_format <VALUE>

для оператора виртуальной АТС:

/domain/<DOMAIN>/alarms/notifiers/email/set subject_format <VALUE>

где

<CLUSTER> - имя кластера с ролью MEDIATOR;<DOMAIN> - имя виртуальной АТС;
<VALUE> - формат темы сообщения, принимает значения:

%CLASS% - класс предупреждения;
%LOCATION% - место возникновения предупреждения;
%INSTANCE% - экземпляр класса предупреждения;
%SEVERITY% - важность предупреждения;
%CAUSE% - причина предупреждения;
%TEXT% - описание предупреждения;
%TYPE% - тип предупреждения;
%TIME% - время предупреждения.

В теле сообщения поддерживаются спецсимволы \n, ~n, для перевода на новую строку.

Пример

Настройка формата для темы почтового сообщения:

/cluster/mediator/md1/alarms/notifiers/email/set * subject_format ECSS1-ALARM (%SEVERITY%)

3. Настройка формата содержимого почтового сообщения.

для администратора системы:

/cluster/mediator/<CLUSTER>/alarms/notifiers/email/set <DOMAIN> body_format <VALUE>

для оператора виртуальной АТС:

/domain/<DOMAIN>/alarms/notifiers/email/set body_format <VALUE>

где

<CLUSTER> - имя кластера с ролью MEDIATOR;
<DOMAIN> - имя виртуальной АТС;
<VALUE> - формат тела сообщения, принимает значения:

%CLASS% - класс предупреждения;
%LOCATION% - место возникновения предупреждения;
%INSTANCE% - экземпляр класса предупреждения;
%SEVERITY% - важность предупреждения;
%CAUSE% - причина предупреждения;
%TEXT% - описание предупреждения;
%TYPE% - тип предупреждения;
%TIME% - время предупреждения.

Пример

Настройка формата содержимого почтового сообщения:

/cluster/mediator/md1/alarms/notifiers/email/set body_format * Class: %CLASS% ~nLocation: %LOCATION% ~nInstance: %INSTANCE% ~nTime: %TIME% ~nText: %TEXT%

4. Установка ограничения на длину темы почтового сообщения.

для администратора системы:

/cluster/mediator/<CLUSTER>/alarms/notifiers/email/set <DOMAIN> subject_limit <VALUE>

для оператора виртуальной АТС:

/domain/<DOMAIN>/alarms/notifiers/email/set subject_limit <VALUE>

где
<CLUSTER> - имя кластера с ролью MEDIATOR;
<DOMAIN> - имя виртуальной АТС;
<VALUE> - максимальное количество символов, которое может содержать тема сообщения.

Пример

Установка ограничения на длину темы и тела сообщения:

/cluster/mediator/md1/alarms/notifiers/email/set * subject_limit 50

5. Установка ограничения на длину тела почтового сообщения.

для администратора системы:

/cluster/mediator/<CLUSTER>/alarms/notifiers/email/set <DOMAIN> body_limit <VALUE>

для оператора виртуальной АТС:

/domain/<DOMAIN>/alarms/notifiers/email/set body_limit <VALUE>

где
<CLUSTER> - имя кластера с ролью MEDIATOR;
<DOMAIN> - имя виртуальной АТС;
<VALUE> - максимальное количество символов, которое может содержать тело сообщения.

Пример

Установка ограничения на длину тела сообщения:

/cluster/mediator/md1/alarms/notifiers/email/set * body_limit 1000

Настройка получателей уведомлений

1. Добавление получателя уведомлений.

для администратора системы:

/cluster/mediator/<CLUSTER>/alarms/notifiers/email/set to <name1@domain1> [,<name2@domain2>, ..., <nameN@domainN>]

для оператора виртуальной АТС:

/domain/<DOMAIN>/alarms/notifiers/email/set to <name1@domain1> [, <name2@domain2>, ..., <nameN@domainN>]

где
<CLUSTER> - имя кластера с ролью MEDIATOR;
<DOMAIN> - имя виртуальной АТС;
<name1@domain1> - адрес электронной почты получателя уведомлений.

Пример

Добавление получателей уведомлений:

/cluster/mediator/md1/alarms/notifiers/email/set to user1@eltex.nsk.ru, user2@eltex.nsk.ru

2. Удаление получателя уведомлений.

для администратора системы:

/cluster/mediator/<CLUSTER>/alarms/notifiers/email/clean <DOMAIN> to <name1@domain1> [,<name2@domain2>, ..., <nameN@domainN>]

для оператора виртуальной АТС:

/domain/<DOMAIN>/alarms/notifiers/email/clean to <name1@domain1> [, <name2@domain2>, ..., <nameN@domainN>]

где
<CLUSTER> - имя кластера с ролью MEDIATOR;
<DOMAIN> - имя виртуальной АТС;
<name1@domain1> - адрес электронной почты получателя уведомлений.

Пример

Удаление получателей уведомлений:

/cluster/mediator/md1/alarms/notifiers/email/clean * to user1@eltex.nsk.ru,user2@eltex.nsk.ru

Просмотр настроек, сброс настроек к заводским и пример содержимого отправляемого письма

Просмотреть текущие настройки для подключения к серверу электронной почты можно командой info:

для администратора системы:

/cluster/mediator/<CLUSTER>/notifier/info

для оператора виртуальной АТС:

/domain/<DOMAIN>/notifier/info

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

Пример

admin@[core1@ecss1]:/$ cluster/mediator/md1/notifier/info 
┌───────────────────────────┬───────┬──────────────────────────┐
│         Property          │Domain │          Value           │
├───────────────────────────┼───────┼──────────────────────────┤
│email                      │       │"noreply@eltex.loc"       │
│email_buffer_limit         │       │50                        │
│email_enable               │       │false                     │
│email_password             │       │"ylperon"                 │
│email_port                 │       │default                   │
│email_protection_connection│       │none                      │
│email_resend_count_max     │       │5                         │
│email_resend_timer         │       │30                        │
│email_server               │       │"notifier.smtp.ecss"      │
│email_username             │       │"noreply@eltex.loc"       │
│jabber_buffer_limit        │       │50                        │
│jabber_enable              │       │false                     │
│jabber_password            │       │"ylperon"                 │
│jabber_port                │       │5222                      │
│jabber_reconnect_timer     │       │10                        │
│jid                        │       │"ecss-10@jabber.eltex.loc"│
└───────────────────────────┴───────┴──────────────────────────┘

Просмотр настроек параметров уведомлений можно командами:

для администратора системы:

/cluster/mediator/<CLUSTER>/alarms/notifiers/email/info

для оператора виртуальной АТС:

/domain/<DOMAIN>/alarms/notifiers/email/info

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

Пример

admin@[core1@ecss1]:/$ domain/test.domain/alarms/notifiers/email/info 
┌──────────────┬───────────┬────────────────────────────────────────────────────────────────────────────────┐
│   Property   │  Domain   │                                     Value                                      │
├──────────────┼───────────┼────────────────────────────────────────────────────────────────────────────────┤
│body_format   │test.domain│"Class: %CLASS% ~nLocation: %LOCATION% ~nInstance: %INSTANCE% ~nTime: %TIME% ~nT│
│              │           │ext: %TEXT%"                                                                    │
│body_limit    │test.domain│1000                                                                            │
│enabled       │test.domain│false                                                                           │
│from_name     │test.domain│"ECSS-NO-REPLY"                                                                 │
│subject_format│test.domain│"ALARM (%SEVERITY%)"                                                            │
│subject_limit │test.domain│50                                                                              │
│to            │test.domain│[]                                                                              │
│to_name       │test.domain│"ECSS-SUPPORT"                                                                  │
└──────────────┴───────────┴────────────────────────────────────────────────────────────────────────────────

Пример получаемого письма для указанных выше настроек:

Абонентам "user1@eltex.nsk.ru" и "user2@eltex.nsk.ru" приходит письмо:

From ECSS-NO-REPLY@mail.eltex.loc
Subject ECSS1-ALARM (critical)
To ECSS-SUPPORT@mail.eltex.loc

Class: ecss::node 
Location: tts1@ecss2 
Instance: tts1@ecss1 
Time: 15/08/2013 14:13:16 
Text: Neighbour node: tts1@ecss1 is DOWN. Reason: noconnection

Для сброса настроек используются команды:

для администратора системы:

/cluster/mediator/<CLUSTER>/alarms/notifiers/email/clean <DOMAIN> [<KEY>]
/cluster/mediator/<CLUSTER>/notifier/clean <DOMAIN> [<KEY>]

для оператора виртуальной АТС:

/domain/<DOMAIN>/alarms/notifiers/email/clean [<KEY>]
/domain/<DOMAIN>/notifier/clean [<KEY>]

где

<CLUSTER> - имя кластера с ролью MEDIATOR;
<DOMAIN> - имя виртуальной АТС;
<КEY> - название параметра, для которого выполняется сброс настроек, опциональный параметр. Если параметр не указывать, то все настройки будут удалены.

Пример

Сброс настроек формата тела сообщения:

/cluster/mediator/md1/alarms/notifiers/email/clean * subject_format

Настройка глобальных параметров администратором системы

Для установки интервала отправки уведомлений на электронную почту задается значение "alarmNotifyInterval" в минутах, по умолчанию установлено 5 минут. В течение заданного периода времени будет осуществляться кэширование сообщений о предупреждениях в системе. По истечении интервала отправляется последняя авария с самым большим severity. Затем считается, что аварий не было и заново повторяем описанный выше алгоритс.
/cluster/mediator/<CLUSTER>/properties/rpss/set <NODE> alarmNotifyInterval <VALUE>
где
<CLUSTER> - имя кластера с ролью MEDIATOR;
<DOMAIN> - имя виртуальной АТС;
<NODE> - имя ноды;
<VALUE> - интервал отправки уведомлений на электронную почту, в минутах.
Пример
Установить интервал отправки уведомлений на электронную почту в 3 минуты:
```
/cluster/mediator/md1/properties/rpss/set * alarmNotifyInterval 3
Property "alarmNotifyInterval" successfully changed from: 
5
   to
3.
```
Для установки размера кэш процесса, осуществляющего рассылку уведомлений, установите значение "alarmNotifyCacheSize", по умолчанию установлено 30. Параметр "alarmNotifyCacheSize" определяет количество одновременно обрабатываемых сообщений о предупреждениях в системе.
/cluster/mediator/<CLUSTER>/properties/rpss/set <NODE> alarmNotifyCacheSize <VALUE>
где
<CLUSTER> - имя кластера с ролью MEDIATOR;
<DOMAIN> - имя виртуальной АТС;
<NODE> - имя ноды;
<VALUE> - количество одновременно обрабатываемых сообщений о предупреждениях в системе.
Пример
Установить количество одновременно обрабатываемых сообщений о предупреждениях для всех кластеров - 35:
```
/cluster/mediator/md1/properties/rpss/set * alarmNotifyCacheSize 35
Property "alarmNotifyCacheSize" successfully changed from: 
30
   to
35.
```

Активация службы администратором системы

После настройки выполняется включение отправки уведомлений:

/cluster/mediator/<CLUSTER>/alarms/notifiers/email/set enabled true

и разрешение отправки:

/cluster/mediator/<CLUSTER>/notifier/set <DOMAIN> email_enable true

где

<CLUSTER> - имя кластера с ролью MEDIATOR.

Пример

admin@[core1@ecss1]:/$ cluster/mediator/md1/alarms/notifiers/email/set test.domain enabled true
Property "enabled" successfully changed from: 
false
   to
true.

Быстрые ссылки

Дерево страниц

Настройка глобальных параметров администратором системы

Активация службы администратором системы

Быстрые ссылки

Дерево страниц

Настройка службы отправки предупреждений по электронной почте

Настройка параметров подключения к серверу электронной почты

Настройка формата писем, отправляемых службой

Настройка получателей уведомлений

Просмотр настроек, сброс настроек к заводским и пример содержимого отправляемого письма

Настройка глобальных параметров администратором системы

Активация службы администратором системы