/domain/<DOMAIN>/alias/ - команды управления алиасами
В этом разделе описываются команды управления, которые относятся к созданию/удалению алиасов и настройке параметров (свойств) алиасов.
Описание параметров алиаса приведено в Таблице 1.
Параметры (свойства) алиасов определяются на нескольких уровнях:
- Уровень алиаса – настройки уровня действуют на определенный алиас (имя домена, имя интерфейса и адрес).
- Уровень домена и интерфейса – настройки уровня действует на все алиасы с заданными именем домена и именем интерфейса.
- Уровень домена и адреса - настройки действуют на все алиасы с заданным именем домена и адресом.
- Уровень домена - настройки действуют на все алиасы с заданным доменом.
- Глобальный уровень - действует на все алиасы системы.
Для администратора виртуальной АТС команды выполняются на уровне виртуальной АТС в разделе /domain/<DOMAIN>/alias/ и применяются только для определенной виртуальной АТС.
address-clean
Команда предназначена для очистки свойств алиасов на уровне домена и адреса.
Путь команды:
/domain/<DOMAIN>/alias/address-clean
Синтаксис:
address-clean <address range> [<property>] [--force]
Параметры:
<address range> - диапазон адресов (номеров) для фильтрации;
<property> - название свойства алиаса (параметр опциональный, если данный параметра не задан, то удаляются значения всех свойств контейнера).
--force - выполнение команды без запроса подтверждения.
Пример:
admin@ds1@ecss1:/$ domain/biysk.local/alias/clean _ loc.gr 240462@biysk.local access_type Property access_type is cleaned for aliases within domain biysk.local: 240462 <-> 064bc964f9da9665 400 <-> 064bc964f9da9665 Legend: *: Cleaning broken <empty>: Successfull clean [exec at: 09.02.2021 11:57:45, exec time: 30ms, nodes: ds1@ecss1 v.3.14.7.562]
address-info
Команда предназначена для вывода информации о свойствах алиасов на уровне домена и адреса.
Если в профиле безопасности (/system/security/profile/) параметр show_password_at_cli = off, то в выводе пароль скрывается, и вместо него показываются ********.
Путь команды:
/domain/<DOMAIN>/alias/address-info
Синтаксис:
address-info <address range>
Параметры:
<address range> - диапазон адресов (номеров) для фильтрации контейнеров.
Пример:
admin@ds1@ecss1:/$ domain/biysk.local/alias/address-info 240462 Addresses in domain: biysk.local ┌───────┬─┬────────────────┬──────────────────┐ │Address│W│ Property │ Value │ ├───────┼─┼────────────────┼──────────────────┤ │240462 │D│access_group │all │ │ │a│access_type │access_type1 │ │ │D│category │ordinarySubscriber│ │ │D│media-profile │"default" │ │ │D│nai │subscriberNumber │ │ │D│ni │private │ │ │D│npi │isdnTelephony │ │ │D│pin │"1111" │ │ │D│screening │networkProvided │ │ │D│ss\mgm\telephone│enabled │ │ │D│timezone │'UTC+07:00' │ └───────┴─┴────────────────┴──────────────────┘ Legend: W: Where property is set: a: This is address property in domain A: This is global address property d: This is domain property D: This is default property Note: * char in W column means "Can't read address info". Error reason in value column in this case [exec at: 09.02.2021 11:55:37, exec time: 13ms, nodes: ds1@ecss1 v.3.14.7.562]
clean
Команда используется для очистки свойств алиаса.
Путь команды:
/domain/<DOMAIN>/alias/clean
Синтаксис:
clean _ | <address range> [[[* | <name group] _ |<name range>] <property>] [--force]
Параметры:
<address range> - диапазон адресов (номеров);
<name group> - группа ECSS-интерфейсов (символ "*" используется для указания всех групп интерфейсов);
<name range> - диапазон ECSS-интерфейсов;
<property> - название свойства алиаса, значение которого необходимо удалить (параметр опциональный, если данный параметр не задан, то удаляются все свойства контейнера на уровне алиаса).
--force - выполнение команды без запроса подтверждения.
Пример:
admin@ds1@ecss1:/$ domain/biysk.local/alias/clean _ loc.gr 240462@biysk.local access_type Property access_type is cleaned for aliases within domain biysk.local: 240462 <-> 064bc964f9da9665 400 <-> 064bc964f9da9665 Legend: *: Cleaning broken <empty>: Successfull clean [exec at: 09.02.2021 11:56:43, exec time: 28ms, nodes: ds1@ecss1 v.3.14.7.562]
declare
Команда создает (декларирует) алиасы в текущем домене <DOMAIN>.
Путь команды:
/domain/<DOMAIN>/alias/declare
Синтаксис
declare <ADDRESS RANGE> <OWNER> <GROUP> <IFACE RANGE>
declare <address range> <name filter> <name range>
Параметры:
[-p | --Passive] - ключ -p или --passive. Если передан ключ -p или --Passive, то декларация будет проходить в пассивном режиме;
<address range> - диапазон адресов (номеров), который используется для создания алиасов;
<name filter> - фильтр диапазона ECSS-интерфейсов в формате <Owner> <Group>, где
<OWNER> - имя профиля владельца (символ "*" используется для указания всех профилей владельцев);
<GROUP> - имя группы (символ "*" используется для указания всех групп);
<name range> - диапазон ECSS-интерфейсов.
Если <name range> определяет только один интерфейс, а <address range> - больше одного адреса, то все адреса будут "связаны" с одним интерфейсом.
Если <address range> определяет только один адрес, а <name range> - больше одного интерфейса, то все интерфейсы будут "связаны" с одним адресом.
Во всех остальных случаях мощности <name range> и <address range> должны совпадать.
Пример:
Задекларировать алиасы на домене biysk.local по следующему правилу:
Номер абонента <-> Название интерфейса
400 <-> 240462@biysk.local
401 <-> 240464@biysk.local
402 <-> 240465@biysk.local
403 <-> 240466@biysk.local
admin@ds1@ecss1:/$ domain/biysk.local/alias/declare 40{0-3} sip1 loc.gr 24046{2-6}@biysk.local
┌───────┬────────────────┬──────┐
│Address│ Iface │Result│
├───────┼────────────────┼──────┤
│400 │064bc964f9da9665│ok │
│401 │064bc964face07a5│ok │
│402 │064bc964fbacf7eb│ok │
│403 │064bc9653091d158│ok │
└───────┴────────────────┴──────┘
[exec at: 09.02.2021 11:54:15, exec time: 55ms, nodes: ds1@ecss1 v.3.14.7.562]
domain-clean
Команда очистки свойств алиасов, установленных на уровне домена.
Путь команды:
/domain/<DOMAIN>/alias/domain-clean [--force]
Синтаксис:
clean-domain [<property>]
Параметры:
<DOMAIN> - имя домена маршрутизации;
<property> - название свойства алиаса, значение которого необходимо удалить (параметр опциональный, если данный параметр не задан, то удаляются все свойства контейнера на уровне домена).
--force - выполнение команды без запроса подтверждения.
Пример:
admin@ds1@ecss1:/$ domain/biysk.local/alias/domain-clean regime Aliases' domain property regime for domain biysk.local clean result: cleaned [exec at: 09.02.2021 11:52:44, exec time: 15ms, nodes: ds1@ecss1 v.3.14.7.562]
domain-info
Просмотр информации о свойствах алиасов, установленных на уровне домена.
Если в профиле безопасности (/system/security/profile/) параметр show_password_at_cli = off, то в выводе пароль скрывается, и вместо него показываются ********.
Путь команды:
/domain/<DOMAIN>/alias/domain-info
Синтаксис:
domain-info
Параметры:
Команда не содержит аргументов.
Пример:
admin@ds1@ecss1:/$ domain/biysk.local/alias/domain-info ┌───────────┬─┬────────────────┬──────────────────┐ │ Domain │W│ Property │ Value │ ├───────────┼─┼────────────────┼──────────────────┤ │biysk.local│d│access_group │all │ │ │d│access_type │access_type0 │ │ │D│category │ordinarySubscriber│ │ │d│cdr_group │bsk3 │ │ │d│media-profile │"default" │ │ │D│nai │subscriberNumber │ │ │D│ni │private │ │ │D│npi │isdnTelephony │ │ │D│pin │"1111" │ │ │d│regime │accsusp │ │ │D│screening │networkProvided │ │ │D│ss\mgm\telephone│enabled │ │ │D│timezone │'UTC+07:00' │ └───────────┴─┴────────────────┴──────────────────┘ Legend: W: Where property is set: d: This is domain property D: This is default property Note: * char in W column means "Can't read domain info". Error reason in value column in this case [exec at: 09.02.2021 11:50:49, exec time: 15ms, nodes: ds1@ecss1 v.3.14.7.562]
extended-info
Данная команда предназначена для просмотра расширенных настроек алиасов.
Если в профиле безопасности (/system/security/profile/) параметр show_password_at_cli = off, то в выводе пароль скрывается, и вместо него показываются ********.
Путь команды:
/domain/<DOMAIN>/alias/extended-info
Синтаксис:
extended-info <Address> <Name>
Параметры:
<Address> - адрес (номер) алиаса;
<Name> - имя алиаса.
Пример:
admin@ds1@ecss1:/$ domain/biysk.local/alias/extended-info 240101 240101@biysk.local
Alias: {"biysk.local",<<"064bc9652bfe3487">>,"240101"}
Alias is exists: true
Domain is exists: true
Interface is exists: true
Interface is active: true
Interface owner: "sip1"
Interface group: "loc.gr"
Default routing context: ctx_from_local
Alias {"biysk.local",<<"064bc9652bfe3487">>,"240101"} properties:
┌─┬──────────────────────────────────────────────────────────────────┬─────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┐
│W│ Property │ Value │
├─┼──────────────────────────────────────────────────────────────────┼─────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┤
│p│access_group │all -> [all] │
│ │address │"240101" │
│p│category │ordinarySubscriber │
│ │domain │"biysk.local" │
│ │iface │<<"064bc9652bfe3487">> │
│ │isActive │true │
│ │isIfaceActive │true │
│ │last_incoming_call_info │{rtop_last_incoming_call_info,1,"3832367000",2214799351,{1612,782864,206839}} │
│D│media-profile │"default" │
│p│nai │subscriberNumber │
│p│ni │private │
│p│npi │isdnTelephony │
│ │password │"pda" │
│D│pin │"1111" │
│ │profile │"user_default" │
│p│screening │networkProvided │
│D│ss\mgm\telephone │enabled │
│ │subscriber_portal\login │"240101" │
│ │subscriber_portal\password │AU6wlKe1TwGG │
│ │teleconference\password │3k1mS2IMXwoS │
│ │terminal_type │smart │
│D│timezone │'UTC+07:00' │
│ │uid │<<"064bc9652c5802a3">> │
│ │user_agent │"Yealink SIP-T28P 2.73.193.50" │
└─┴──────────────────────────────────────────────────────────────────┴─────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┘
Legend:
W: Where property is set:
a: This is address property in domain
A: This is global address property
d: This is domain property
D: This is default property
i: This is iface property in domain
g: This is global property
p: This is alias'es profile's property
<Empty>: This is alias property
Note: * char in W column means "Can't read alias info". Error reason in value column in this case
Domain "biysk.local" properties:
┌─┬──────────────────────────────────────────────────────────────────┬─────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┐
│W│ Property │ Value │
├─┼──────────────────────────────────────────────────────────────────┼─────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┤
│g│ivr\scripts\migrate_to_db │true │
│g│ivr\scripts\migrate_to_db\default_incoming_call │true │
│g│ivr\scripts\migrate_to_db\enter_number_of_conference_room │true │
│g│ivr\scripts\migrate_to_db\enter_number_of_teleconference │true │
│g│ivr\scripts\migrate_to_db\fax_to_email │true │
│g│msr_timers\migrate │true │
│g│oct_timers\migrate │true │
│g│oct_timers\migrate\alias │true │
│g│oct_timers\migrate\single_subscriber_conference_timeout │true │
│g│routing\ctx\migrate_to_db │true │
│g│teleconference\property\no_answer_timeout\migrate │true │
│ │active │true │
│ │description │[] │
│ │cdr │default_prefix: [] │
│ │ │default_mode: {time,[{0,0,0}]} │
│ │create_time │{1611,824701,909331} │
│ │uid │<<"064bc957dde020c9">> │
│ │alias\profile\default │"user_default" │
│ │failover │true │
│ │tc\meeting │[{tc_ds_meeting,<<"default">>,"default",[],[],[],#{},true,false}] │
│ │numbering_plan │[{domain_numbering_plan,<<"np_240">>,[],[],[],[]}] │
│ │cdr_groups │[{bsk3,"bsk3",[csv],{time,[{0,0,0}]}}, │
│ │ │ {'1',[],[csv],{period,10}}, │
│ │ │ {'2',[],[csv],{period,10}}, │
│ │ │ {'13',[],[csv],{period,10}}, │
│ │ │ {'4',[],[csv],{count,1}}] │
│ │access-list │['3way',acb,alarm,assistant,auto_redial,auto_redial_with_callback,avatar,blf, │
│ │ │ boss_group,call_recording,callback,cc_agent,cf_aon,cf_sip,cfb,cfnr, │
│ │ │ cfnr_type2,cfos,cft,cfu,cfu_type2,cgg,chold,chunt,click_to_call,clip,clir, │
│ │ │ cliro,cnip,cnip_audio,conference,cpip,ctr,cw,direct_call,distinctive_picture, │
│ │ │ distinctive_ring,dnd,fax_receiver,fax_to_email,fbc,find_me, │
│ │ │ find_me_no_response,flexicall,follow_me,follow_me_no_response,fxo_trunk, │
│ │ │ hide_cf_name,intercom,intervention,introduce,mcid,meet_me_conference,message, │
│ │ │ ml,multicast_listen,multicast_page,park,personal_ivr,pickup,presence,privacy, │
│ │ │ qsig_cfb,qsig_cfnr,qsig_cfu,rbp,redial,remote_phone,remote_ring,rfc, │
│ │ │ ring_back_tone,s4b_presence,sca,sco_black,sco_white,scr,second_handset, │
│ │ │ sip_message,smart_cancel,speed_dial,teleconference,teleconference_manager, │
│ │ │ tsmn_request,vip_call,voice_page,voice_page_control,voicemail,walkie_talkie, │
│ │ │ zone_page] │
│ │callcenter\enabled │true │
│ │teleconference\enabled │true │
│ │ivr\enabled │true │
│ │ss\profiles\domain │[{'rtop-ss-domain-profile-row',"work_ss", │
│ │ │ [{ss_profile_entity,clip,6,true,true,[]}, │
│ │ │ {ss_profile_entity,cnip,4,true,true,[]}, │
│ │ │ {ss_profile_entity,chold,9,true,true, │
│ │ │ [{disable_moh,false},{dtmf_sequence_as_flash,false}]}, │
│ │ │ {ss_profile_entity,ctr,6,true,true,[]}, │
│ │ │ {ss_profile_entity,conference,11,true,true, │
│ │ │ [{destroy_mode,by_no_master},{max_participants,16}]}, │
│ │ │ {ss_profile_entity,cf_sip,10,true,true,[]}, │
│ │ │ {ss_profile_entity,cc_agent,4,true,true,[{extra_number,[]}]}, │
│ │ │ {ss_profile_entity,ml,7,true,true,[{line_count,3},{line_count_out,-1}]}, │
│ │ │ {ss_profile_entity,mcid,3,true,true,[]}, │
│ │ │ {ss_profile_entity,intervention,5,true,true, │
│ │ │ [{restriction,full_control}]}, │
│ │ │ {ss_profile_entity,park,3,true,true,[]}], │
│ │ │ "for_office"}, │
│ │ │ {'rtop-ss-domain-profile-row',"min_ss", │
│ │ │ [{ss_profile_entity,chold,9,true,true, │
│ │ │ [{disable_moh,false},{dtmf_sequence_as_flash,false}]}, │
│ │ │ {ss_profile_entity,clip,6,true,true,[]}], │
│ │ │ "only_clip_cnip_chold"}] │
└─┴──────────────────────────────────────────────────────────────────┴─────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┘
Legend:
W: Where property is set:
g: This is global domain property
<Empty>: This is domain property
Iface <<"064bc9652bfe3487">> properties:
┌─┬──────────────────────────────────────────────────────────────────┬─────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┐
│W│ Property │ Value │
├─┼──────────────────────────────────────────────────────────────────┼─────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┤
│D│site │<<"local">> │
│D│terminal_type │smart │
│D│zone │<<"default">> │
│ │gate │{gate_amqp,<<"acp.adapter.init.ex">>,<<"acp.sip.sip1.ipset1.init.rk">>} │
│ │group │"loc.gr" │
│ │owner │"sip1" │
│ │id │<<"064bc9652bfe3487">> │
│ │name │"240101@biysk.local" │
│ │type │sip │
│ │profile │undefined │
│ │isActive │true │
│ │account │{"...50-52-48-49-48-49","...101-120-116-95-49-48-49-95-83-83-87-45-51"} │
│ │adapter\version │"3.14.7.525" │
│ │alias │"alias-as-user" │
│ │aliases_list │["240101"] │
│ │auth_qop │true │
│ │declaration │{"admin",{1611,824914,797366}} │
│ │my_from │none │
│ │routing.context │ctx_from_local │
│ │sip_domain │"biysk.local" │
│ │subtype │user │
│ │user_name │"240101" │
│ │user_agent │"Yealink SIP-T28P 2.73.193.50" │
│ │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}} │
└─┴──────────────────────────────────────────────────────────────────┴─────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┘
Legend:
W: Where property is set:
G: This is global iface property
g: This is group iface property
o: This is owner iface property
<Empty>: This is iface property
Supplementary services settings:
Domain: biysk.local
Supplementary services' settings:
┌────────────────────────────────────┬────────────────────────────────────────────────────────────┬──┬──┬─────────────────────────────────────────────────────────────────────────────────────────────────┐
│ Address │ Name │V │E │ CSD │
├────────────────────────────────────┼────────────────────────────────────────────────────────────┼──┼──┼─────────────────────────────────────────────────────────────────────────────────────────────────┤
│240101 │cc_agent │4 │T │extra_number = [] │
│240101 │cf_sip │10│T │ │
│240101 │chold │9 │T │disable_moh = false │
│ │ │ │ │dtmf_sequence_as_flash = false │
│240101 │clip │6 │T │ │
│240101 │cnip │4 │T │ │
│240101 │conference │11│T │destroy_mode = by_no_master │
│ │ │ │ │max_participants = 16 │
│240101 │ctr │6 │T │ │
│240101 │intervention │5 │T │restriction = full_control │
│240101 │mcid │3 │T │ │
│240101 │ml │7 │T │line_count = 3 │
│ │ │ │ │line_count_out = -1 │
│240101 │park │3 │T │ │
└────────────────────────────────────┴────────────────────────────────────────────────────────────┴──┴──┴─────────────────────────────────────────────────────────────────────────────────────────────────┘
Legend:
V - version of the supplementary service;
E - enable state of selected supplementary service to current domain, address
[exec at: 09.02.2021 11:59:04, exec time: 39ms, nodes: ds1@ecss1 v.3.14.7.562]
import-regime
Данная команда позволяет импортировать режимы доступа абонента из файла.
Путь команды:
/domain/<DOMAIN>/alias/import-regime
Синтаксис:
import-regime <NODE> <FILE> [-<Flag>]
Параметры:
<NODE> - имя ноды подсистемы DS;
<FILE> - имя файла (файл располагается по пути: /{DATA_ROOT}/regime - для команды уровня кластера;
/{DATA_ROOT}/regime/<DOMAIN> - для команды уровня домена);
<Flag> - флаг, при указании которого будет доступен следующий функционал:
-l | -log - сохранять результат выполнения команды в log-файл. Имя log-файла формируется из имени <FILE>, добавлением расширения ".log".
Формат файла (для команды уровня домена): АДРЕС_АБОНЕНТА РЕЖИМ_ОБСЛУЖИВАНИЯ
Address_1 Regime_1
Address_2 Regime_2
...
Address_N Regime_N
Формат файла логов:
% В случае, если не удалось распарсить строку Номер_Строки: Строка;2;Время_Выполнения_Команды % В случае успешного импорта режима для абонента Address Имя_Домена;Address;1;Время_Выполнения_Команды % В случае, если не удалось импортировать режим для абонента Address (например в случае, если алиас или указанный режим не существуют). Имя_Домена;Address;0;Время_Выполнения_Команды
Пример:
admin@ds1@ecss1:/$ domain/biysk.local/alias/import-regime ds1@ecss1 regime.2 09.02.2021 12:09:35: Successfully imported: 2. Successfully imported regimes to the 2 aliases. [exec at: 09.02.2021 12:09:35, exec time: 159ms, nodes: ds1@ecss1 v.3.14.7.562]
Пример, если была ошибка при импорте:
admin@ds1@ecss1:/$ domain/biysk.local/alias/import-regime ds1@ecss1 regime.2 09.02.2021 12:08:58: Successfully imported: 1. 09.02.2021 12:08:58: Failed imports: 1. Successfully imported regimes to the 1 aliases. There are 1 errors was occured during importing regimes: ┌─────────────────────────────────────────────────┐ │ Error │ ├─────────────────────────────────────────────────┤ │Regime admin1 undefuned in the domain biysk.local│ └─────────────────────────────────────────────────┘ [exec at: 09.02.2021 12:08:58, exec time: 161ms, nodes: ds1@ecss1 v.3.14.7.562]
info
Команда для просмотра информации о свойствах алиасов.
Если в профиле безопасности (/system/security/profile/) параметр show_password_at_cli = off, то в выводе пароль скрывается, и вместо него показываются ********.
Путь команды:
domain/<DOMAIN>/alias/info
Синтаксис:
info <ADDRESS RANGE> [[<IFACE GROUP> <IFACE RANGE>] <PROPERTY>]
info [--iface-id | --iface-name] _ |<address range> [[[* | <iface group>] _ | <name range>] <property>]
Параметры:
--iface-id - уникальный идентификатор алиаса отображается в столбце "Iface";
--iface-name - имя интерфейса, отображается в столбце "Iface";
<address range> - диапазон адресов;
<iface group> - группа интерфейсов (символ "*" используется для указания всех групп интерфейсов);
<name range> - диапазон имен интерфейсов;
<property> - название свойства алиаса, опциональный параметр.
<ADDRESS RANGE> - диапазон адресов (номеров);
<IFACE GROUP> - группа интерфейсов (символ "*" используется для указания всех групп интерфейсов);
<IFACE RANGE> - диапазон интерфейсов;
<PROPERTY> - название свойства алиаса, опциональный параметр.
Пример:
Просмотр информации о свойствах алиасов:
admin@ds1@ecss1:/$ domain/biysk.local/alias/info 240101 Aliases in domain biysk.local ┌───────┬──────────────────┬─┬─┬──────────────────────────┬──────────────────────────────┐ │Address│ Iface │A│W│ Property │ Value │ ├───────┼──────────────────┼─┼─┼──────────────────────────┼──────────────────────────────┤ │240101 │240101@biysk.local│ │ │user_agent │"Yealink SIP-T28P 2.73.193.50"│ │ │ │ │ │uid │064bc9652c5802a3 │ │ │ │ │D│timezone │'UTC+07:00' │ │ │ │ │ │terminal_type │smart │ │ │ │ │ │teleconference\password │3k1mS2IMXwoS │ │ │ │ │ │subscriber_portal\password│AU6wlKe1TwGG │ │ │ │ │ │subscriber_portal\login │"240101" │ │ │ │ │D│ss\mgm\telephone │enabled │ │ │ │ │p│screening │networkProvided │ │ │ │ │ │profile │"user_default" │ │ │ │ │D│pin │"1111" │ │ │ │ │ │password │"pda" │ │ │ │ │p│npi │isdnTelephony │ │ │ │ │p│ni │private │ │ │ │ │p│nai │subscriberNumber │ │ │ │ │d│media-profile │"default" │ │ │ │ │ │last_incoming_call_info │Version: 1 │ │ │ │ │ │ │Digits: 3832367000 │ │ │ │ │ │ │Call reference: 2214799351 │ │ │ │ │ │ │Date time: 2021/02/08 18:14:24│ │ │ │ │ │isIfaceActive │true │ │ │ │ │d│cdr_group │bsk3 │ │ │ │ │p│category │ordinarySubscriber │ │ │ │ │d│access_type │access_type0 │ │ │ │ │p│access_group │all │ └───────┴──────────────────┴─┴─┴──────────────────────────┴──────────────────────────────┘ Legend: A: "Is active" alias flag: *: Passive alias <Empty>: Active alias W: Where property is set: a: This is address property in domain A: This is global address property d: This is domain property D: This is default property i: This is iface property in domain g: This is global property p: This is alias'es profile's property <Empty>: This is alias property Note: * char in W column means "Can't read alias info". Error reason in value column in this case [exec at: 09.02.2021 11:09:36, exec time: 21ms, nodes: ds1@ecss1 v.3.14.7.562]
iface-clean
Команда очистки свойств алиасов, установленных на уровне домена и интерфейса.
Путь команды:
/domain/<DOMAIN>/alias/iface-clean
Синтаксис:
iface-clean * | <iface group> _ | <iface range> [<property>] [--force]
Параметры:
<iface group> - группа интерфейсов (символ "*" используется для указания всех групп интерфейсов);
<iface range> - диапазон интерфейсов (символ "_" используется для указания всех интерфейсов);
<property> - название свойства алиаса, значение которого необходимо удалить (параметр опциональный, если данный параметр не задан, то удаляются все свойства контейнера на уровне интерфейса).
--force - выполнение команды без запроса подтверждения.
Пример:
admin@ds1@ecss1:/$ domain/biysk.local/alias/iface-clean loc.gr 240469@biysk.local [iface-clean] You are going to clean all customized alias-iface's properties. Are you sure?: yes/no ?> yes Cleaned aliases' interfaces within domain: biysk.local 064bc964fd6e09e2 Legend: *: Cleaning broken <empty>: Successfull clean [exec at: 09.02.2021 12:11:48, exec time: 2s 607ms, nodes: ds1@ecss1 v.3.14.7.562]
iface-info
Просмотр информации о свойствах алиасов, установленных на уровне домена и интерфейса.
Если в профиле безопасности (/system/security/profile/) параметр show_password_at_cli = off, то в выводе пароль скрывается, и вместо него показываются ********.
Путь команды:
/domain/<DOMAIN>/alias/iface-info
Синтаксис:
iface-info <iface-group> <iface range>
Параметры:
<iface-group> - группа интерфейсов (символ "*" используется для указания всех групп интерфейсов);
<iface range> - диапазон интерфейсов (символ "*" используется для указания всех интерфейсов).
Пример:
admin@ds1@ecss1:/$ domain/biysk.local/alias/iface-info loc.gr 240799@biysk.local Alias ifaceses' properties for domain biysk.local: ┌────────────────┬─┬─────────────────┬──────────────────┐ │ Interface │W│ Property │ Value │ ├────────────────┼─┼─────────────────┼──────────────────┤ │064bc9650b815fb0│D│access_group │all │ │ │D│category │ordinarySubscriber│ │ │D│media-profile │"default" │ │ │D│nai │subscriberNumber │ │ │D│ni │private │ │ │i│no_answer_timeout│30s │ │ │D│npi │isdnTelephony │ │ │D│pin │"1111" │ │ │D│screening │networkProvided │ │ │D│ss\mgm\telephone │enabled │ │ │D│timezone │'UTC+07:00' │ └────────────────┴─┴─────────────────┴──────────────────┘ Legend: W: Where property is set: d: This is domain property D: This is default property i: This is iface property in domain Note: * char in W column means "Can't read alias interface info". Error reason in value column in this case [exec at: 09.02.2021 12:14:54, exec time: 15ms, nodes: ds1@ecss1 v.3.14.7.562]
list
Команда возвращает список алиасов, определенных в виртуальной АТС и определенных в виртуальной АТС для определенного адреса.
Путь команды:
/domain/<DOMAIN>/alias/list
Синтаксис:
команда уровня виртуальной АТС:
list [<address range>]
Параметры:
<address range> - диапазон адресов (номеров).
Пример:
admin@ds1@ecss1:/$ domain/biysk.local/alias/list 24047{1-5}
Aliases of the ECSS domain: biysk.local
┌────┬──────────────────┬─────────┐
│Type│ Iface │Addresses│
├────┼──────────────────┼─────────┤
│sip │240471@biysk.local│ 240471 │
│sip │240474@biysk.local│ 240474 │
│sip │240473@biysk.local│ 240473 │
│sip │240475@biysk.local│ 240475 │
└────┴──────────────────┴─────────┘
Total: 4
Note:
Asterix (*) of the address is shows inactivity of the alias
[exec at: 09.02.2021 11:28:25, exec time: 26ms, nodes: ds1@ecss1 v.3.14.7.562]
move
Команда предназначена для перемещения алиаса с одного интерфейса на другой в рамках одного домена.
Если у создаваемого и существующего алиаса свойства различаются, то система выдаст пользователю запрос на выбор действия с данными различиями.
Путь команды:
/domain/<DOMAIN>/alias/move [--force]
Синтаксис:
move <address> <old name group> <old name> <new name group> <new name>
Параметры:
<address> - адрес алиаса, который необходимо переместить;
<old name group> - группа интерфейсов (символ "*" используется для указания всех групп интерфейсов);
<old name> - интерфейс алиаса, который необходимо переместить;
<new name group> - группа интерфейсов (символ "*" используется для указания всех групп интерфейсов);
--force - выполнение команды без запроса подтверждения.
Пример:
admin@ds1@ecss1:/$ domain/biysk.local/alias/move 403 loc.gr 240466@biysk.local loc.gr 240793@biysk.local
[move] In the domain "biysk.local" for iface "064bc9650b815138" already exists aliases
with numbers: 240793 (active).
Would you like to continue moving alias?: yes/no ?> yes
Alias in domain "biysk.local" with address "403" successfully changed iface from "064bc9653091d158" to "064bc9650b815138".
[exec at: 09.02.2021 12:16:00, exec time: 6s 497ms, nodes: ds1@ecss1 v.3.14.7.562]
remove
Команда для удаления алиасов из системы.
Путь команды:
/domain/<DOMAIN>/alias/remove
Синтаксис:
remove [-i | a] [(<Name range> <address range>) | (<range>)] [ --force]
Параметры:
-i - для удаления алиасов, достаточно указать диапазон интерфейсов <Name range>;
-a - для удаления алиасов, достаточно указать диапазон адресов <address range>.
Параметр опциональный, если данный флаг не установлен, то для удаления алиаса должен быть задан диапазон интерфейсов <Name range> и диапазон адресов <address range>.
<Name range> - диапазон интерфейсов;
<address range> - диапазон адресов;
--force - выполнение команды без запроса подтверждения.
Пример:
admin@ds1@ecss1:/$ domain/biysk.local/alias/remove 240793@biysk.local 403 Aliases are removed from ECSS domain biysk.local: 403 -> 064bc9650b815138 [exec at: 09.02.2021 12:17:15, exec time: 41ms, nodes: ds1@ecss1 v.3.14.7.562]
set
Командой устанавливаются свойства алиасов.
Пароли проверяются на соответствие требованиям, установленным в профиле безопасности (/system/security/profile/), параметр restrictions.
Путь команды:
/domain/<DOMAIN>/alias/set
Синтаксис:
set _|<address range> *|<iface group> _|<name range> <property> <value>
Параметры:
<address range> - диапазон адресов (номеров);
<iface group> - группа интерфейсов (символ "*" используется для указания всех групп интерфейсов);
<name range> - диапазон имен интерфейсов;
<property> - название свойства алиаса, значение которого необходимо установить, список параметров приведен в Приложении А. Набор параметров алиасов или во вкладке ниже.
<value> - значение свойства, список значений приведен в Приложении А. Набор параметров алиасов или во вкладке ниже.
Приложение А. Набор параметров алиасов
Пример:
admin@ds1@ecss1:/$ domain/biysk.local/alias/set 240462 loc.gr 240462@biysk.local password pda There are aliases within domain biysk.local affected by settings property password: 240462 <-> 064bc964f9da9665 Legend: a: Setup alias address i: Setup alias inteface !: Setup broken. Alias allready exists *: Setup broken. Alias not exists L: Setup broken. No free subscriber licences. x: Setup broken. Unexpected error <empty>: Successfull setup [exec at: 09.02.2021 12:18:14, exec time: 84ms, nodes: ds1@ecss1 v.3.14.7.562]
set-for-address
Командой устанавливаются свойства алиасов на уровне домена и адреса.
Пароли проверяются на соответствие требованиям, установленным в профиле безопасности (/system/security/profile/), параметр restrictions.
Путь команды:
/domain/<DOMAIN>/alias/set-for-address
Синтаксис:
set-for-address <address range> <property> <value>
Параметры:
<address range> - диапазон адресов (номеров);
<property> - название свойства алиаса, значение которого необходимо установить, список параметров приведен в Приложении А, Набор параметров алиасов или во вкладке ниже.
<value> - значение свойства, список значений приведен в Приложении А, Набор параметров алиасов или во вкладке ниже.
Приложение А. Набор параметров алиасов
Пример:
admin@ds1@ecss1:/$ domain/biysk.local/alias/set-for-address 240462 access_type access_type1 Affected addresses in domain: biysk.local 240462 [exec at: 09.02.2021 11:49:16, exec time: 31ms, nodes: ds1@ecss1 v.3.14.7.562]
set-for-domain
Данной командой устанавливается значение свойства алиасов на уровне домена.
Пароли проверяются на соответствие требованиям, установленным в профиле безопасности (/system/security/profile/), параметр restrictions.
Путь команды:
/domain/<DOMAIN>/alias/set-for-domain
Синтаксис:
set-for-domain <property> <value>
Параметры:
<DOMAIN> - имя домена маршрутизации;
<property> - название свойства алиаса, значение которого необходимо установить, список параметров приведен в Приложении А, Набор параметров алиасов или во вкладке ниже.
<value> - значение свойства, список значений приведен в Приложении А, Набор параметров алиасов или во вкладке ниже.
Приложение А. Набор параметров алиасов
Пример:
admin@ds1@ecss1:/$ domain/biysk.local/alias/set-for-domain regime accsusp ok [exec at: 09.02.2021 11:48:13, exec time: 28ms, nodes: ds1@ecss1 v.3.14.7.562]
set-for-iface
Данной командой устанавливаются свойства алиасов на уровне домена и интерфейса.
Пароли проверяются на соответствие требованиям, установленным в профиле безопасности (/system/security/profile/), параметр restrictions.
Путь команды:
/domain/<DOMAIN>/alias/set-for-iface
Синтаксис:
set-for-iface *|<iface group> _|<iface range> <property> <value>
Параметры:
<iface group> - группа интерфейсов (символ "*" используется для указания всех групп интерфейсов);
<iface range> - диапазон интерфейсов;
<property> - название свойства алиаса, значение которого необходимо установить, список параметров приведен в Приложении А, Набор параметров алиасов или во вкладке ниже.
<value> - значение свойства, список значений приведен в Приложении А, Набор параметров алиасов или во вкладке ниже.
Приложение А. Набор параметров алиасов
Пример:
admin@ds1@ecss1:/$ domain/biysk.local/alias/set-for-iface loc.gr 240469@biysk.local category hotelsSubscriber Affected ifaces in domain: biysk.local 064bc964fd6e09e2 [exec at: 09.02.2021 11:47:32, exec time: 28ms, nodes: ds1@ecss1 v.3.14.7.562]
statistics
Команда предназначена для просмотра статистики регистраций алиасов.
Путь команды:
/domain/<DOMAIN>/alias/statistics
Синтаксис:
statistics
Параметры:
Команда не содержит аргументов.
Пример:
admin@ds1@ecss1:/$ domain/biysk.local/alias/statistics Aliases registrations in the domain: biysk.local ┌─────┬────────────┬──────────────┐ │Type │Active users│Inactive users│ ├─────┼────────────┼──────────────┤ │SIP │208 │112 │ │- │- │- │ │Total│208 │112 │ └─────┴────────────┴──────────────┘ [exec at: 09.02.2021 11:45:28, exec time: 24ms, nodes: ds1@ecss1 v.3.14.7.562]
subscribers-limit
Команда для просмотра количества используемых абонентских лицензий в текущий момент времени, ограничения по количеству, и наличие свободных лицензий на алиасы (абоненты) в рамках storage-кластера.
Путь команды:
/domain/<DOMAIN>/alias/subscribers-limit
Синтаксис:
subscribers-limit
Параметры:
Команда не содержит аргументов.
Пример:
admin@ds1@ecss1:/$ domain/biysk.local/alias/subscribers-limit Licence alias limit: 2000 Licence virtual alias limit: infinity Active, declared aliases in the domain: 320 Active, declared virtual aliases in the domain: 5 --------------------------------- Avaliable aliases: infinity Avaliable virtual aliases: infinity [exec at: 09.02.2021 11:44:42, exec time: 38ms, nodes: ds1@ecss1 v.3.14.7.562]
user-agents
Команда, которая сформирует реестр используемого на софтсвиче абонентского оборудования.
Путь команды:
/domain/<DOMAIN>/alias/user-agents
Синтаксис:
/user-agents [<FLAGS>]
Параметры:
<FLAGS> :: ключи вывода (short | full | with_iface | with_alias | with_ip | sort <COLUMN> <SORT_TYPE>);
- --short - краткий вывод и количество активных/всего;
- --full - полный вывод всех полей(алиас, интерфейс). Символ * в последнем столбце показывает активную регистрацию в данный момент;
- --with_real_ip - отображение реального ip-адреса;
- --with_iface - отображение интерфейсов;
- --with_alias - отображение алиасов;
- --with_ip - отображение ip-адреса;
- --with_id - отображение id или номера строки;
inactive - показывает только неактивных UA;
active - показывает только активных UA;
limit <COUNT> - отображает только лимитированное количество строк;
sort <COLUMN> <SORT_TYPE> - сортировка по столбцу <COLUMN> порядок сортировки задается в <SORT_TYPE>;
<COLUMN> :: user_agent | amount | iface | alias - имя столбца;
<SORT_TYPE> :: asc | desc - порядок сортировки(asc - по возрастанию, desc - по убыванию) ;
Вывод команды без параметров аналогичен ключу --short;
Вывод команды с параметрами --with_iface --with_alias --with_ip аналогичен ключу --full
В столбце "Status" символом "*" отмечены зарегистрированные(активные) интерфейсы
Примеры:
Команда запущена без параметров - показывается короткий вид таблицы.
admin@ds1@ecss1:/$ domain/biysk.local/alias/user-agents ┌───────────────────────────────────────────────────┬──────┐ │ User Agent │Amount│ ├───────────────────────────────────────────────────┼──────┤ │Asterisk PBX 13.1.0~dfsg-1.1ubuntu4.1 │198 │ │RG-1402G/1.8.1 SN/VI0C000069 sofia-sip/1.12.10 │2 │ │RG-1404GF-W/1.11.0 SN/VI25002012 sofia-sip/1.12.10 │2 │ │TAU-2M.IP/2.0.0.229 SN/VI39005419 sofia-sip/1.12.10│2 │ │TAU-4M.IP/2.1.0.38 SN/VI4D001354 sofia-sip/1.12.10 │1 │ │VP-12/2.5.0.203 sofia-sip/1.12.10 │1 │ │VP-15P/2.5.0.203 sofia-sip/1.12.10 │2 │ │Yealink SIP-T28P 2.73.193.50 │1 │ │Yealink SIP-T28P 2.73.193.50 │1 │ └───────────────────────────────────────────────────┴──────┘ Total active user agents amount: 208 Total user agents types amount: 9 Total user agents amount: 210 [exec at: 09.02.2021 11:38:16, exec time: 148ms, nodes: ds1@ecss1 v.3.14.7.562]
Вывод команды в полном режиме(--full).
admin@ds1@ecss1:/$ domain/biysk.local/alias/user-agents --full --sort user_agent desc ┌───┬───────────────────────────────────────────────────┬──────┬──────────────────┬─────────────┬─────────────┬──────┐ │ N │ User Agent │Alias │ Iface │ IP │ Real IP │Status│ ├───┼───────────────────────────────────────────────────┼──────┼──────────────────┼─────────────┼─────────────┼──────┤ │1 │Yealink SIP-T28P 2.73.193.50 │240101│240101@biysk.local│192.168.2.26 │192.168.2.26 │ * │ │2 │Yealink SIP-T28P 2.73.193.50 │240244│240244@biysk.local│192.168.2.26 │192.168.2.26 │ * │ │3 │VP-15P/2.5.0.203 sofia-sip/1.12.10 │240100│240100@biysk.local│192.168.2.26 │192.168.2.26 │ * │ │4 │VP-15P/2.5.0.203 sofia-sip/1.12.10 │240006│240006@biysk.local│192.168.2.211│192.168.2.211│ * │ │5 │VP-12/2.5.0.203 sofia-sip/1.12.10 │240466│240466@biysk.local│192.168.2.26 │192.168.2.26 │ * │ │6 │TAU-4M.IP/2.1.0.38 SN/VI4D001354 sofia-sip/1.12.10 │240316│240316@biysk.local│192.168.2.26 │192.168.2.26 │ * │ │7 │TAU-2M.IP/2.0.0.229 SN/VI39005419 sofia-sip/1.12.10│240465│240465@biysk.local│192.168.2.200│192.168.2.200│ * │ │8 │TAU-2M.IP/2.0.0.229 SN/VI39005419 sofia-sip/1.12.10│240464│240464@biysk.local│192.168.2.200│192.168.2.200│ * │ │9 │RG-1404GF-W/1.11.0 SN/VI25002012 sofia-sip/1.12.10 │240474│240474@biysk.local│192.168.2.26 │192.168.2.26 │ * │ │10 │RG-1404GF-W/1.11.0 SN/VI25002012 sofia-sip/1.12.10 │240470│240470@biysk.local│192.168.2.26 │192.168.2.26 │ * │ │11 │RG-1402G/1.8.1 SN/VI0C000069 sofia-sip/1.12.10 │240475│240475@biysk.local│ │ │ │ │12 │RG-1402G/1.8.1 SN/VI0C000069 sofia-sip/1.12.10 │240471│240471@biysk.local│ │ │ │ │13 │Asterisk PBX 13.1.0~dfsg-1.1ubuntu4.1 │240699│240699@biysk.local│192.168.2.26 │192.168.2.26 │ * │ │14 │Asterisk PBX 13.1.0~dfsg-1.1ubuntu4.1 │240698│240698@biysk.local│192.168.2.26 │192.168.2.26 │ * │ │15 │Asterisk PBX 13.1.0~dfsg-1.1ubuntu4.1 │240697│240697@biysk.local│192.168.2.26 │192.168.2.26 │ * │ ... │209│Asterisk PBX 13.1.0~dfsg-1.1ubuntu4.1 │240501│240501@biysk.local│192.168.2.26 │192.168.2.26 │ * │ │210│Asterisk PBX 13.1.0~dfsg-1.1ubuntu4.1 │240500│240500@biysk.local│192.168.2.26 │192.168.2.26 │ * │ └───┴───────────────────────────────────────────────────┴──────┴──────────────────┴─────────────┴─────────────┴──────┘ Total active user agents amount: 208 Total user agents types amount: 9 Total user agents amount: 210 [exec at: 09.02.2021 11:39:35, exec time: 157ms, nodes: ds1@ecss1 v.3.14.7.562]
Вывод команды с реальными ip-адресами, вывод ограничен 5-ю записями:
admin@ds1@ecss1:/$ domain/biysk.local/alias/user-agents --with_real_ip --limit 5 --sort user_agent desc ┌──────────────────────────────────┬─────────────┬──────┐ │ User Agent │ Real IP │Status│ ├──────────────────────────────────┼─────────────┼──────┤ │Yealink SIP-T28P 2.73.193.50 │192.168.2.26 │ * │ │Yealink SIP-T28P 2.73.193.50 │192.168.2.26 │ * │ │VP-15P/2.5.0.203 sofia-sip/1.12.10│192.168.2.26 │ * │ │VP-15P/2.5.0.203 sofia-sip/1.12.10│192.168.2.211│ * │ │VP-12/2.5.0.203 sofia-sip/1.12.10 │192.168.2.26 │ * │ └──────────────────────────────────┴─────────────┴──────┘ Total active user agents amount: 208 Total user agents types amount: 9 Total user agents amount: 210 [exec at: 09.02.2021 11:41:51, exec time: 153ms, nodes: ds1@ecss1 v.3.14.7.562]
where
Команда поиска алиасов по адресу.
Путь команды:
/domain/<DOMAIN>/alias/where
Синтаксис:
where <DOMAIN> <ADDRESS RANGE>
Параметры:
<ADDRESS RANGE> - диапазон адресов (номеров) для поиска.
Пример:
admin@ds1@ecss1:/$ domain/biysk.local/alias/where 240466 Aliases: ┌───────┬───────────┬────────────────┬──────────────────┬────────────┬──────┬──────┐ │Address│ Domain │ Iface │ Iface name │Display name│Active│Binded│ ├───────┼───────────┼────────────────┼──────────────────┼────────────┼──────┼──────┤ │240466 │biysk.local│064bc9653091d158│240466@biysk.local│ │true │true │ └───────┴───────────┴────────────────┴──────────────────┴────────────┴──────┴──────┘ Note: Binded column show is iface exists or not. [exec at: 09.02.2021 11:42:52, exec time: 13ms, nodes: ds1@ecss1 v.3.14.7.562]
who
Команда поиска алиаса по интерфейсу.
Путь команды:
/domain/<DOMAIN>/alias/who
Синтаксис:
who * | <owner> * | <group> * | <range>
Параметры:
<owner> - название владельца (символ "*" используется для указания всех владельцев);
<group> - название группы (символ "*" используется для указания всех групп);
<range> - диапазон интерфейсов ("портов"/"пучков") для поиска (символ "*" используется для указания всех интерфейсов для заданной группы, владельца).
Пример:
admin@ds1@ecss1:/$ domain/biysk.local/alias/who sip1 loc.gr 240101@biysk.local Aliases: ┌────────────────┬───────────┬───────┬────────────┬──────┐ │ Iface │ Domain │Address│Display name│Active│ ├────────────────┼───────────┼───────┼────────────┼──────┤ │064bc9652bfe3487│biysk.local│240101 │ │true │ └────────────────┴───────────┴───────┴────────────┴──────┘ [exec at: 09.02.2021 11:43:44, exec time: 13ms, nodes: ds1@ecss1 v.3.14.7.562]