/domain/<DOMAIN>/direction/ - команды управления направлениями
В текущем разделе описываются команды управления направлениями.
Направления могут применяться для распределения исходящей вызывной нагрузки через разные транки. При недоступности первого по списку транка нагрузка распределяется на следующий и т. д.
Созданное направление позволяет указывать только имя в правилах контекстов маршрутизации. Это позволяет легко использовать направления в разных контекстах/правилах маршрутизации.
Также направление позволяет менять её настройки без изменения контекстов маршрутизации (например, добавлять/удалять транки в рамках направления, изменять максимальное количество вызовов, которые могут проходить через данное направление).
В таблице 1 приведено описание свойств направлений.
Таблица 1 - Описание свойств направлений
Название свойства | Значение по умолчанию | Описание |
---|---|---|
description | - | Краткое описание направления. |
isActive | false | Состояние направления: - true - направление включено; - false - направление выключено. |
bandwidth | unbounded(0) | Задается в виде X(Y), где - X - максимальное возможное количество одновременных вызовов на данном направлении (unbounded - не ограничено); - Y - сколько вызовов в данный момент проходит через направление. |
trunks | - | Список транков, объединенных в данном направлении, задается в виде <OWNER> <GROUP> <TRUNK>, где <OWNER> - владелец транка; <GROUP> - группа транка; <TRUNK> - имя транка, может быть указан список транков через пробел. |
add-trunks
Команда для добавления транка в определенное направление.
Путь команды:
/domain/<DOMAIN>/direction/add-trunks
Синтаксис:
add-trunks <DIRECTION> <OWNER> <GROUP> <TRUNKS>
Параметры:
<DIRECTION> - имя направления, в которое добавляется транк;
<OWNER> - имя владельца транка, символ "*" используется для указания любого владельца;
<GROUP> - имя группы транка, символ "*" используется для указания любой группы;
<TRUNKS> - имя транка, который нужно добавить в направление, также может быть задан список транков через пробел.
Пример:
admin@[mycelium1@ecss1]:/$ domain/biysk.local/direction/add-trunks tg-112 sip1 ssw.gr ems1 bsk1 ok [exec at: 06.03.2019 10:47:50, exec time: 134ms, nodes: core1@ecss2]
clean
Данной командой для определенного свойства направления устанавливается значение по умолчанию.
Путь команды:
/domain/<DOMAIN>/direction/clean
Синтаксис:
clean <DIRECTION> <PROPERTY>
Параметры:
<DIRECTION> - имя направления, для свойства которого выполняется установка значения по умолчанию;
<PROPERTIES> - имя свойства, значение которого необходимо установить по умолчанию: description; isActive; bandwidth; trunks. Значение по умолчанию приведено в таблице 1.
Пример:
admin@[mycelium1@ecss1]:/$ domain/biysk.local/direction/clean tg-112 description ok [exec at: 06.03.2019 11:43:06, exec time: 186ms, nodes: core1@ecss1]
declare
Данной командой создается направление.
Путь команды:
/domain/<DOMAIN>/direction/declare
Синтаксис:
declare <DIRECTION> [<PROPERTIES> = <VALUE>]
Параметры:
<DIRECTION> - имя направления;
<PROPERTIES> - имя свойства, значение которого необходимо настроить. Описание свойств приведено в таблице 1.
<VALUE> - новое значение свойства, возможные значения приведены в таблице 1.
Пример:
admin@[mycelium1@ecss1]:/$ domain/biysk.local/direction/declare tg-112 bandwidth = 12, isActive = true, description = tg-edds_112 ok [exec at: 06.03.2019 10:45:15, exec time: 108ms, nodes: core1@ecss2]
info
Команда просмотра конфигурации определенного направления:
- Direction - имя направления;
- Description - краткое описание;
- Active - состояние направления;
- Bandwidth - максимальное возможное количество одновременных вызовов на данном направлении, в "()" указывается количество вызовов, которое в данный момент проходит через направление;
- Trunks - список входящих в направление транков;
- Properties - дополнительная информацию:
- mlpp\isActive: - режим работы подсистемы MLPP: активен (true) , не активен (false), не определен (undefined);
- cp_list: - список идентификаторов call-процессов, которые заняли ресурс данного направления;
- mlpp\at_queue: - количество call-процессов, находящихся в ожидании освобождения направления;
- stat\out: - количество занятий направления;
- stat\reject: - количество отказов в выделении направления;
- stat\last_activity: - время последней активности по данному направлению. (когда последний раз было к нему обращение)
undefined - значит активности по нему пока не было.
Путь команды:
/domain/<DOMAIN>/direction/info
Синтаксис:
info <DIRECTION>
Параметры:
<DIRECTION> - имя направления, для которого выполняется настройка конфигурации.
Пример:
admin@[mycelium1@ecss1]:/$ domain/biysk.local/direction/info tg-112 ┌─────────┬───────────┬──────┬─────────┬──────┬────────────────────────────────────────┐ │Direction│Description│Active│Bandwidth│Trunks│ Properties │ │ │ │ │ (calls) │ │ │ ├─────────┼───────────┼──────┼─────────┼──────┼────────────────────────────────────────┤ │tg-112 │tg-edds_112│true │12(2) │bsk2 │mlpp\isActive: undefined │ │ │ │ │ │ems2 │cp_list: [{<<"89438b824ef170d3">>,{out,<│ │ │ │ │ │ │<"89438b84bf19b842">>}}, │ │ │ │ │ │ │ {<<"8943890f64053671">>,{out,<│ │ │ │ │ │ │<"89438911c0a5d44a">>}}] │ │ │ │ │ │ │mlpp\at_queue: 0 │ │ │ │ │ │ │stat\out: 44 │ │ │ │ │ │ │stat\reject: 60 │ │ │ │ │ │ │stat\last_activity: 2019/03/06 11:34:45 │ └─────────┴───────────┴──────┴─────────┴──────┴────────────────────────────────────────┘ [exec at: 06.03.2019 11:35:16, exec time: 127ms, nodes: core1@ecss1]
list
Команда просмотра списка направлений.
Путь команды:
/domain/<DOMAIN>/direction/list
Синтаксис:
list
Параметры:
Команда не содержит аргументов.
Пример:
admin@[mycelium1@ecss1]:/$ domain/biysk.local/direction/list Collecting data... [**********************************************************************] 7ms ┌─────────┬───────────┬──────┬─────────┬────────┐ │Direction│Description│Active│Bandwidth│ Trunks │ │ │ │ │ (calls) │ │ ├─────────┼───────────┼──────┼─────────┼────────┤ │tg-112 │tg-edds_112│true │12(0) │ems1 │ │ │ │ │ │bsk1 │ │tg:ems │tg-115 │true │50(0) │to_aster│ │ │ │ │ │to_sipp │ └─────────┴───────────┴──────┴─────────┴────────┘ Total: 2 [exec at: 06.03.2019 11:08:49, exec time: 91ms, nodes: core1@ecss1]
remove
Данной командой удаляется направление.
Путь команды:
/domain/<DOMAIN>/direction/remove
Синтаксис:
remove <DIRECTION>
Параметры:
<DIRECTION> - имя направления, которое требуется удалить.
Пример:
admin@[mycelium1@ecss1]:/$ domain/biysk.local/direction/remove tg:ems ok [exec at: 06.03.2019 11:40:51, exec time: 150ms, nodes: core1@ecss2]
remove-trunks
Команда для удаления транка/группы транков из определенного направления.
Путь команды:
/domain/<DOMAIN>/direction/remove-trunks
Синтаксис:
remove-trunks <DIRECTION> <OWNER> <GROUP> <TRUNKS>
Параметры:
<DIRECTION> - имя направления, из которого удаляется транк;
<OWNER> - имя владельца транка, символ "*" используется для указания любого владельца;
<GROUP> - имя группы транка, символ "*" используется для указания любой группы;
<TRUNKS> - имя транка, который нужно удалить из направления, также может быть задан список транков через пробел.
Пример:
admin@[mycelium1@ecss1]:/$ domain/biysk.local/direction/remove-trunks tg-112 bsk2 ok [exec at: 06.03.2019 11:37:51, exec time: 219ms, nodes: core1@ecss2]
reset-statistics
Команда удаления статистики по направлению.
Путь команды:
/domain/<DOMAIN>/direction/reset-statistics
Синтаксис:
reset-statistics <DIRECTION> <OPTION>
Параметры:
<DIRECTION> - имя направления, для которого сбрасывается статистика;
<OPTION> - назначаемое действие:
- all - сбросить всю статистику;
- stat\out - сбросить статистику по прошедшим через данное направление вызовам;
- stat\reject - сбросить статистику по отклоненным вызовам.
Пример:
admin@[mycelium1@ecss1]:/$ domain/biysk.local/direction/reset-statistics tg-112 all ok [exec at: 06.03.2019 11:38:36, exec time: 216ms, nodes: core1@ecss2]
set
Данной командой выполняется настройка конфигурации заданного направления.
Путь команды:
/domain/<DOMAIN>/direction/set
Синтаксис:
set <DIRECTION> <PROPERTY> <VALUE>
Параметры:
<DOMAIN> - имя виртуальной АТС, значения свойств которой необходимо установить. При указании символа "*" значение свойства устанавливается для всех виртуальных АТС системы;
<DIRECTION> - имя направления, для которого выполняется настройка конфигурации;
<PROPERTIES> - имя свойства, значение которого необходимо изменить: description; isActive; bandwidth; trunks. Описание свойств приведено в таблице 1.
<VALUE> - новое значение свойства, возможные значения приведены в таблице 1.
Пример:
admin@[mycelium1@ecss1]:/$ domain/biysk.local/direction/set tg-112 trunks sip1 ssw.gr ems2 bsk2 ok [exec at: 06.03.2019 11:14:43, exec time: 100ms, nodes: core1@ecss1]