/domain/<DOMAIN>/iface/ - команды управления интерфейсами
В этом разделе описываются команды для управления конфигурацией интерфейсов.
Для администратора виртуальной АТС команды выполняются в разделе /domain/<DOMAIN>/iface/ и применяются только для определенной виртуальной АТС.
<DOMAIN> - имя виртуальной АТС.
Описание параметров (свойств) SIP-интерфейса приведено в разделе Приложение Б. Набор параметров интерфейса SIP или во вкладке ниже.
Приложение Б. Набор параметров интерфейса SIP
Описание параметров (свойств) MEGACO-интерфейса приведено в разделе Приложении В. Набор параметров интерфейса MEGACO или во вкладке ниже.
Приложение В. Набор параметров интерфейса MEGACO
Команды управления конфигурацией определенного интерфейса
info
Команда для вывода на экран информации о свойствах (свойстве) определенного интерфейса.
Путь команды:
/domain/<DOMAIN>/iface/info
Синтаксис:
info *|<OWNER> *|<GROUP> <NAME RANGE> [<PROPERTY>]
Параметры:
<OWNER> - название владельца (символ "*" используется для указания всех владельцев);
<GROUP> - название группы (символ "*" используется для указания всех групп);
<NAME RANGE> - название интерфейса;
<PROPERTY> - свойство (опциональный параметр, если параметр не задан, то будет отображена информация о всех свойствах данного интерфейса).
Примеры:
Просмотр параметров интерфейса абонента:
admin@ds1@ecss1:/$ domain/biysk.local/iface/info * loc.gr 240006@biysk.local
┌──────────────────┬─┬───────────────┬────────────────────────────────────────────────────────────────────────────────┐
│ Interface │W│ Property │ Value │
├──────────────────┼─┼───────────────┼────────────────────────────────────────────────────────────────────────────────┤
│240006@biysk.local│i│account │{"...50-52-48-48-48-54","...66-115-107-95-48-48-54-45-116-101-115-116"} │
│ │i│adapter\version│"3.14.7.525" │
│ │i│alias │"alias-as-user" │
│ │i│aliases_list │["240006"] │
│ │i│auth_qop │true │
│ │i│declaration │{"admin",{1611,824911,432238}} │
│ │i│gate │{gate_amqp,<<"acp.adapter.init.ex">>,<<"acp.sip.sip1.ipset1.init.rk">>} │
│ │i│group │"loc.gr" │
│ │i│id │<<"064bc964f6513fd8">> │
│ │i│isActive │true │
│ │i│media-profile │{media_profile,"default",user, │
│ │ │ │ [{media_profile_codecs,'<other>', │
│ │ │ │ [{media_profile_codec,<<"<other>">>,<<"*">>,true,#{}}], │
│ │ │ │ #{offroad => false,'rtcp-enabled' => true}}, │
│ │ │ │ {media_profile_codecs,audio, │
│ │ │ │ [{media_profile_codec,<<"G722">>,<<"*">>,true,#{}}, │
│ │ │ │ {media_profile_codec,<<"PCMA">>,<<"*">>,true,#{}}, │
│ │ │ │ {media_profile_codec,<<"PCMU">>,<<"*">>,true,#{}}, │
│ │ │ │ {media_profile_codec,<<"G729">>,<<"*">>,true,#{}}, │
│ │ │ │ {media_profile_codec,<<"telephone-event">>,<<"*">>,true,#{}}], │
│ │ │ │ #{offroad => false,'rtcp-enabled' => true}}], │
│ │ │ │ #{'dtmf-receive-type' => auto,'dtmf-transmit-type' => transit}} │
│ │i│my_from │none │
│ │i│owner │"sip1" │
│ │i│profile │undefined │
│ │i│routing.context│ctx_from_local │
│ │i│sip_domain │"biysk.local" │
│ │D│site │<<"local">> │
│ │i│subtype │user │
│ │D│terminal_type │smart │
│ │i│type │sip │
│ │i│user_agent │"VP-15P/2.5.0.203 sofia-sip/1.12.10" │
│ │i│user_name │"240006" │
│ │D│zone │<<"default">> │
└──────────────────┴─┴───────────────┴────────────────────────────────────────────────────────────────────────────────┘
Legend:
W: Where property is set:
D: This is default property
G: This is global property
g: This is group property
O: This is owner property
B: This is group+owner property
i: This is interface property
?: Unknown property level
Note: * char in W column means "Can't read iface resource info". Error reason in value column in this case
[exec at: 16.02.2021 15:03:03, exec time: 20ms, nodes: ds1@ecss1 v.3.14.7.585
Просмотр установленного значения временной зоны для транка:
admin@ds1@ecss1:/$ domain/biysk.local/iface/info * * trunk timezone ┌─────────┬─┬────────┬───────────┐ │Interface│W│Property│ Value │ ├─────────┼─┼────────┼───────────┤ │trunk │i│timezone│'UTC+07:00'│ └─────────┴─┴────────┴───────────┘ Legend: W: Where property is set: D: This is default property G: This is global property g: This is group property O: This is owner property B: This is group+owner property i: This is interface property ?: Unknown property level Note: * char in W column means "Can't read iface resource info". Error reason in value column in this case [exec at: 03.11.2023 16:48:18, exec time: 7ms, nodes: ds1@ecss1 v.3.14.14.600]
list
Команда для просмотра списка интерфейсов ECSS-10 для определенного профиля группы, владельца.
Путь команды:
/domain/<DOMAIN>/iface/list
Синтаксис:
list [*|<OWNER> [*|<GROUP>]] [<PROPERTY> <OPERATOR> <VALUE>]]
Параметры:
- <OWNER> - название владельца (символ "*" используется для указания всех владельцев);
- <GROUP> - название группы (символ "*" используется для указания всех групп).
- <PROPERTY> - свойство интерфейса, возможные значения приведены в таблице 1.;
- <OPERATOR> - оператор сравнения : '==' | '<>' | '>' | '<' | '>=' | '=<' | '~';
- '==' - равно;
- '<>' - не равно;
- '>' - больше;
- '>=' - больше или равно;
- '<' - меньше;
- '=<' - меньше или равно;
- '~' - содержит.
- <VALUE> - значение свойства.
Пример:
admin@ds1@ecss1:/$ domain/biysk.local/iface/list sip1 loc.gr terminal_type == basic ┌───────────┬───────────────────────────────────────────────┬───────────────────────────────────────────────────────────────┬───────────────────────────────┬───────────────────────────────┬───────────┐ │ Type │ Iface │ Name │ Owner │ Group │ Active │ ├───────────┼───────────────────────────────────────────────┼───────────────────────────────────────────────────────────────┼───────────────────────────────┼───────────────────────────────┼───────────┤ │sip │064bc964febdde57 │240470@biysk.local │sip1 │loc.gr │true │ │sip │064bc9653cd7615b │240475@biysk.local │sip1 │loc.gr │false │ │sip │064bc965007abdf0 │240474@biysk.local │sip1 │loc.gr │true │ │sip │064bc964fbacf7eb │240465@biysk.local │sip1 │loc.gr │true │ │sip │064bc96537760556 │240471@biysk.local │sip1 │loc.gr │false │ │sip │064bc964face07a5 │240464@biysk.local │sip1 │loc.gr │true │ │sip │064bc9653aef6a3b │240473@biysk.local │sip1 │loc.gr │false │ └───────────┴───────────────────────────────────────────────┴───────────────────────────────────────────────────────────────┴───────────────────────────────┴───────────────────────────────┴───────────┘ Ifaces for domain: "biysk.local" Ifaces in table: 7 [exec at: 16.02.2021 15:07:11, exec time: 32ms, nodes: ds1@ecss1 v.3.14.7.585]
user-set
Данной командой настраиваются свойства интерфейса. Описание свойств, которые настраиваются на определенном интерфейсе приведено выше.
Путь команды:
/domain/<DOMAIN>/iface/user-set
Синтаксис:
user-set <OWNER> <GROUP> <IFACE RANGE> <PROPERTY> <VALUE>
Параметры:
<OWNER> - название владельца (символ "*" используется для указания всех владельцев);
<GROUP> - название группы (символ "*" используется для указания всех групп);
<IFACE RANGE> - название интерфейса;
<PROPERTY> - свойство интерфейса, значение которого требуется установить, описание приведено в таблице 1
<VALUE> - значение свойства.
Примеры:
Установка кодировки:
admin@ds1@ecss1:/$ domain/biysk.local/iface/user-set sip1 loc.gr 240530@biysk.local support-encoding utf8 Property 'support-encoding' successfully changed to 'utf8' for interfaces: 240530@biysk.local [exec at: 16.02.2021 15:08:04, exec time: 18ms, nodes: ds1@ecss1 v.3.14.7.585]
Установка контекста маршрутизации:
admin@ds1@ecss1:/$ domain/biysk.local/iface/user-set .system * system:ivr routing.context ctx_from_local Property 'routing.context' successfully changed to 'ctx_from_local' for interfaces: system:ivr [exec at: 16.02.2021 15:08:33, exec time: 28ms, nodes: ds1@ecss1 v.3.14.7.585]
Установка предпочитаемого сайта для абонента:
admin@ds1@ecss1:/$ domain/biysk.local/iface/user-set sip1 loc.gr 240606@biysk.local site remote Property 'site' successfully changed to 'remote' for interfaces: 240606@biysk.local [exec at: 16.02.2021 15:12:10, exec time: 21ms, nodes: ds1@ecss1 v.3.14.7.585]
Установка зоны для транка:
admin@ds1@ecss1:/$ domain/biysk.local/iface/user-set sip1 sbc.gr nsk_sbc zone nsk Property 'zone' successfully changed to 'nsk' for interfaces: nsk_sbc [exec at: 16.02.2021 15:12:35, exec time: 26ms, nodes: ds1@ecss1 v.3.14.7.585]
Включение поддержки CFC на интерфейсе:
admin@ds1@ecss1:/$ domain/biysk.local/iface/user-set sip1 loc.gr 240473@biysk.local cfc-support true Property 'cfc-support' successfully changed to 'true' for interfaces: 240473@biysk.local [exec at: 16.02.2021 15:12:56, exec time: 30ms, nodes: ds1@ecss1 v.3.14.7.585]
Установка временной зоны для транка:
admin@ds1@ecss1:/$ domain/biysk.local/iface/user-set * * trunk timezone UTC+07:00 Property 'timezone' successfully changed to 'UTC+07:00' for interfaces: trunk [exec at: 03.11.2023 16:58:15, exec time: 13ms, nodes: ds1@ecss1 v.3.14.14.600]
Команды конфигурирования свойств интерфейсов для профиля группы, профиля владельца
group-info
Команда для просмотра информации о свойствах интерфейсов.
Путь команды:
/domain/<DOMAIN>/iface/group-info
Синтаксис:
group-info [-o <OWNER>] [-g <GROUP>]
Параметры:
-о - флаг, который указывает на свойства уровня владельца интерфейса;
-g - флаг, который указывает на свойства глобального уровня;
<OWNER> - имя профиля владельца;
<GROUP> - имя профиля группы.
Пример:
admin@ds1@ecss1:/$ domain/biysk.local/iface/group-info -g sbc.gr -o sip1
Domain biysk.local onwer sip1 group sbc.gr iface resoureces properties:
┌─┬────────┬───────────────────────────────────────────────────────────────────────┐
│W│Property│ Value │
├─┼────────┼───────────────────────────────────────────────────────────────────────┤
│g│domain │"biysk.local" │
│g│gate │{gate_amqp,<<"acp.adapter.init.ex">>,<<"acp.sip.sip1.ipset1.init.rk">>}│
│g│group │{gate_amqp,<<"acp.adapter.init.ex">>,<<"acp.sip.sip1.ipset1.init.rk">>}│
│g│owner │"sip1" │
└─┴────────┴───────────────────────────────────────────────────────────────────────┘
Legend:
W: Where property is set:
G: This is global property
g: This is group property
O: This is owner group property
B: This is group+owner property
?: Unknown property level
Note: * char in W column means "Can't read iface resource info". Error reason in value column in this case
[exec at: 16.02.2021 15:13:19, exec time: 5ms, nodes: ds1@ecss1 v.3.14.7.585]
group-clean
Команда для сброса свойств интерфейсов.
Путь команды:
/domain/<DOMAIN>/iface/group-clean
Синтаксис:
group-clean [-o <OWNER>] [-g <GROUP>] -p <PROPERTY>
Параметры:
-о - флаг, который указывает на свойства уровня владельца интерфейса;
-g - флаг, который указывает на свойство принадлежности группы;
-p - флаг, который указывает на параметр для группы интерфейса
<OWNER> - имя профиля владельца;
<GROUP> - имя профиля группы;
<PROPERTY> - свойство интерфейса.
Пример:
admin@ds1@ecss1:/$ domain/biysk.local/iface/group-clean -g ssw.gr -o sip1 -p cfc-support Iface resources group property cfc-support is cleaned for domain biysk.local owner sip1, group ssw.gr [exec at: 16.02.2021 15:14:24, exec time: 24ms, nodes: ds1@ecss1 v.3.14.7.585]
group-set
Команда для установки свойств интерфейсов.
Путь команды:
/domain/<DOMAIN>/iface/group-set
Синтаксис:
group-set [-o <OWNER>] [-g <GROUP>] -p <PROPERTY> <VALUE>
Параметры:
-о - флаг, который указывает на свойства уровня владельца интерфейса;
-g - флаг, который указывает на свойства глобального уровня;
-p - флаг, который указывает на параметр для группы интерфейса
<OWNER> - имя профиля владельца;
<GROUP> - имя профиля группы;
<PROPERTY> - свойство интерфейса;
<VALUE> - значение свойства.
Пример:
admin@ds1@ecss1:/$ domain/biysk.local/iface/group-set -g ssw.gr -o sip1 -p cfc-support true Defined iface resources group property cfc-support for group ssw.gr, owner sip1 [exec at: 16.02.2021 15:13:50, exec time: 20ms, nodes: ds1@ecss1 v.3.14.7.585]