Модуль check_point.mgmt.cp_mgmt_smtp_server — управление объектами SMTP-серверов Checkpoint через API веб-служб

Примечание

Этот модуль входит в коллекцию check_point.mgmt (версия 6.9.0).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.

Чтобы установить её, используйте: ansible-galaxy collection install check_point.mgmt.

Чтобы использовать её в плейбуке, укажите: check_point.mgmt.cp_mgmt_smtp_server.

Добавлено в check_point.mgmt 3.0.0

Обзор
Параметры
Примеры
Возвращаемые значения

Обзор

Управляет объектами SMTP-серверов на устройствах Checkpoint, включая создание, обновление и удаление объектов.
Все операции выполняются через API веб-служб.
Доступно начиная с версии системы управления R81.20.

Параметры

Параметр	Комментарии
authentication логическое значение	Требует ли почтовый сервер аутентификацию. Варианты: `false` `true`
auto_publish_session логическое значение	Опубликовать текущий сеанс после завершения задачи, если в него были внесены изменения. Варианты: `false` ← (по умолчанию) `true`
color строка	Цвет объекта. Должен быть одним из существующих цветов. Варианты: `"aquamarine"` `"black"` `"blue"` `"crete blue"` `"burlywood"` `"cyan"` `"dark green"` `"khaki"` `"orchid"` `"dark orange"` `"dark sea green"` `"pink"` `"turquoise"` `"dark blue"` `"firebrick"` `"brown"` `"forest green"` `"gold"` `"dark gold"` `"gray"` `"dark gray"` `"light green"` `"lemon chiffon"` `"coral"` `"sea green"` `"sky blue"` `"magenta"` `"purple"` `"slate blue"` `"violet red"` `"navy blue"` `"olive"` `"orange"` `"red"` `"sienna"` `"yellow"`
comments строка	Строка комментариев.
details_level строка	Уровень детализации некоторых полей в ответе может варьироваться от отображения только значения UID объекта до полностью подробного представления объекта. Варианты: `"uid"` `"standard"` `"full"`
domains_to_process список / элементы=строка	Указывает, в каких доменах выполнять команды. Нельзя использовать вместе со значением full для details-level; запускать команду можно только из системного домена и при значении true для ignore-warnings. Допустимые значения: CURRENT_DOMAIN, ALL_DOMAINS_ON_THIS_SERVER.
encryption строка	Тип шифрования. Варианты: `"none"` `"ssl"` `"tls"`
ignore_errors логическое значение	Применять изменения, игнорируя ошибки. Опубликовать такие изменения не удастся. Если флаг ignore-warnings не указан, предупреждения также будут игнорироваться. Варианты: `false` `true`
ignore_warnings логическое значение	Применять изменения, игнорируя предупреждения. Варианты: `false` `true`
name строка / обязательный	Имя объекта.
password строка	Пароль для SMTP-сервера.
port целое число	Используемый порт SMTP.
server строка	Адрес SMTP-сервера.
state строка	Состояние правила доступа (present или absent). Варианты: `"present"` ← (по умолчанию) `"absent"`
tags список / элементы=строка	Коллекция идентификаторов тегов.
username строка	Имя пользователя для SMTP-сервера.
version строка	Версия Checkpoint. Если она не указана, используется последняя версия.
wait_for_task логическое значение	Ожидать завершения задачи, например задачи публикации. Варианты: `false` `true` ← (по умолчанию)
wait_for_task_timeout целое число	Количество минут ожидания до возникновения ошибки тайм-аута. По умолчанию: `30`

Примеры

- name: add-smtp-server
  cp_mgmt_smtp_server:
    encryption: none
    name: SMTP1
    port: '25'
    server: smtp.example.com
    state: present

- name: set-smtp-server
  cp_mgmt_smtp_server:
    name: SMTP
    port: '25'
    server: smtp.example.com
    state: present

- name: delete-smtp-server
  cp_mgmt_smtp_server:
    name: SMTP
    state: absent

Возвращаемые значения

Общие возвращаемые значения описаны здесь; ниже перечислены поля, уникальные для этого модуля:

Ключ	Описание
cp_mgmt_smtp_server словарь	Созданный или обновлённый объект Checkpoint. Возвращается: всегда, кроме случаев удаления объекта.

Авторы

Eden Brillant (@chkp-edenbr)

Ссылки на коллекцию

© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/check_point/mgmt/cp_mgmt_smtp_server_module.html