Сервер CommuniGate Pro поддерживает несколько способов обращения к CLI:
Когда CLI используется через соединение PWD, то команды CLI принимаются после аутентификации пользователя. Для каждой команды CLI Сервер проверяет права доступа аутентифицированного пользователя.
Если команда возвращает какие-либо данные, то данные отправляются сразу после строки положительного ответа протокола. Комбинация CR-LF отправляется после данных. Ниже приводится пример PWD сессии, содержащей команды CLI:
C: telnet servername.com 106
S: 200 CommuniGate Pro at mail.servername.com PWD Server 5.3 ready
C: USER postmaster
S: 300 please send the PASS
C: PASS postmasterpassword
S: 200 login OK
C: CreateAccount "user1"
S: 200 OK
C: CreateAccount "user1"
S: 501 Account with this name already exists
C: RenameAccount "user1" into "user2"
S: 200 OK
C: CreateDomain "client1.com"
S: 200 OK
C: CreateAccount "user1@client1.com" TextMailbox
S: 200 OK
C: ListDomains
S: 200 data follow
S: (mail.servername.com, client1.com, client2.com)
C: QUIT
S: 200 CommuniGate Pro PWD connection closed
В документе Perl Интерфейс CommuniGate Pro (на английском языке) содержится описание и набор утилит на языке Perl, позволяющий сценариям Perl получать доступ к CLI API CommuniGate Pro через протокол PWD. В документе также содержатся ссылки на несколько полезных примеров сценариев Perl (автоматизирующих создание и удаление Пользователей и т.п.)
В документе Java Интерфейс CommuniGate Pro (на английском языке) содержится описание и набор классов на языке Java, позволяющий программам Java получать доступ к CLI API CommuniGate Pro через протокол PWD. В документе также содержатся ссылки на несколько полезных примеров программ Java.
Интерфейс CLI CommuniGate Pro использует стандартные Форматы Данных для разбора команд и вывода результатов.
Обратите внимание: Правила Синтаксиса формата Словарь позволяют вам задавать строку без знаков кавычки, если в строке содержатся только алфавитно-цифровые символы. Вы должны использовать знак кавычки, если в строке содержится точка (.), запятая (,) или другие не алфавитно-цифровые символы.
Несмотря на то, что в стандартных форматах Данных могут использовать несколько текстовых строк, все задаваемые вами в качестве параметров CLI данные (включая массивы и словари) должны находиться в одной командной строке.
Если команда CLI возвращает какие-либо данные в формате массива или словаря, то эти выходные данные могут располагаться на нескольких строках.
Пользователь должен иметь право доступа Все Домены для использования команд CLI по Администрированию Наборов Доменов.
Следующие команды доступны только для Администраторов Системы:
- LISTDOMAINS
- Используйте эту команду для получения списка доменов. Эта команда возвращает массив с именами всех доменов сервера.
- MAINDOMAINNAME
- Используйте эту команду для получения имени Главного Домена. Эта команда возвращает данные - строку с именем Главного Домена.
- GETDOMAINDEFAULTS
- Используйте эту команду для получения общесерверных Установок по Умолчанию для Домена. Эта команда возвращает словарь с Установками по Умолчанию для Домена.
- UPDATEDOMAINDEFAULTS newSettings
- Используйте эту команду для изменения общесерверных Установок по Умолчанию для Домена.
- newSettings : словарь
- Этот словарь используется для изменения словаря с общесерверными Установками по Умолчанию для Домена. Он не обязан содержать в себе все установки; отсутствующие в словаре установки просто не будут изменены.
- SETDOMAINDEFAULTS newSettings
- Используйте эту команду для изменения общесерверных Установок по Умолчанию для Домена.
- newSettings : словарь
- Этот словарь используется для замещения словаря общесерверных Установками по Умолчанию для Домена.
- GETCLUSTERDOMAINDEFAULTS
UPDATECLUSTERDOMAINDEFAULTS newSettings
SETCLUSTERDOMAINDEFAULTS newSettings
- Эти команды доступны только в Динамическом Кластере.
Используйте эти команды вместо команд [GET|UPDATE|SET]DOMAINDEFAULTS для работы с общекластерными Установками по Умолчанию для Домена.
- GETSERVERACCOUNTDEFAULTS
- Используйте эту команду для получения общесерверных Установок по Умолчанию для Пользователя. Эта команда возвращает словарь с глобальными Установками по Умолчанию для Пользователя.
- UPDATESERVERACCOUNTDEFAULTS newSettings
- Используйте эту команду для изменения общесерверных Установок по Умолчанию для Пользователя.
- newSettings : словарь
- Этот словарь используется для изменения словаря с Установками по Умолчанию для Пользователя. Он не обязан содержать в себе все установки; отсутствующие в словаре установки просто не будут изменены.
- SETSERVERACCOUNTDEFAULTS newSettings
- Используйте эту команду для изменения общесерверных Установок по Умолчанию для Пользователя.
- newSettings : словарь
- Этот словарь используется для замещения словаря общесерверных Установок по Умолчанию для Пользователя.
- GETCLUSTERACCOUNTDEFAULTS
UPDATECLUSTERACCOUNTDEFAULTS newSettings
SETCLUSTERACCOUNTDEFAULTS newSettings
- Эти команды доступны только в Динамическом Кластере.
Используйте эти команды вместо команд [GET|UPDATE|SET]SERVERACCOUNTDEFAULTS для работы с общекластерными Установками по Умолчанию для Пользователя.
- GETSERVERACCOUNTPREFS
- Используйте эту команду для получения общесерверных Настроек Пользователя по умолчанию. Эта команда возвращает словарь, в котором содержатся Настройки по умолчанию.
- SETSERVERACCOUNTPREFS newSettings
- Используйте эту команду для изменения общесерверных Настроек Пользователя по умолчанию.
- newSettings : словарь
- Этот словарь используется для замещения словаря общесерверных Настроек Пользователя по умолчанию. Все старые общесерверные Настройки Пользователя, применяемые по умолчанию, удаляются.
- UPDATESERVERACCOUNTPREFS newSettings
- Используйте эту команду для изменения общесерверных Настроек Пользователя по умолчанию.
- newSettings : словарь
- Этот словарь используется для изменения Настроек Пользователя по умолчанию. Он не обязан содержать в себе все настройки; отсутствующие в словаре Настройки просто не будут изменены.
- GETCLUSTERACCOUNTPREFS
SETCLUSTERACCOUNTPREFS newSettings
UPDATECLUSTERACCOUNTPREFS newSettings
- Эти команды доступны только в Динамическом Кластере.
Используйте эти команды вместо команд [GET|SET|UPDATE]SERVERACCOUNTPREFS для работы с общекластерными Настройками Пользователя по Умолчанию.
- CREATEDOMAIN domainName [ SHARED ] [ PATH storage ] [ settings ]
- Используйте эту команду для создания нового Домена.
- domainName : строка
- Этот параметр указывает имя создаваемого Домена.
- storage : строка
- Необязательный параметр; задаёт директорию "Точки монтирования хранилища" для данных Домена (имя должно быть указано без суффикса .mnt).
- settings : словарь
- Необязательный словарь с установками Домена.
Ключевое слово SHARED используется при создании общекластерного Домена в Динамическом Кластере.
- RENAMEDOMAIN oldDomainName INTO newDomainName [ PATH storage ]
- Используйте эту команду для переименования Домена.
- oldDomainName : строка
- Этот параметр указывает имя существующего Домена.
- newDomainName : строка
- Этот параметр указывает новое имя Домена.
- storage : строка
- Необязательный параметр; задаёт новую директорию "Точки монтирования хранилища" для данных Домена (имя должно быть указано без суффикса .mnt).
- DELETEDOMAIN domainName [ FORCE ]
- Используйте эту команду для удаления Домена.
- domainName : строка
- В этом параметре задаётся имя удаляемого Домена.
- FORCE
- Этот необязательный параметр указывает, что Домен должен быть удалён, даже если он не пустой. Все объекты Домена (Пользователи, Группы и т.д.) будут удалены.
- CREATEDIRECTORYDOMAIN domainName [ settings ]
- Используйте эту команду для создания нового Домена в Справочнике (Directory-Based).
- domainName : строка
- Этот параметр указывает имя создаваемого Домена.
- settings : словарь
- Необязательный словарь с установками Домена.
Эта операция может быть выполнена, только если разрешено использование Доменов в Справочнике.
- RELOADDIRECTORYDOMAINS
- Используйте эту команду, чтобы Сервер зачитал заново деревья Доменов в Справочнике и нашёл все новые Домены, созданные непосредственно в Справочнике, минуя административные интерфейсы CommuniGate Pro.
Эта операция может быть выполнена, только если разрешено использование Доменов в Справочнике.
- LISTSERVERTELNUMS [ FILTER filter ] limit
- Используйте эту команду для чтения номеров Telnum, созданных во всех Доменах (не кластерных). Эта команда возвращает словарь, в котором каждый элемент является номером Telnum, а значение элемента - это имя Пользователя, которому этот номер назначен. Для пустого ключа "" добавляется числовой элемент, содержащий общее число созданных номеров Telnum.
- filter : строка
- Если этот необязательный параметр указан, то возвращаются только те номера Telnum, в которых содержится указанная строка.
- limit : число
- Максимальное количество возвращаемых номеров Telnum.
- LISTCLUSTERTELNUMS [ FILTER filter ] limit
- Аналогично команде LISTSERVERTELNUMS, но для общих кластерных Доменов.
- GETSERVERTRUSTEDCERTS
- Используйте эту команду для получения общесерверного набора Доверенных Сертификатов. Эта команда возвращает массив из блоков данных. В каждом блоке данных содержатся данные одного Сертификата X.509.
- SETSERVERTRUSTEDCERTS newCertificates
- Используйте эту команду для установки общесерверного набора Доверенных Сертификатов.
- newCertificates : массив
- Этот массив должен содержать блоки данных с данными сертификатов в соответствии с X.509. Этот массив используется для замещения общесерверного списка Доверенных Сертификатов.
- GETCLUSTERTRUSTEDCERTS
SETCLUSTERTRUSTEDCERTS newCertificates
- Эти команды доступны только в Динамическом Кластере.
Используйте эти команды вместо команд [GET|SET]SERVERTRUSTEDCERTS для работы с общекластерным набором Доверенных Сертификатов.
- GETDIRECTORYINTEGRATION
- Используйте эту команду для получения общесерверных установок Интеграции с Центральным Справочником. Эта команда возвращает словарь, в котором содержатся установки Интеграции с Центральным Справочником.
- SETDIRECTORYINTEGRATION newSettings
- Используйте эту команду для задания общесерверных установок Интеграции с Центральным Справочником.
- newSettings : словарь
- Этот словарь используется для замещения словаря общесерверных установок Интеграции с Центральным Справочником.
- GETCLUSTERDIRECTORYINTEGRATION
SETCLUSTERDIRECTORYINTEGRATION newSettings
- Эти команды доступны только в Динамическом Кластере.
Используйте эти команды вместо команд [GET|SET]DIRECTORYINTEGRATION для работы с общекластерными установками Интеграции с Центральным Справочником.
- CREATEDOMAINSTORAGE [ SHARED ] PATH storage
- Используйте эту команду для создания "Точки монтирования хранилища" для новых Доменов.
- storage : строка
- Этот параметр указывает имя "Точки монтирования хранилища".
Ключевое слово SHARED используется при создании "Точки монтирования хранилища" для кластерных Доменов в Динамическом Кластере.
- LISTDOMAINSTORAGE [ SHARED ]
- Используйте эту команду для получения списка "Точек монтирования хранилищ" Доменов.
Эта команда возвращает массив с именами "Точек монтирования хранилищ".
Ключевое слово SHARED используется при получении списка "Точек монтирования хранилищ" для кластерных Доменов в Динамическом Кластере.
Для использования команд CLI Управления Доменом необходимо иметь право доступа Все Домены или обладать правами на Управление Доменом.
- GETDOMAINSETTINGS [ domainName ]
- Используйте эту команду для получения установок Домена. Эта команда возвращает словарь с установками Домена. В словарь включаются только те установки, которые заданы явно (не являются установками по умолчанию).
- domainName : строка
- Этот необязательный параметр указывает имя существующего Домена.
- GETDOMAINEFFECTIVESETTINGS [ domainName ]
- Используйте эту команду для получения фактических установок Домена. Эта команда возвращает словарь с установками Домена domainName. В этот словарь включаются и явно заданные установки, и применяемые по умолчанию настройки.
- domainName : строка
- Этот необязательный параметр указывает имя существующего Домена.
- UPDATEDOMAINSETTINGS [ domainName ] newSettings
- Используйте эту команду для изменения установок Домена.
- domainName : строка
- Этот необязательный параметр указывает имя существующего Домена.
- newSettings : словарь
- Этот словарь используется для изменения словаря с установками Домена. Он не обязан содержать в себе все установки; отсутствующие в словаре установки просто не будут изменены. Если новое значение установки указано как строка default, то значения установок Домена удаляются и вместо них используются применяемые по умолчанию установки Домена.
Если эта команда используется Администратором Домена, то она будет изменять только те установки Домена, которые этому Администратору разрешается изменять.
- GETACCOUNTDEFAULTS [ domainName ]
- Используйте эту команду для получения Установок по Умолчанию для Пользователя в указанном Домене. Эта команда возвращает словарь, в котором содержатся установки по умолчанию.
- domainName : строка
- Этот необязательный параметр указывает имя Домена. Если имя Домена не указано, то команда применяется к Домену Администратора.
- UPDATEACCOUNTDEFAULTS [ domainName ] newSettings
- Используйте эту команду для изменения Установок по Умолчанию для Пользователя в указанном Домене.
- domainName : строка
- Этот необязательный параметр указывает имя Домена. Если имя Домена не указано, то команда применяется к Домену администратора.
- newSettings : словарь
- Этот словарь используется для изменения Установок по Умолчанию для Пользователя в указанном Домене. Словарь не обязан содержать в себе все установки; отсутствующие в словаре установки просто не будут изменены. Если новое значение установки указано как строка default, то значения установок удаляются и вместо них используются глобальные общесерверные Настройки по Умолчанию для Пользователя.
Если эта команда используется Администратором Домена, то она будет изменять только те Установки по Умолчанию для Пользователя, которые этому Администратору разрешается изменять.
- GETACCOUNTDEFAULTPREFS [ domainName ]
- Используйте эту команду для получения Настроек Пользователя по умолчанию, действующих в указанном Домене. Эта команда возвращает словарь, в котором содержатся Настройки по умолчанию.
- domainName : строка
- Этот необязательный параметр указывает имя Домена. Если имя Домена не указано, то команда применяется к Домену администратора.
- SETACCOUNTDEFAULTPREFS [ domainName ] newSettings
- Используйте эту команду для изменения Настроек Пользователя, применяемых в указанном Домене по умолчанию.
- domainName : строка
- Этот необязательный параметр указывает имя Домена. Если имя Домена не указано, то команда применяется к Домену аутентифицированного пользователя.
- newSettings : словарь
- Этот словарь используется для замещения Настроек Пользователя, применяемых в указанном Домене по умолчанию. Все старые Настройки Пользователя по умолчанию при этом удаляются.
Эта команда может использоваться Администраторами Домена, только если они имеют право доступа Настройки(WebUserSettings).
- UPDATEACCOUNTDEFAULTPREFS [ domainName ] newSettings
- Используйте эту команду для изменения Настроек Пользователя, применяемых в указанном Домене по умолчанию.
- domainName : строка
- Этот необязательный параметр указывает имя Домена. Если имя Домена не указано, то команда применяется к Домену аутентифицированного пользователя.
- newSettings : словарь
- Этот словарь используется для изменения Настроек Пользователя, применяемых в указанном Домене по умолчанию. Он не обязан содержать в себе все Настройки; отсутствующие в словаре настройки просто не будут изменены.
Если новое значение элемента указано как строка default, то значение Настройки по умолчанию удаляется и вместо неё используется значение из общесерверных (или общекластерных) Настроек Пользователя, применяемых по умолчанию.
Эта команда может использоваться Администраторами Домена, только если они имеют право доступа Настройки(WebUserSettings).
- GETACCOUNTTEMPLATE [ domainName ]
- Используйте эту команду для получения установок Шаблона Пользователя. Эта команда возвращает словарь, в котором содержатся установки Шаблона.
- domainName : строка
- Этот необязательный параметр указывает имя Домена. Если имя Домена не указано, то команда применяется к Домену администратора.
- UPDATEACCOUNTTEMPLATE [ domainName ] newSettings
- Используйте эту команду для изменения установок Шаблона Пользователя.
- domainName : строка
- Этот необязательный параметр указывает имя Домена. Если имя Домена не указано, то команда применяется к Домену администратора.
- newSettings : словарь
- Этот словарь используется для изменения Шаблона Пользователя Домена. Все новые Пользователи в указанном Домене будут создаваться с установками из Шаблона. Словарь не обязан содержать в себе все установки; отсутствующие в словаре установки просто не будут изменены. Если новое значение установки указано как строка default, то значение установки Шаблона удаляется.
Если эта команда используется Администратором Домена, то она будет изменять только те установки Шаблона, которые этому Администратору разрешается изменять.
- GETDOMAINALIASES domainName
- Используйте эту команду для получения списка Псевдонимов Домена. Эта команда возвращает массив с именами псевдонимов Домена.
- domainName : строка
- В этом параметре задаётся имя существующего Домена.
- GETDOMAINMAILRULES domainName
- Используйте эту команду для получения списка Почтовых Правил Домена. Эта команда возвращает массив Почтовых Правил Домена.
- domainName : строка
- В этом параметре задаётся имя существующего Домена.
- SETDOMAINMAILRULES domainName newRules
- Используйте эту команду для задания Почтовых Правил Домена.
- domainName : строка
- В этом параметре задаётся имя существующего Домена.
- newRules : массив
- Этот массив должен содержать Почтовые Правила Домена. Все старые Почтовые Правила Домена при этом удаляются.
Эта команда может использоваться Администраторами Домена, только если они имеют право доступа Разрешённые Почтовые Правила(RulesAllowed).
- GETDOMAINSIGNALRULES domainName
- Используйте эту команду для получения списка Сигнальных Правил Домена. Эта команда возвращает массив Сигнальных Правил Домена.
- domainName : строка
- В этом параметре задаётся имя существующего Домена.
- SETDOMAINSIGNALRULES domainName newRules
- Используйте эту команду для задания Сигнальных Правил Домена.
- domainName : строка
- В этом параметре задаётся имя существующего Домена.
- newRules : массив
- Этот массив должен содержать Сигнальные Правила Домена. Все старые Сигнальные Правила Домена при этом удаляются.
Эта команда может использоваться Администраторами Домена, только если они имеют право доступа Разрешённые Сигнальные Правила(SignalRulesAllowed).
- LISTADMINDOMAINS [ domainName ]
- Используйте эту команду для получения списка всех Доменов, которые могут управляться Пользователями Администраторами Домена из Домена domainName. Эта команда возвращает массив имён Доменов.
- domainName : строка
- Этот необязательный параметр указывает имя Домена. Если имя Домена не указано, то команда применяется к Домену аутентифицированного пользователя.
- LISTDOMAINOBJECTS domainName [ FILTER filter ] limit [ ACCOUNTS ] [ ALIASES ] [ FORWARDERS ] [COOKIE cookie
- Используйте эту команду для получения списка объектов Домена.
- domainName : строка
- Этот параметр указывает имя Домена.
- filter : строка
- Этот необязательный параметр задаёт строку-фильтр: возвращаются только те объекты, имена которых включают в себя строку-фильтр как подстроку.
- limit : числовая строка
- В этом параметре задаётся максимальное число объектов в списке.
- ACCOUNTS, ALIASES, FORWARDERS
- Эти ключевые слова указывают типы объектов Домена, которые должны быть в списке.
- cookie : строка
- Этот необязательный параметр указывает строку с "закладкой".
Эта команда возвращает массив со следующими элементами:
- числовая строка с общим числом Пользователей в Домене
- словарь с Объектами Домена. Каждый ключ словаря является именем Объекта Домена. Значения словаря зависят от типа Объекта Домена:
- Пользователь
- объектами словаря являются строки (тип Пользователя)
- Псевдоним Пользователя
- объект словаря является массивом. Его единственным элементом является строка с именем оригинального Пользователя - владельца Псевдонима.
- Переадресатор
- объект словаря является массивом. Его единственным элементом является массив. Его единственным элементом является строка с адресом Переадресатора.
- числовая строка с общим количеством Псевдонимов в Домене.
- числовая строка с общим количеством Переадресаторов в Домене.
- необязательная строка с новой "закладкой" (существует, только если в команде была часть COOKIE cookie.)
Для перечисления Объектов в больших Доменах указывайте какое-нибудь разумное значение limit (менее 10 000) и задавайте пустую строку cookie. Если возвращаются не все Объекты, то выполните эту команду повторно, используя новое значение cookie, указанное в возвращаемом массиве. Если возвращаются все Объекты, то новое значение cookie в ответе является пустой строкой.
- LISTACCOUNTS [ domainName ]
- Используйте эту команду для получения списка всех Пользователей в Домене. Эта команда возвращает словарь с ключами, в которых перечислены все Пользователи из указанного (или взятого по умолчанию) Домена.
- domainName : строка
- Этот необязательный параметр указывает имя Домена. Если имя Домена не указано, то команда применяется к Домену администратора.
- LISTDOMAINTELNUMS domainName [ FILTER filter ] limit
- Используйте эту команду для чтения номеров Telnum, созданных в указанном Домене. Эта команда возвращает словарь, в котором каждый элемент является номером Telnum, а значение элемента - это имя Пользователя, которому этот номер назначен. Для пустого ключа "" добавляется числовой элемент, содержащий общее число созданных номеров Telnum.
- domainName : строка
- Этот параметр указывает имя Домена.
- filter : строка
- Если этот необязательный параметр указан, то возвращаются только те номера Telnum, в которых содержится указанная строка.
- limit : число
- Максимальное количество возвращаемых номеров Telnum.
- INSERTDIRECTORYRECORDS domainName
- Используйте эту команду для того, чтобы вставить записи Объектов Домена (Пользователи, Группы, Списки Рассылки, Переадресаторы) в Справочник.
- domainName : строка
- Этот необязательный параметр указывает имя Домена. Если имя Домена не указано, то команда применяется к Домену аутентифицированного пользователя.
Эта команда может использоваться Администраторами Домена, только если они имеют право доступа Центральный Справочник (CentralDirectory).
- DELETEDIRECTORYRECORDS domainName
- Используйте эту команду для удаления записей объекта Домена из Справочника.
- domainName : строка
- Этот необязательный параметр указывает имя Домена. Если имя Домена не указано, то команда применяется к Домену аутентифицированного пользователя.
Эта команда может использоваться Администраторами Домена, только если они имеют право доступа Центральный Справочник (CentralDirectory).
- CREATEACCOUNTSTORAGE domainName PATH storage
- Используйте эту команду для создания "Точки монтирования хранилища" для новых Пользователей в Домене.
- domainName : строка
- Этот параметр указывает имя Домена.
- storage : строка
- Этот параметр указывает имя "Точки монтирования хранилища".
- LISTACCOUNTSTORAGE domainName
- Используйте эту команду для получения списка "Точек монтирования хранилищ" Пользователей в Домене.
Эта команда возвращает массив с именами "Точек монтирования хранилищ".
- domainName : строка
- Этот параметр указывает имя Домена.
Следующие команды доступны только Администраторам Системы:
- SETDOMAINALIASES domainName newAliases
- Используйте эту команду для задания псевдонимов Домена.
- domainName : строка
- В этом параметре задаётся имя существующего Домена.
- newAliases : массив
- Этот массив должен содержать строки с именами псевдонимов Домена. Все старые псевдонимы Домена при этом удаляются.
- SETDOMAINSETTINGS domainName newSettings
- Используйте эту команду для изменения установок Домена.
- domainName : строка
- В этом параметре задаётся имя существующего Домена.
- newSettings : словарь
- Этот словарь используется для замещения словаря установок Домена. Все старые установки Домена при этом удаляются.
- SETACCOUNTDEFAULTS [ domainName ] newSettings
- Используйте эту команду для изменения Установок по Умолчанию для Пользователя в указанном Домене.
- domainName : строка
- Этот параметр указывает имя Домена.
- newSettings : словарь
- Этот словарь используется для замещения Установок по Умолчанию для Пользователя в указанном Домене. Все старые Установки по Умолчанию для Пользователя удаляются.
- SETACCOUNTTEMPLATE [ domainName ] newSettings
- Используйте эту команду для изменения установок Шаблона Пользователя.
- domainName : строка
- Этот необязательный параметр указывает имя Домена. Если имя Домена не указано, то команда применяется к Домену администратора.
- newSettings : словарь
- Этот словарь используется для изменения Шаблона Пользователя Домена. Все новые Пользователи в указанном Домене будут создаваться с установками из Шаблона. Все старые установки Шаблона Пользователя удаляются.
- GETDOMAINLOCATION [ domainName ]
- Используйте эту команду для получения пути к файловой директории Домена (относительно директории данных Сервера). Эта команда возвращает строку с путём к файловой директории Домена.
- domainName : строка
- Этот необязательный параметр указывает имя Домена. Если имя Домена не указано, то команда применяется к Домену администратора.
- SUSPENDDOMAIN domainName
- Используйте эту команду для приостановки Домена; все текущие активные сессии Пользователей Домена закрываются и не могут быть открыты снова.
- domainName : строка
- В этом параметре задаётся имя Домена, который должен быть приостановлен.
- RESUMEDOMAIN domainName
- Используйте эту команду для возобновления работы Домена; Пользователи смогут обслуживаться в этом Домене.
- domainName : строка
- В этом параметре задаётся имя Домена, работа которого должна быть возобновлена.
Для использования команд CLI для Управления Пользователями необходимо иметь право доступа Все Домены или обладать правами на Управление Доменом.
- CREATEACCOUNT accountName [ accountType ] [ PATH storage ] [ LEGACY ] [ settings ]
- Используйте эту команду для создания новых пользователей.
- accountName : строка
- Этот параметр задаёт имя нового Пользователя.
Имя может содержать символ @, за которым следует имя Домена; в этом случае Пользователь создаётся в указанном Домене. Если имя Домена не указано, то команда применяется к Домену администратора.
- accountType : MultiMailbox | TextMailbox | MailDirMailbox | AGrade | BGrade | CGrade
- Этот необязательный параметр указывает тип создаваемого Пользователя. Если тип Пользователя не указан, то создаётся Пользователь с типом MultiMailbox (Набор Папок).
- storage : строка
- Необязательный параметр; задаёт директорию "Точки монтирования хранилища" для данных Пользователя (имя должно быть указано без суффикса .mnt).
- LEGACY
- Этот необязательный флаг указывает системе создавать Пользователя с внешним (доступным старым почтовым программам) INBOX.
- settings : словарь
- Этот необязательный словарь начальные установки Пользователя. Пользователь создаётся с установками, указанными в Шаблоне Пользователя для выбранного Домена. Если указан параметр settings, то он используется для изменения установок из Шаблона.
Эта команда может использоваться Администраторами Домена, только если они имеют право доступа Может создавать Пользователей (CanCreateAccounts).
Если эта команда используется Администратором Домена, то она будет работать только с теми установками Пользователя, которые этому Администратору разрешается изменять.
- RENAMEACCOUNT oldAccountName into newAccountName [ PATH storage ]
- Используйте эту команду для переименования Пользователей.
- oldAccountName : строка
- В этом параметре задаётся имя существующего Пользователя. Имя может включать в себя имя Домена (смотрите выше).
- newAccountName : строка
- В этом параметре задаётся новое имя Пользователя. Имя может включать в себя имя Домена (смотрите выше).
- storage : строка
- Необязательный параметр; задаёт новую директорию "Точки монтирования хранилища" для данных Пользователя (имя должно быть указано без суффикса .mnt).
Эта команда может использоваться Администраторами Домена, только если они имеют право доступа Может создавать Пользователей (CanCreateAccounts).
- DELETEACCOUNT oldAccountName
- Используйте эту команду для удаления Пользователей.
- oldAccountName : строка
- В этом параметре задаётся имя существующего Пользователя. Имя может включать в себя имя Домена (смотрите выше).
Эта команда может использоваться Администраторами Домена, только если они имеют право доступа Может создавать Пользователей (CanCreateAccounts).
- SETACCOUNTTYPE accountName accountType
- Используйте эту команду для изменения типа Пользователя.
- accountName : строка
- В этом параметре задаётся имя существующего Пользователя. Имя может включать в себя имя Домена (смотрите выше).
- accountType : MultiMailbox | AGrade | BGrade | CGrade
- В этом параметре задаётся новый тип Пользователя. Тип текущего Пользователя также должен принадлежать к этому набору типов.
Эта команда может использоваться Администраторами Домена, только если они имеют право доступа Может создавать Пользователей (CanCreateAccounts).
- GETACCOUNTSETTINGS accountName
- Используйте эту команду для получения установок Пользователя. Эта команда возвращает словарь, в котором содержатся установки Пользователя. В словарь включаются только те установки Пользователя, которые заданы явно (не являются установками по умолчанию).
- accountName : строка
- В этом параметре задаётся имя существующего Пользователя. Имя может включать в себя имя Домена (смотрите выше).
Вместо имени Пользователя вы также можете указать один символ звёздочка (*). Это будет означать текущего аутентифицированного Пользователя.
Обратите внимание: Все пользователи могут отправлять команду GETACCOUNTSETTINGS для самих себя.
- UPDATEACCOUNTSETTINGS accountName newSettings
- Используйте эту команду для изменения установок Пользователя.
- accountName : строка
- В этом параметре задаётся имя существующего Пользователя. Имя может включать в себя имя Домена (смотрите выше).
- newSettings : словарь
- Данные этого словаря используются для изменения словаря установок Пользователя. Он не обязан содержать в себе все установки; отсутствующие в словаре установки просто не будут изменены. Если новое значение установки указано как строка default, то эта установка Пользователя удаляется и вместо неё используется установка Пользователя, применяемая по умолчанию.
Если эта команда используется Администратором Домена, то она будет изменять только те установки Пользователя, которые этому Администратору разрешается изменять.
- GETACCOUNTEFFECTIVESETTINGS accountName
- Используйте эту команду для получения фактических установок Пользователя. Эта команда возвращает словарь, в котором содержатся установки Пользователя. В словарь включаются как набор явно заданных установок Пользователя, так и набор установок, применяемый по умолчанию.
- accountName : строка
- В этом параметре задаётся имя существующего Пользователя. Имя может включать в себя имя Домена (смотрите выше).
Вместо имени Пользователя вы также можете указать один символ звёздочка (*). Это будет означать текущего аутентифицированного Пользователя.
Обратите внимание: Все Пользователи могут отправлять команду GETACCOUNTEFFECTIVESETTINGS для самих себя.
- GETACCOUNTONESETTING accountName keyName
- Используйте эту команду для получения одного элемента из фактических установок Пользователя. Эта команда возвращает объект,
который может быть строкой, массивом или словарём, в котором содержится установка Пользователя, или нулевым объектом.
- accountName : строка
- В этом параметре задаётся имя существующего Пользователя. Имя может включать в себя имя Домена (смотрите выше).
Вместо имени Пользователя вы также можете указать один символ звёздочка (*). Это будет означать текущего аутентифицированного Пользователя.
- keyName : строка
- В этом параметре задаётся имя элемента установки Пользователя.
Обратите внимание: Все Пользователи могут отправлять команду GETACCOUNTONESETTING для самих себя.
- SETACCOUNTPASSWORD accountName PASSWORD newPassword [ METHOD method | NAME tag ] [ CHECK ]
- Используйте эту команду для изменения пароля Пользователя.
- accountName : строка
- В этом параметре задаётся имя существующего Пользователя. Имя может включать в себя имя Домена (смотрите выше).
- newPassword : строка
- Эта строка задаёт новый пароль Пользователя. Новый пароль будет сохранён с использованием действующей установки Шифрование Пароля для этого Пользователя.
- tag : строка
- Этот необязательный параметр задаёт метку для Пароля Приложений. Если строка newPassword пуста, то соответствующий метке Пароль Приложений удаляется.
- method : строка
- Этот необязательный параметр указывает способ доступа Пользователя. Если этот способ "SIP", то изменяется Альтернативный Пароль SIP, если способ - "RADIUS", то изменяется Альтернативный Пароль RADIUS. Во всех других случаях изменяется установка Пароля CommuniGate. Новый пароль будет сохранён с использованием действующей установки Шифрование Пароля для этого Пользователя.
Для использования этой команды необходимо обладать для Домена Пользователя правом Администратора Домена "Основные Установки".
Пользователь может изменять свой пароль. В этом случае или, когда явно указано ключевое слово CHECK, операция выполняется успешно, только если новый пароль удовлетворяет требованиям сложности и размера пароля и у Пользователя фактически включена установка CanModifyPassword.
- VERIFYACCOUNTPASSWORD accountName PASSWORD password
- Используйте эту команду для проверки пароля Пользователя.
- accountName : строка
- В этом параметре задаётся имя существующего Пользователя. Имя может включать в себя имя Домена (смотрите выше).
- password : строка
- Эта строка используется для указания проверяемого пароля (в открытом текстовом формате).
Для использования этой команды необходимо обладать какими-нибудь правами Администрирования Домена в Домене этого Пользователя.
- VERIFYACCOUNTIDENTITY accountName FOR identity
- Используйте эту команду для проверки допустимости содержимого заголовка 'From:' в сообщениях Пользователя.
- accountName : строка
- В этом параметре задаётся имя существующего Пользователя. Имя может включать в себя имя Домена (смотрите выше).
- identity : строка
- Эта строка должна содержать значение проверяемого заголовка 'From:', например, "Real Name <user@domain.dom>"
Для использования этой команды необходимо обладать какими-нибудь правами Администрирования Домена в Домене этого Пользователя.
- GETACCOUNTALIASES accountName
- Используйте эту команду для получения списка псевдонимов Пользователя. Эта команда возвращает массив с именами псевдонимов Пользователя.
- accountName : строка
- В этом параметре задаётся имя существующего Пользователя. Имя может включать в себя имя Домена (смотрите выше).
- SETACCOUNTALIASES accountName newAliases
- Используйте эту команду для задания псевдонимов Пользователя.
- accountName : строка
- В этом параметре задаётся имя существующего Пользователя. Имя может включать в себя имя Домена (смотрите выше).
- newAliases : массив
- Этот массив должен содержать строки с именами псевдонимов Пользователя. Старые псевдонимы Пользователя при этом удаляются.
Эта команда может использоваться Администраторами Домена, только если они имеют право доступа Может создавать Псевдонимы (CanCreateAliases).
- GETACCOUNTTELNUMS accountName
- Используйте эту команду для получения списка телефонных номеров, присвоенных Пользователю. Эта команда возвращает массив с присвоенными телефонными номерами.
- accountName : строка
- В этом параметре задаётся имя существующего Пользователя. Имя может включать в себя имя Домена (смотрите выше).
- SETACCOUNTTELNUMS accountName newTelnums
- Используйте эту команду для присвоения Пользователю телефонных номеров.
- accountName : строка
- В этом параметре задаётся имя существующего Пользователя. Имя может включать в себя имя Домена (смотрите выше).
- newTelnums : массив
- Этот массив должен содержать строки с телефонными номерами. Все ранее присвоенные Пользователю телефонные номера удаляются.
Эта команда может использоваться Администраторами Домена, только если они имеют право доступа Может присваивать Телефонные Номера (CanCreateTelnums).
- MODIFYACCOUNTTELNUMS accountName parameters
- Используйте эту команду для изменения списка телефонных номеров, присвоенных Пользователю.
- accountName : строка
- В этом параметре задаётся имя существующего Пользователя. Имя может включать в себя имя Домена (смотрите выше).
- parameters : словарь
- Этот словарь должен содержать элемент с ключом what, задающий применяемую операцию:
- add
- словарь parameters должен содержать ключ telnum со значением номера telnum, который должен быть добавлен к набору номеров Telnum указанного Пользователя. Если этот Telnum уже присвоен Пользователю, то возвращается код ошибки.
- del
- словарь parameters должен содержать ключ telnum со значением номера telnum, который должен быть удалён из набора номеров Telnum указанного Пользователя. Если этот Telnum не принадлежит Пользователю, то возвращается код ошибки.
- pop
- Словарь parameters не должен содержать других ключей. Первый из присвоенных Пользователю номеров Telnum удаляется из набора номеров Telnum указанного Пользователя и копируется в словарь ответа. Если набор номеров Telnum указанного Пользователя был пуст, то код ошибки не возвращается и в словарь результата не копируется никаких элементов.
Эта команда возвращает словарь. В случае операции pop этот словарь содержит строку с ключом telnum, значением которого является строка с номером Telnum, удалённым из набора номеров Telnum Пользователя.
Эта команда может использоваться Администраторами Домена, только если они имеют право доступа Может присваивать Телефонные Номера (CanCreateTelnums).
- GETACCOUNTMAILRULES accountName
- Используйте эту команду для получения Почтовых Правил Пользователя. Эта команда возвращает массив Почтовых Правил Пользователя.
- accountName : строка
- В этом параметре задаётся имя существующего Пользователя. Имя может включать в себя имя Домена (смотрите выше).
- SETACCOUNTMAILRULES accountName newRules
- Используйте эту команду для задания Почтовых Правил Пользователя.
- accountName : строка
- В этом параметре задаётся имя существующего Пользователя. Имя может включать в себя имя Домена (смотрите выше).
- newRules : массив
- Этот массив должен содержать Почтовые Правила Пользователя. Все старые Почтовые Правила Пользователя при этом удаляются.
Эта команда может использоваться Администраторами Домена, только если они имеют право доступа Разрешённые Почтовые Правила (RulesAllowed).
Эта команда может доступна любому Пользователю для изменения собственных Правил (в соответствии с ограничениями, налагаемыми "разрешёнными действиями").
- GETACCOUNTSIGNALRULES accountName
- Используйте эту команду для получения Сигнальных Правил Пользователя. Эта команда возвращает массив Сигнальных Правил Пользователя.
- accountName : строка
- В этом параметре задаётся имя существующего Пользователя. Имя может включать в себя имя Домена (смотрите выше).
- SETACCOUNTSIGNALRULES accountName newRules
- Используйте эту команду для задания Сигнальных Правил Пользователя.
- accountName : строка
- В этом параметре задаётся имя существующего Пользователя. Имя может включать в себя имя Домена (смотрите выше).
- newRules : массив
- Этот массив должен содержать Сигнальные Правила Пользователя. Все старые Сигнальные Правила Пользователя при этом удаляются.
Эта команда может использоваться Администраторами Домена, только если они имеют право доступа Разрешённые Сигнальные Правила (SignalRulesAllowed).
- UPDATEACCOUNTMAILRULE accountName newRule
UPDATEACCOUNTMAILRULE accountName DELETE oldRule
UPDATEACCOUNTSIGNALRULE accountName newRule
UPDATEACCOUNTSIGNALRULE accountName DELETE oldRule
- Используйте эти команды для изменения Почтовых/Сигнальных Правил Пользователя.
- accountName : строка
- В этом параметре задаётся имя существующего Пользователя. Имя может включать в себя имя Домена (смотрите выше).
- newRule : массив
- Этот параметр должен быть массивом, первый элемент которого задаёт приоритет Правила, а второй задаёт имя Правила. Необязательные третий, четвёртый и пятый элементы задают условия Правил, Действия Правил и комментарии к Правилам.
Если массив параметров содержит менее четырёх элементов, то первый элемент используется для изменения приоритета существующего Правила, имя которого задаётся во втором элементе массива. Если такое Правило не существует, то команда возвращает ошибку.
Если массив параметров содержит 4 или более элементов, то весь массив параметров сохраняется как новое Правило. Если есть существующее Правило с таким же именем, то оно удаляется.
- oldRule : строка
- Эта строка-параметр (указываемая после ключевого слова DELETE) задаёт имя Правила, которое должно быть удалено. Если такое Правило не существует, то команда не совершает никаких операций и не возвращает ошибку.
Команда UpdateAccountMailRule может использоваться Администраторами Домена, только если они имеют право доступа Разрешённые Правила для Почты (RulesAllowed).
Команда UpdateAccountSignalRule может использоваться Администраторами Домена, только если они имеют право доступа Разрешённые Правила для Звонков (SignalRulesAllowed).
Эта команда может доступна любому Пользователю для изменения собственных Правил (в соответствии с ограничениями, налагаемыми "разрешёнными действиями").
- GETACCOUNTRPOPS accountName
- Используйте эту команду для получения учётных записей RPOP Пользователя. Эта команда возвращает словарь, в котором содержатся учётные записи RPOP Пользователя.
- accountName : строка
- В этом параметре задаётся имя существующего Пользователя. Имя может включать в себя имя Домена (смотрите выше).
- SETACCOUNTRPOPS accountName newRecords
- Используйте эту команду для изменения учётных записей RPOP Пользователя.
- accountName : строка
- В этом параметре задаётся имя существующего Пользователя. Имя может включать в себя имя Домена (смотрите выше).
- newRecords : словарь
- Этот словарь должен содержать учётные записи RPOP Пользователя. Старые учётные записи RPOP Пользователя при этом удаляются.
Эта команда может использоваться Администраторами Домена, только если они имеют право доступа Модификации RPOP (CanModifyRPOP).
- GETACCOUNTRIMAPS accountName
- Используйте эту команду для получения учётных записей RIMAP Пользователя. Эта команда возвращает словарь, в котором содержатся учётные записи RIMAP Пользователя.
- accountName : строка
- В этом параметре задаётся имя существующего Пользователя. Имя может включать в себя имя Домена (смотрите выше).
- SETACCOUNTRIMAPS accountName newRecords
- Используйте эту команду для изменения учётных записей RIMAP Пользователя.
- accountName : строка
- В этом параметре задаётся имя существующего Пользователя. Имя может включать в себя имя Домена (смотрите выше).
- newRecords : словарь
- Этот словарь должен содержать учётные записи RIMAP Пользователя. Старые учётные записи RIMAP Пользователя при этом удаляются.
Эта команда может использоваться Администраторами Домена, только если они имеют право доступа Модификации RPOP (CanModifyRPOP).
- GETACCOUNTRSIPS accountName
- Используйте эту команду для получения учётных записей RSIP Пользователя. Эта команда возвращает словарь, в котором содержатся учётные записи RSIP Пользователя.
- accountName : строка
- В этом параметре задаётся имя существующего Пользователя. Имя может включать в себя имя Домена (смотрите выше).
- SETACCOUNTRSIPS accountName newRecords
- Используйте эту команду для изменения учётных записей RSIP Пользователя.
- accountName : строка
- В этом параметре задаётся имя существующего Пользователя. Имя может включать в себя имя Домена (смотрите выше).
- newRecords : словарь
- Этот словарь должен содержать учётные записи RSIP Пользователя. Старые учётные записи RSIP Пользователя при этом удаляются.
Эта команда может использоваться Администраторами Домена, только если они имеют право доступа Модификации RSIP (CanModifyRSIP).
- UPDATESCHEDULEDTASK accountName taskData
- Используйте эту команду для управления Расписанием Задач Пользователя.
- accountName : строка
- В этом параметре задаётся имя существующего Пользователя. Имя может включать в себя имя Домена (смотрите выше).
- taskData : словарь
- Этот словарь должен содержать данные выполняемых по расписанию задач:
- id
- строка с именем выполняемой по расписанию задачи. Если задачи с таким именем нет, создаётся новая запись Расписания Задач.
- program
- строка с именем программы выполняемой по расписанию задачи. Это должно быть имя Приложения Реального Времени, доступного в среде Домена Пользователя.
- script
- Если строка с именем программы выполняемой по расписанию задачи не задана, то этот параметр может задать строкой имя Синхронного Скрипта, доступного в среде Домена Пользователя. Если не указан ни этот элемент, ни program , то существующая запись в Расписании Задач (если такая есть) удаляется.
- parameter
- необязательный базовый объект. Когда Задача запускается по расписанию, этот Объект передаётся ей в элементе startParameter.
- when
- отметка времени (время GMT), указывающая, когда Задача должна быть запущена по расписанию, или строка now.
- period
- необязательный параметр - строка day, week, month или year или число. Если он указан, то задача автоматически добавляется в расписание через указанный период времени (в случае указания числа - через такое количество секунд).
Если этот параметр не указан, то Задача удаляется из Расписания сразу после выполнения.
При запуске Задачи по Расписанию выполняется её точка входа main. Массив startParameter Задачи содержит следующие элементы:
- startParameter[0] - строка с именем выполняемой по расписанию задачи
- startParameter[1] содержит отметку времени запуска Задачи
- startParameter[2] (необязательный параметр) содержит данные parameter запускаемой по расписанию Задачи
Эта команда может использоваться Администраторами Домена, только если они имеют право доступа Модификации RSIP (CanModifyRSIP) для этого Пользователя.
- GETACCOUNTRIGHTS accountName
- Используйте эту команду для получения массива прав доступа к Серверу или Домену, предоставленных указанному пользователю. Эта команда возвращает данные - массив, в котором перечисляются все Права доступа Пользователя к Серверу.
- accountName : строка
- В этом параметре задаётся имя существующего Пользователя. Имя может включать в себя имя Домена.
- GETACCOUNTINFO accountName [Key keyName | ( keyList) ]
- Используйте эту команду для получения словаря с "информацией" о Пользователе. Эта команда возвращает данные (смотрите ниже).
- accountName : строка
- В этом параметре задаётся имя существующего Пользователя. Имя может включать в себя имя Домена (смотрите выше). Вместо имени Пользователя вы также можете указать один символ звёздочка (*). Это будет означать текущего аутентифицированного Пользователя.
- keyList : массив
- Этот необязательный параметр задаёт имена ключей, информацию по которым необходимо получить.
Обратите внимание, что "информационные" данные Пользователя хранятся в словарях в файлах .info, а имена словарей "инфо" элементов начинаются с символа решётка (#). Вы НЕ должны включать символ решётка в параметр keyName команды GETACCOUNTINFO.
Пример:GETACCOUNTINFO "user1@domain1.com" (LastLogin,LastAddress)
Обратите внимание: имена элементов "инфо" зависимы от регистра клавиатуры.
Команда возвращает словарь всех существующих и указанных в массиве keyList элементов "инфо".
- keyName : строка
- Этот необязательный параметр указывает имя запрашиваемого элемента "инфо". Оно может быть указано только в том случае, если параметр keyList не задан.
Обратите внимание, что "информационные" данные Пользователя хранятся в словарях, в файлах .info, а имена словарей "инфо" элементов начинаются с символа решётка. Вы НЕ должны включать символ решётка в параметр keyName команды GETACCOUNTINFO.
Пример:GETACCOUNTINFO "user1@domain1.com" Key LastLogin
Обратите внимание: имена элементов "инфо" зависимы от регистра клавиатуры.
Команда возвращает указанный элемент "инфо". Если элемент не найден, то команда возвращает пустую строку - два знака кавычек подряд ("").
Обратите внимание: Все пользователи могут использовать команду GETACCOUNTINFO для получения элементов из своих собственных объектов "инфо".
- GETACCOUNTPREFS accountName
- Используйте эту команду для получения Настроек Пользователя. Эта команда возвращает словарь, в котором содержатся Настройки Пользователя.
- accountName : строка
- В этом параметре задаётся имя существующего Пользователя. Имя может включать в себя имя Домена (смотрите выше).
Обратите внимание: Любой Пользователь может использовать команду GETACCOUNTPREFS для получения своих Настроек.
- UPDATEACCOUNTPREFS accountName newSettings
- Используйте эту команду для изменения Настроек Пользователя.
- accountName : строка
- В этом параметре задаётся имя существующего Пользователя. Имя может включать в себя имя Домена (смотрите выше).
- newSettings : словарь
- Этот словарь используется для изменения словаря Настроек Пользователя. Он не обязан содержать в себе все Настройки; отсутствующие в словаре настройки просто не будут изменены. Если новое значение Настроек указано как строка default, то значение Настроек удаляется и вместо них используются Настройки, применяемые по умолчанию.
Эта команда может использоваться Администраторами Домена, только если они имеют право доступа Настройки (WebUserSettings).
- SETACCOUNTPREFS accountName newSettings
- Используйте эту команду для задания Настроек Пользователя.
- accountName : строка
- В этом параметре задаётся имя существующего Пользователя. Имя может включать в себя имя Домена (смотрите выше).
- newSettings : словарь
- В этом словаре должны находиться новые Настройки Пользователя. Все старые Настройки Пользователя при этом удаляются.
Эта команда может использоваться Администраторами Домена, только если они имеют право доступа Настройки (WebUserSettings).
- GETACCOUNTEFFECTIVEPREFS accountName
- Используйте эту команду для получения фактических Настроек Пользователя. Эта команда возвращает словарь, в котором содержатся Настройки Пользователя. В этот словарь включаются и явно заданные настройки, и применяемые по умолчанию настройки.
- accountName : строка
- В этом параметре задаётся имя существующего Пользователя. Имя может включать в себя имя Домена (смотрите выше).
Обратите внимание: Все пользователи могут использовать эту команду для получения всех своих фактических Настроек.
- KILLACCOUNTSESSIONS accountName
- Используйте эту команду для прекращения всех сессий Пользователя (POP, IMAP, FTP, WebUser и т.д.).
- accountName : строка
- В этом параметре задаётся имя существующего Пользователя. Имя может включать в себя имя Домена (смотрите выше).
Обратите внимание: Все Администратора Домена могут использовать эту команду.
Следующая команда управляет Правами Доступа Пользователя. Эта команда доступна Пользователю и Администраторам Домена, только если они имеют право доступа Может выступать от имени других (CanImpersonate).
- GETACCOUNTACL accountName [ AUTH authAccountName ]
- Используйте эту команду для получения списка прав доступа (ACL) к Пользователю. Эта команда возвращает словарь, в котором содержатся элементы ACL.
- accountName : строка
- В этом параметре задаётся имя существующего Пользователя (требуемого Пользователя). Символ звёздочка (*) может использоваться для указания текущего аутентифицированного Пользователя.
- authAccountName : строка
- Этот необязательный параметр указывает имя Пользователя, от имени которого должна быть произведена операция. Если это имя задано, то информация ACL возвращается только если указанный Пользователь имеет право доступа Управлять для требуемого Пользователя.
- SETACCOUNTACL accountName [ AUTH authAccountName ] newACL
- Используйте эту команду для изменения списка прав доступа (ACL) Пользователя.
- accountName : строка
- В этом параметре задаётся имя существующего Пользователя (требуемого Пользователя). Символ звёздочка (*) может использоваться для указания текущего аутентифицированного Пользователя.
- authAccountName : строка
- Этот необязательный параметр указывает имя Пользователя, от имени которого должна быть произведена операция. Если это имя задано, то информация ACL изменяется только если указанный Пользователь имеет право доступа Управлять для требуемого Пользователя.
- newACL : словарь
- В этом параметре задаются элементы прав доступа, которые должны быть изменены. Каждый ключ словаря задаёт идентификатор, а значения ключей должны быть строками с символами прав доступа.
Если значение ключа начинается с символа минус ("-"), то права доступа, указанные в этой строке, убираются из элемента прав доступа.
Если значение ключа начинается с символа плюс ("+"), то права доступа, указанные в этой строке, добавляются к элементу прав доступа.
В других случаях, права доступа, указанные в строке, замещают набор прав в элементе прав доступа.
Если элемент права доступа для указанного ключа не существует, то он будет создан.
Если новый элемент права доступа имеет пустой набор прав доступа, то элемент удаляется.
- GETACCOUNTACLRIGHTS accountName AUTH authAccountName
- Эта команда возвращает строку с фактически действующими правами доступа для данного authAccountName.
- accountName : строка
- В этом параметре задаётся имя существующего Пользователя (требуемого Пользователя). Символ звёздочка (*) может использоваться для указания текущего аутентифицированного Пользователя.
- authAccountName : строка
- Этот параметр указывает имя Пользователя, чьи фактические права доступа к требуемому Пользователю должны быть получены.
Следующие команды доступны только Администраторам Системы:
- SETACCOUNTSETTINGS accountName newSettings
- Используйте эту команду для изменения установок Пользователя.
- accountName : строка
- В этом параметре задаётся имя существующего Пользователя.
- newSettings : словарь
- Этот словарь используется для замещения словаря установок Пользователя. Все старые установки Пользователя при этом удаляются.
- GETACCOUNTLOCATION accountName
- Используйте эту команду для получения пути к файловой директории Пользователя (для Пользователей с типом Набор Папок) или получения пути к файлу папки INBOX Пользователя (для пользователей, имеющих только одну папку). Эта команда возвращает строку с путём к файловой директории Пользователя. Путь указывается относительно к файловой директории Домена Пользователя.
- accountName : строка
- В этом параметре задаётся имя существующего Пользователя. Имя может включать в себя имя Домена (смотрите выше).
- GETACCOUNTPRESENCE accountName
- Используйте эту команду для получения статуса присутствия Пользователя. Эта команда возвращает результат:
- массив из двух строк - статус присутствия Пользователя и произвольное сообщение статуса, или
- строка - статус присутствия Пользователя (если произвольное сообщение статуса не задано), или
- нулевой объект - если статус присутствия Пользователя не задан совсем.
- accountName : строка
- В этом параметре задаётся имя существующего Пользователя. Имя может включать в себя имя Домена (смотрите выше).
Элемент AccessMode установок Пользователя и Домена задаёт Включённые Услуги. Значение установки может быть одним из следующих:
- Строка All: включены все услуги.
- Строка None: все услуги выключены.
- Массив строк. В первом элементе массива содержится число или числовая строка, в последующих элементах - имена включённых услуг.
Все услуги с номерами выше числа, указанного в первом элементе массива, тоже включены.
Услуги (с их номерами), поддерживаемые текущими версиями Сервера:
1:Mail, 2:POP, 3:IMAP, 4:WebMail, 5:PWD, 6:Agent, 7:WebSite, 8:Relay, 9:Roaming, 10:FTP, 11:MAPI, 12:TLS, 13:S/MIME, 14:LDAP, 15:WebCAL, 16:RADIUS, 17:SIP, 18:PBX, 19:XMPP, 20:XIMSS, 21:Signal, 22:AirSync, 23:HTTP, 24:MobilePBX, 25:XMedia, 26:YMedia, 27:MobileClient, 28:ClientMail, 29:ClientIM, 30:ClientVoIP
Для использования команд CLI Управления Группами необходимо иметь право доступа к разделу Все Домены Сервера или обладать правами на Управление Доменом.
- LISTGROUPS [ domainName ]
- Используйте эту команду для получения списка всех Групп в Домене. Эта команда возвращает массив, в котором содержатся имена всех Групп в указанном (или взятом по умолчанию) Домене.
- domainName : строка
- Этот необязательный параметр указывает имя Домена. Если имя Домена не указано, то команда применяется к Домену администратора.
- CREATEGROUP groupName [ settings ]
- Используйте эту команду для создания новых Групп.
- groupName : строка
- Этот параметр задаёт имя новой Группы.
Имя может содержать символ @, за которым следует имя Домена; в этом случае Группа создаётся в указанном Домене. Если имя Домена не указано, то команда применяется к Домену администратора.
- settings : словарь
- Этот необязательный параметр задаёт начальные установки Группы и список участников.
Эта команда может использоваться Администраторами Домена, только если они имеют право доступа Может создавать Группы (CanCreateGroups).
- RENAMEGROUP oldGroupName into newGroupName
- Используйте эту команду для переименования Групп.
- oldGroupName : строка
- Этот параметр указывает имя существующей Группы. Имя может включать в себя имя Домена (смотрите выше).
- newGroupName : строка
- В этом параметре задаётся имя новой Группы. Имя может включать в себя имя Домена (смотрите выше).
Эта команда может использоваться Администраторами Домена, только если они имеют право доступа Может создавать Группы (CanCreateGroups).
- DELETEGROUP groupName
- Используйте эту команду для удаления Групп.
- groupName : строка
- Этот параметр указывает имя существующей Группы. Имя может включать в себя имя Домена (смотрите выше).
Эта команда может использоваться Администраторами Домена, только если они имеют право доступа Может создавать Группы (CanCreateGroups).
- GETGROUP groupName
- Используйте эту команду для получения установок групп. Эта команда возвращает словарь, в котором содержатся установки Группы и её члены.
- groupName : строка
- Этот параметр указывает имя существующей Группы. Имя может включать в себя имя Домена (смотрите выше).
- SETGROUP groupName newSettings
- Используйте эту команду для задания установок Группы.
- groupName : строка
- Этот параметр указывает имя существующей Группы. Имя может включать в себя имя Домена (смотрите выше).
- newSettings : словарь
- Этот словарь используется для замещения словаря установок Группы.
Эта команда может использоваться Администраторами Домена, только если они имеют право доступа Может создавать Группы (CanCreateGroups).
Для использования команд CLI управления Переадресаторами необходимо иметь право доступа Все Домены или обладать правами на Управление Доменом.
- LISTFORWARDERS [ domainName ]
- Используйте эту команду для получения списка всех Переадресаторов в Домене. Эта команда возвращает массив, в котором содержатся имена всех Переадресаторов в указанном (или взятом по умолчанию) Домене.
- domainName : строка
- Этот необязательный параметр указывает имя Домена. Если имя Домена не указано, то команда применяется к Домену администратора.
- CREATEFORWARDER forwarderName TO address
- Используйте эту команду для создания нового Переадресатора.
- forwarderName : строка
- Этот параметр задаёт имя нового переадресатора.
Имя может содержать символ @, за которым следует имя Домена; в этом случае Переадресатор создаётся в указанном Домене. Если имя Домена не указано, то команда применяется к Домену администратора.
- address : строка
- В этом параметре задаётся адрес электронной почты, на который Переадресатор должен перенаправлять сообщения и Сигналы.
Эта команда может использоваться Администраторами Домена, только если они имеют право доступа Может создавать Переадресаторы (CanCreateForwarders).
- RENAMEFORWARDER oldForwarderName INTO newForwarderName
- Используйте эту команду для переименования Переадресаторов.
- oldForwarderName : строка
- В этом параметре задаётся имя существующего Переадресатора. Имя может включать в себя имя Домена (смотрите выше).
- newForwarderName : строка
- В этом параметре задаётся имя нового Переадресатора. Имя может включать в себя имя Домена (смотрите выше).
Эта команда может использоваться Администраторами Домена, только если они имеют право доступа Может создавать Переадресаторы (CanCreateForwarders).
- DELETEFORWARDER forwarderName
- Используйте эту команду для удаления Переадресатора.
- forwarderName : строка
- В этом параметре задаётся имя существующего Переадресатора. Имя может включать в себя имя Домена (смотрите выше).
Эта команда может использоваться Администраторами Домена, только если они имеют право доступа Может создавать Переадресаторы (CanCreateForwarders).
- GETFORWARDER forwarderName
- Используйте эту команду для получения адреса Переадресатора. Команда возвращает строку с адресом электронной почты, на который этот Переадресатор перенаправляет сообщения и Сигналы; или словарь, если в настройках Переадресатора больше данных.
- forwarderName : строка
- В этом параметре задаётся имя существующего Переадресатора. Имя может включать в себя имя Домена (смотрите выше).
- UPDATEFORWARDER forwarderName newSettings
- Используйте эту команду для изменения установок Переадресатора.
- forwarderName : строка
- В этом параметре задаётся имя существующего Переадресатора. Имя может включать в себя имя Домена (смотрите выше).
- newSettings : словарь
- Этот словарь используется для замещения словаря установок Переадресатора.
- FINDFORWARDERS domainName TO forwarderAddress
- Используйте эту команду для получения всех Переадресаторов, указывающих на указанный адрес. Эта команда возвращает массив со всеми найденными именами Переадресаторов.
- domainName : строка
- Этот параметр указывает имя Домена.
- forwarderAddress : строка
- Этот параметр задаёт искомый адрес электронной почты.
Для использования команд CLI управления Именованными Задачами необходимо иметь право доступа к разделу Все Домены Сервера или обладать правами на Управление Доменом.
- LISTDOMAINNAMEDTASKS [ domainName ]
- Используйте эту команду для получения списка всех Именованных Задач в Домене. Результатом работы команды является словарь, в котором все ключи - имена Именованных Задач, а значения - словари, содержащие имена владельца задачи, Настоящее Имя задачи и имя Приложения Реального Времени, обслуживающего Именованную Задачу.
- domainName : строка
- Этот необязательный параметр указывает имя Домена. Если имя Домена не указано, то команда применяется к Домену администратора.
- LISTACCOUNTNAMEDTASKS accountName
- Используйте эту команду для получения списка всех Именованных Задач, принадлежащих указанному Пользователю. Эта команда возвращает словарь в том же формате, что и команда LISTDOMAINNAMEDTASKS.
- accountName : строка
- В этом параметре задаётся имя Пользователя - владельца Именованных Задач.
- CREATENAMEDTASK taskName FOR accountName
- Используйте эту команду для создания новых Именованных Задач.
- taskName : строка
- Этот параметр задаёт имя новой Именованной Задачи.
Имя может содержать символ @, за которым следует имя Домена; в этом случае Именованная Задача создаётся в указанном Домене. Если имя Домена не указано, то команда применяется к Домену администратора.
- accountName : строка
- В этом параметре задаётся имя Пользователя - владельца Именованной Задачи. Оно не должно содержать символ @ и имя Домена, поскольку Пользователь может владеть Именованной Задачей только в том же Домене.
Эта команда может использоваться Администраторами Домена, только если они имеют право доступа Создание Именованных Задач (CanCreateNamedTasks).
- RENAMENAMEDTASK oldTaskName into newTaskName
- Используйте эту команду для переименования Именованной Задачи.
- oldTaskName : строка
- В этом параметре задаётся имя существующей Именованной Задачи. Имя может включать в себя имя Домена (смотрите выше).
- newTaskName : строка
- Этот параметр задаёт новое имя Именованной Задачи.
Эта команда может использоваться Администраторами Домена, только если они имеют право доступа Создание Именованных Задач (CanCreateNamedTasks).
- DELETENAMEDTASK taskName
- Используйте эту команду для удаления Именованной Задачи.
- taskName : строка
- В этом параметре задаётся имя существующей Именованной Задачи. Имя может включать в себя имя Домена (смотрите выше).
Эта команда может использоваться Администраторами Домена, только если они имеют право доступа Создание Именованных Задач (CanCreateNamedTasks).
- GETNAMEDTASK taskName
- Используйте эту команду для получения установок Именованной Задачи. Эта команда возвращает словарь с установками Именованной Задачи.
- taskName : строка
- В этом параметре задаётся имя существующей Именованной Задачи. Имя может включать в себя имя Домена (смотрите выше).
- UPDATENAMEDTASK taskName newSettings
- Используйте эту команду для изменения установок Именованной Задачи.
- taskName : строка
- В этом параметре задаётся имя существующей Именованной Задачи. Имя может включать в себя имя Домена (смотрите выше).
- newSettings : словарь
- Данные этого словаря используются для изменения словаря установок Именованной Задачи.
Эта команда может использоваться Администраторами Домена, только если они имеют право доступа Создание Именованных Задач (CanCreateNamedTasks).
Пользователь должен иметь право доступа к Серверу Может Всё, чтобы использовать команды CLI для Управления Правами Доступа на Сервер.
- SETACCOUNTRIGHTS accountName newRights
- Используйте эту команду для задания Прав Доступа к Серверу для Пользователя.
- accountName : строка
- В этом параметре задаётся имя существующего Пользователя. Имя может включать в себя имя Домена.
- newRights : массив
- Этот массив должен содержать коды Прав Доступа. Все старые права доступа Пользователя при этом удаляются.
Для установки прав доступа для Пользователя не из Главного Домена (то есть, для установки Прав на Администрирование Домена) пользователю достаточно иметь только права доступа к разделу Все Домены Сервера.
Для использования команд CLI по администрированию Папок, Пользователь должен быть или владельцем папки, или иметь право Все Домены, или обладать правом доступа Полный доступ ко всем Папкам (CanAccessMailboxes) Администратора Домена.
- LISTMAILBOXES accountName [ FILTER filter ] [ AUTH authAccountName ]
- Используйте эту команду для получения списка Папок Пользователя. Эта команда возвращает словарь.
каждый ключ словаря задаёт имя папки;
Если пользователь authAccountName не указан или указанный пользователь имеет для этой папки право доступа Входить, то значение ключа содержит словарь с информацией о папке;
если указанное authAccountName не имеет права доступа Входить, то значение ключа содержит пустой массив;
если есть "папка" с ключом словаря, но нет "обычной" папки с таким именем, то значением ключа будет пустой массив;
если есть "папка" с ключом словаря, и также существует "обычная" папка с таким именем, то значением ключа будет массив из одного элемента - информация для "обычной" папки (или словарь, или пустой массив).
- accountName : строка
- В этом параметре задаётся имя существующего Пользователя. Символ звёздочка (*) может использоваться для указания текущего аутентифицированного Пользователя.
- filter : строка
- Этот необязательный параметр задаёт фильтр, применяемый к именам Папок Пользователя. В фильтре могут использоваться те же символы шаблона подстановки "*" и "%", что и в команде LIST протокола IMAP. Если фильтр не указан, то считается, что в качестве фильтра задана строка "*" и возвращаются все Папки Пользователя.
- authAccountName : строка
- Этот необязательный параметр указывает имя Пользователя, от имени которого должна быть произведена операция LIST. Если это имя задано, ты выводятся только те имена папок, для которых указанный Пользователь имеет право доступа Видеть.
- CREATEMAILBOX accountName MAILBOX mailboxName [ CLASS mailboxClass ] [ AUTH authAccountName ]
- Используйте эту команду для создания Папки у указанного Пользователя.
- accountName : строка
- В этом параметре задаётся имя существующего Пользователя. Символ звёздочка (*) может использоваться для указания текущего аутентифицированного Пользователя.
- mailboxName : строка
- Этот параметр задаёт имя новой Папки.
- authAccountName : строка
- Этот необязательный параметр указывает имя Пользователя, от имени которого должна быть произведена эта операция.
- mailboxClass : строка
- Этот необязательный параметр задаёт класс новой Папки
- DELETEMAILBOX accountName MAILBOX mailboxName [ AUTH authAccountName ]
DELETEMAILBOX accountName MAILBOXES mailboxName [ AUTH authAccountName ]
- Используйте эту команду для удаления Папки у указанного Пользователя. Если используется ключевое слово MAILBOXES, то все вложенные папки (подпапки) также будут удалены.
- accountName : строка
- В этом параметре задаётся имя существующего Пользователя. Символ звёздочка (*) может использоваться для указания текущего аутентифицированного Пользователя.
- mailboxName : строка
- В этом параметре задаётся имя папки, которая должна быть удалена.
- authaccountname : строка
- Этот необязательный параметр указывает имя Пользователя, от имени которого должна быть произведена операция. Если это имя указано, то папка удаляется, только если указанный Пользователь имеет право доступа Создать для "внешней" папки (это означает, что для того, чтобы удалить папку Archive/March Пользователь должен иметь право доступа Создать для папки Archive), а также указанный Пользователь имеет право Удалить для указанной папки.
- RENAMEMAILBOX accountName MAILBOX mailboxName INTO newMailboxName [ AUTH authAccountName ]
RENAMEMAILBOX accountName MAILBOXES mailboxName INTO newMailboxName [ AUTH authAccountName ]
- Используйте эту команду для переименования папки у указанного Пользователя. Если используется ключевое слово MAILBOXES, то все вложенные папки также будут переименованы.
- accountName : строка
- В этом параметре задаётся имя существующего Пользователя. Символ звёздочка (*) может использоваться для указания текущего аутентифицированного Пользователя.
- mailboxName : строка
- В этом параметре задаётся имя папки, которая должна быть переименована.
- newMailboxName : строка
- Этот параметр задаёт новое имя папки.
- authaccountname : строка
- Этот необязательный параметр указывает имя Пользователя, от имени которого должна быть произведена операция. Если это имя указано, то папка переименовывается, только если указанный Пользователь имеет право выполнять операцию DELETEMAILBOX с оригинальной папкой и операцию CREATEMAILBOX с новой папкой (смотрите выше).
- GETMAILBOXINFO accountName MAILBOX mailboxName [ AUTH authAccountName ]
- Используйте эту команду для получения внутренней информации о Папке Пользователя. Эта команда возвращает словарь, в котором содержится внутренняя информация о папке.
- accountName : строка
- В этом параметре задаётся имя существующего Пользователя. Символ звёздочка (*) может использоваться для указания текущего аутентифицированного Пользователя.
- mailboxName : строка
- В этом параметре задаётся имя существующей у указанного Пользователя папки.
- authaccountname : строка
- Этот необязательный параметр указывает имя Пользователя, от имени которого должна быть произведена операция. Если это имя задано, то информация о папке возвращается, только если указанный Пользователь имеет право доступа к папке Входить.
- GETMAILBOXACL accountName MAILBOX mailboxName [ AUTH authAccountName ]
- Используйте эту команду для получения списка прав доступа к Папке Пользователя. Эта команда возвращает словарь, в котором содержатся элементы прав доступа к папке.
- accountName : строка
- В этом параметре задаётся имя существующего Пользователя. Символ звёздочка (*) может использоваться для указания текущего аутентифицированного Пользователя.
- mailboxName : строка
- В этом параметре задаётся имя существующей у указанного Пользователя папки.
- authaccountname : строка
- Этот необязательный параметр указывает имя Пользователя, от имени которого должна быть произведена операция. Если это имя задано, то информация ACL возвращается, только если указанный Пользователь имеет право доступа к папке Управлять.
- SETMAILBOXACL accountName MAILBOX mailboxName [ AUTH authAccountName ] newACL
- Используйте эту команду для изменения списка прав доступа к Папке Пользователя.
- accountName : строка
- В этом параметре задаётся имя существующего Пользователя. Символ звёздочка (*) может использоваться для указания текущего аутентифицированного Пользователя.
- mailboxName : строка
- В этом параметре задаётся имя существующей у указанного Пользователя папки.
- authaccountname : строка
- Этот необязательный параметр указывает имя Пользователя, от имени которого должна быть произведена операция. Если это имя задано, то информация ACL изменяется, только если указанный Пользователь имеет право доступа к папке Управлять.
- newACL : словарь
- В этом параметре задаются элементы прав доступа, которые должны быть изменены. Каждый ключ словаря задаёт идентификатор, а значения ключей должны быть строками с символами прав доступа.
Если значение ключа начинается с символа минус ("-"), то права доступа, указанные в этой строке, убираются из элемента прав доступа.
Если значение ключа начинается с символа плюс ("+"), то права доступа, указанные в этой строке, добавляются к элементу прав доступа.
В других случаях, права доступа, указанные в строке, замещают набор прав в элементе прав доступа.
Если элемент права доступа для указанного ключа не существует, то он будет создан.
Если новый элемент права доступа имеет пустой набор прав доступа, то элемент удаляется.
- GETMAILBOXRIGHTS accountName MAILBOX mailboxName AUTH authAccountName
- Эта команда возвращает строку с фактически действующими правами доступа к папке для данного authAccountName.
- accountName : строка
- В этом параметре задаётся имя существующего Пользователя. Символ звёздочка (*) может использоваться для указания текущего аутентифицированного Пользователя.
- mailboxName : строка
- В этом параметре задаётся имя существующей у указанного Пользователя папки.
- authaccountname : строка
- Этот опциональный параметр указывает имя Пользователя, чьи фактические права доступа к папке должны быть получены.
- SETMAILBOXCLASS accountName MAILBOX mailboxName [ AUTH authAccountName ] CLASS newClass
- Используйте эту команду для задания "класса" папки Пользователя.
- accountName : строка
- В этом параметре задаётся имя существующего Пользователя. Символ звёздочка (*) может использоваться для указания текущего аутентифицированного Пользователя.
- mailboxName : строка
- В этом параметре задаётся имя существующей у указанного Пользователя папки.
- authaccountname : строка
- Этот опциональный параметр указывает имя Пользователя, чьи права доступа к папке должны быть использованы.
- newClass : строка
- Класс папки.
- GETMAILBOXSUBSCRIPTION accountName
- Эта команда возвращает массив, в котором содержится список "подписанных папок" Пользователя.
- accountName : строка
- В этом параметре задаётся имя существующего Пользователя. Символ звёздочка (*) может использоваться для указания текущего аутентифицированного Пользователя.
- SETMAILBOXSUBSCRIPTION accountName newSubscription
- Используйте эту команду для задания списка "подписанных папок" Пользователя.
- accountName : строка
- В этом параметре задаётся имя существующего Пользователя. Символ звёздочка (*) может использоваться для указания текущего аутентифицированного Пользователя.
- newSubscription : массив
- Список "подписанных папок". Каждый элемент массива должен быть строкой с именем папки.
- GETMAILBOXALIASES accountName
- Эта команда возвращает словарь. Каждый ключ словаря является именем псевдонима существующей папки, а значение ключа является строкой с именем папки, на которую указывает этот псевдоним.
- accountName : строка
- В этом параметре задаётся имя существующего Пользователя. Символ звёздочка (*) может использоваться для указания текущего аутентифицированного Пользователя.
- SETMAILBOXALIASES accountName newAliases
- Используйте эту команду для задания Псевдонимов Папок Пользователя.
- accountName : строка
- В этом параметре задаётся имя существующего Пользователя. Символ звёздочка (*) может использоваться для указания текущего аутентифицированного Пользователя.
- newAliases : словарь
- Набор новых псевдонимов папок.
Пользователь должен иметь право доступа к разделу Все Домены Интерфейса Администратора Сервера или право доступа Может публиковать Предупреждения в Управлении Доменом для использования команд CLI для управления Предупреждениями.
- GETDOMAINALERTS [ domainName ]
- Используйте эту команду для получения Предупреждений Домена. Эта команда возвращает словарь, в котором содержатся строки с предупреждениями и отметки времени.
- domainName : строка
- Этот необязательный параметр указывает имя существующего Домена.
- SETDOMAINALERTS [ domainName ] newAlerts
- Используйте эту команду для изменения предупреждений Домена.
- domainName : строка
- Этот необязательный параметр указывает имя существующего Домена.
- newAlerts : словарь
- Этот словарь используется для замещения словаря предупреждений Домена. Все старые предупреждения Домена при этом удаляются.
- POSTDOMAINALERT domainName ALERT newAlert
- Используйте эту команду для публикации общедоменного предупреждения.
- domainName : строка
- В этом параметре задаётся имя существующего Домена.
- newAlert : строка
- В этой строке указывается текст предупреждения.
- REMOVEDOMAINALERT domainName ALERT timeStamp
- Используйте эту команду для удаления общедоменного предупреждения.
- domainName : строка
- В этом параметре задаётся имя существующего Домена.
- timeStamp : строка
- В этой строке указывается отметка времени Предупреждения, которое должно быть удалено.
- GETACCOUNTALERTS accountName
- Используйте эту команду для получения Предупреждений Пользователя. Эта команда возвращает словарь, в котором содержатся строки с предупреждениями Пользователю и отметки времени.
- accountName : строка
- В этом параметре задаётся имя существующего Пользователя. Символ звёздочка (*) может использоваться для указания текущего аутентифицированного Пользователя.
- SETACCOUNTALERTS accountName newAlerts
- Используйте эту команду для изменения предупреждений Пользователя.
- accountName : строка
- В этом параметре задаётся имя существующего Пользователя. Символ звёздочка (*) может использоваться для указания текущего аутентифицированного Пользователя.
- newAlerts : словарь
- Этот словарь используется для замещения словаря предупреждений Пользователя. Все старые предупреждения Пользователя при этом удаляются.
- POSTACCOUNTALERT accountName ALERT newAlert
- Используйте эту команду для публикации предупреждения Пользователю.
- accountName : строка
- В этом параметре задаётся имя существующего Пользователя. Символ звёздочка (*) может использоваться для указания текущего аутентифицированного Пользователя.
- newAlert : строка
- В этой строке указывается текст предупреждения.
- REMOVEACCOUNTALERT accountName ALERT timeStamp
- Используйте эту команду для удаления предупреждения Пользователю.
- accountName : строка
- В этом параметре задаётся имя существующего Пользователя. Символ звёздочка (*) может использоваться для указания текущего аутентифицированного Пользователя.
- timeStamp : строка
- В этой строке указывается отметка времени Предупреждения, которое должно быть удалено.
Следующие команды доступны только Администраторам Системы:
- GETSERVERALERTS
- Используйте эту команду для получения списка общесерверных Предупреждений. Эта команда возвращает словарь, в котором содержатся строки с предупреждениями сервера и отметки времени.
- SETSERVERALERTS newAlerts
- Используйте эту команду для изменения общесерверных Предупреждений.
- newAlerts : словарь
- Этот словарь используется для замещения общесерверного словаря предупреждений. Все старые общесерверные предупреждения при этом удаляются.
- POSTSERVERALERT newAlert
- Используйте эту команду для публикации общесерверного Предупреждения.
- newAlert : строка
- В этой строке указывается текст предупреждения.
- REMOVESERVERALERT timeStamp
- Используйте эту команду для удаления общесерверного предупреждения.
- timeStamp : строка
- В этой строке указывается отметка времени Предупреждения, которое должно быть удалено.
- GETCLUSTERALERTS
SETCLUSTERALERTS newAlerts
POSTCLUSTERALERT newAlert
REMOVECLUSTERALERT timeStamp
- Эти команды доступны только в Динамическом Кластере.
Используйте эти команды вместо команд [GET|SET|POST|REMOVE]SERVERALERT[S] для работы с общекластерными Предупреждениями.
Следующие команды позволяют аутентифицированному пользователю работать с файлами в Хранилище Файлов Пользователя. Для доступа к Хранилищу Файлов:
- аутентифицированный пользователь должен быть владельцем хранилища, или
- у аутентифицированного пользователя должно быть право доступа к разделу Все Домены интерфейса Администратора Сервера или право Доступ к Хранилищам Файлов (CanAccessWebSites) Администратора Домена, или
- аутентифицированному пользователю должны быть даны Права Доступа к Файлам для указанных файлов иди директорий (только если не указан параметр AUTH)
Если имя файла заканчивается символом косая черта (/), то оно обозначает имя файловой директории.
- READSTORAGEFILE accountName FILE fileName [ OFFSET position ] [ SIZE sliceSize ] [ AUTH authAccountName ]
- Используйте эту команду для получения файла из Хранилища Файлов Пользователя. Эта команда возвращает массив из трёх элементов. Первым элементом массива является блок данных с содержанием указанного файла, вторым элементом массива является отметка времени модификации файла и третьим элементом массива является текущий размер файла.
- accountName : строка
- В этом параметре задаётся имя существующего Пользователя. Символ звёздочка (*) может использоваться для указания текущего аутентифицированного Пользователя.
- fileName : строка
- Этот параметр задаёт имя файла, которое необходимо получить из Хранилища Файлов.
- position : число
- Если задан этот параметр, то файл в Хранилище Файлов читается, начиная с указанной позиции в файле.
- sliceSize : число
- Если задан этот параметр, то будет прочитано не более чем указанное число байт данных файла.
- authAccountName : строка
- Этот необязательный параметр указывает имя Пользователя, от имени которого должна быть произведена операция.
- WRITESTORAGEFILE accountName FILE fileName [ OFFSET position ] [ AUTH authAccountName ] DATA fileData
- Используйте эту команду для сохранения файла в Хранилище Файлов Пользователя.
Если в Хранилище Файлов файл с указанным именем уже существует, то старый файл удаляется.
Если fileName указывает на директорию (оканчивается символом косая черта /), то команда создаёт директорию. В этом случае, часть OFFSET position должна отсутствовать, а параметр fileData должен быть пустым блоком данных.
- accountName : строка
- В этом параметре задаётся имя существующего Пользователя. Символ звёздочка (*) может использоваться для указания текущего аутентифицированного Пользователя.
- fileName : строка
- Этот параметр задаёт имя файла в Хранилище Файлов.
- position : смещение
- Если этот параметр отсутствует или его значение равно нулю, то существующий файл (если он есть) сначала удаляется, а затем создаётся новый.
Если этот параметр - неравное нулю число, то его значение должно быть положительным; файл в Хранилище Файлов перезаписывается/дополняется, начиная с указанной позиции в файле. Файл должен существовать, и указанная позиция не должна быть больше, чем текущий размер файла.
Если этот параметр имеет значение BEG, то файл уже должен существовать; файл перезаписывается с начала, но его старые данные, находящиеся за пределами данных в fileData, не удаляются.
Если эта опция имеет значение END, то данные fileData добавляются к концу файла. Если файл не существует, то он создаётся.
Если эта опция имеет значение NEW, то файл не должен существовать; новый файл создаётся и данные из fileData записываются в него.
- authAccountName : строка
- Этот необязательный параметр указывает имя Пользователя, от имени которого должна быть произведена операция.
- fileData : блок данных
- В этом параметре содержатся данные файла.
- RENAMESTORAGEFILE accountName FILE oldFileName INTO newFileName [ AUTH authAccountName ]
- Используйте эту команду для переименования файла или файловой директории в Хранилище Файлов Пользователя.
- accountName : строка
- В этом параметре задаётся имя существующего Пользователя. Символ звёздочка (*) может использоваться для указания текущего аутентифицированного Пользователя.
- oldFileName : строка
- В этом параметре задаётся имя существующего файла или файловой директории в Хранилище Файлов.
- newFileName : строка
- Этот параметр задаёт новое имя файла или файловой директории в Хранилище Файлов.
- authAccountName : строка
- Этот необязательный параметр указывает имя Пользователя, от имени которого должна быть произведена операция.
- DELETESTORAGEFILE accountName FILE fileName [ AUTH authAccountName ]
- Используйте эту команду для удаления файла или файловой директории из Хранилища Файлов Пользователя.
- accountName : строка
- В этом параметре задаётся имя существующего Пользователя. Символ звёздочка (*) может использоваться для указания текущего аутентифицированного Пользователя.
- fileName : строка
- В этом параметре задаётся имя существующего файла или файловой директории в Хранилище Файлов.
- authAccountName : строка
- Этот необязательный параметр указывает имя Пользователя, от имени которого должна быть произведена операция.
- LISTSTORAGEFILES accountName [ PATH filePath ] [ AUTH authAccountName ]
- Используйте эту команду для получения списка всех файлов в верхней директории Хранилища Файлов или в одной из его поддиректорий. Эта команда возвращает словарь, где каждый ключ является именем файла из Хранилища Файлов, а значением ключа является словарь для обычного файла и пустой массив для поддиректорий.
- accountName : строка
- В этом параметре задаётся имя существующего Пользователя. Символ звёздочка (*) может использоваться для указания текущего аутентифицированного Пользователя.
- filePath : строка
- Этот необязательный параметр указывает имя поддиректории в Хранилище Файлов. Вы можете опустить этот параметр вместе с ключевым словом PATH, в этом случае команда возвращает список файлов в верхней директории Хранилища Файлов.
- authAccountName : строка
- Этот необязательный параметр указывает имя Пользователя, от имени которого должна быть произведена операция.
- GETSTORAGEFILEINFO accountName [ PATH filePath ] [ AUTH authAccountName ]
- Используйте эту команду для получения статистической информации обо всех файлах, находящихся в Хранилище Файлов Пользователя. Эта команда возвращает массив с двумя числовыми элементами. Первый элемент содержит общий размер всех файлов, находящихся в Хранилище Файлов, а второй элемент содержит число файлов, находящихся в Хранилище Файлов.
- accountName : строка
- В этом параметре задаётся имя существующего Пользователя. Символ звёздочка (*) может использоваться для указания текущего аутентифицированного Пользователя.
- authAccountName : строка
- Этот необязательный параметр указывает имя Пользователя, от имени которого должна быть произведена операция.
- READSTORAGEFILEATTR accountName FILE fileName [ attributes ] [ AUTH authAccountName ]
- Эта функция читает атрибуты файла или директории fileName в Хранилище Файлов Пользователя. Эта команда возвращает массив из элементов XML с атрибутами файла или файловой директории.
- accountName : строка
- В этом параметре задаётся имя существующего Пользователя. Символ звёздочка (*) может использоваться для указания текущего аутентифицированного Пользователя.
- fileName : строка
- В этом параметре задаётся имя существующего файла или файловой директории в Хранилище Файлов.
- attributes : массив
- Необязательный параметр с массивом строк. Если указан, то только читаются значения только атрибутов с именами из этого массива.
- authAccountName : строка
- Этот необязательный параметр указывает имя Пользователя, от имени которого должна быть произведена операция.
- UPDATESTORAGEFILEATTR accountName FILE fileName attributes [ AUTH authAccountName ]
- Эта функция читает атрибуты файла или директории fileName в Хранилище Файлов Пользователя.
- accountName : строка
- В этом параметре задаётся имя существующего Пользователя. Символ звёздочка (*) может использоваться для указания текущего аутентифицированного Пользователя.
- fileName : строка
- В этом параметре задаётся имя существующего файла или файловой директории в Хранилище Файлов.
- attributes : массив
- Параметр задаёт массив элементов XML - новых значений атрибутов.
- authAccountName : строка
- Этот необязательный параметр указывает имя Пользователя, от имени которого должна быть произведена операция.
- GETFILESUBSCRIPTION accountName
- Эта команда возвращает массив со списком "подписанных папок" Пользователя.
- accountName : строка
- В этом параметре задаётся имя существующего Пользователя. Символ звёздочка (*) может использоваться для указания текущего аутентифицированного Пользователя.
- SETFILESUBSCRIPTION accountName newSubscription
- Используйте эту команду для задания списка "подписанных папок" Пользователя.
- accountName : строка
- В этом параметре задаётся имя существующего Пользователя. Символ звёздочка (*) может использоваться для указания текущего аутентифицированного Пользователя.
- newSubscription : массив
- Список "подписанных папок". Каждый элемент массива должен быть строкой с именем папки.
Для использования команд CLI Управления Списками Рассылки необходимо иметь право доступа к разделу Все Домены Интерфейса Администратора Сервера или обладать правами для Управления Доменом.
- LISTLISTS [ domainName ]
- Используйте эту команду для получения списка Списков Рассылки Домена. Эта команда возвращает массив строк. Каждая строка является именем списка рассылки в указанном (или в выбранном по умолчанию) Домене.
- domainName : строка
- Этот необязательный параметр указывает имя Домена.
- GETDOMAINLISTS [ domainName ]
- Используйте эту команду для получения списка Списков Рассылки Домена. Эта команда возвращает словарь. Каждый ключ словаря является именем списка рассылки в указанном (или в выбранном по умолчанию) Домене. Значением ключа является числовая строка с фактическим числом подписчиков списка ("-1", если текущее число подписчиков списка неизвестно).
- domainName : строка
- Этот необязательный параметр указывает имя Домена.
- GETACCOUNTLISTS accountName
- Используйте эту команду для получения списка всех списков рассылки, принадлежащих указанному Пользователю. Эта команда возвращает словарь. Каждый ключ словаря является именем списка рассылки, принадлежащего указанному (или выбранному по умолчанию) Пользователю. Значением ключа является числовая строка с фактическим числом подписчиков списка ("-1", если текущее число подписчиков списка неизвестно).
- accountName : строка
- В этом параметре задаётся имя Пользователя - владельца списка.
- CREATELIST listName for accountName
- Используйте эту команду для создания списка рассылки.
- listName : строка
- В этом параметре задаётся имя создаваемого списка рассылки. Он может включать в себя имя Домена. Если имя Домена не указано, то по умолчанию используется Домен пользователя.
- accountName : строка
- В этом параметре задаётся имя владельца списка рассылки (без имени Домена). Оно должно быть именем уже существующего Пользователя из Домена списка рассылки.
Эта команда может использоваться Администраторами Домена, только если у них есть право доступа "Может создавать Списки Рассылки (CanCreateLists)".
- RENAMELIST listName into newName
- Используйте эту команду для переименования списка рассылки.
- listName : строка
- В этом параметре задаётся имя существующего списка рассылки. Он может включать в себя имя Домена. Если имя Домена не указано, то по умолчанию используется Домен пользователя.
- newName : строка
- Этот параметр задаёт новое имя списка рассылки (без доменной части).
Эта команда может использоваться Администраторами Домена, только если у них есть право доступа "Может создавать Списки Рассылки (CanCreateLists)".
- DELETELIST listName
- Используйте эту команду для удаления списка рассылки.
- listName : строка
- В этом параметре задаётся имя существующего списка рассылки. Он может включать в себя имя Домена. Если имя Домена не указано, то по умолчанию используется Домен пользователя.
Эта команда может использоваться Администраторами Домена, только если у них есть право доступа "Может создавать Списки Рассылки (CanCreateLists)".
Следующие команды могут использоваться владельцем списка рассылки, Администратором Домена с правом доступа "Полный доступ ко всем Спискам (CanAccessLists )" или Администратором Сервера с правами Все Домены.
- GETLIST listName
- Используйте эту команду для получения установок списка. Эта команда возвращает словарь, в котором содержатся установки списка listName.
- listName : строка
- В этом параметре задаётся имя существующего списка рассылки. Он может включать в себя имя Домена. Если имя Домена не указано, то по умолчанию используется Домен пользователя.
- UPDATELIST listName newSettings
- Используйте эту команду для изменения установок списка.
- listName : строка
- В этом параметре задаётся имя существующего списка рассылки. Он может включать в себя имя Домена. Если имя Домена не указано, то по умолчанию используется Домен пользователя.
- newSettings : словарь
- Этот словарь используется для изменения словаря установок списка рассылки. Он не обязан содержать в себе все установки; отсутствующие в словаре установки просто не будут изменены.
- LIST listName operation [silently] [confirm] subscriber
- Используйте эту команду для изменения списка подписчиков.
- listName : строка
- В этом параметре задаётся имя существующего списка рассылки. Он может включать в себя имя Домена. Если имя Домена не указано, то по умолчанию используется Домен пользователя.
- operation : subscribe | feed | digest | index | null | banned | unsubscribe
- Этот параметр задаёт операцию (дополнительную информацию смотрите в разделе модуль LIST).
- silently
- Этот необязательный параметр указывает серверу не отправлять подписчику Приветственное/Прощальное Письмо.
- confirm
- Этот необязательный параметр указывает серверу не отправлять подписчику запрос на подтверждение.
- subscriber : адрес E-mail
- Адрес подписчика. Он может включать в себя комментарий, используемый как настоящее имя подписчика.
Пример:LIST MyList@mydomain.com FEED confirm "Bill Jones" <BJones@company.com>
- LISTSUBSCRIBERS listName [ FILTER filter [ limit ] ]
- Используйте эту команду для получения списка подписчиков. Эта команда возвращает массив с адресами электронной почты подписчиков.
- listName : строка
- В этом параметре задаётся имя существующего списка рассылки. Он может включать в себя имя Домена. Если имя Домена не указано, то по умолчанию используется Домен пользователя.
- filter : строка
- Если этот необязательный параметр указан, то возвращаются только адреса, в которых содержится указанная строка.
- limit : число
- Этот необязательный параметр ограничивает число возвращаемых адресов подписчиков.
- READSUBSCRIBERS listName [ FILTER filter [ limit ] ]
- Используйте эту команду для получения списка подписчиков. Эта команда возвращает массив, первый элемент которого - полное число подписчиков списка, а второй элемент - массив словарей, описывающих подписчиков.
- listName : строка
- В этом параметре задаётся имя существующего списка рассылки. Он может включать в себя имя Домена. Если имя Домена не указано, то по умолчанию используется Домен пользователя.
- filter : строка
- Если этот необязательный параметр указан, то возвращаются только подписчики, в адресах которых содержится указанная строка.
- limit : число
- Этот необязательный параметр ограничивает число возвращаемых описателей подписчиков.
Словарь, описывающий подписчика, состоит из следующих элементов:
- Sub
- Строка с адресом электронной почты
- RealName
- необязательная строка с Настоящим Именем
- mode
- срока с режимом подписки (index, digest, null и т.д.)
- subscribeTime
- отметка времени подписки пользователя.
- posts
- число публикаций в этом списке
- lastBounceTime
- необязательная отметка времени последней ошибки при отправке сообщения этому пользователю.
- bounces
- необязательное число уведомлений об ошибках доставки сообщения этому подписчику.
- GETSUBSCRIBERINFO listName NAME subscriberAddress
- Используйте эту команду для получения информации о подписчике списка. Эта команда возвращает словарь с информацией о подписчике.
- listName : строка
- В этом параметре задаётся имя существующего списка рассылки. Оно может включать в себя имя Домена. Если имя Домена не указано, то по умолчанию используется Домен пользователя.
- subscriberAddress : строка
- В этом параметре задаётся адрес электронной почты подписчика списка.
Если подписчик не существует, то возвращается пустой словарь. В противном случае словарь содержит следующие элементы:
- mode
- Эта строка определяет режим подписки (digest, index и т.д.) Этот элемент равен unsubcribe, если подписка для адреса была отменена, но адрес ещё не был удалён из списка. Этот элемент равен subscribe, если пользователь начал процесс подписки, но подписка не была подтверждена.
- confirmationID
- В этом элементе содержится строка с Идентификатором Подтверждения для Пользователя.
- timeSubscribed
- Эта строка указывает время подписки адреса (в формате даты/времени ACAP).
- posts
- Этот элемент может содержать строки special, moderateAll, prohibited или строку с числом сообщений, опубликованных с этого адреса. Если следующая публикация с этого адреса должна модерироваться, то элемент содержит массив одностроковых элементов, содержащих число модерируемых публикаций.
- bounces
- Эта необязательная строка содержит число ошибок, полученных при отправке сообщений на этот адрес.
- lastBounced
- Эта необязательная строка указывает время последней ошибки, связанной с этим адресом. Время указано в формате ACAP.
- RealName
- Эта необязательная строка содержит настоящее имя подписчика.
- SETPOSTINGMODE listName FOR subscriberAddress [ UNMODERATED | MODERATEALL | PROHIBITED | SPECIAL | numberOfModerated ]
- Используйте эту команду для задания режима публикации для указанного подписчика.
- listName : строка
- В этом параметре задаётся имя существующего списка рассылки. Оно может включать в себя имя Домена. Если имя Домена не указано, то по умолчанию используется Домен пользователя.
- subscriberAddress : строка
- В этом параметре задаётся адрес электронной почты подписчика списка.
- postingMode : число
- Этот необязательный параметр ограничивает число возвращаемых адресов подписчиков.
Эта команда задаёт для указанного подписчика режим публикации. Если указано numberOfModerated (число), то режим публикации задаёт необходимость модерирования первых numberOfModerated сообщений от этого подписчика.
- PROCESSBOUNCE listName [ FATAL ] FOR subscriberAddress
- Используйте эту команду для выполнения действий, выполняемых Менеджером Списка при получении ошибки от адреса подписчика.
- listName : строка
- В этом параметре задаётся имя существующего списка рассылки. Оно может включать в себя имя Домена. Если имя Домена не указано, то по умолчанию используется Домен пользователя.
- subscriberAddress : строка
- В этом параметре задаётся адрес электронной почты подписчика списка.
Используйте ключевое слово FATAL для имитации "фатальной" ошибки. В противном случае команда будет имитировать нефатальную ошибку.
Следующие команды могут использоваться для управления Видом Интерфейса Веб Интерфейса Пользователя CommuniGate Pro.
Чтобы иметь возможность изменения Видов Интефейса Домена, у пользователя должно быть право доступа Все Домены или право доступа Может модифицировать Виды Интерфейса (CanModifySkins) Администратора Домена.
- LISTDOMAINSKINS [ domainName ]
- Используйте эту команду для получения списка пользовательских Видов Интерфейса Домена. Эта команда возвращает массив с именами Видов Интерфейса.
- domainName : строка
- Этот необязательный параметр указывает имя Домена. Если имя Домена не указано, то команда применяется к Домену администратора.
- CREATEDOMAINSKIN [ domainName SKIN ] skinName
- Используйте эту команду для создания пользовательского Вида Интерфейса Домена.
- domainName : строка
- Этот необязательный параметр указывает имя Домена. Если имя Домена не указано, то команда применяется к Домену администратора. Если оно указано, то за ним должно следовать ключевое слово SKIN.
- skinName : строка
- В этом параметре задаётся имя нового Вида Интерфейса.
Для того, чтобы создать Безымянный Вид Интерфейса Домена, в параметре skinName укажите пустую строку.
Именованный Вид Интерфейса Домена может быть создан только если Безымянный Вид Интерфейса уже существует.
- RENAMEDOMAINSKIN [ domainName SKIN ] skinName INTO newSkinName
- Используйте эту команду для переименования пользовательского именованного Вида Интерфейса Домена.
- domainName : строка
- Этот необязательный параметр указывает имя Домена. Если имя Домена не указано, то команда применяется к Домену администратора. Если оно указано, то за ним должно следовать ключевое слово SKIN.
- skinName : строка
- В этом параметре задаётся имя существующего именованного Вида Интерфейса Домена.
- newSkinName : строка
- Этот параметр задаёт новое имя Вида Интерфейса.
- DELETEDOMAINSKIN [ domainName SKIN ] skinName
- Используйте эту команду для удаления пользовательского Вида Интерфейса Домена.
- domainName : строка
- Этот необязательный параметр указывает имя Домена. Если имя Домена не указано, то команда применяется к Домену администратора. Если оно указано, то за ним должно следовать ключевое слово SKIN.
- skinName : строка
- В этом параметре задаётся имя Вида Интерфейса, который должен быть удалён.
Для удаления именованного Вида Интерфейса Домена в значении параметра skinName укажите пустую строку.
Безымянный Вид Интерфейса Домена может быть удалён, только если в Домене не осталось именованных Видов Интерфейса.
- LISTDOMAINSKINFILES [ domainName SKIN] skinName
- Используйте эту команду для получения списков файлов из Пользовательского Вида Интерфейса Домена. Эта команда возвращает словарь, в ключах которого содержатся имена файлов Вида Интерфейса. Значением элементов словаря являются словари с атрибутами файлов.
- domainName : строка
- Этот необязательный параметр указывает имя Домена. Если имя Домена не указано, то команда применяется к Домену администратора. Если оно указано, то за ним должно следовать ключевое слово SKIN.
- skinName : строка
- В этом параметре задаётся имя существующего Вида Интерфейса Домена.
- READDOMAINSKINFILE [ domainName SKIN ] skinName FILE fileName
- Используйте эту команду для чтения файла из пользовательского Вида Интерфейса Домена. Эта команда возвращает массив. Первым элементом массива является блок данных с содержанием файла Вида Интерфейса, вторым элементом массива является отметка времени с датой изменения файла.
- domainName : строка
- Этот необязательный параметр указывает имя Домена. Если имя Домена не указано, то команда применяется к Домену администратора. Если оно указано, то за ним должно следовать ключевое слово SKIN.
- skinName : строка
- В этом параметре задаётся имя существующего Вида Интерфейса Домена.
- fileName : строка
- В этом параметре задаётся имя существующего файла указанного Вида Интерфейса Домена.
- STOREDOMAINSKINFILE [ domainName SKIN ] skinName FILE fileName DATA fileContent
STOREDOMAINSKINFILE [ domainName SKIN ] skinName FILE fileName DELETE
- Используйте эту команду для сохранения файла в пользовательском Виде Интерфейса Домена или для удаления файла из пользовательского Вида Интерфейса Домена.
- domainName : строка
- Этот необязательный параметр указывает имя Домена. Если имя Домена не указано, то команда применяется к Домену администратора. Если оно указано, то за ним должно следовать ключевое слово SKIN.
- skinName : строка
- В этом параметре задаётся имя существующего Вида Интерфейса Домена.
- fileName : строка
- В этом параметре задаётся имя файла Вида Интерфейса.
- fileContent : блок данных
- В этом блоке данных находится содержимое файла. Этот параметр указывается, только если используется ключевое слово DATA.
Если указано ключевое слово DATA и Вид Интерфейса содержит файл с тем же именем, то старый файл удаляется. Файл с указанным именем удаляется из Кэша (в Динамическом Кластере файл удаляется из Кэша всех членов Кластера).
Следующие команды доступны только Администраторам Системы:
- LISTSERVERSKINS
- Используйте эту команду для получения списка пользовательских Видов Интерфейса Сервера. Эта команда возвращает массив с именами Видов Интерфейса.
- CREATESERVERSKIN skinName
- Используйте эту команду для создания пользовательского Вида Интерфейса Сервера.
- skinName : строка
- В этом параметре задаётся имя нового Вида Интерфейса.
- RENAMESERVERSKIN skinName INTO newSkinName
- Используйте эту команду для переименования пользовательского Вида Интерфейса Сервера.
- skinName : строка
- Этот параметр указывает имя существующего Вида Интерфейса.
- newSkinName : строка
- Этот параметр задаёт новое имя Вида Интерфейса.
- DELETESERVERSKIN skinName
- Используйте эту команду для удаления пользовательского Вида Интерфейса Сервера.
- skinName : строка
- В этом параметре задаётся имя Вида Интерфейса, который должен быть удалён.
- LISTSERVERSKINFILES skinName
- Используйте эту команду для получения списка файлов из пользовательского Вида Интерфейса Сервера. Эта команда возвращает словарь, в ключах которого содержатся имена файлов Вида Интерфейса. Значением элементов словаря являются словари с атрибутами файлов.
- skinName : строка
- В этом параметре задаётся имя существующего Вида Интерфейса Сервера.
- READSERVERSKINFILE skinName FILE fileName
- Используйте эту команду для чтения файла из пользовательского Вида Интерфейса Сервера. Эта команда возвращает массив. Первым элементом массива является блок данных с содержанием файла Вида Интерфейса, вторым элементом массива является отметка времени с датой изменения файла.
- skinName : строка
- В этом параметре задаётся имя существующего Вида Интерфейса Сервера.
- fileName : строка
- В этом параметре задаётся имя существующего файла указанного Вида Интерфейса Сервера.
- STORESERVERSKINFILE skinName FILE fileName DATA fileContent
STORESERVERSKINFILE skinName FILE fileName DELETE
- Используйте эту команду для сохранения файла в пользовательском Виде Интерфейса Сервера или для удаления файла из пользовательского Вида Интерфейса Сервера.
- skinName : строка
- В этом параметре задаётся имя существующего Вида Интерфейса Сервера.
- fileName : строка
- В этом параметре задаётся имя файла Вида Интерфейса.
- fileContent : блок данных
- В этом блоке данных находится содержимое файла. Этот параметр указывается, только если используется ключевое слово DATA.
Если указано ключевое слово DATA и Вид Интерфейса содержит файл с тем же именем, то старый файл удаляется. Файл с указанным именем удаляется из Кэша (в Динамическом Кластере файл удаляется из Кэша всех членов Кластера).
- LISTCLUSTERSKINS
CREATECLUSTERSKIN skinName
RENAMECLUSTERSKIN skinName INTO newSkinName
DELETECLUSTERSKIN skinName
- Эти команды доступны только в Динамическом Кластере.
Используйте эти команды вместо команд [LIST|CREATE|RENAME|DELETE]SERVERSKIN[S] для работы с общекластерными Видами Интерфейса.
- LISTCLUSTERSKINFILES skinName
READCLUSTERSKINFILE skinName FILE fileName
STORECLUSTERSKINFILE skinName FILE fileName DATA fileContent
STORECLUSTERSKINFILE skinName FILE fileName DELETE
- Эти команды доступны только в Динамическом Кластере.
Используйте эти команды вместо команд [LIST|READ|STORE]SERVERSKINFILE[S] для работы с общекластерными Видами Интерфейса.
- LISTSTOCKSKINFILES skinName
READSTOCKSKINFILE skinName FILE fileName
- Используйте эти команды вместо команд [LIST|READ]SERVERSKINFILE[S] для работы со встроенными Видами Интерфейса.
Следующие команды могут использоваться для интеграции Веб Интерфейса Пользователя CommuniGate Pro с приложениями сторонних производителей.
- CREATEWEBUSERSESSION accountName ADDRESS ip-address [ FOR orig-address ] [ SKIN skinName ]
- Используйте эту команду для создания сессии WebUser для указанного Пользователя. Эта команда возвращает строку с идентификатором сессии WebUser. Эта строка может быть использована для создания URL, который позволит браузеру клиента "войти" в Сессию WebUser. Этот URL может иметь следующий формат:
http://cgateproserver:port/Session/rrrrrrrrrrrr/Mailboxes.wssp где rrrrrrrrrrrr является возвращённой строкой с идентификатором сессии.
- accountName : строка
- В этом параметре задаётся имя Пользователя.
- ip-address : строка или адрес IP
- В этом параметре задаётся адрес IP браузера клиента.
Если у Пользователя включена Установка "Фиксированный IP", то запросы в рамках сессии будут разрешены только с этого IP адреса.
- orig-address : строка
- В этом параметре задаётся оригинальный адрес IP браузера клиента в случае, если клиент соединяется через прокси. Параметр ip-address указывает IP адрес прокси.
Если у Пользователя включена Установка "Фиксированный IP", то соединения в рамках сессии будут разрешены только с IP адреса прокси и только с оригинального IP адреса (переданного с прокси в заголовке HTTP X-FORWARDED-FOR).
- skinName : строка
- Этот необязательный параметр указывает Вид Интерфейса, используемый для вновь создаваемой сессии.
Для создания сессий WebUser аутентифицированный пользователь должен иметь право Все Домены или обладать правом доступа Может создавать WebUser сессии (CanCreateWebUserSessions) Администратора Домена.
- CREATEXIMSSSESSION accountName ADDRESS ip-address [ FOR orig-address ]
- Используйте эту команду для создания сессии XIMSS для указанного Пользователя. Эта команда возвращает строку с идентификатором Сессии XIMSS. Эта строка может быть использована для создания URL, который позволит браузеру клиента работать с Сессией XIMSS используя протокол HTTP.
- accountName : строка
- В этом параметре задаётся имя Пользователя.
- ip-address : строка
- orig-address : строка
- Эти параметры имеют тот же смысл, что и для команды CREATEWEBUSERSESSION.
Для создания сессий XIMSS аутентифицированный пользователь должен иметь право Все Домены или обладать правом доступа Может создавать WebUser сессии (CanCreateWebUserSessions) Администратора Домена.
- CREATELITESESSION ADDRESS ip-address [ FOR orig-address ]
- Используйте эту команду для создания сессии LITE. Эта команда возвращает строку с идентификатором Сессии LITE. Эта строка может быть использована для создания URL, который позволит браузеру клиента работать с Сессией LITE используя протокол HTTP.
- ip-address : string
- orig-address : string
- Эти параметры имеют тот же смысл, что и для команды CREATEWEBUSERSESSION.
Для создания сессий LITE аутентифицированный пользователь должен иметь право Все Домены или обладать правом доступа Может создавать WebUser сессии (CanCreateWebUserSessions) Администратора Домена.
- FINDACCOUNTSESSION accountName [ ADDRESS ip-address [ FOR proxied-address ] ] [ PROTOCOL protocol ] [ TRANSPORT transport ] [ CLIENT client ]
- Используйте эту команду для того, чтобы найти для указанного Пользователя существующую сессию. Эта команда возвращает строку с идентификатором Сессии.
- accountName : строка
- В этом параметре задаётся имя Пользователя.
- ip-address : строка или адрес IP
- В этом необязательном параметре задаётся IP адрес браузера клиента. Если он указан, то команда найдёт только те сессии, у которых Настройка "Фиксированный IP" выключена или у которых IP адрес входа совпадает с указанным в этом параметре.
- proxied-address : строка
- В этом необязательном параметре задаётся IP адрес браузера клиента, если браузер находится за HTTP прокси. IP адрес такого прокси указывается в ip-address.
- protocol : строка
- Этот необязательный параметр указывает протокол Сессии (WebUser, XIMSS, XMPP и т.п.) Если он указан, то поиск осуществляется только в сессиях по указанному протоколу.
- transport : строка
- Этот необязательный параметр задаёт транспорт Сессии (HTTP, XIMSS, XMPP и т.п.) Если он указан, то поиск осуществляется только в сессиях, созданных с указанным транспортом.
- client : строка
- Этот необязательный параметр указывает клиента Сессии. Если он указан, то поиск осуществляется только в сессиях, созданных с указанным клиентом (если клиент проинформировал сессию о своём имени).
Для использования этой команды аутентифицированный пользователь должен иметь право Все Домены или обладать правом доступа Может создавать WebUser сессии (CanCreateWebUserSessions) Администратора Домена.
- LISTACCOUNTSESSIONS accountName [ ADDRESS ip-address [ FOR proxied-address ] ] [ PROTOCOL protocol ] [ TRANSPORT transport ] [ CLIENT client ]
- Используйте эту команду для того, чтобы найти для указанного Пользователя все существующие сессии. Эта команда возвращает массив строк - идентификаторов Сессий.
Параметры команды такие же, как у FINDACCOUNTSESSION.
Для использования этой команды аутентифицированный пользователь должен иметь право Все Домены или обладать правом доступа Может создавать WebUser сессии (CanCreateWebUserSessions) Администратора Домена.
- LISTLITESESSIONS [ ADDRESS ip-address [ FOR proxied-address ] ]
- Используйте эту команду для того, чтобы найти все существующие сессии LITE. Эта команда возвращает массив строк - идентификаторов Сессий.
Параметры команды такие же, как у LISTACCOUNTSESSIONS.
Для использования этой команды аутентифицированный пользователь должен иметь право Все Домены или обладать правом доступа Может создавать WebUser сессии (CanCreateWebUserSessions) Администратора Домена.
- GETSESSION sessionID [ DOMAIN domainName ]
- Используйте эту команду для получения данных Сессии. Эта команда возвращает словарь, в котором содержится набор данных сессии (описанный в разделе WSSP настоящего руководства).
- sessionID : строка
- В этом параметре задаётся Идентификатор Сессии.
- domainName : строка
- Этот необязательный параметр указывает имя Домена, которому принадлежит Пользователь этой сессии.
Если параметр domainName не указан, то для получения данных Сессии аутентифицированный пользователь должен иметь право доступа Все Домены. Если указано domainName, то аутентифицированный пользователь должен иметь для указанного Домена право доступа Может создавать WebUser сессии (CanCreateWebUserSessions) Администратора Домена.
Эта операция сбрасывает таймер неактивности сессии.
- UPDATESESSION sessionID [ DOMAIN domainName ] dictParam
- Используйте эту команду для прекращения сессии.
- sessionID : строка
- В этом параметре задаётся Идентификатор Сессии.
- domainName : строка
- Этот необязательный параметр указывает имя Домена, которому принадлежит Пользователь этой сессии.
- dictParam : словарь
- Этот параметр задаёт словарь с атрибутами для модификации. Специальное значение #NULL# может быть использовано для удаления атрибута.
Если параметр domainName не указан, то для модификации Сессии аутентифицированный пользователь должен иметь право доступа Все Домены. Если указано domainName, то аутентифицированный пользователь должен иметь для указанного Домена право доступа Может создавать WebUser сессии (CanCreateWebUserSessions) Администратора Домена.
- KILLSESSION sessionID [ DOMAIN domainName ]
- Используйте эту команду для прекращения сессии.
- sessionID : строка
- В этом параметре задаётся Идентификатор Сессии.
- domainName : строка
- Этот необязательный параметр указывает имя Домена, которому принадлежит Пользователь этой сессии.
Если параметр domainName не указан, то для прекращения Сессии аутентифицированный пользователь должен иметь право доступа Все Домены. Если указано domainName, то аутентифицированный пользователь должен иметь для указанного Домена право доступа Может создавать WebUser сессии (CanCreateWebUserSessions) Администратора Домена.
- BLESSSESSION sessionID [ PASSWORD secret ] [ AUTH accountName ]
- Используйте эту команду для завершения процесса Двухфакторной Аутентификации для указанной сессии.
- sessionID : строка
- В этом параметре задаётся Идентификатор Сессии.
- secret : строка
- Этот необязательный параметр задаёт одноразовый пароль Двухфакторной Аутентификации.
- accountName : строка
- Этот необязательный параметр указывает имя Пользователя, которому принадлежит эта сессия.
Если параметер secret не указан (когда Сессия должна быть в состоянии ожидания выполнения фоновой Двухфакторной Аутентификации), то аутентифицированный пользователь должен иметь право доступа Master Администратора сервера. Если указан accountName, то аутентифицированный пользователь должен иметь для указанного Домена право доступа Может выступать от имени других (CanImpersonate) Администратора Домена.
Специальные административные права не нужны, когда аутентифицированный пользователь завершает процесс Двухфакторной Аутентификации для своей же сессии.
- STORESESSIONFILE sessionID [ DOMAIN domainName ] FILE fileName [ OFFSET position ] UPLOADID uploadID
- Используйте эту команду для сохранения загруженного файла из "набора загруженных файлов" сессии как файла в Хранилище Файлов.
- sessionID : строка
- В этом параметре задаётся Идентификатор Сессии.
- domainName : строка
- Этот необязательный параметр указывает имя Домена, которому принадлежит Пользователь этой сессии.
- fileName : строка
- Этот параметр задаёт имя файла в Хранилище Файлов.
- position : смещение
- Если этот параметр отсутствует или его значение равно нулю, то существующий файл (если он есть) сначала удаляется, а затем создаётся новый.
Если этот параметр - неравное нулю число, то его значение должно быть положительным; файл в Хранилище Файлов перезаписывается/дополняется, начиная с указанной позиции в файле. Файл должен существовать, и указанная позиция не должна быть больше, чем текущий размер файла.
Если этот параметр имеет значение BEG, то файл уже должен существовать; файл перезаписывается с начала, но его старые данные, находящиеся за пределами данных в новом файле, не удаляются.
Если эта опция имеет значение END, то данные нового файла добавляются к концу файла. Если файл не существует, то он создаётся.
Если эта опция имеет значение NEW, то файл не должен существовать; новый файл создаётся и данные записываются в него.
- uploadID : строка
- Этот параметр идентифицирует файл в "наборе загруженных файлов".
Если параметр domainName не указан, то для сохранения загруженного файла аутентифицированный пользователь должен иметь право доступа Все Домены.
Если указано domainName, то аутентифицированный пользователь должен иметь для указанного Домена права доступа Может создавать сессии (CanCreateWebUserSession) и
Полный доступ ко всем Файлам (CanAccessWebSites) Администратора Домена.
Следующие команды могут использоваться для обслуживания Среды Программ Реального Времени CommuniGate Pro.
Для изменения Среды Домена для Программ Реального Времени необходимо иметь право доступа Все Домены или обладать правом доступа Может модифицировать PBX Приложения (CanModifyPBXApps) Администратора Домена.
- CREATEDOMAINPBX domainName [ FILE language ]
- Используйте эту команду для создания Среды Домена для Программ Реального Времени или для создания национального набора.
- domainName : строка
- Этот параметр указывает имя Домена.
- language : строка
- Этf необязательная строка содержит название локализации.
- DELETEDOMAINPBX domainName FILE language
- Используйте эту команду для удаления локализации из Среды Домена для Программ Реального Времени.
- domainName : строка
- Этот параметр указывает имя Домена.
- language : строка
- Этот параметр указывает название локализации.
- LISTDOMAINPBXFILES domainName [ FILE language ]
- Используйте эту команду для получения списка файлов с Приложениями Реального Времени из Среды Домена. Эта команда возвращает словарь, ключи которого являются именами файлов. Значением элементов словаря являются словари с атрибутами файлов.
- domainName : строка
- Этот необязательный параметр указывает имя Домена. Если имя Домена не указано, то команда применяется к Домену администратора.
- language : строка
- Эта необязательная строка содержит название локализации.
- READDOMAINPBXFILE domainName FILE fileName
- Используйте эту команду для чтения файла с Приложением Реального Времени из Среды Домена. Эта команда возвращает блок данных, в котором находится содержимое файла.
- domainName : строка
- Этот параметр указывает имя Домена.
- fileName : строка
- В этом параметре задаётся имя файла. Для получения файла из национального набора укажите его имя как language/fileName.
- STOREDOMAINPBXFILE domainName FILE fileName DATA fileContent
STOREDOMAINPBXFILE domainName FILE fileName DELETE
- Используйте эту команду для сохранения файла с Приложением Реального Времени в Среду Домена или для удаления файла с Приложением Реального Времени из Среды Домена.
- domainName : строка
- Этот параметр указывает имя Домена.
- fileName : строка
- В этом параметре задаётся имя файла. Для сохранения файла в национальном наборе укажите его имя как language/fileName.
- fileContent : блок данных
- Этот параметр указывается, только если используется ключевое слово DATA. В нём должно быть передано содержимое файла.
Если указано ключевое слово DATA и среда содержит файл с указанным именем, то старый файл удаляется. Файл с указанным именем удаляется из Кэша Среды (в Динамическом Кластере файл удаляется из Кэша всех членов Кластера).
Следующие команды доступны только Администраторам Системы:
- CREATESERVERPBX language
- Используйте эту команду для создания общесерверной Среды для Приложений Реального Времени или национального набора в ней.
- language : строка
- Этот параметр указывает название локализации.
- DELETESERVERPBX language
- Используйте эту команду для удаления локализации из общесерверной Среды для Программ Реального Времени.
- language : строка
- Этот параметр указывает название локализации.
- LISTSERVERPBXFILES [ language ]
- Используйте эту команду для получения списка файлов Приложений Реального Времени из общесерверной Среды. Эта команда возвращает словарь, ключи которого являются именами файлов. Значением элементов словаря являются словари с атрибутами файлов.
- language : строка
- Эта необязательная строка содержит название локализации.
- READSERVERPBXFILE fileName
- Используйте эту команду для чтения файла с Приложением Реального Времени из общесерверной Среды. Эта команда возвращает блок данных, в котором находится содержимое файла.
- fileName : строка
- В этом параметре задаётся имя файла. Для получения файла из национального набора укажите его имя как language/fileName.
- STORESERVERPBXFILE fileName DATA fileContent
STORESERVERPBXFILE fileName DELETE
- Используйте эту команду для сохранения файла с Приложением Реального Времени в общесерверную Среду или для удаления файла с Приложением Реального Времени из общесерверной среды.
- fileName : строка
- В этом параметре задаётся имя файла. Для сохранения файла в национальном наборе укажите его имя как language/fileName.
- fileContent : блок данных
- Этот параметр указывается, только если используется ключевое слово DATA. В нём должно быть передано содержимое файла.
Если указано ключевое слово DATA и среда содержит файл с указанным именем, то старый файл удаляется. Файл с указанным именем удаляется из Кэша Среды (в Динамическом Кластере файл удаляется из Кэша всех членов Кластера).
- CREATECLUSTERPBX language
DELETECLUSTERPBX language
LISTCLUSTERPBXFILES [ language ]
READCLUSTERPBXFILE fileName
STORECLUSTERPBXFILE fileName DATA fileContent
STORECLUSTERPBXFILE fileName DELETE
- Эти команды доступны только в Динамическом Кластере.
Используйте эти команды вместо команд [LIST|READ|STORE]SERVERPBXFILE[S] для работы с файлами общекластерной Среды Приложений Реального Времени.
- LISTSTOCKPBXFILES [ language ]
READSTOCKPBXFILE fileName
- Используйте эти команды вместо команд[LIST|READ|STORE]SERVERPBXFILE[S] для работы с файлами общекластерной Среды Приложений Реального Времени.
Следующие команды могут использоваться для выполнения Задач Приложений Реального Времени CommuniGate Pro.
- STARTPBXTASK accountName PROGRAM programName [ ENTRY entryName ] [ PARAM parameter ]
- Используйте эту команду для запуска новой Задачи PBX. Эта команда возвращает строку с идентификатором Задачи.
- accountName : строка
- В этом параметре задаётся имя Пользователя. Задача запускается от имени этого Пользователя.
Имя может включать в себя имя Домена. Если имя Домена не указано, то по умолчанию используется текущий Домен пользователя.
- programName : строка
- Имя запускаемой программы (файл .sppr).
- entryName : строка
- Этот необязательный параметр указывает точку входа программы. Если этот параметр не указан, то используется точка входа main.
- parameter : объект
- Этот необязательный параметр указывает стартовый параметр программы. Программы может получить этот параметр при помощи следующего кода:
Vars().startParameter
- SENDTASKEVENT taskID EVENT eventName [ PARAM parameter ]
- Используйте эту команду для отправки События существующей Задаче PBX.
- taskID : строка
- В этом параметре задаётся ID Задачи.
- eventName : строка
- Имя отправляемого События.
- parameter : объект
- Это - необязательный параметр События.
- KILLNODE taskID
- Используйте эту команду для завершения существующей PBX Задачи.
- taskID : строка
- В этом параметре задаётся ID Задачи.
- READNODESTATUS taskID
- Используйте эту команду для чтения текущего статуса приложения существующей PBX Задачи. Эта команда возвращает объект со статусом приложения.
- taskID : строка
- В этом параметре задаётся ID Задачи.
Следующие команды могут использоваться для выполнения Синхронных Скриптов, расположенных на сервере.
- RUNSCRIPT accountName PROGRAM programName [ ENTRY entryName ] [ PARAM parameter ]
- Используйте эту команду для запуска на сервере синхронного скрипта. Эта команда возвращает объект, созданный в результате выполнения синхронного скрипта.
- accountName : строка
- В этом параметре задаётся имя Пользователя. Скрипт запускается от имени этого Пользователя.
Имя может включать в себя имя Домена. Если имя Домена не указано, то по умолчанию используется текущий Домен пользователя.
- programName : строка
- Имя запускаемого скрипта (файл .scgp).
- entryName : строка
- Этот необязательный параметр указывает точку входа скрипта. Если этот параметр не указан, то используется точка входа main.
- parameter : объект
- Этот необязательный параметр указывает стартовый параметр скрипта. Скрипт может получить этот параметр при помощи следующего кода:
Vars().startParameter
Следующие команды могут использоваться для управления различными данными Пользователя.
- REMOVEACCOUNTSUBSET accountName SUBSET subsetName
- Используйте эту команду для удаления "набора данных" Пользователя (например, такого, как адресная книга RepliedAddresses).
Использование этой команды доступно либо самому Пользователю, либо Пользователю, имеющем право доступа Основные Установки Администратора Домена.
- accountName : строка
- В этом параметре задаётся имя существующего Пользователя. Символ звёздочка (*) может использоваться для указания текущего аутентифицированного Пользователя.
- subsetName : строка
- В этом параметре задаётся имя существующего у указанного Пользователя набора данных.
- DATASET accountName parameters
- Используйте эту команду для управления набором данных Пользователя. Эта команда возвращает словарь, в котором содержатся результаты операции.
Использование этой команды доступно либо самому Пользователю, либо Пользователю, имеющем право доступа Основные Установки Администратора Домена.
- accountName : строка
- В этом параметре задаётся имя существующего Пользователя. Символ звёздочка (*) может использоваться для указания текущего аутентифицированного Пользователя.
- parameters : словарь
- Этот словарь должен содержать:
- subsetName : строка
- строка, задающая набор данных или его подмножество
- what
- строка с типом выполняемой операции.
Другие элементы словаря зависят от типа операции.
Ниже перечисляются доступные операции (значения what) и дополнительные элементы словаря parameters для каждой операции:
- listSubsets
- операция перечисляет все разделы Набора Данных Пользователя. Чтобы перечислить Наборы Данных верхнего уровня Пользователя, в качестве значения subsetName пустую строку. Словарь результата будет содержать имена найденных подмножеств в качестве ключей и пустые строки в качестве их значений.
- createSet
- операция создаёт указанный Набор Данных.
- removeSet
- операция удаляет указанный Набор Данных.
- listEntries
- операция выдаёт список элементов подмножества. Словарь результата будет содержать имена найденных элементов в качестве ключей и атрибуты этих элементов виде словарей.
- attribute, data
- необязательный строковые элементы; указывают имя и значение атрибута. Если они указаны, то операция возвращает только те данные, у которых указанный атрибут имеет указанное значение.
Для фильтрации по именам элементов используйте имя атрибута entry.
- mode
- необязательная строка, задающая режим сравнения; если она отсутствует или её значение равно eq, тогда указанный атрибут должен быть равен указанному значению;
если её значение beg, тогда начало значения атрибута должно совпадать с указанным значением;
если её значение end, то конец значения атрибута должен совпадать с указанным значением;
если её значение incl, значение указанного атрибута должно включать в себя указанное значение.
- setEntry
- эта операция создаёт новую запись или изменяет запись.
- data
- словарь с парами ключ-значение атрибутов; они используются для создания новой записи или изменения существующей.
- entryName
- строка с именем записи; если записи с таким названием не существует, то она будет создана. Если этот элемент отсутствует, для новой записи генерируется уникальное имя.
- ifExists
- если параметр задан, тогда новая запись не может быть создана, и только существующая запись может быть изменена; если параметр не задан, а указанный набор данных не существует, он создаётся.
- deleteEntry
- операция удаляет указанную запись из указанного Набора Данных.
- entryName
- строка с именем записи
- addRandomEntry
- операция добавляет новую запись в набор данных или его подмножество. Генерируется уникальное имя для новой записи. Если операция успешна, в словаре результата будет элемент entryName с именем созданной записи.
- data
- словарь с парами ключ-значение атрибутов. Он должен содержать атрибут addressbook.Email.
- entryLimit
- необязательное число; если указано и больше нуля, то операция проверяет текущее количество записей в подмножестве набора данных и не превышает этот предел.
Если набор данных уже содержит запись с таким же значением атрибута addressbook.Email, набор данных не изменяется.
- findAddress
- эта операция находит запись с указанным значением атрибута addressbook.Email. Результат операции является словарём. Если запись найдена, её имя в словаре результатом передаётся как элемент с пустым именем.
- address
- строка с искомым адресом электронной почты
- ROSTER accountName parameters
- Используйте эту команду для управления Ростером Пользователя. Эта команда возвращает словарь, в котором содержатся результаты операции.
Использование этой команды доступно либо самому Пользователю, либо Пользователю, имеющем право доступа Основные Установки Администратора Домена.
- accountName : строка
- В этом параметре задаётся имя существующего Пользователя. Символ звёздочка (*) может использоваться для указания текущего аутентифицированного Пользователя.
- parameters : словарь
- Этот словарь должен содержать элемент what, строка которого задаёт применяемую операцию: List, Update, remove, Presence, probe. Другие элементы словаря зависят от типа операции.
- BALANCE accountName parameters
- Используйте эту команду для управления балансовыми Остатками Пользователя. Эта команда возвращает словарь, в котором содержатся результаты операции (согласно описанию, приведённому в разделе Тарификация).
Использование этой команды доступно либо самому Пользователю, либо Пользователю, имеющем право доступа Может Кредитовать Пользователей (CanCreditAccounts) Администратора Домена.
- accountName : строка
- В этом параметре задаётся имя существующего Пользователя. Символ звёздочка (*) может использоваться для указания текущего аутентифицированного Пользователя.
- parameters : словарь
- Этот словарь должен содержать строковый элемент op, задающий применяемую операцию: list, reserve, release, charge, credit, read, readAll, history, remove. Другие элементы словаря зависят от типа операции; их описание приведено в разделе Тарификация.
Пользователь должен иметь право доступа к разделу Установки Интерфейса Администрирования Сервера для использования команд CLI, затрагивающих Установки Сервера.
- LISTMODULES
- Используйте эту команду для получения списка модулей Сервера. Эта команда возвращает массив с именами модулей.
- GETMODULE moduleName
- Используйте эту команду для получения установок модуля. Эта команда возвращает словарь, в котором содержатся установки модуля.
- moduleName : строка
- В этом параметре задаётся имя модуля Сервера CommuniGate Pro.
- SETMODULE moduleName newSettings
- Используйте эту команду для изменения установок модуля.
- moduleName : строка
- В этом параметре задаётся имя модуля Сервера CommuniGate Pro.
- newSettings : словарь
- Словарь с новыми установками модуля.
- UPDATEMODULE moduleName newSettings
- Используйте эту команду для изменения установок модуля.
- moduleName : строка
- В этом параметре задаётся имя модуля Сервера CommuniGate Pro.
- newSettings : словарь
- Этот словарь используется для изменения словаря установок модуля. Он не обязан содержать в себе все установки; отсутствующие в словаре установки просто не будут изменены.
- KILLMODULEJOB moduleName JobID
- Используйте эту команду для прерывания задач (соединений) модуля.
- moduleName : строка
- В этом параметре можно использовать значения: HTTPU, HTTPA, PWD, LDAP, POP, IMAP, FTP, XIMSS, SMTPI (для входящих SMTP соединений), SMTPO (для исходящих SMTP соединений), XMPPI, XMPPO, SESSION (для пользовательских сессий).
- JobID : числовая строка
- В этом параметре указывается идентификатор задачи.
- GETQUEUESETTINGS
- Используйте эту команду для получения установок Очереди. Эта команда возвращает словарь, в котором содержатся Установки Очереди.
- SETQUEUESETTINGS newSettings
- Используйте эту команду для задания Установок Очереди.
- newSettings : словарь
- Словарь с новыми установками Очереди.
- GETSIGNALSETTINGS
- Используйте эту команду для получения установок Сигналов. Эта команда возвращает словарь, в котором содержатся установки компонента.
- SETSIGNALSETTINGS newSettings
- Используйте эту команду для задания установок Сигналов.
- newSettings : словарь
- Словарь с новыми установками Сигналов.
- GETMEDIASERVERSETTINGS
- Используйте эту команду для чтения установок компонента Медиасервера. Эта команда возвращает словарь, в котором содержатся установки компонента.
- SETMEDIASERVERSETTINGS newSettings
- Используйте эту команду для записи установок компонента Медиасервера.
- newSettings : словарь
- Словарь с новыми установками компонента.
- GETSESSIONSETTINGS
- Используйте эту команду для получения установок Сессий пользователя. Эта команда возвращает словарь с установками Сессий.
- SETSESSIONSETTINGS newSettings
- Используйте эту команду для задания установок Сессий.
- newSettings : словарь
- Словарь с новыми установками Сессий.
- GETCLUSTERSETTINGS
- Используйте эту команду для получения установок Кластера. Эта команда возвращает словарь, в котором содержатся установки Кластера.
- SETCLUSTERSETTINGS newSettings
- Используйте эту команду для задания установок Кластера.
- newSettings : словарь
- Словарь с новыми установками Кластера.
- GETLOGSETTINGS
- Используйте эту команду для получения установок Журнала Сервера. Эта команда возвращает словарь с установками Журнала Сервера.
- UPDATELOGSETTINGS newSettings
- Используйте эту команду для изменения установок Журнала Сервера.
- newSettings : словарь
- Этот словарь используется для изменения словаря установок Журнала Сервера.
- GETNETWORK
- Используйте эту команду для получения установок Сети. Эта команда возвращает словарь с установками Сети сервера.
- SETNETWORK newSettings
- Используйте эту команду для задания Установок Сети сервера.
- newSettings : словарь
- Новые установки Сети.
- GETDNRSETTINGS
- Используйте эту команду для получения установок DNR (Клиента DNS). Эта команда возвращает словарь с установками DNR.
- SETDNRSETTINGS newSettings
- Используйте эту команду для записи установок DNR (Клиента DNS).
- newSettings : словарь
- Новые установки DNR.
- GETBANNED
- Используйте эту команду для получения установок Запрещённых Строк. Эта команда возвращает словарь с установками Запрещённые Строки сервера.
- SETBANNED newSettings
- Используйте эту команду для задания установок Запрещённых Строк сервера.
- newSettings : словарь
- Новая установка Запрещённых Строк сервера.
- GETCLUSTERNETWORK
SETCLUSTERNETWORK newSettings
- Используйте эти команды для получения и изменения общекластерных установок Сети.
- GETCLUSTERBANNED
SETCLUSTERBANNED newSettings
- Используйте эти команды для получения и изменения общекластерных установок Запрещённых Строк.
- GETSERVERMAILRULES
- Используйте эту команду для чтения Общесерверных Почтовых Правил. Эта команда возвращает массив Почтовых Правил Сервера.
- SETSERVERMAILRULES newRules
- Используйте эту команду для задания Общесерверных Почтовых Правил.
- newRules : массив
- Массив с новыми Почтовыми Правилами Сервера.
- GETSERVERSIGNALRULES
- Используйте эту команду для чтения Общесерверных Сигнальных Правил. Эта команда возвращает массив с Сигнальными Правилами Сервера.
- SETSERVERSIGNALRULES newRules
- Используйте эту команду для задания Общесерверных Сигнальных Правил.
- newRules : массив
- Массив с новыми Сигнальными Правилами Сервера.
- GETCLUSTERMAILRULES
SETCLUSTERMAILRULES newRules
GETCLUSTERSIGNALRULES
SETCLUSTERSIGNALRULES newRules
- Используйте эти команды для получения и изменения общекластерных Правил.
- GETROUTERTABLE
- Используйте эту команду для чтения Таблицы Маршрутизации. Эта команда возвращает строку (из нескольких строк) с текстом Таблицы Маршрутизации.
- SETROUTERTABLE newTable
- Используйте эту команду для задания Таблицы Маршрутизации.
- newTable : строка
- Строка (из несколько строк), в которой содержится текст новой Таблицы Маршрутизации.
Обратите внимание: строки должны разделяться символами \e.
- GETROUTERSETTINGS
- Используйте эту команду для чтения установок Маршрутизации. Эта команда возвращает словарь с установками Маршрутизатора.
- SETROUTERSETTINGS newSettings
- Используйте эту команду для задания установок Маршрутизатора.
- newSettings : словарь
- Словарь с новыми установками Маршрутизатора.
- GETCLUSTERROUTERTABLE
SETCLUSTERROUTERTABLE newTable
GETCLUSTERROUTERSETTINGS
SETCLUSTERROUTERSETTINGS newSettings
- Используйте эти команды для работы с общекластерной Таблицей Маршрутизации и установками Маршрутизатора.
- GETSERVERSETTINGS
- Используйте эту команду для чтения дополнительных установок Сервера. Эта команда возвращает словарь с дополнительными установками Сервера.
- UPDATESERVERSETTINGS newSettings
- Используйте эту команду для изменения дополнительных установок Сервера.
- newSettings : словарь
- Словарь с новыми Установками сервера.
- GETSMTPSENDPROFILES
SETSMTPSENDPROFILES newProfiles
- Используйте эти команды для получения и установки профилей хостов получателей модуля SMTP.
- newProfiles : словарь
- Словарь с новыми установками профилей.
- GETSMTPRECVPROFILES
SETSMTPRECVPROFILES newProfiles
- Используйте эти команды для получения и установки профилей адресов отправителей модуля SMTP.
- newProfiles : словарь
- Словарь с новыми установками профилей.
- REFRESHOSDATA
- Используйте эту команду для того, чтобы заставить сервер прочитать заново данные об адресах IP из ОС Сервера: набор локальных адресов IP и набор адресов DNS.
- GETADDRLISTS
- Используйте эту команду для получения набора именованных Списков Адресов. Эта команда возвращает словарь с Списками Адресов.
- SETADDRLISTS newLists
- Используйте эту команду для изменения набора именованных Списков Адресов.
- newLists : словарь
- Этот параметр содержит новый набор имён и значений Списков Адресов.
- GETCLUSTERADDRLISTS
SETCLUSTERADDRLISTS newLists
- Используйте эти команды для получения и установки общекластерного набора именованных Списков Адресов.
- GETLANIPS
- Используйте эту команду для получения списка Адресов LAN. Эта команда возвращает строку (несколько строк) с Адресами LAN и диапазонами адресов.
- SETLANIPS newAddresses
- Используйте эту команду для изменения списка Адресов LAN.
- newAddresses : строка
- Этот параметр с типом строка (несколько строк) содержит набор адресов и диапазон адресов, задающие новый набор Адресов LAN.
- GETCLUSTERLANIPS
- Используйте эту команду для получения общекластерного набора Адресов LAN. Эта команда возвращает строку (несколько строк) с общекластеными Адресами LAN и диапазонами адресов.
- SETCLUSTERLANIPS newAddresses
- Используйте эту команду для изменения общекластерного списка Адресов LAN.
- newAddresses : строка
- Этот параметр с типом строка (несколько строк) содержит набор адресов и диапазон адресов, задающие новый набор общекластерных Адресов LAN.
Следующие команды имеют одинаковые параметры и возвращают такие же данные, как команды GETLANIPS | SETLANIPS | GETCLUSTERLANIPS | SETCLUSTERLANIPS:
- GETCLIENTIPS
SETCLIENTIPS newAddresses
GETCLUSTERCLIENTIPS
SETCLUSTERCLIENTIPS newAddresses
- Используйте эти команды для получения и установки общекластерных и общесерверных Сетевых Адресов Клиентов.
- GETWHITEHOLEIPS
SETWHITEHOLEIPS newAddresses
GETCLUSTERWHITEHOLEIPS
SETCLUSTERWHITEHOLEIPS newAddresses
- Используйте эти команды для получения и установки общекластерных и общесерверных Белого Списка (неблокируемых) Сетевых Адресов.
- GETNATEDIPS
SETNATEDIPS newAddresses
GETCLUSTERNATEDIPS
SETCLUSTERNATEDIPS newAddresses
- Используйте эти команды для получения и установки общекластерных и общесерверных Частных Сетевых Адресов (NAT).
- GETNATSITEIPS
SETNATSITEIPS newAddresses
GETCLUSTERNATSITEIPS
SETCLUSTERNATSITEIPS newAddresses
- Используйте эти команды для получения и установки общекластерных и общесерверных Сетевых Адресов Шлюзов в частные сети (NAT Sites).
- GETDEBUGIPS
SETDEBUGIPS newAddresses
GETCLUSTERDEBUGIPS
SETCLUSTERDEBUGIPS newAddresses
- Используйте эти команды для получения и установки общекластерных и общесерверных Сетевых Адресов Отладки.
- GETDENIEDIPS
SETDENIEDIPS newAddresses
GETCLUSTERDENIEDIPS
SETCLUSTERDENIEDIPS newAddresses
- Используйте эти команды для получения и установки общекластерных и общесерверных Игнорируемых Сетевых Адресов.
Пользователь должен иметь права доступа к разделам Установки или Пользователи Интерфейса Администратора Сервера для использования следующих команд CLI.
- ROUTE address [ mail | access | signal ]
- Используйте эту команду для получения маршрута указанного адреса.
- address : строка
- В этом параметре задаётся адрес электронной почты, обрабатываемый Маршрутизатором CommuniGate Pro.
- mail или access или signal
- Эти необязательные флаги задают тип Маршрутизации (дополнительную информацию смотрите в разделе Маршрутизатор). Режимом по умолчанию является access.
Эта команда возвращает массив из трёх строк:
- module
- имя модуля CommuniGate Pro, в который направляется адрес или SYSTEM если адрес маршрутизируется на встроенный "адрес" (такой как NULL).
- host
- объект/очередь, обрабатываемая указанным модулем: для модуля SMTP это будет именем Домена в Интернет, для модуля Местной Доставки - локальное имя пользователя и т.д.
- address
- адрес внутри очереди (адрес электронной почты для SMTP, адрес Real-To: для модуля Местной Доставки и т.д.).
- GETIPSTATE ip-address
- Используйте эту команду для получения статуса для указанного адреса IP. Эта команда возвращает строку с типом адреса IP.
- ip-address : строка или адрес IP
- В этом параметре задаётся IP адрес для проверки.
Пользователь должен иметь права доступа к разделу Главное Интерфейса Администратора Сервера для использования следующих команд CLI.
- GETSERVERINTERCEPT
- Используйте эту команду для чтения установок СОРМ - перехвата сообщений. Эта команда возвращает словарь с установками Перехвата.
- SETSERVERINTERCEPT newSettings
- Используйте эту команду для задания установок СОРМ - перехвата сообщений.
- newSettings : словарь
- Словарь, содержащий установки Перехвата.
- GETCLUSTERINTERCEPT
SETCLUSTERINTERCEPT newSettings
- Эти команды аналогичны командам GETSERVERINTERCEPT и SETSERVERINTERCEPT, но они работают с общекластерными установками СОРМ - перехвата сообщений.
Пользователь должен иметь право доступа к разделу Наблюдение Интерфейса Администрирования Сервера для использования команд CLI для Наблюдения за Сервером.
- GETSTATELEMENT ObjectID
- Используйте эту команду для получения текущих значений элементов статистики сервера (SNMP).
- ObjectID : строка
- Идентификатор элемента статистики сервера (дополнительную информацию смотрите в разделе SNMP).
Эта команда возвращает число, строку или другой объект со значением элемента статистики сервера.
- SETSTATELEMENT ObjectID [ INC | SET ] setValue
- Используйте эту команду для изменения значений элементов статистики сервера (SNMP). Изменять можно только Модифицируемые Элементы Статистики.
- ObjectID : строка
- Идентификатор элемента статистики сервера (дополнительную информацию смотрите в разделе SNMP).
- setValue : числовая строка
- при использовании ключевого слова INC значение прибавляется к текущему значению счётчика статистики, при использовании SET значение записывается в счётчик.
- GETNEXTSTATNAME ObjectID
- Используйте эту команду для перебора всех элементов статистики сервера (SNMP).
- ObjectID : строка
- Идентификатор элемента статистики сервера (дополнительную информацию смотрите в разделе SNMP).
Эта команда возвращает строку с ObjectID следующего элемента статистики.
Если значением параметра ObjectID передана пустая строка, команда выдаёт идентификатор первого элемента статистики.
Команда возвращает код ошибки, если указанный в ObjectID элемент статистики не найден, или найден последний элемент.
- GETDIALOGINFO DialogID
- Используйте эту команду для получения информации об Объекте Диалога Сигналов.
- DialogID : число
- Идентификатор Диалога.
Эта команда возвращает словарь с данными статуса Диалога.
- SHUTDOWN
- Используйте эту команду для остановки Сервера CommuniGate Pro.
Статистические данные Пользователя собираются при условии, что у Пользователя включена опция Статистика.
Для включения этой опции, Откройте в разделе Установки Веб Интерфейса Администратора Сервера CommuniGate Pro страницу Общее, затем на странице Прочее найдите панель Локальные Пользователи.
- GETACCOUNTSTAT accountName [ KEY keyName ]
- Используйте эту команду для получения статистических данных об указанном Пользователе.
- accountName : строка
- В этом параметре задаётся имя существующего Пользователя. Символ звёздочка (*) может использоваться для указания текущего аутентифицированного Пользователя.
- keyName : строка
- Этот необязательный параметр задаёт имя ключа со статистической информацией, который необходимо получить.
Эта команда возвращает число или отметку времени с затребованной статистической информацией или (если ключевое слово KEY и параметр keyName не указаны) словарь со всеми доступными статистическими данными.
Если статистические данные для указанного ключа не существуют, то возвращается пустая строка.
Для использования этой команды необходимо обладать для требуемого Домена правами Администратора. Все пользователи могут получать о себе статистическую информацию.
- RESETACCOUNTSTAT accountName [ KEY keyName ]
- Используйте эту команду для очистки статистических данных указанного Пользователя.
- accountName : строка
- В этом параметре задаётся имя существующего Пользователя. Символ звёздочка (*) может использоваться для указания текущего аутентифицированного Пользователя.
- keyName : строка
- Этот необязательный параметр задаёт имя ключа записи статистической информации, который необходимо сбросить.
Если ключевое слово KEY и параметр keyName не указаны, то все статистические данные Пользователя сбрасываются.
Для использования этой команды необходимо обладать для Домена Пользователя правом Администратора Домена "Основные Установки".
Реализованы следующие ключи со статистическими данными Пользователя:
| Имя Ключа | | Значение |
|---|
| StatReset | | Дата и время отправки этому Пользователю последней команды RESETACCOUNTSTAT без параметров. |
| MessagesReceived | | Общее число сообщений, доставленных Пользователю |
| BytesReceived | | Общий размер всех сообщений, доставленных Пользователю |
| MessagesSent | | Общее число сообщений, отправленных от имени Пользователя |
| BytesSent | | Общее размер всех сообщений, отправленных от имени Пользователя |
| CallsReceived | | Общее число вызовов, полученных Пользователем. |
| CallsSent | | Общее число вызовов, совершённых от имени Пользователя |
| Logins | | Общее число успешных аутентификаций Пользователя |
|
- GETDOMAINSTAT domainName [ KEY keyName ]
- Используйте эту команду для получения статистических данных об указанном Домене.
- domainName : строка
- В этом параметре задаётся имя существующего Домена. Символ звёздочка (*) может использоваться для указания Домена текущего аутентифицированного Пользователя.
- keyName : строка
- Этот необязательный параметр задаёт имя ключа со статистической информацией, который необходимо получить.
Эта команда возвращает строку с затребованной статистической информацией или (если ключевое слово KEY и параметр keyName не указаны) словарь со всеми доступными статистическими данными.
Для использования этой команды необходимо обладать для требуемого Домена правами Администратора.
- RESETDOMAINSTAT domainName [ KEY keyName ]
- Используйте эту команду для очистки статистических данных об указанном Домене.
- domainName : строка
- В этом параметре задаётся имя существующего Домена. Символ звёздочка (*) может использоваться для указания Домена текущего аутентифицированного Пользователя.
- keyName : строка
- Этот необязательный параметр задаёт имя ключа записи статистической информации, который необходимо сбросить.
Если ключевое слово KEY и параметр keyName не указаны, то все статистические данные Домена сбрасываются.
Для использования этой команды необходимо обладать для требуемого Домена правом Администратора "Основные Установки ".
Реализованы следующие ключи со статистическими данными о Домене:
| Имя Ключа | | Значение |
|---|
| StatReset | | Дата и время отправки этому Домену последней команды RESETDOMAINSTAT без параметров |
| MessagesReceived | | Общее число сообщений, доставленных Пользователям Домена |
| BytesReceived | | Общий размер всех сообщений, доставленных Пользователям Домена |
| MessagesSent | | Общее число сообщений, отправленных от имени Пользователей Домена |
| BytesSent | | Общее размер всех сообщений, отправленных от имени Пользователей Домена |
| CallsReceived | | Общее число вызовов, полученных Пользователями Домена |
| CallsSent | | Общее число вызовов, совершённых от имени Пользователей Домена |
|
Пользователь должен иметь право доступа к Серверу Справочник для использования команд CLI для Управления Справочником.
- LISTDIRECTORYUNITS [ SHARED ]
- Используйте эту команду для получения списка хранилищ Справочника. Если использовано ключевое слово SHARED, выдаётся список общекластерных хранилищ. Эта команда возвращает словарь, ключами которого являются DN точек монтирования хранилищ, а значениями - имена хранилищ.
- CREATEDIRECTORYUNIT unitName [ SHARED ] [ REMOTE ] mountPoint
- Используйте эту команду для создания нового хранилища Справочника.
- unitName : строка
- В этом параметре задаётся имя нового хранилища.
- mountPoint : строка
- В этом параметре задаётся точка монтирования (DN) нового хранилища.
Если использовано ключевое слово SHARED, создаётся общекластерное хранилище.
Если использовано ключевое слово REMOTE , создаётся Удалённое Хранилище (по протоколу LDAP), иначе создаётся Локальное хранилище (на файлах).
- RELOCATEDIRECTORYUNIT unitName [ SHARED ] newMountPoint
- Используйте эту команду для перемонтирования существующего хранилища на другой точки монтирования.
- unitName : строка
- В этом параметре задаётся имя хранилища. Если использовано ключевое слово SHARED, создаётся общекластерное хранилище.
- mountPoint : строка
- В этом параметре задаётся новая точка монтирования (DN) хранилища.
- DELETEDIRECTORYUNIT unitName [ SHARED ]
- Используйте эту команду для удаления существующего хранилища Справочника.
- unitName : строка
- В этом параметре задаётся имя хранилища. Если использовано ключевое слово SHARED, удаляется общекластерное хранилище.
- GETDIRECTORYUNIT unitName [ SHARED ]
- Используйте эту команду для получения установок Хранилища Справочника.
- unitName : строка
- В этом параметре задаётся имя хранилища. Если использовано ключевое слово SHARED, используется общекластерное хранилище.
Эта команда возвращает словарь, в котором содержатся установки Хранилища Справочника.
- SETDIRECTORYUNIT unitName [ SHARED ] newSettings
- Используйте эту команду для изменения установок существующего хранилища Справочника.
- unitName : строка
- В этом параметре задаётся имя хранилища. Если использовано ключевое слово SHARED, используется общекластерное хранилище.
- newSettings : словарь
- В этом параметре задаются новые установки хранилища.
- GETDIRECTORYACCESSRIGHTS [ SHARED ]
- Используйте эту команду для чтения Прав Доступа к Справочнику. Если использовано ключевое слово SHARED, читаются общекластерные права. Эта команда возвращает массив с элементами Прав Доступа.
- SETDIRECTORYACCESSRIGHTS [ SHARED ] newAccessRights
- Используйте эту команду для смены Прав Доступа к Справочнику. Если использовано ключевое слово SHARED, изменяются общекластерные права.
- newAccessRights : массив
- В этом параметре задаются новые Права Доступа к Справочнику.
- LISTCLICOMMANDS
- Используйте эту команду для получения списка всех команд CLI, поддерживаемых этой версией Сервера CommuniGate Pro.
Эта команда возвращает массив строк с именами команд CLI.
- NOOP
- Команда всегда завершается успешно.
- ECHO object
- Эта команда возвращает объект, скопированный из параметра команды.
- GETVERSION
- Функция возвращает строку с номером версии Сервера CommuniGate Pro.
- GETSYSTEMINFO what
- Команда возвращает объект аналогично функции CG/PL SystemInfo, вызванной с параметром what.
В случаях, когда функция возвращает нулевой объект, эта команда возвращает строку с кодом ошибки.
- GETCURRENTTIME
- Функция возвращает отметку времени с текущим значением внутреннего таймера Сервера CommuniGate Pro.
- SETLOGALL [ ON | OFF ]
- Используйте эту команду для управления режимом "Запись всего в Журнал Сервера" (этот же режим включается параметром командной строки --LogAll).
Для использования этой команды необходимо обладать правами Администратора Сервера "Может наблюдать за Сервером".
- DUMPALLOBJECTS [ FILE ]
- Используйте эту команду для выдачи списка всех объектов Сервера.
Если указано ключевое слово FILE, то создаётся файл objects_dump.txt в корне "директории данных" сервера и в него осуществляется выдача; если такой файл уже существует, то команда ничего не делает.
Если ключевое слово FILE не указано, то выдача осуществляется в журнал Операционной Системы.
Обратите внимание: этот список может содержать миллионы объектов, и команда может вызвать перегрузку журнала ОС. На время выполнения команды блокируются все операции создания и удаления объектов, что фактически блокирует все операции Сервера CommuniGate Pro до выдачи полного списка.
Для использования этой команды необходимо обладать правами Администратора Сервера "Может Всё".
- TESTLOOP seconds
- Используйте эту команду для тестирования загрузки CPU. Команда выполняет некий вычислительный цикл в течение указанного времени. Результатом команды является число, которое говорит о производительности треда, обработавшего команду (количество проходов цикла делённое на время теста).
Для использования этой команды необходимо обладать правами Администратора Сервера "Может наблюдать за Сервером".
- SETTRACE facility [ ON | OFF ]
- Используйте эту команду для управления внутренними механизмами Сервера для записи в Журнал Операционной Системы. Параметр facility должен быть одной из следующих поддерживаемых строк:
- FileIO
- запись всех файловых операций чтения/записи/сокращения
- FileOp
- запись всех файловых операций создания/переименования/удаления
Для использования этой команды необходимо обладать правами Администратора Сервера "Может наблюдать за Сервером".
- WRITELOG logLevel logRecord
- Используйте эту команду для записи в Журнал работы Сервера.
- logLevel : число
- В этом параметре задаётся уровень Журнала.
- logRecord : строка
- Этот параметр указывает строку, которая будет помещена в Журнал работы Сервера.
Записи, созданные при помощи этой команды, имеют префикс SYSTEM.
Для использования этой команды необходимо обладать правами Администратора Сервера "Может наблюдать за Сервером".
- RELEASESMTPQUEUE queueName
- Используйте эту команду для освобождения очереди SMTP.
- queueName : строка
- Этот параметр указывает имя очереди (домена), которую необходимо освободить.
В среде Динамического Кластера эта команда освобождает указанную очередь SMTP на всех серверах.
Для использования этой команды необходимо обладать правами Администратора Сервера "Может наблюдать за Сервером".
- REJECTQUEUEMESSAGE messageID [ REPORT errorText ]
- Используйте эту команду для того, чтобы отвергнуть сообщение, находящееся в Очереди Сервера.
- messageID : число
- В этом параметре задаётся Идентификатор Сообщения.
- errorText : строка
- Этот необязательный параметр указывает текст сообщения об ошибке, которое будет включено в уведомление отправителю сообщения о недоставке. Если этот параметр указан как NONDN, то DSN-уведомление не создаётся.
Для использования этой команды необходимо обладать правами Администратора Сервера "Может отвергать Почтовые Очереди ".
- REJECTQUEUEMESSAGES SENDER authedSender [ REPORT errorText ] [ MSGID Message-Id ]
- Используйте эту команду для того, чтобы отвергнуть сообщение указанного аутентифицированного отправителя, находящееся в Очереди Сервера.
- authedSender : строка
- В этом параметре задаётся адрес аутентифицированного отправителя.
- errorText : строка
- Этот необязательный параметр указывает текст сообщения об ошибке, которое будет включено в уведомление отправителю сообщения о недоставке. Если этот параметр указан как NONDN, то DSN-уведомление не создаётся.
- Message-Id : строка
- Этот необязательный параметр указывает значение заголовка Message-Id письма, которое должно быть удалено. Если этот параметр указан, то удаляются только письма с таким значением заголовка.
В среде Динамического Кластера эта команда удаляет сообщения на всех серверах. Для использования этой команды необходимо обладать правами Администратора Сервера "Может отвергать Почтовые Очереди ".
- GETMESSAGEQUEUEINFO moduleName QUEUE queueName
- Используйте эту команду для чтения информации об Очереди сообщений модуля.
- moduleName : строка
- В этом параметре задаётся имя модуля.
- queueName : строка
- В этом параметре задаётся имя очереди модуля.
Эта команда возвращает словарь с информацией об очереди.
Если модуль не имеет указанной очереди, то словарь будет пустым. В противном случае в нём содержатся следующие элементы:
- nTotal
- число - общее число сообщений в очереди
- size
- число - общий размер всех сообщений в очереди
- delayedTill
- необязательная отметка времени - фактическое время освобождения для этой очереди
- lastError
- необязательная строка с отчётом о последней возникшей проблеме
- GETCURRENTCONTROLLER
- Используйте эту команду для получения IP адреса текущего Контроллера Динамического Кластера.
Эта команда возвращает строку с IP адресом Контроллера Кластера.
Для использования этой команды необходимо обладать правами Администратора Сервера "Может наблюдать за Сервером".
- RECONNECTCLUSTERADMIN
- Используйте эту команду, чтобы член Динамического Кластера заново открыл все свои внутрикластерные административные соединения, а для членов помимо Контроллера - ещё и открыть заново Административные соединения с Контроллером.
- REPORTFAILEDLOGINADDRESS address
- Используйте эту команду для увеличения счётчика неудачных попыток Входа с указанного IP адреса, используемого в функциональности Временно Блокированные Адреса.
- address : строка
- Сетевой (IP) адрес, для которого должен быть увеличен счётчик неудачных попыток Входа.
Для использования этой команды необходимо обладать правами по Администрированию Сервера "Может менять установки Сервера".
- TEMPBLACKLISTIP address [ TIMEOUT seconds | DELETE ]
- Используйте эту команду для добавления и удаления адреса в списке Временно Блокированных Сетевых Адресов.
- address : строка
- Сетевой (IP) адрес для добавления или удаления.
- seconds : число
- Время, на которое адрес добавляется в список.
Используйте ключевое слово DELETE, чтобы удалить адрес из списка.
- GETTEMPBLACKLISTEDIPS
- Используйте эту команду для получения списка Временно Блокированных Сетевых Адресов. Эта команда возвращает строку с разделёнными через запятую (,) Временно Блокированными Сетевыми Адресами.
Каждый IP адрес может иметь суффикс -nnnn, где nnnn является либо числом секунд, в течении которых этот адрес будет оставаться заблокированным, либо символом *, указывающим, что этот адрес заблокирован постоянно.
Для использования этой команды необходимо обладать правами Администратора Сервера "Может наблюдать за Сервером".
- SETTEMPBLACKLISTEDIPS addresses
- Используйте эту команду для добавления адреса в список Временно Блокированных Сетевых Адресов.
- addresses : строка
- Строка со списком IP адресов в формате выдачи команды GetTempBlacklistedIPs.
Для использования этой команды необходимо обладать правами по Администрированию Сервера "Может менять установки Сервера".
- TEMPUNBLOCKIP address [ TIMEOUT seconds | DELETE ]
- Используйте эту команду для добавления и удаления адреса в списке Временно Неблокируемых Сетевых Адресов.
- address : строка
- Сетевой (IP) адрес для добавления или удаления.
- seconds : число
- Время, на которое адрес добавляется в список.
Используйте ключевое слово DELETE, чтобы удалить адрес из списка.
- GETTEMPUNBLOCKABLEIPS
- Используйте эту команду для получения списка Временно Неблокируемых Сетевых Адресов. Эта команда возвращает строку с разделёнными через запятую (,) Временно Неблокируемыми Сетевыми Адресами.
Каждый IP адрес может иметь суффикс -nnnn, где nnnn является либо числом секунд, в течении которых этот адрес будет оставаться неблокируемым, либо символом *, указывающим, что этот адрес неблокируем постоянно.
Для использования этой команды необходимо обладать правами Администратора Сервера "Может наблюдать за Сервером".
- SETTEMPUNBLOCKABLEIPS addresses
- Используйте эту команду для добавления адреса в список Временно Неблокируемых Сетевых Адресов.
- addresses : строка
- Строка со списком IP адресов в формате выдачи команды GetTempUnblockableIPs.
Для использования этой команды необходимо обладать правами по Администрированию Сервера "Может менять установки Сервера".
- TEMPDEBUGIP address [ TIMEOUT seconds | DELETE ]
- Используйте эту команду для добавления и удаления адреса в списке Сетевых Адресов Временно под Отладкой.
- address : строка
- Сетевой (IP) адрес для добавления или удаления.
- seconds : число
- Время, на которое адрес добавляется в список.
Используйте ключевое слово DELETE, чтобы удалить адрес из списка.
- GETTEMPDEBUGIPS
- Используйте эту команду для получения списка Сетевых Адресов Временно под Отладкой. Эта команда возвращает строку с разделёнными через запятую (,) Сетевыми Адресами.
Каждый IP адрес может иметь суффикс -nnnn, где nnnn является либо числом секунд, в течении которых этот адрес будет оставаться под Отладкой, либо символом *, указывающим, что этот адрес под Отладкой постоянно.
Для использования этой команды необходимо обладать правами Администратора Сервера "Может наблюдать за Сервером".
- SETTEMPDEBUGIPS addresses
- Используйте эту команду для добавления адреса в список Сетевых Адресов Временно под Отладкой.
- addresses : строка
- Строка со списком IP адресов в формате выдачи команды GetTempDebugIPs.
Для использования этой команды необходимо обладать правами по Администрированию Сервера "Может менять установки Сервера".
- IPGEOLOCATION ip-address [ parameters ]
- Используйте эту команду для управления кэшем данных IP-геолокации.
-
- Описание параметров и результатов приведено в разделе Геолокация.
- Управление Наборами Доменов
-
LISTDOMAINS, MAINDOMAINNAME
GETDOMAINDEFAULTS, UPDATEDOMAINDEFAULTS, SETDOMAINDEFAULTS, GETCLUSTERDOMAINDEFAULTS, UPDATECLUSTERDOMAINDEFAULTS, SETCLUSTERDOMAINDEFAULTS
GETSERVERACCOUNTDEFAULTS, UPDATESERVERACCOUNTDEFAULTS, SETSERVERACCOUNTDEFAULTS, GETCLUSTERACCOUNTDEFAULTS, UPDATECLUSTERACCOUNTDEFAULTS, SETCLUSTERACCOUNTDEFAULTS
GETSERVERACCOUNTPREFS, SETSERVERACCOUNTPREFS, UPDATESERVERACCOUNTPREFS, GETCLUSTERACCOUNTPREFS, SETCLUSTERACCOUNTPREFS, UPDATECLUSTERACCOUNTPREFS
CREATEDOMAIN, RENAMEDOMAIN, DELETEDOMAIN, CREATEDIRECTORYDOMAIN, RELOADDIRECTORYDOMAINS
LISTSERVERTELNUMS, LISTCLUSTERTELNUMS
GETSERVERTRUSTEDCERTS, SETSERVERTRUSTEDCERTS, GETCLUSTERTRUSTEDCERTS, SETCLUSTERTRUSTEDCERTS
GETDIRECTORYINTEGRATION, GETCLUSTERDIRECTORYINTEGRATION, SETCLUSTERDIRECTORYINTEGRATION,
CREATEDOMAINSTORAGE, LISTDOMAINSTORAGE
- Управление Доменом
-
GETDOMAINSETTINGS, GETDOMAINEFFECTIVESETTINGS, UPDATEDOMAINSETTINGS, SETDOMAINSETTINGS
GETACCOUNTDEFAULTS, UPDATEACCOUNTDEFAULTS, SETACCOUNTDEFAULTS
GETACCOUNTDEFAULTPREFS, UPDATEACCOUNTDEFAULTPREFS, SETACCOUNTDEFAULTPREFS
GETDOMAINALIASES, SETDOMAINALIASES
GETACCOUNTTEMPLATE, UPDATEACCOUNTTEMPLATE, SETACCOUNTTEMPLATE
GETDOMAINMAILRULES, SETDOMAINMAILRULES, GETDOMAINSIGNALRULES, SETDOMAINSIGNALRULES,
LISTADMINDOMAINS
LISTDOMAINOBJECTS, LISTACCOUNTS, LISTDOMAINTELNUMS
INSERTDIRECTORYRECORDS, DELETEDIRECTORYRECORDS
GETDOMAINLOCATION, CREATEACCOUNTSTORAGE, LISTACCOUNTSTORAGE,
SUSPENDDOMAIN, RESUMEDOMAIN
- Управление Пользователями
-
CREATEACCOUNT, RENAMEACCOUNT, DELETEACCOUNT
SETACCOUNTTYPE, GETACCOUNTSETTINGS, UPDATEACCOUNTSETTINGS,
GETACCOUNTEFFECTIVESETTINGS,
GETACCOUNTONESETTING,
SETACCOUNTSETTINGS
SETACCOUNTPASSWORD, VERIFYACCOUNTPASSWORD,
VERIFYACCOUNTIDENTITY
GETACCOUNTALIASES, SETACCOUNTALIASES, GETACCOUNTTELNUMS, SETACCOUNTTELNUMS MODIFYACCOUNTTELNUMS
GETACCOUNTMAILRULES, SETACCOUNTMAILRULES, GETACCOUNTSIGNALRULES, SETACCOUNTSIGNALRULES, UPDATEACCOUNTMAILRULE, UPDATEACCOUNTMAILRULE, UPDATEACCOUNTSIGNALRULE, UPDATEACCOUNTSIGNALRULE
GETACCOUNTRPOPS, SETACCOUNTRPOPS, GETACCOUNTRIMAPS, SETACCOUNTRIMAPS, GETACCOUNTRSIPS, SETACCOUNTRSIPS, UPDATESCHEDULEDTASK, GETACCOUNTRIGHTS, GETACCOUNTINFO
GETACCOUNTPREFS, UPDATEACCOUNTPREFS, SETACCOUNTPREFS, GETACCOUNTEFFECTIVEPREFS
KILLACCOUNTSESSIONS
GETACCOUNTACL, SETACCOUNTACL, GETACCOUNTACLRIGHTS
GETACCOUNTLOCATION GETACCOUNTPRESENCE
- Управление Группами
-
LISTGROUPS,
CREATEGROUP,
RENAMEGROUP,
DELETEGROUP,
GETGROUP,
SETGROUP
- Управление Переадресаторами
-
LISTFORWARDERS,
CREATEFORWARDER,
RENAMEFORWARDER,
DELETEFORWARDER,
GETFORWARDER,
UPDATEFORWARDER,
FINDFORWARDERS
- Управление Именованными Задачами
-
LISTDOMAINNAMEDTASKS,
LISTACCOUNTNAMEDTASKS,
CREATENAMEDTASK,
RENAMENAMEDTASK,
DELETENAMEDTASK,
GETNAMEDTASK,
UPDATENAMEDTASK
- Управление Правами Доступа
-
SETACCOUNTRIGHTS
- Управление Папками
-
LISTMAILBOXES,
CREATEMAILBOX,
DELETEMAILBOX,
RENAMEMAILBOX,
SETMAILBOXCLASS
GETMAILBOXINFO,
GETMAILBOXACL,
SETMAILBOXACL,
GETMAILBOXRIGHTS
GETMAILBOXSUBSCRIPTION,
SETMAILBOXSUBSCRIPTION
GETMAILBOXALIASES,
SETMAILBOXALIASES
- Управление Предупреждениями
-
GETDOMAINALERTS, SETDOMAINALERTS, POSTDOMAINALERT, REMOVEDOMAINALERT
GETACCOUNTALERTS, SETACCOUNTALERTS, POSTACCOUNTALERT, REMOVEACCOUNTALERT
GETSERVERALERTS, SETSERVERALERTS, POSTSERVERALERT, REMOVESERVERALERT, GETCLUSTERALERTS, SETCLUSTERALERTS, POSTCLUSTERALERT, REMOVECLUSTERALERT
- Управление Хранилищем Файлов
-
READSTORAGEFILE, WRITESTORAGEFILE, RENAMESTORAGEFILE, DELETESTORAGEFILE, LISTSTORAGEFILES, GETSTORAGEFILEINFO READSTORAGEFILEATTR UPDATESTORAGEFILEATTR GETFILESUBSCRIPTION SETFILESUBSCRIPTION
- Управление Списками Рассылки
-
LISTLISTS, GETDOMAINLISTS, GETACCOUNTLISTS
CREATELIST, RENAMELIST, DELETELIST, GETLIST, UPDATELIST
LIST, LISTSUBSCRIBERS, READSUBSCRIBERS
GETSUBSCRIBERINFO, SETPOSTINGMODE, PROCESSBOUNCE
- Управление Видами Веб Интерфейса
-
LISTDOMAINSKINS, CREATEDOMAINSKIN, RENAMEDOMAINSKIN, DELETEDOMAINSKIN, LISTDOMAINSKINFILES, READDOMAINSKINFILE, STOREDOMAINSKINFILE
LISTSERVERSKINS, CREATESERVERSKIN, RENAMESERVERSKIN, DELETESERVERSKIN, LISTSERVERSKINFILES, READSERVERSKINFILE, STORESERVERSKINFILE
LISTCLUSTERSKINS, CREATECLUSTERSKIN, RENAMECLUSTERSKIN, DELETECLUSTERSKIN, LISTCLUSTERSKINFILES, READCLUSTERSKINFILE, STORECLUSTERSKINFILE, STORECLUSTERSKINFILE
LISTSTOCKSKINFILES, READSTOCKSKINFILE
- Интеграция с Веб Интерфейсом
-
CREATEWEBUSERSESSION, CREATEXIMSSSESSION, CREATELITESESSION, FINDACCOUNTSESSION, LISTACCOUNTSESSIONS, LISTLITESESSIONS,
GETSESSION,
UPDATESESSION,
KILLSESSION,
BLESSSESSION
STORESESSIONFILE
- Управление Приложениями Реального Времени
-
CREATEDOMAINPBX, DELETEDOMAINPBX, LISTDOMAINPBXFILES, READDOMAINPBXFILE, STOREDOMAINPBXFILE
CREATESERVERPBX, DELETESERVERPBX, LISTSERVERPBXFILES, READSERVERPBXFILE, STORESERVERPBXFILE
CREATECLUSTERPBX, DELETECLUSTERPBX, LISTCLUSTERPBXFILES, READCLUSTERPBXFILE, STORECLUSTERPBXFILE
LISTSTOCKPBXFILES, READSTOCKPBXFILE
- Выполнение Приложений Реального Времени
-
STARTPBXTASK, SENDTASKEVENT, KILLNODE, READNODESTATUS
- Синхронные Скрипты
-
RUNSCRIPT
- Услуги для Пользователя
-
REMOVEACCOUNTSUBSET DATASET ROSTER BALANCE
- Установки Сервера
-
LISTMODULES,
GETMODULE,
SETMODULE,
UPDATEMODULE
KILLMODULEJOB
GETQUEUESETTINGS,
SETQUEUESETTINGS,
GETSIGNALSETTINGS,
SETSIGNALSETTINGS,
GETMEDIASERVERSETTINGS,
SETMEDIASERVERSETTINGS
GETSESSIONSETTINGS,
SETSESSIONSETTINGS
GETCLUSTERSETTINGS,
SETCLUSTERSETTINGS
GETLOGSETTINGS,
UPDATELOGSETTINGS
GETNETWORK,
SETNETWORK,
GETCLUSTERNETWORK,
SETCLUSTERNETWORK
GETDNRSETTINGS,
SETDNRSETTINGS,
GETBANNED,
GETCLUSTERBANNED,
SETBANNED,
SETCLUSTERBANNED
GETSERVERMAILRULES,
SETSERVERMAILRULES,
GETCLUSTERMAILRULES,
SETCLUSTERMAILRULES
GETSERVERSIGNALRULES,
SETSERVERSIGNALRULES,
GETCLUSTERSIGNALRULES,
SETCLUSTERSIGNALRULES
GETROUTERTABLE,
SETROUTERTABLE,
GETCLUSTERROUTERTABLE,
SETCLUSTERROUTERTABLE
GETROUTERSETTINGS,
SETROUTERSETTINGS,
GETCLUSTERROUTERSETTINGS,
SETCLUSTERROUTERSETTINGS
REFRESHOSDATA
GETADDRLISTS,
SETADDRLISTS,
GETCLUSTERADDRLISTS,
SETCLUSTERADDRLISTS
GETLANIPS,
SETLANIPS,
GETCLUSTERLANIPS,
SETCLUSTERLANIPS
GETCLIENTIPS,
SETCLIENTIPS,
GETCLUSTERCLIENTIPS,
SETCLUSTERCLIENTIPS
GETWHITEHOLEIPS,
SETWHITEHOLEIPS,
GETCLUSTERWHITEHOLEIPS,
SETCLUSTERWHITEHOLEIPS
GETNATEDIPS,
SETNATEDIPS,
GETCLUSTERNATEDIPS,
SETCLUSTERNATEDIPS
GETNATSITEIPS,
SETNATSITEIPS,
GETCLUSTERNATSITEIPS,
SETCLUSTERNATSITEIPS
GETDEBUGIPS,
SETDEBUGIPS,
GETCLUSTERDEBUGIPS,
SETCLUSTERDEBUGIPS
GETDENIEDIPS,
SETDENIEDIPS,
GETCLUSTERDENIEDIPS,
SETCLUSTERDENIEDIPS
ROUTE
GETIPSTATE
GETSERVERINTERCEPT,
SETSERVERINTERCEPT,
GETCLUSTERINTERCEPT,
SETCLUSTERINTERCEPT
GETSERVERSETTINGS
UPDATESERVERSETTINGS
GETSMTPSENDPROFILES
SETSMTPSENDPROFILES
GETSMTPRECVPROFILES
SETSMTPRECVPROFILES
- Наблюдение
-
GETSTATELEMENT, SETSTATELEMENT, GETNEXTSTATNAME, GETDIALOGINFO, SHUTDOWN
- Статистика
-
GETACCOUNTSTAT, RESETACCOUNTSTAT, GETDOMAINSTAT, RESETDOMAINSTAT
- Управление Справочником
-
LISTDIRECTORYUNITS, CREATEDIRECTORYUNIT, RELOCATEDIRECTORYUNIT, DELETEDIRECTORYUNIT, GETDIRECTORYUNIT, SETDIRECTORYUNIT, GETDIRECTORYACCESSRIGHTS, SETDIRECTORYACCESSRIGHTS
- Разные Команды
-
LISTCLICOMMANDS,
NOOP,
ECHO,
GETVERSION,
GETSYSTEMINFO,
GETCURRENTTIME,
SETLOGALL,
DUMPALLOBJECTS,
TESTLOOP,
WRITELOG,
RELEASESMTPQUEUE,
REJECTQUEUEMESSAGE,
REJECTQUEUEMESSAGES,
GETMESSAGEQUEUEINFO,
GETCURRENTCONTROLLER,
RECONNECTCLUSTERADMIN,
REPORTFAILEDLOGINADDRESS,
TEMPBLACKLISTIP,
GETTEMPBLACKLISTEDIPS,
SETTEMPBLACKLISTEDIPS,
TEMPUNBLOCKIP,
GETTEMPUNBLOCKABLEIPS,
SETTEMPUNBLOCKABLEIPS,
TEMPDEBUGIP,
GETTEMPDEBUGIPS,
SETTEMPDEBUGIPS,
IPGEOLOCATION
|
