/domain/<DOMAIN>/sip/ldap/ - команды управления параметрами соединения с сервером LDAP
В данном разделе описываются команды работы с уже настроенным и запущенным сервером LDAP.
LDAP-сервер представляется собой сервер, участвующий в аутентификации абонентов.
Не является LDAP-сервером, аутентифицирующим права доступа к сущностям SSW (терминал и т.д.).
Физически это может быть один и тот же сервер.
Внимание! Не рекомендуется использовать LDAP для хранения авторизационных данных абонентов. По умолчанию на текущей версии ПО авторизационные данные хранятся в DS.
<DOMAIN> - имя виртуальной АТС.
В таблице 1 приведено описание параметров соединения с сервером LDAP.
Таблица 1 - Описание параметров соединения с сервером LDAP
Название | Значение по умолчанию | Описание |
---|---|---|
access.login | cn=admin,dc=ecss | атрибут, хранящий имя пользователя |
access.passw | admin | пароль доступа к данным по назначенному пути |
access.path | ou=sip1,dc=ecss | путь доступа, который назначается кластеру для хранения/получения информации по авторизации абонента |
alive_timeout | 10000 | период времени между периодическими запросами до LDAP-сервера (проверка подключения, обновление данных учетных записей локальных пользователей) |
attr.domain | dc | атрибут, хранящий домены регистрации |
attr.login | cn | атрибут, хранящий логин пользователя |
attr.passw | description | атрибут, хранящий пароль пользователя |
attr.phone | telephoneNumber | атрибут, хранящий телефонный номер авторизующегося абонента |
enable | false | запуск (true) или остановка (false) соединения с LDAP-сервером |
ip | localhost | IP-адрес LDAP-сервера |
port | 389 | порт LDAP-сервера |
check
Команда просмотра информации о состоянии соединения с сервером LDAP (отображается идентификатор процесса, контролирующего соединение). Также выполняется автоматическая периодическая проверка состояния соединения посредством тестового запроса к LDAP-серверу. При пропадании соединения отправляется предупреждение.
Путь команды:
/domain/<DOMAIN>/sip/ldap/check
Синтаксис:
check
Параметры:
Команда не содержит аргументов.
Пример:
admin@mycelium1@ecss1:/$ domain/biysk.local/sip/ldap/check Executed on the sip1@ecss1 ┌────────────┬──────────────────────┐ │ Node │ Check │ ├────────────┼──────────────────────┤ │ sip1@ecss1 │ {connected,<0.802.1>}│ │ sip1@ecss2 │ {disconnected,false} │ └────────────┴──────────────────────┘
clean
Командой устанавливаются значение по умолчанию для параметров соединения с сервером LDAP.
Путь команды:
/domain/<DOMAIN>/sip/ldap/clean
Синтаксис:
clean [<KEY>] [--force]
Параметры:
<KEY> - название параметра, значение которого нужно установить по умолчанию. Опциональный параметр. Если параметр не указывать, то все значения будут установлены по умолчанию. Список параметров приведен в таблице 1.
--force - выполнение команды без запроса подтверждения.
Пример:
admin@mycelium1@ecss1:/$ domain/biysk.local/sip/ldap/clean access.path Property access.path values successfully restored
domain
Команда управления записью о домене регистрации SIP.
Путь команды:
/domain/<DOMAIN>/sip/ldap/domain
Синтаксис:
domain <ACT>
Параметры:
<ACT> - назначаемое действие, принимает значение:
- list - получение списка существующих доменов регистрации;
- remove - удаление домена регистрации с именем <DOMAIN> из каталога.
- --force - удаление домена без дополнительного вопроса.
Пример:
Получение списка существующих доменов регистрации:
admin@mycelium1@ecss1:/$ domain/biysk.local/sip/ldap/domain list Executed on the sip1@ecss1 ["10.16.33.21","192.168.1.21"]
info
Команда просмотра информации о параметрах соединения с сервером LDAP.
Путь команды:
/domain/<DOMAIN>/sip/ldap/info
Синтаксис:
info [<KEY>]
Параметры:
<KEY> – настраиваемый опциональный параметр, если не указывать параметр, будет показана информация обо всех параметрах соединения с сервером LDAP. Список параметров и их описание приведено в таблице 1.
Пример:
admin@mycelium1@ecss1:/$ domain/biysk.local/sip/ldap/info ┌─────────────┬───────────┬────────────────┐ │ Property │ Domain │ Value │ ├─────────────┼───────────┼────────────────┤ │access.login │biysk.local│cn=admin,dc=ecss│ │access.passw │biysk.local│admin │ │access.path │biysk.local│ou=sip1,dc=ecss │ │alive_timeout│biysk.local│10000 │ │attr.domain │biysk.local│dc │ │attr.login │biysk.local│cn │ │attr.passw │biysk.local│description │ │attr.phone │biysk.local│telephoneNumber │ │enable │biysk.local│true │ │ip │biysk.local│192.168.1.21 │ │port │biysk.local│389 │ └─────────────┴───────────┴────────────────┘
set
Команда установки значения параметров соединения с сервером LDAP.
Путь команды:
/domain/<DOMAIN>/sip/ldap/set
Синтаксис:
set <KEY> <VALUE>
Параметры:
- <KEY> – настраиваемый параметр. Список параметров приведен в таблице 1.
- <VALUE> - значение параметра.
Примеры:
Установить адрес LDAP-сервера ldap.maas.eltex.loc
admin@mycelium1@ecss1:/$ domain/biysk.local/sip/ldap/set ip 192.168.1.21 Property "ip" successfully changed from: localhost to 192.168.1.21.
Установить порт LDAP-сервера 3389:
admin@mycelium1@ecss1:/$ domain/biysk.local/sip/ldap/set port 3389 Property "port" successfully changed from: 389 to 3389.
Установить путь доступа для хранения/получения информации по авторизации абонента «sip»:
admin@mycelium1@ecss1:/$ domain/biysk.local/sip/ldap/set access.path ou=sip1,dc=ecss Property "access.path" successfully changed from: ou=sip1,dc=ecss to ou=sip1,dc=ecss.
user
Команда управления записями о SIP-абонентах на сервере LDAP.
Путь команды:
/domain/<DOMAIN>/sip/ldap/user
Синтаксис:
user list <DOMAIN>
user remove <DOMAIN> [--force]
user test <DOMAIN> <USER> <LOGIN> <PASSWORD>
Параметры:
- user list – просмотр списка параметров авторизированных SIP-абонентов (аккаунтов);
- user remove – удаление абонента (аккаунта) из каталога;
- user test – тестовый вызов для получения авторизации;
<DOMAIN> - имя домена регистрации;
[--force] - команда для удаления абонента без дополнительных вопросов;
<PHONE> - телефонный номер абонента;
При авторизации по связке <DOMAIN> + <PHONE> определяется результат <USER> + <PASSWORD>.
В рамках одного домена логин должен быть уникальным. Назначение нескольких логинов одному телефонному номеру разрешено.
Сейчас нельзя изменить параметры аккаунта. В случае некорректного ввода нужно удалить неверный аккаунт и создать новый.
<USER> - логин абонента;
<PASSWORD> - пароль абонента.
Пример:
admin@mycelium1@ecss1:/$ domain/biysk.local/sip/ldap/user list biysk.local Executed on the sip1@ecss1 ┌────────────────────┬────────────────┐ │ User │ Login │ ├────────────────────┼────────────────┤ │ 240799@biysk.local │ 240799:test4PW │ ...