IVA Mail Studio. Руководство оператора

Пошаговое руководство по работе с программой — клиентом протокола CMD сервера IVA Mail, который раньше использовался через telnet или nc. Предполагается, что у вас есть административная учётная запись на сервере и вы знаете, какую команду хотите выполнить; опыт работы именно с этим клиентом не требуется.

Установка не требуется. Скопируйте папку релиза в любое место и запустите:

В переданной вам папке находится:

При первом запуске список серверов пуст, о чём программа и сообщает:

Выбор способа аутентификации

Если подключение происходит без TLS, замените LOGIN на один из этих способов. Они защищают только пароль, а не весь остальной сеанс, и потому не заменяют TLS, но сделать это стоит. Сервер поддерживает все четыре способа.

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

Ещё до подключения на карточке сервера видно, каким будет соединение:

Возможные варианты в зависимости от настроек профиля.:

После подключения открывается терминал с итогом того, что произошло:

Профиль — это именованный список серверов. В одной копии программы их может быть сколько угодно: продуктив, тестовый стенд, кластер заказчика. Открыт всегда ровно один. Выбор профиля находится вверху панели серверов, над тем списком, который он называет.

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

Копирование сервера в другой профиль

Сервер остаётся на месте, копия переносится вместе с паролем. Повторное копирование того же сервера в тот же профиль отклоняется: это один и тот же сервер в двух списках, а не два разных. Поле появляется только тогда, когда есть куда копировать.

Профили или --data-dir

И то и другое даёт несколько наборов серверов, но отвечает на разные вопросы. Профили переключаются во время работы и используют общий файл настроек и общую папку transcripts\. Ключ --data-dir Файлы и переносимость задаётся при запуске и разделяет всё, включая журналы сеансов. Профили удобны, когда нужно «на минуту заглянуть в соседний кластер», --data-dir — когда конфигурации вообще не должны пересекаться.

Кнопка Импорт из JSON под списком серверов читает файл profiles.json и добавляет описанные в нём серверы в открытый профиль. Принимаются оба формата.

Серверы и сохранённые пароли переносятся без изменений, исходный файл не изменяется. Поэтому обе программы могут работать параллельно, пока идёт переход, а повторный импорт того же файла ничего не добавляет.

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

Две прежние настройки поменяли смысл при переходе со старого клиента. Флажки inline и noescape раньше влияли на то, что присылает сервер. Теперь это только настройки отображения на стороне клиента: соединение само согласовывает нужные ему режимы, а форматирование выполняется здесь. Функциональность при этом не теряется.

Наберите команду в поле внизу и нажмите Enter.

Начните набирать — появятся подходящие команды. Список приходит с того сервера, к которому вы подключены, поэтому всегда соответствует именно его набору команд.

Строка подсказки

Под полем ввода отображается сигнатура команды — та, что сообщил сам сервер:

А для большинства команд ещё и краткое описание того, что она делает:

Серый текст после курсора — подсказка. Он показывает форму того, что может идти дальше, а не конкретное значение, поэтому сам по себе не подставляется.

Tab — значение аргументов

Когда список закрыт, Tab запрашивает у сервера, что может стоять в набираемом аргументе:

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

Каждый результат остаётся на строке, которая его вызвала. Отдельной панели «последний результат» нет, поэтому ничего никуда не перенаправляется и ничего нельзя случайно закрыть и потерять.

Дерево, Текст и Таблица

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

Щелчок по корню сворачивает весь результат:

Щелчок по ветке раскрывает её на месте:

Или переключитесь на текстовый вид:

Окно таблицы

Кнопки в заголовке

Ошибки

Ответ 4xx или 5xx — обычный результат, а не разрыв соединения. Он отображается цветной строкой, и сеанс остаётся рабочим.

Нажмите Ctrl + F либо кнопку Поиск.

Откройте вкладку Объекты.

Раскройте домен — и его объекты будут запрошены именно в этот момент, а не заранее для всех доменов сразу.

Выберите один объект — его настройки отобразятся рядом с деревом.

По умолчанию панель открывается в режиме Только заданные здесь, поскольку именно это обычно и требуется при просмотре объекта. Снимите флажок, чтобы увидеть полную картину:

У доменов есть собственные настройки; они запрашиваются отдельной командой и отображаются так же:

Введите значение в верхнем поле и нажмите Enter либо Найти.

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

Этот поиск работает не по имени, а по значению параметра — то есть отвечает на вопросы вида «у каких объектов задан такой-то параметр и какое у него значение».

Наберите имя параметра во втором поле — например, IsAdmin, чтобы найти учётные записи с признаком администратора, — и нажмите Enter либо Найти.

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

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

На большом сервере поиск занимает время, поскольку выполняется отдельной командой на каждый домен:

Результат поиска — обычное выделение, поэтому его можно сразу использовать в разделах Создание, переименование, удаление или Одна команда, много объектов.

Кнопки под деревом действуют на выбранный домен или объект.

Если сервер отклонил запрос, отказ отображается, и других действий не выполняется.

Выберите несколько объектов в дереве — полоса над кнопками покажет, что именно выделено.

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

Сохранение выделения

Команда Сохранить как группу… присваивает выделению имя и сохраняет его вместе с профилем сервера. Позже такую группу можно выбрать из списка Сохранённые группы, команда Удалить группу удаляет запись.

Сохранённая группа — это список объектов, который хранится в профиле клиента. Это не группа на сервере: такую создаёт кнопка Новая группа.

Кнопка Снять очищает выделение. Вместе с ним очищается и панель настроек.

Кнопка Снять выделение на той же полосе сбрасывает объекты, выбранные во вкладке «Объекты».

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

Если ответы разошлись, в итоге предлагается кнопка Сравнить.

Сравнение выполняется по содержимому ответа, а не по строке статуса: два сервера, одинаково ответившие 200 OK, — это как раз тот случай, когда важно увидеть различие в данных.

Окно построено по параметрам. Каждый различающийся параметр указан по точечному пути (Router.Limits.Max, ciphers[1]), а под ним — каждое значение по одному разу, с перечнем серверов, которые его дали, и их количеством; первым идёт значение, с которым согласно большинство. Поэтому параметр, по которому двадцать серверов разошлись на два значения, — это две строки, а не двадцать, и вопрос, ради которого окно открывают, — кто отличается и чем, — виден прямо в структуре таблицы.

Перечисляются только различающиеся параметры — в настройках их сотни, и включение совпадающих скрыло бы те немногие, что действительно важны, — а строка над таблицей сообщает, сколько параметров разошлось и сколько серверов было опрошено. Массивы сравниваются по позициям, поэтому изменение порядка элементов также остаётся заметным.

Сценарий — обычный текстовый файл: по команде на строку, пустые строки и строки, начинающиеся с #, игнорируются. Файл example-script.txt из папки релиза — безопасная отправная точка: он выполняет только команды чтения.

Каждая команда завершается на всех серверах, прежде чем начнётся следующая. Для последовательности изменяющих команд это принципиально: иначе один сервер может остаться на середине сценария, пока остальные уже выполнят его до конца.

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

Выделение вывода

Вывод выделяется мышью так же, как обычный текст на странице. Выделение свободно тянется от любой строки до любой другой: команда, строка ответа и содержимое под ней — это один сплошной текст, а не три отдельных поля. Ctl+C копирует выделенное. Двойной щелчок выделяет имя целиком — например, corp.dom или user@host, если тянуть за верхний или нижний край, вывод прокручивается сам.

Результат, выделенный целиком, копируется целиком — со всеми уровнями дерева, даже если на экране они свёрнуты. У свёрнутой ветки показаны только первые несколько полей, и это краткая сводка, а не данные, — копировать её вместо содержимого смысла нет. Если выделить часть результата, скопируется ровно то, что выделено.

Как только вы начинаете набирать команду, выделение снимается, и Ctl + C снова копирует из поля ввода.

В поле ввода команды

В поле поиска Enter / Shift + Enter переводят между совпадениями.

Всё, что программа читает и записывает, находится рядом с исполняемым файлом:

Программа не записывает данные в %APPDATA%, %LOCALAPPDATA%, Program Files или реестр и не использует интеграцию с оболочкой Windows. Папку можно скопировать на промежуточный узел, в общий каталог или на флешку — всё будет работать, при удалении папки не останется следов.

Расположение файлов определяется папкой исполняемого файла, а не текущим рабочим каталогом, поэтому ярлык с другой рабочей папкой всё равно найдёт список серверов.

Несколько конфигураций из одной копии

profiles.json и transcripts\ при этом создаются внутри указанной папки. Относительный путь отсчитывается от папки исполняемого файла — по той же причине, что и выше. Если указанный ключ запуска программе непонятен, она останавливается с подсказкой, а не запускается на папке по умолчанию с ощущением, что серверы пропали.

Пароли

Пароли в profiles.json зашифрованы средствами Windows DPAPI и привязаны к конкретной машине и учётной записи Windows.

Копия, перенесённая на другой компьютер, сохранит список серверов, но запросит пароли заново. Это ожидаемое поведение такого шифрования, а не ограничение, которое стоит обходить.

В строке подсказки используется штатная нотация сервера:

Имя принимается везде, где в нотации указано "dom.name"|domUID, поэтому UID — это допустимая возможность, а не обязательное требование; для чтения удобнее использовать имя.

Префиксы типов в значениях

Значения получают префикс типа там, где тип не очевиден из самого JSON:

Русский и английский язык интерфейса переключаются списком в заголовке окна. Изменение применяется сразу, без перезапуска программы, а выбор сохраняется вместе с профилями серверов.