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

Новая в версии 2.6.

Краткое описание
Параметры
Примечания
Примеры
Возвращаемые значения
Статус

Краткое описание

Позволяет настроить 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 добавлено в 2.5			Объект типа dict, содержащий данные подключения.
	auth_provider string		Настраивает поставщика аутентификации для получения маркеров аутентификации с удаленного устройства. Этот параметр действительно используется при работе с устройствами BIG-IQ.
	password string / обязательно		Пароль для учетной записи пользователя, используемой для подключения к BIG-IP. Вы можете опустить этот параметр, установив переменную среды `F5_PASSWORD`. псевдонимы: pass, pwd
	server string / обязательно		Хост BIG-IP. Вы можете опустить этот параметр, установив переменную среды `F5_SERVER`.
	server_port integer	По умолчанию: 443	Порт сервера BIG-IP. Вы можете опустить этот параметр, установив переменную среды `F5_SERVER_PORT`.
	ssh_keyfile path		Указывает SSH-ключевой файл для аутентификации подключения к удаленному устройству. Этот аргумент используется только для транспортов cli. Вы можете опустить этот параметр, установив переменную среды `ANSIBLE_NET_SSH_KEYFILE`.
	timeout integer		Указывает таймаут в секундах для связи с сетевым устройством для подключения или отправки команд. Если таймаут истечет до завершения операции, модуль выдаст ошибку.
	transport string	Варианты: cli 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 конфигурация сохранится на диске, убедитесь, что включён хотя бы один шаг, использующий модуль 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	изменённое	Указывается, активны ли параметры аутентификации. Пример: True
encryption string	изменённое	Новое значение параметра SMTP-конфигурации `encryption`. Пример: tls
from_address string	изменённое	Новое значение параметра SMTP-конфигурации `from_address`. Пример: no-reply@mydomain.com
local_host_name string	изменённое	Новое значение параметра SMTP-конфигурации `local_host_name`. Пример: smtp.mydomain.com
smtp_server string	изменённое	Новое значение параметра SMTP-конфигурации `smtp_server`. Пример: mail.mydomain.com
smtp_server_port integer	изменённое	Новое значение параметра SMTP-конфигурации `smtp_server_port`. Пример: 25

Статус

Данный модуль не гарантирует обратной совместимости интерфейса. [превью]
Этот модуль поддерживается партнёром Ansible. [сертифицировано]

Авторы

Tim Rupp (@caphrim007)

Подсказка

Если вы заметили какие-либо проблемы в этой документации, вы можете отредактировать этот документ, чтобы улучшить его.

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.9/modules/bigip_smtp_module.html