Demo
Demo
База знаний PMTA›Точка API§ 8.2.3

Перечень файлов конфигурации

/configFile listconfigfiles
Какие файлы вообще есть

Перечисляет действующие файлы конфигурации: главный, подключённые строкой include и файл умолчаний.

Вызов — GET /configFile?op=listconfigfiles&format=json. Без format ответ приходит в XML.

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

Файл умолчаний в списке есть, но править его нельзя: установка и обновление перезаписывают его целиком.

Для чтения ключ не обязателен, если адресу запроса выдан уровень не ниже operator в http-access; ключ из http-api-key в заголовке X-API-Key снимает ограничение по адресу.

Главная ловушка — принять список за всё, что читает MTA. Здесь только файлы конфигурации. Лицензия, сертификаты и ключи подписи, которые директивы называют путём, сюда не входят, и копия «по этому списку» окажется неполной.
Что делает Хаб. Не спрашивает: состав файлов на узле Хаб знает сам — он их и пишет: /etc/pmta/config, файл адресов отправки /etc/pmta/virtualhost.txt и файл прокси /etc/pmta/proxy.txt.
Рекомендуемые значения

Параметры:

Параметр Обязателен Что задаёт
op да listconfigfiles — перечень файлов
format нет json или xml, по умолчанию xml
Параметры, умолчание формата и оговорка про файл умолчаний — из руководства (§ 8.2.3, § 5.6). Вывод про неполную резервную копию — наш.
Пример в конфигурации
# действующие файлы конфигурации
curl -s 'http://127.0.0.1:8080/configFile?format=json&op=listconfigfiles'
В ответе будет и файл умолчаний /etc/pmta/config-defaults: он действует, но правки в нём не переживут обновления.
жёлтым — — имена директив, голубым — блоки. Так же они подсвечены и в тексте карточки.
Совместимость
PowerMTA 6.0
описана в руководстве этой версии · платформа: любая
С какой версии директива доступна, вендор указывает не для всех — здесь пометки нет. Имя встречается и в издании руководства 5.0.
⇄

Связанные записи

1 связь

Работают в паре

Прочитать файл конфигурации по сетиСмежная запись каталога. § 8.2.3

Как проверить на узле
Сверить перечень со строками подключения:
curl -s 'http://127.0.0.1:8080/configFile?format=json&op=listconfigfiles'
grep -rn '^include' /etc/pmta/config
Руководство обещает в перечне действующие файлы, так что подключённый, но пропавший из ответа файл — повод проверить путь в строке include.
◇

Что ещё почитать

3 статьи

◇Принять, направить, доставитьПуть письма внутри узла: принять, решить куда, доставить — и между этими тремя шагами живут все настройки.◇Четыре типа значений, на которых написан весь конфигЛогическое, образец домена, регулярное выражение и промежуток времени — определены один раз в § 3.2 и дальше используются всеми директивами.◇Перезагрузка настроек против перезапуска службыКонфигурация читается при старте, дальше правки подхватываются командой перезагрузки — кроме тех директив, которые руководство помечает как требующие перезапуска.

В Хабе
Цена ошибки
безопасно: неверное значение ничего не ломает
Сценарии
Жизненный цикл конфигурации