Справочник команд CLI

Завершает CLI-сессию и закрывает соединение.

Останавливает сервер.

Переключает режим вывода объектов в результатах команд между компактным и многострочным.

Переключает режим вывода объектов в результатах команд между стандартным и расширенным.

Устанавливает тайм-аут чтения в соединении в 365 дней.

Переключает флаг экранирования служебных символов в выводе последующих команд.

Выводит список команд с возможностью фильтрации.

Отвечает фиксированным сообщением.

Вызывает аварийное завершение процесса с генерацией системного сигнала SIGSEGV.

Выдаёт описание схемы настроек.

Выдаёт список инициализированных модулей.

Выдаёт список инициализированных почтовых модулей.

Выдаёт сведения о почтовой очереди модуля. Если имя модуля не указано или пустое, выдаётся общая очередь.

Выдаёт сведения об активных или ожидающих блоках доставки в очереди почтового модуля.

Выдаёт словарь настроек модуля.

Обновляет настройки модуля.

Изменяет уровень журналирования модуля.

Выдаёт объект настроек модуля.

Устанавливает объект настроек модуля.

Удаляет объект настроек модуля и возвращает значение по умолчанию.

Выдаёт список методов хэширования.

Выдаёт список методов шифрования.

Выдаёт список методов преобразования паролей в ключи.

Выдаёт список потоков выполнения.

Выдаёт список активных сетевых соединений.

Выдаёт список файлов журналов указанного типа с размерами в байтах.

Удаляет файлы журналов указанного типа, перечисленные в массиве.

Запускает задачу обслуживания Maintenance для всего сервера, или для отдельного домена, или для отдельного аккаунта.

Выдаёт общие сведения о сервере.

Выдаёт список активных (не просроченных) системных предупреждений: остановка сервера, потоки, соединения, слушатели, DNS, плагины, файлы, приближение истечения срока действия лицензии и т.д.

Выдаёт текущие права администратора данного CMD-подключения.

Выдаёт геолокационные данные по IP-адресу.

Выдаёт сведения о блоке доставки batch в очереди почтового модуля moduleName.

Возобновляет обработку ожидающего блока доставки batch в очереди почтового модуля moduleName.

Выдаёт сведения о письме в очереди по его идентификатору fileID.

Удаляет письмо fileID из очереди. Необязательный параметр reason задаёт текст ошибки, который записывается для адресатов письма.

Выдаёт административные права, с которыми работает текущее CLI-соединение.

Создаёт TOTP-ключ для идентификатора identifier и выдаёт ссылку otpauth:// для добавления ключа в приложение-аутентификатор.

Выдаёт список зарегистрированных доменов в виде словаря с числовыми ключами. Ключ — UID домена, значение — основное имя домена.

Создаёт домен.

Удаляет домен.

Переименовывает домен.

Выдаёт UID домена по его имени.

Выдаёт список всех имён домена по его имени.

Добавляет домену дополнительное имя.

Удаляет имя домена.

Делает имя основным.

Переносит новое имя домену.

Выдаёт флаги доменного имени.

Устанавливает флаги доменного имени.

Выдаёт объект настроек домена.

Выдаёт значение настройки домена по ключу или пути из массива ключей.

Устанавливает значение настройки в объект настроек домена.

Удаляет настройку домена, возвращая значение по умолчанию.

Обновляет настройки домена.

Выдаёт объект настроек по умолчанию для доменов.

Выдаёт настройку доменов по умолчанию.

Изменяет настройки доменов по умолчанию.

Удаляет объект настроек по умолчанию для доменов.

Обновляет настройки доменов по умолчанию.

Выдаёт глобальную карту соответствия "IP-адрес — домен".

Устанавливает для домена список IP-адресов и обновляет глобальную карту.

Добавляет в домен запись keytab Kerberos. Содержимое keytab передаётся в параметре keytabBase64 в кодировке Base64.

Выдаёт список записей keytab Kerberos домена.

Удаляет запись keytab Kerberos из домена по индексу index.

Выдаёт значения нескольких настроек домена. Ключи настроек передаются массивом requestKeys; допускаются только ключи верхнего уровня.

Проверяет, есть ли значение object в списке, который хранится в настройке домена key.

Добавляет значение object в список, который хранится в настройке домена key.

Удаляет значение object из списка, который хранится в настройке домена key.

Выдаёт адрес (URL) веб-сервера для пользователей домена.

Выдаёт сведения о TLS-контексте (профиле сертификата), который сейчас используется доменом.

Выдаёт список TLS-контекстов (профилей сертификатов), настроенных в домене.

Добавляет в домен TLS-контекст (профиль сертификата) с именем name. В параметрах передаются сертификат cert, закрытый ключ key и, при необходимости, цепочка сертификатов chain.

Удаляет из домена TLS-контекст с именем name.

Выдаёт содержимое TLS-контекста name: массив из сертификата, закрытого ключа и цепочки сертификатов в формате PEM.

Делает TLS-контекст name активным для домена. Необязательным массивом [crt,key,chn] можно заменить отдельные части контекста: сертификат, ключ, цепочку.

Отменяет выбор TLS-контекста для домена.

Выдаёт статистику использования ресурсов домена.

Выдаёт список зарегистрированных объектов домена в виде словаря с числовыми ключами: ключ — UID объекта, значение — основное имя объекта.

Создаёт переадресатор.

Создаёт группу.

Создаёт список рассылки.

Удаляет объект.

Переименовывает объект.

Выдаёт UID объекта по его имени objName.

Выдаёт список имён объекта.

Добавляет объекту дополнительное имя newName. Необязательный параметр flag задаёт флаг применения имени (по умолчанию 255).

Удаляет имя объекта.

Делает имя objName основным именем объекта (первым в списке его имён). Имя должно принадлежать объекту.

Переносит имя объекту.

Выдаёт флаги имени объекта.

Устанавливает флаги имени объекта.

Выдаёт настройки объекта.

Выдаёт настройку объекта.

Изменяет настройку объекта.

Удаляет настройку объекта.

Проверяет наличие значения в списке настройки.

Добавляет значение в список настройки.

Удаляет значение из списка настройки.

Обновляет настройки объекта.

Выдаёт количество объектов в домене.

Создаёт аккаунт accName на точке монтирования mountName домена. Необязательный параметр — словарь настроек settingsDict или массив settingsKeyValArray, в котором чередуются названия настроек и их значения. Эти настройки применяются сразу после создания аккаунта.

Создаёт ресурсный аккаунт resName с владельцем owner.

Создаёт ресурсный аккаунт resName с владельцем owner на точке монтирования mountName домена.

Создаёт переадресатор fwdName на точке монтирования mountName домена. Письма, отправленные на адрес переадресатора, перенаправляются на адрес destination.

Создаёт группу grpName на точке монтирования mountName домена. Необязательный параметр — словарь настроек settingsDict или массив settingsKeyValArray, в котором чередуются названия настроек и их значения. Эти настройки применяются сразу после создания группы.

Выдаёт значения нескольких настроек объекта. Ключи настроек передаются массивом requestKeys; допускаются только ключи верхнего уровня.

Загружает объект в домен из архива. Параметр path — путь к папке с архивом относительно рабочего каталога сервера.

Создаёт аккаунт в домене. Настройки из необязательного параметра применяются сразу после создания аккаунта.

Создаёт профиль настроек аккаунтов.

Удаляет профиль настроек аккаунтов.

Задаёт пароль аккаунта. Необязательный параметр tag задаёт метку пароля; пустая строка — основной пароль.

Проверяет пароль аккаунта.

Выдаёт пароль аккаунта с меткой tag; пустая строка — основной пароль.

Выдаёт настройки аккаунтов по умолчанию.

Выдаёт настройку аккаунтов по умолчанию.

Изменяет настройку аккаунтов по умолчанию.

Удаляет настройку аккаунтов по умолчанию.

Обновляет настройки аккаунтов по умолчанию.

Выдаёт список пространств имён папок аккаунта.

Выдаёт список почтовых папок аккаунта.

Выдаёт размер почтового хранилища аккаунта.

Удаляет пароль аккаунта. Необязательный параметр tag задаёт метку пароля; пустая строка — основной пароль.

Закрывает все сессии аккаунта.

Выдаёт список папок аккаунта, открытых в данный момент.

Восстанавливает сведения о файлах аккаунта по фактически хранящимся данным.

Выдаёт сведения о файлах и папках аккаунта по пути path. Необязательный параметр depth задаёт глубину обхода вложенных папок (по умолчанию 1).

Добавляет в группу участника или массив участников. Если указать true, сохраняется адрес электронной почты; иначе для локальных участников сохраняется их UID.

Удаляет из группы участника или массив участников. Если указать true, участник ищется по адресу с учётом маршрутизации.

Проверяет наличие участника в группе.

Выдаёт владельца группы.

Назначает владельца группы.

Возвращает адреса участников списка рассылки.

Добавляет один или несколько адресов участников списка рассылки.

Удаляет один или несколько адресов участников списка рассылки.

Возвращает текущие параметры участника списка рассылки.

Возвращает список адресов на которые оформлена подписка участника списка рассылки.

Возвращает адрес владельца списка рассылки.

Устанавливает адрес владельца списка рассылки.

Возвращает статус подписки участника списка рассылки.

Устанавливает статус подписки участника списка рассылки.

Выдаёт словарь папок аккаунта. Ключи словаря — полные имена папок в формате, заданном параметром mode.

Переименовывает папку.

Удаляет папку toDelete вместе со всеми вложенными папками.

Выдаёт ACL папки.

Изменяет ACL папки.

Выдаёт значение метаданных папки по ключу settings.key. Если ключ не указан, выдаются все сведения о папке.

Задаёт значение метаданных папки по ключу settings.key. Если значение object не указано, ключ удаляется из метаданных.

Выдаёт значение метаданных объекта по ключу или пути из массива ключей.

Задаёт значение метаданных объекта по ключу. Если значение object не указано, ключ удаляется из метаданных.

Увеличивает значение счётчика объекта.

Увеличивает значение временного счётчика объекта.

Выдаёт права аккаунта на папку.

Выдаёт ACL календаря.

Изменяет ACL календаря.

Выдаёт права аккаунта на календарь.

Выдаёт сведения о письме с UID msgUID в папке аккаунта. Папка задаётся именем mboxName или UID mbxUID.

Выдаёт список административных ролей.

Создаёт административную роль roleName с правами из массива. Уровень задаётся так же, как в команде RolesList: домен, сервер или кластер. Необязательный флаг true отключает рассылку уведомлений о смене прав по кластеру.

Удаляет административную роль roleName. Уровень задаётся так же, как в команде RolesList: домен, сервер или кластер. Необязательный флаг true отключает рассылку уведомлений о смене прав по кластеру.

Выдаёт список прав роли.

Изменяет административную роль roleName: удаляет права из массива rightsDel и добавляет права из массива rightsAdd. Уровень задаётся так же, как в команде RolesList: домен, сервер или кластер. Необязательный флаг true отключает рассылку уведомлений о смене прав по кластеру.

Выдаёт список администраторов.

Назначает пользователя user администратором с правами из массива. Уровень задаётся так же, как в команде AdminsList: домен, сервер или кластер. Необязательный флаг true отключает рассылку уведомлений о смене прав по кластеру.

Удаляет пользователя user из списка администраторов. Уровень задаётся так же, как в команде AdminsList: домен, сервер или кластер. Необязательный флаг true отключает рассылку уведомлений о смене прав по кластеру.

Выдаёт права администратора.

Изменяет права и роли администратора user: удаляет права из массива rightsDel и добавляет права из массива rightsAdd. Уровень задаётся так же, как в команде AdminsList: домен, сервер или кластер. Необязательный флаг true отключает рассылку уведомлений о смене прав по кластеру.

Выдаёт административные права аккаунта.

Выдаёт список административных прав, доступных текущему администратору. Если указать true, права выдаются вложенными словарями в соответствии с иерархией прав.

Выдаёт записи справочника, соответствующие запросу.

Добавляет в справочник запись с DN dn и атрибутами из JSON-объекта attributes.

Изменяет атрибуты записи справочника dn: атрибуты из JSON-объекта changedAttributes добавляются к существующим или заменяют их.

Перемещает запись справочника.

Удаляет запись справочника.

Запускает синхронизацию томов справочника, для которых настроено зеркалирование. Если указан dn, синхронизируется только том с этим DN; иначе — все тома с зеркалированием.

Синхронизирует справочник для доменов из массива. Если массив пустой, синхронизируются все домены.

Добавляет запись с DN dn и атрибутами из JSON-объекта attributes в справочник в базе данных PostgreSQL. Параметр server — URI подключения в формате postgres://user:pass@host:port/db.

Изменяет атрибуты записи dn в справочнике в базе данных PostgreSQL: атрибуты из JSON-объекта changedAttributes добавляются к существующим или заменяют их. Параметр server — URI подключения в формате postgres://user:pass@host:port/db.

Перемещает запись PostgreSQL-справочника.

Удаляет запись PostgreSQL-справочника.

Выдаёт записи LDAP-сервера, соответствующие запросу.

Выдаёт список плагинов с их настройками и статусом.

Создаёт плагин указанного типа с указанным именем.

Удаляет плагин указанного типа с указанным именем.

Запускает плагин указанного типа с указанным именем.

Останавливает плагин указанного типа с указанным именем.

Создаёт сессию для аккаунта и выдаёт токен сессии. Необязательный параметр protocolVersion задаёт версию протокола; по умолчанию используется последняя.

Закрывает сессию.

Выдаёт данные сессии.

Дополняет данные сессии с токеном token данными из объекта newInfo.

Отправляет в сессию с токеном token событие event.

Выдаёт список точек монтирования домена.

Создаёт в домене точку монтирования name. В кластере дополнительно передаётся фактическое имя каталога точки монтирования path.

Удаляет точку монтирования name домена. В точке монтирования не должно быть объектов. В кластере можно передать true, чтобы удалить и каталог точки монтирования.

Переносит каталог объекта домена на точку монтирования mountName и выдаёт новый путь к каталогу. Если mountName не указан, каталог переносится в основной каталог домена.

Выдаёт имя точки монтирования, на которой хранится каталог объекта. Пустая строка означает, что каталог находится в основном каталоге домена.

Выдаёт список объектов, которые хранятся на точке монтирования name домена. Если указать пустую строку, выдаются объекты, которые хранятся непосредственно в каталоге домена.

Выдаёт владельца ресурсного аккаунта, если он задан. Владелец может управлять ресурсом без административных прав.

Назначает владельца ресурсного аккаунта. Владелец может управлять ресурсом без административных прав.

Выдаёт список правил обработки почты. Уровень правила задаётся первыми двумя параметрами (см. начало раздела).

Выдаёт настройки правила ruleName. Уровень правила задаётся первыми двумя параметрами (см. начало раздела).

Удаляет правило ruleName. Уровень правила задаётся первыми двумя параметрами (см. начало раздела).

Создаёт правило ruleName с настройками из объекта ruleData. Уровень правила задаётся первыми двумя параметрами (см. начало раздела).

Изменяет правило ruleName в соответствии с объектом ruleData. Чтобы переименовать правило, передайте в ruleData ключ name с новым именем. Уровень правила задаётся первыми двумя параметрами (см. начало раздела).

Выдаёт настройки правила автоответа ruleName.

Удаляет правило автоответа ruleName.

Выдаёт список именованных наборов строк или содержимое набора listname, если он указан. Уровень правила задаётся первыми двумя параметрами (см. начало раздела).

Выдаёт значение общекластерной настройки по ключу или пути из массива ключей.

Задаёт значение общекластерной настройки по ключу или пути из массива ключей. Если skipCast — true, новое значение не передаётся на другие узлы кластера.

Удаляет значение общекластерной настройки. Если skipCast — true, удаление не передаётся на другие узлы кластера.

Выдаёт список файлов в хранилище некорректных файлов.

Выдаёт содержимое файла name из хранилища некорректных файлов в кодировке Base64.

Очищает хранилище некорректных файлов.

Добавляет адреса в белый список: в течение интервала, заданного в настройках сервера, они не блокируются. Адреса, которые были в чёрном списке, удаляются из него. Для адресов, которые уже есть в белом списке, срок продлевается.

Добавляет адреса в чёрный список: они блокируются на интервал, заданный в настройках сервера. Адреса, которые были в белом списке, удаляются из него. Для адресов, которые уже есть в чёрном списке, срок продлевается.

Удаляет адреса из белого списка.

Удаляет адреса из чёрного списка.

Выдаёт события календаря аккаунта за интервал от fromTime до tillTime. Повторяющиеся события разбиваются на отдельные экземпляры по правилам повторения (RRULE). Выдаётся не более countBefore событий до момента referenceTime и не более countAfter — после него.

Выдаёт событие календаря по его UID или по номеру письма msgUID в том виде, в котором оно хранится.

Заменяет напоминания события на переданные в параметре alarm (сокращённый VCALENDAR с VALARM или внутренний формат). Если передать пустой список, напоминания события удаляются.

Выдаёт ближайшее напоминание о событии в календаре. Если fromTime пустой, поиск начинается с текущего момента. Если calendarUID пустой, ищется ближайшее напоминание среди всех событий.

Выдаёт периоды занятости аккаунта за интервал от fromTime до tillTime. Интервал должен лежать в пределах от текущего момента до 30 дней вперёд. Обязательный параметр accessorMail — адрес аккаунта, от имени которого выполняется запрос; пустая строка — анонимный запрос.

Принимает (accept) или отклоняет (decline) предложение по событию calendarUID. Предложение хранится в письме proposal_msgUID в папке proposalMboxName; recurrenceID указывает экземпляр повторяющегося события.

Выдаёт UID всех событий календаря аккаунта.

Выдаёт список часовых поясов, известных серверу.

Создаёт или изменяет контакт в адресной книге аккаунта. Контакт передаётся объектом в формате vCard (RFC) или JUMP.

Удаляет контакт из адресной книги аккаунта по UID vCard или по номеру письма msgUID, в котором хранится контакт.

Ищет письма в папке аккаунта mboxName по полнотекстовому индексу и выдаёт UID писем, которые содержат слова из запроса query. Необязательный массив задаёт поля поиска: Body, Attachment, Subject, From, To, Cc, Bcc; по умолчанию поиск ведётся по всем полям.

Синхронизирует полнотекстовые индексы папок аккаунта user@domain, всех аккаунтов домена domain или всего сервера (*). Отсутствующие индексы создаются, недостающие письма индексируются, а записи об удалённых письмах удаляются из индекса.

Ищет письма по всей системе. Параметры поиска передаются словарём params.

Выдаёт профиль SMTP-Input name или все профили, если имя не указано. Если указать true, в результат включаются описания полей; если false — результат не содержит значений по умолчанию.

Выдаёт все профили SMTP-Output (без унаследованных значений по умолчанию) или профиль name (с унаследованными значениями). Если указать true, в результат включаются описания полей; если false — результат не содержит значений по умолчанию.

Выдаёт набор настроек федеративного доступа name или все наборы, если имя не указано.

Удаляет задание uid из планировщика.

Планирует отправку письма messageID на время delayTill. После успешной отправки письмо перемещается в папку targetMbox; если папка не указана, письмо не сохраняется.

Выдаёт сведения об отложенных письмах аккаунта (не более 100).

Проверяет маршрутизацию адреса и выдаёт результат: домен, объект и папку, тег, возможность ретрансляции и внешний маршрут. Необязательный параметр mode задаёт таблицу маршрутизатора, noext отключает вывод внешних маршрутов.

Выдаёт текст таблицы маршрутизатора: mode — 0 для почты, 1 для доступа. Если указан null, выдаётся общекластерная таблица.

Заменяет таблицу маршрутизатора mode текстом tabletext и применяет её. Если указан null, заменяется общекластерная таблица.

Выдаёт список DNS-серверов, настроенных на сервере.

Выполняет DNS-запрос записи типа recordType (A, AAAA, MX, TXT, NS, CNAME, PTR) для имени или адреса domName.

Выдаёт текущее состояние кластера (образ кластера) со сведениями обо всех узлах.

Выдаёт список блокировок объектов домена domUID; если указан accUID — только для этого объекта.

Выдаёт блокировки, которые удерживает узел memberUID. Результат можно ограничить доменом domUID и объектом accUID.

Выдаёт статистику по узлам кластера: число объектов и подключений.

Выводит текущий узел из кластера: узел переходит в режим офлайн. Роль диспетчера при этом может перейти к резервному узлу.

Исключает узел memberUID из кластера.

Формирует запрос на лицензию, подписанный ключом сервера, и сохраняет его в файл file или выдаёт в формате PEM. Словарь object содержит данные запроса: название организации, количество аккаунтов и т. п.

Проверяет и устанавливает лицензию из файла, строки PEM или словаря. В кластере лицензия передаётся диспетчеру.