f5networks.f5_modules.bigip_smtp – Управляет настройками SMTP на BIG-IP

Примечание

Этот плагин входит в коллекцию f5networks.f5_modules (версия 1.7.1).

Для установки используйте: ansible-galaxy collection install f5networks.f5_modules.

Чтобы использовать его в книге задач, укажите: f5networks.f5_modules.bigip_smtp.

Новый в версии 1.0.0: модуля f5networks.f5_modules

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

Обзор

Позволяет настроить BIG-IP на отправку почты через SMTP-сервер, настраивая параметры SMTP-сервера.

Параметры

Параметр		Варианты/Значения по умолчанию	Комментарии
authentication boolean		Варианты: no yes	Учетные данные могут быть заданы в конфигурации SMTP-сервера, даже если эта аутентификация не используется (например, для конфигураций разработки или внештатных изменений). Этот параметр служит переключателем для активации или деактивации указанных `smtp_server_username` и `smtp_server_password` параметров. При `yes`, параметры аутентификации активны. При `no`, параметры аутентификации неактивны.
encryption string		Варианты: none ssl tls	Указывает, требуется ли SMTP-серверу зашифрованное соединение для отправки почты.
from_address string			Адрес электронной почты, с которого отправляется письмо. Это адрес "Ответ", который видит получатель.
local_host_name string			Имя хоста, используемое в SMTP-заголовках в формате полностью квалифицированного доменного имени. Это значение не относится к имени хоста системы BIG-IP.
name string / обязательно			Указывает имя конфигурации SMTP-сервера.
partition string		Значение по умолчанию: "Common"	Раздел устройства для управления ресурсами.
provider dictionary добавлен в версии 1.0.0 f5networks.f5_modules			Объект типа dict, содержащий данные подключения.
	auth_provider string		Настраивает поставщика аутентификации для получения маркеров аутентификации от удаленного устройства. Этот параметр действительно используется при работе с устройствами BIG-IQ.
	no_f5_teem boolean	Варианты: no yes	Если `yes`, данные телеметрии TEEM не отправляются в F5. Вы можете пропустить этот параметр, установив переменную среды `F5_TEEM`.
	password string / обязательно		Пароль учетной записи пользователя для подключения к BIG-IP. Вы можете пропустить этот параметр, установив переменную среды `F5_PASSWORD`. Псевдонимы: pass, pwd
	server string / обязательно		Хост BIG-IP. Вы можете пропустить этот параметр, установив переменную среды `F5_SERVER`.
	server_port integer	Значение по умолчанию: 443	Порт сервера BIG-IP. Вы можете пропустить этот параметр, установив переменную среды `F5_SERVER_PORT`.
	timeout integer		Указывает таймаут в секундах для связи с сетевым устройством для подключения или отправки команд. Если таймаут истечет до завершения операции, модуль вернёт ошибку.
	transport string	Варианты: rest ←	Настраивает транспортное соединение для использования при подключении к удаленному устройству.
	user string / обязательно		Имя пользователя для подключения к BIG-IP. Этот пользователь должен иметь административные права на устройстве. Вы можете пропустить этот параметр, установив переменную среды `F5_USER`.
	validate_certs boolean	Варианты: no yes ←	Если `no`, сертификаты SSL не проверяются. Используйте только на контролируемых вами сайтах с самоподписанными сертификатами. Вы можете пропустить этот параметр, установив переменную среды `F5_VALIDATE_CERTS`.
smtp_server string			Имя хоста SMTP-сервера в формате полностью квалифицированного доменного имени. Это значение обязательно при создании новой конфигурации SMTP.
smtp_server_password string			Пароль, запрашиваемый SMTP-сервером при проверке пользователя.
smtp_server_port integer			Указывает номер порта SMTP. При создании новой конфигурации SMTP значение по умолчанию — `25`, когда `encryption` равно `none` или `tls`. По умолчанию — `465`, когда выбрано `ssl`.
smtp_server_username string			Имя пользователя, требуемое SMTP-сервером для проверки пользователя.
state string		Варианты: present ← absent	При `present`, гарантирует существование конфигурации SMTP. При `absent`, гарантирует отсутствие конфигурации SMTP.
update_password string		Варианты: always ← on_create	Пароли хранятся зашифрованными, поэтому модуль не может определить, совпадает ли предоставленный `smtp_server_password` с существующим паролем или является новым. Этот параметр управляет обновлением `smtp_server_password` учетных данных. При `always`, система всегда обновляет пароль. При `on_create`, система устанавливает пароль только для новых конфигураций SMTP-серверов.

Примечания

Примечание

Дополнительную информацию об использовании Ansible для управления устройствами F5 Networks см. на https://www.ansible.com/integrations/networks/f5.
Требуется версия ПО BIG-IP >= 12.
Модули F5 изменяют только текущую конфигурацию продукта F5. Чтобы гарантировать сохранение специфичной для BIG-IP конфигурации на диске, обязательно включите хотя бы одну задачу, использующую модуль f5networks.f5_modules.bigip_config для сохранения текущей конфигурации. Обратитесь к документации модуля для правильного использования модуля, чтобы сохранить текущую конфигурацию.

Примеры

- name: Create a base SMTP server configuration
  bigip_smtp:
    name: my-smtp
    smtp_server: 1.1.1.1
    smtp_server_username: mail-admin
    smtp_server_password: mail-secret
    local_host_name: smtp.mydomain.com
    from_address: no-reply@mydomain.com
    state: present
    provider:
      user: admin
      password: secret
      server: lb.mydomain.com
  delegate_to: localhost

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

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

Ключ	Возвращаемое значение	Описание
authentication boolean	changed	Активны ли параметры аутентификации или нет. Пример: True
encryption string	changed	Новое значение `encryption` конфигурации SMTP. Пример: tls
from_address string	changed	Новое значение `from_address` конфигурации SMTP. Пример: no-reply@mydomain.com
local_host_name string	changed	Новое значение `local_host_name` конфигурации SMTP. Пример: smtp.mydomain.com
smtp_server string	changed	Новое значение `smtp_server` конфигурации SMTP. Пример: mail.mydomain.com
smtp_server_port integer	changed	Новое значение `smtp_server_port` конфигурации SMTP. Пример: 25

Авторы

Tim Rupp (@caphrim007)

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/f5networks/f5_modules/bigip_smtp_module.html