Модуль fortinet.fortios.fortios_system_email_server – настройка почтового сервера, используемого FortiGate для различных целей. Например, для отправки пользователям сообщений электронной почты с целью поддержки функций аутентификации пользователей в Fortinet FortiOS и FortiGate.

Примечание

Этот модуль входит в коллекцию fortinet.fortios (версия 2.5.1).

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

Для установки используйте: ansible-galaxy collection install fortinet.fortios. Для использования этого модуля могут потребоваться дополнительные компоненты; подробности см. в разделе Требования.

Чтобы использовать модуль в плейбуке, укажите: fortinet.fortios.fortios_system_email_server.

Добавлено в fortinet.fortios 2.0.0

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

Обзор

Этот модуль позволяет настраивать устройство FortiGate или FortiOS (FOS), задавая и изменяя параметры системной функции и категории email_server. Перед использованием необходимо настроить все параметры и значения, например указать источники данных. Проверено с FOS v6.0.0

Требования

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

ansible>=2.16

Параметры

Параметр	Комментарии
access_token string	Аутентификация на основе токена. Создается в графическом интерфейсе FortiGate.
enable_log boolean	Включить или отключить ведение журнала для задачи. Варианты: `false` ← (по умолчанию) `true`
member_path string	Путь к атрибуту элемента, с которым необходимо выполнить операцию. Если атрибутов несколько, они разделяются символом косой черты. Параметр с атрибутом member_path можно использовать для выполнения операции с элементом.
member_state string	Добавить или удалить элемент по указанному пути к атрибуту. Если указан member_state, параметр state игнорируется. Варианты: `"present"` `"absent"`
system_email_server dictionary	Настройка почтового сервера, используемого FortiGate для различных целей. Например, для отправки пользователям сообщений электронной почты с целью поддержки функций аутентификации пользователей.
authenticate string	Включить или отключить аутентификацию. Варианты: `"enable"` `"disable"`
interface string	Укажите исходящий интерфейс для доступа к серверу. Источник: system.interface.name.
interface_select_method string	Укажите способ выбора исходящего интерфейса для доступа к серверу. Варианты: `"auto"` `"sdwan"` `"specify"`
password string	Пароль пользователя SMTP-сервера для аутентификации.
port integer	Порт SMTP-сервера.
reply_to string	Адрес электронной почты для ответа (Reply-To).
security string	Безопасность соединения, используемая почтовым сервером. Варианты: `"none"` `"starttls"` `"smtps"`
server string	IP-адрес или имя узла SMTP-сервера.
source_ip string	Исходный IPv4-адрес SMTP-сервера.
source_ip6 string	Исходный IPv6-адрес SMTP-сервера.
ssl_min_proto_version string	Минимальная поддерживаемая версия протокола для SSL/TLS-соединений. Варианты: `"default"` `"SSLv3"` `"TLSv1"` `"TLSv1-1"` `"TLSv1-2"` `"TLSv1-3"`
type string	Использовать службу сообщений FortiGuard или пользовательский почтовый сервер. Варианты: `"custom"`
username string	Имя пользователя SMTP-сервера для аутентификации.
validate_server string	Включить или отключить проверку сертификата сервера. Варианты: `"enable"` `"disable"`
vrf_select integer	Идентификатор VRF, используемый для подключения к серверу.
vdom string	Виртуальный домен из числа ранее определенных. VDOM — это виртуальный экземпляр FortiGate, который можно настроить и использовать как отдельное устройство. По умолчанию: `"root"`

Примечания

Примечание

Устаревший fortiosapi объявлен устаревшим; для запуска плейбуков рекомендуется использовать httpapi
Модуль поддерживает check_mode.

Примеры

- name: Configure the email server used by the FortiGate various things. For example, for sending email messages to users to support user authentication
   features.
  fortinet.fortios.fortios_system_email_server:
      vdom: "{{ vdom }}"
      system_email_server:
          authenticate: "enable"
          interface: "<your_own_value> (source system.interface.name)"
          interface_select_method: "auto"
          password: "<your_own_value>"
          port: "25"
          reply_to: "<your_own_value>"
          security: "none"
          server: "192.168.100.40"
          source_ip: "84.230.14.43"
          source_ip6: "<your_own_value>"
          ssl_min_proto_version: "default"
          type: "custom"
          username: "<your_own_value>"
          validate_server: "enable"
          vrf_select: "0"

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

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

Ключ	Описание
build string	Номер сборки образа FortiGate Возвращается: всегда Пример: `"1547"`
http_method string	Последний метод, использованный для передачи конфигурации на FortiGate Возвращается: всегда Пример: `"PUT"`
http_status string	Последний результат, возвращенный FortiGate при выполнении последней операции Возвращается: всегда Пример: `"200"`
mkey string	Мастер-ключ (идентификатор), использованный при последнем вызове FortiGate Возвращается: при успешном выполнении Пример: `"id"`
name string	Имя таблицы, использованной для выполнения запроса Возвращается: всегда Пример: `"urlfilter"`
path string	Путь к таблице, использованной для выполнения запроса Возвращается: всегда Пример: `"webfilter"`
revision string	Внутренний номер редакции Возвращается: всегда Пример: `"17.0.2.10658"`
serial string	Серийный номер устройства Возвращается: всегда Пример: `"FGVMEVYYQT3AB5352"`
status string	Результат операции Возвращается: всегда Пример: `"success"`
vdom string	Использованный виртуальный домен Возвращается: всегда Пример: `"root"`
version string	Версия FortiGate Возвращается: всегда Пример: `"v5.6.3"`

Авторы

Link Zheng (@chillancezen)
Jie Xue (@JieX19)
Hongbin Lu (@fgtdev-hblu)
Frank Shen (@frankshen01)
Miguel Angel Munoz (@mamunozgonzalez)
Nicolas Thomas (@thomnico)

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

© 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/fortinet/fortios/fortios_system_email_server_module.html