В данном разделе описаны общие команды для управления доменами.
clean
Командой /domain/clean удаляются значения определенных свойств виртуальных АТС, установленные на глобальном уровне.
Команда доступна только пользователю с правами ECSS_ROOT
Командой /domain/<DOMAIN>/clean удаляются значения определенных свойств заданной виртуальной АТС.
Путь команды:
/domain/clean
Синтаксис:
clean [<PROPERTY>]
Параметры:
<PROPERTY> - название свойства, значение которого будет удалено.
Пример:
support@[mycelium1@biysk1]:/$ domain/clean ecss_cm\email_notifier_config_base\to_na
configure-start
Командой /domain/<DOMAIN>/configure-start предназначена для входа CoCon-сессии в режим редактирования для заданной виртуальной АТС. Режим редактирования автоматически отключится через 5 минут.
Путь команды:
/domain/<DOMAIN>/configure-start
Синтаксис:
configure-start
Параметры:
Входных параметров команда не требует.
Пример:
$ /domain/p.city/configure-start Successfuly entered in the configuration mode for system. $ /domain/p.city/configure-start Error: system configuration locked by user: "antoniy"
configure-stop
Командой /domain/<DOMAIN>/configure-stop предназначена для выхода CoCon-сессии из режима редактирования для заданной виртуальной АТС.
Путь команды:
/domain/<DOMAIN>/configure-stop
Синтаксис:
configure-stop
Параметры:
Входных параметров команда не требует.
Пример:
[CONFIG]$ /domain/p.city/configure-stop Successfully exit from the configuration mode.
copy
Командой /domain/</copy предназначена для создания копии домена с новым именем на основе имеющегося домена с сохранением всех настроек. Команда доступна начиная с версии ПО 3.10.1.
Путь команды:
/domain/copy
Синтаксис:
copy <SRC_DOMAIN> <DST_DOMAIN> [--digitmap <DIGITMAP>] [--to-main-bridge <SRC_BRIDGE_NAME> <DST_BRIDGE_NAME>]
Параметры:
<SRC_DOMAIN> - исходное имя домена;
<DST_DOMAIN> - имя нового домена;
<DIGITMAP> - список масок набора, по которому будет валидироваться номер во вновь создаваемом домене. Формат описания параметра см. в разделе Общие команды управления доменами;
<SRC_BRIDGE_NAME> - имя бриджа, копию которого необходимо создать для выхода в вышестоящий домен.
Пример:
/domain/copy 111.bsk 222.bsk --digitmap 6XX --to-main-bridge br_to_111 br_to_222
pbx-declare
Команда предназначена для создания домена с предопределенными настройками под небольшие виртуальные АТС.
Путь команды:
/domain/pbx-declare
Синтаксис:
pbx-declare <Name> <Type> <DefaultSSProfile | --skip> <AliasLimit> <ExternalCallLimit> <TotalCallLimit> <IncomingIVRScript> <SIPIpSet> <ParentPBX> <ParentContext> <ParentNP> [<CityNumbers>]
Параметры:
<Name> - имя домена с предопределенными настройками под небольшие виртуальные АТС;
<Type> - тип домена, принимает значения:
- pbx10 - трехзначный номер, не более 10 абонентов,
- pbx100 - трехзначный номер, не более 100 абонентов,
- pbx1000 - четырехзначный номер, не более 1000 абонентов;
<DefaultSSProfile> - имя профиля дополнительных услуг, которое будет скопировано в создаваемую виртуальную АТС (--skip, чтобы пропустить);
<AliasLimit> - количество алиасов в ВАТС;
<ExternalCallLimit> - количество входящих вызовов (от/до ВАТС);
<TotalCallLimit> - количество вызовов в ВАТС;
<SIPIpSet> - имя ip-set-а для SIP транспорта для данного домена;
<IncomingIVRScript> - в случае, если параметр выставлен в true - то все входящие вызовы в рамках домена будут проходить через предсозданный IVR скрипт default_incomming_call. Иначе входящие вызовы будут проходить через дефолтный контекст маршрутизации;
<ParentPBX> - имя ВАТС для исходящих вызовов;
<ParentContext> - контекст маршрутизации по умолчанию для входящих вызовов от созданной ВАТС к исходной ВАТС;
<ParentNP> - имя плана нумерации в исходной ВАТС для созданной ВАТС;
<CityNumbers> :: <CityNumber1>[, <CityNumber2>[, ...]] - список городских номеров (в домене <ParentPBX>).
Пример:
admin@[sip1@ecss1]:/$ domain/pbx-declare ext.pbx pbx10 --skip 10 5 10 ipset2 biysk.local ctx_from_local np_240 Start operation: 'Create "ext.pbx" PBX domain' Operation complete Start operation: 'Declare numbering plan for PBX ext.pbx' Operation complete Start operation: 'Import routing contexts' Operation complete Start operation: 'Set default routing context for calls from IVR' Operation complete Start operation: 'Import IVR scripts' Operation complete Start operation: 'Declare bridge biysk.local_to_ext.pbx between ext.pbx and biysk.local' Operation complete Start operation: 'Bind NP numbers from parent PBX to bridge' Operation complete Start operation: 'Set PBX IP set' Operation complete Start operation: 'Declare SIP users' 10 interfaces check for existing ... [**********************************************************************] 99mks 10 users interfaces declaration ... [**********************************************************************] 161ms 10 users aliases declaration ... [**********************************************************************] 24mks 10 interfaces recall to base [**********************************************************************] 13ms Operation complete Start operation: 'Declare PBX admin ext.pbx' Operation complete 10 make users list ... [**********************************************************************] 54mks 10 users information read ... [**********************************************************************] 42ms PBX "ext.pbx" successfully created. PBX's admin login: ext.pbx PBX's admin password: 8cC5z3TQG9oQ Create SIP users': ┌───────────┬─────┬────────────┐ │ Uri │Login│ Password │ ├───────────┼─────┼────────────┤ │400@ext.pbx│400 │9U56mqOH6pHK│ │401@ext.pbx│401 │2hKMjNnmMdDQ│ │402@ext.pbx│402 │6lM2zwHSqpK6│ │403@ext.pbx│403 │wY4qUsN2sT8Y│ │404@ext.pbx│404 │4uPH4mLXwaY6│ │405@ext.pbx│405 │wmN4xqQUqhTi│ │406@ext.pbx│406 │7sZNa4pdP59r│ │407@ext.pbx│407 │8cJKoEC4uhvb│ │408@ext.pbx│408 │eWHKkDylxKK2│ │409@ext.pbx│409 │6fPDrW64oDWK│ └───────────┴─────┴────────────┘ [exec at: 22.02.2019 08:31:06, exec time: 20s 654ms, nodes: ds1@ecss1,ds1@ecss2,sip1@ecss1]
purge
Команда для удаления различных данных из виртуальной АТС без удаления конфигурации виртуальной АТС.
Путь команды:
/domain/purge
/domain/<DOMAIN>/purge
Синтаксис:
Для команды уровня системы:
remove [<FLAGS>] <DOMAIN>
Для команды уровня определенного домена:
remove [<FLAGS>]
Параметры:
<DOMAIN> - имя виртуальной АТС;<FLAGS> :: --<FLAG_1> --<FLAG_2> ...
<FLAG> :: routing | statistics | call-history | cdr | call-trace | record-calls | subscriber-sounds | sounds | faxes | purge-all | force
- routing - удалить исходные файлы контекстов маршрутизации после удаления домена;
- statistics - удалить статистику КЦ, по вызовам;
- call-history - удалить историю вызовов по данному домену;
- cdr - удалить CDR записи по данному домену;
- call-trace - удалить трассировки вызовов по данному домену;
- record-calls - удалить записанные разговоры по данному домену;
- subscriber-sounds - удалить пользовательские аудио-файлы (музыка, голосовая почта) по данному домену;
- sounds - удалить доменные аудио-файлы по данному домену;
- faxes - удалить факсы, полученные с данного домена;
- all - удалить всю имеющуюся информацию по данному домену;
- force - принудительное удаление виртуальной АТС. Данная опция позволяет безусловно удалить виртуальную АТС, не учитывая ее текущее состояние.
Пример 1:
support@[mycelium1@biysk1]:/$ domain/purge --cdr --call-history biysk.local
Пример 2:
support@[mycelium1@biysk1]:/$ domain/biysk.local/purge --all
declare
Команда используется для создания новой виртуальной АТС в системе ECSS-10.
Путь команды:
/domain/declare
Синтаксис:
declare <DOMAIN> [--alias-limit <AliasLimit>] [--virtual-alias-limit <VirtualAliasLimit>] [--call-limit <CallLimit>] [--add-domain-user-privileges] [--add-domain-admin-privileges] [--degraded]
Параметры:
<DOMAIN> - имя виртуальной АТС;
--alias-limit - командой задается <AliasLimit> - ограничение на количество алиасов на домен, по умолчанию значение <AliasLimit> устанавливается из лицензии;
--apply-ss-profile <SSProfileName> - имя системного профиля услуг, копируемого в создаваемый домен;
--virtual-alias-limit командой задается <VirtualAliasLimit> - ограничение на количество виртуальных алиасов на домен, по умолчанию значение <VirtualAliasLimit> устанавливается из лицензии;
--call-limit - командой задается <CallLimit> - ограничение на количество одновременных вызовов на домен, по умолчанию значение <CallLimit> устанавливается из лицензии;
--add-domain-user-privileges - флаг, определяющий, необходимо ли добавлять текущего пользователя в группу пользователей создаваемого домена, опциональный параметр, принимает значения:
- true - добавлять, установлено по умолчанию;
- false - не добавлять.
--add-domain-admin-privileges - флаг, определяющий, необходимо ли добавлять текущего пользователя в группу администраторов создаваемого домена, опциональный параметр, принимает значения:
- true - добавлять, установлено по умолчанию;
- false - не добавлять.
--degraded - флаг, определяющий, является ли данный домен доменом без резервирования вызовов или нет:
- false - домен будет с резервированием вызовов, установлено по умолчанию;
- true - домен без резервирования.
--digitmap - cписок масок набора, по которому будет валидироваться алиасы при создании. Параметр доступен начиная с версии ПО 3.10.1.
Формат описания digitmap
Digitmap :: Правило_1 | Правило_2 |...| Правило_N
Номер удовлетворяет digitmap, когда он удовлетворяет одному из перечисленных правил.
Формат правила:
- X или х – любая цифра от 0 до 9, равнозначно диапазону [0-9];
- 0 - 9 – цифры от 0 до 9;
- "A", "B", "C", "D" - символы «A», «B», «C», «D»;
- * – символ *;
- # – символ #;
- [ ] – указание диапазона (через тире), либо перечисление (без пробелов, запятых и прочих символов между цифрами), например:
- диапазон [1-5] - 1,2,3,4 или 5;
- перечисление [138] - 1,3 или 8;
- диапазон и перечисление [0-9*#] – от 0 до 9, а также * и #.
- {min,max} – указание количества повторений символа, стоящего перед скобками, диапазона или символов *#. min - минимальное количество повторений, max - максимальное. {,max} – равнозначно {0,max}; {min,} – равнозначно {min,inf.}.
Пример:
5{2,5} – цифру 5 можно набрать от двух до пяти раз. Равнозначно записи 55|555|5555|55555
- . – спецсимвол «точка» указывает на возможность повторения предшествующей перед данным символом цифры, диапазона или символов *# от нуля до бесконечности раз. Равнозначно записи {0,}
Пример:
5х.* - х в данном правиле может либо отсутствовать вообще, либо присутствовать сколько угодно раз. Равнозначно записи 5*|5х*|5xx*|5xxx*|...
- + – повторение предшествующей перед символом «+» цифры, диапазона или символов *# от одного до бесконечности раз. Равнозначно записи {1,}.
Пример:
support@[mycelium1@biysk1]:/$ /domain/declare d.city --digitmap [1-3]xx
info
Командой /domain/info просматривается информация о глобальных свойств виртуальной АТС.
Команда доступна только пользователю с правами ECSS_ROOT
Командой /domain/<DOMAIN>/info просматривается информация о свойствах определенной виртуальной АТС.
Путь команды:
/domain/info
/domain/<DOMAIN>/info
Синтаксис:
info [<PROPERTY>]
Параметры:
[<PROPERTY>] - название свойства, опциональный параметр.
Пример:
support@[mycelium1@biysk1]:/$ domain/info Global properties of domais -------------------------------------------------------------------------------------------------------------------------------------- |W| Property | Value | |-+-------------------------------------------------+--------------------------------------------------------------------------------| |g|ecss_cm\email_notifier_config_base\to_name |[] | |g|ecss_cm\email_notifier_config_base\enabled |false | |g|ecss_cm\email_notifier_config_base\body_limit |undefined | |g|ecss_cm\email_notifier_config_base\from_name |"%INSTANCE%" | |g|ecss_cm\email_notifier_config_base\subject_limit |undefined | |g|ecss_cm\email_notifier_config_base\to |["ecss10biysk@mail.ru"] | |g|ecss_cm\email_notifier_config_base\subject_format|"alarm: %SEVERITY% Loc: %LOCATION% - %INSTANCE%" | |g|ecss_cm\email_notifier_config_base\body_format |"\"Time: %TIME% Class: %CLASS% Location: %LOCATION% Severity: %SEVERITY% Text: %| | | |TEXT% Cause: %CAUSE%\"" | -------------------------------------------------------------------------------------------------------------------------------------- Legend: W: Where property is set: g: This is global property Note: * char in W column means "Can't read domain info". Error reason in value column in this case [exec at: 19.05.2014 15:54:29, exec time: 9ms, nodes: ds1@biysk1]
list
Команда для просмотра зарегистрированных в системе виртуальных АТС.
Путь команды:
/domain/list
Синтаксис:
list
Параметры:
Команда не содержит аргументов.
Пример:
support@[mycelium1@biysk1]:/$ domain/list There are declared ECSS domains: biysk.local [exec at: 19.05.2014 15:59:48, exec time: 9ms, nodes: ds1@biysk1]
remove
Команда для удаления виртуальной АТС из системы.
Путь команды:
/domain/remove
Синтаксис:
remove [<FLAGS>] <DOMAIN>
Параметры:
<DOMAIN> - имя виртуальной АТС;<FLAGS> :: --<FLAG_1> --<FLAG_2> ...
<FLAG> :: routing | statistics | call-history | cdr | call-trace | record-calls | subscriber-sounds | sounds | faxes | purge-all | force
- routing - удалить исходные файлы контекстов маршрутизации после удаления домена;
- statistics - удалить статистику КЦ, по вызовам;
- call-history - удалить историю вызовов по данному домену;
- cdr - удалить CDR записи по данному домену;
- call-trace - удалить трассировки вызовов по данному домену;
- record-calls - удалить записанные разговоры по данному домену;
- subscriber-sounds - удалить пользовательские аудио-файлы (музыка, голосовая почта) по данному домену;
- sounds - удалить доменные аудио-файлы по данному домену;
- faxes - удалить факсы, полученные с данного домена;
- purge-all - удалить всю имеющуюся информацию по данному домену;
- force - принудительное удаление виртуальной АТС. Данная опция позволяет безусловно удалить виртуальную АТС, не учитывая ее текущее состояние.
Пример 1:
support@[mycelium1@biysk1]:/$ domain/remove biysk.local
Пример 2:
support@[mycelium1@biysk1]:/$ domain/remove --purge-all biysk.local
set
Командой /domain/set задается значение свойства виртуальной АТС на глобальном уровне.
Команда доступна только пользователю с правами ECSS_ROOT
Командой /domain/<DOMAIN>/set задается значение свойства виртуальной АТС на уровне домена (виртуальной АТС).
Путь команды:
/domain/set
/domain/<DOMAIN>/set
Синтаксис:
set <PROPERTY> <VALUE>
Параметры:
<PROPERTY> - название свойства;
<VALUE> - значение свойства.
Пример:
support@[mycelium1@biysk1]:/$ domain/set ecss_cm\email_notifier_config_base\enabled false