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

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

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

Обзор

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

Требования

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

f5-sdk >= 3.0.16

Параметры

Параметр		Варианты/Значения по умолчанию	Комментарии
authentication boolean		Варианты: no yes	Данные аутентификации могут быть заданы в настройках SMTP-сервера, даже если эта аутентификация не используется (например, для конфигураций разработки или экстренных изменений). Этот параметр действует как переключатель для активации или деактивации параметров `smtp_server_username` и `smtp_server_password`. При `yes`, параметры аутентификации будут активны. При `no`, параметры аутентификации будут неактивны.
encryption -		Варианты: none ssl tls	Указывает, требуется ли SMTP-серверу зашифрованное соединение для отправки почты.
from_address -			Адрес электронной почты, с которого отправляется письмо. Это адрес "Ответ", который видит получатель.
local_host_name -			Имя хоста, используемое в заголовках SMTP в формате полностью квалифицированного доменного имени. Это значение не относится к имени хоста системы BIG-IP.
name - / обязательно			Указывает имя конфигурации SMTP-сервера.
partition -		По умолчанию: "Общие"	Раздел устройства для управления ресурсами.
password - / обязательно			Пароль учетной записи пользователя для подключения к BIG-IP. Вы можете опустить этот параметр, задав переменную среды `F5_PASSWORD`. псевдонимы: pass, pwd
provider - добавлен в 2.5		По умолчанию: null	Объект словаря, содержащий сведения о подключении.
	password - / обязательно		Пароль учетной записи пользователя для подключения к BIG-IP. Вы можете опустить этот параметр, задав переменную среды `F5_PASSWORD`. псевдонимы: pass, pwd
	server - / обязательно		Хост BIG-IP. Вы можете опустить этот параметр, задав переменную среды `F5_SERVER`.
	server_port -	По умолчанию: 443	Порт сервера BIG-IP. Вы можете опустить этот параметр, задав переменную среды `F5_SERVER_PORT`.
	ssh_keyfile -		Указывает файл SSH-ключа для аутентификации подключения к удаленному устройству. Этот аргумент используется только для транспортов cli. Вы можете опустить этот параметр, задав переменную среды `ANSIBLE_NET_SSH_KEYFILE`.
	timeout -	По умолчанию: 10	Указывает таймаут в секундах для связи с сетевым устройством при подключении или отправке команд. Если таймаут истекает до завершения операции, модуль выдаст ошибку.
	transport - / обязательно	Варианты: rest cli ←	Настраивает транспортное подключение для подключения к удаленному устройству.
	user - / обязательно		Имя пользователя для подключения к BIG-IP. Этот пользователь должен иметь административные привилегии на устройстве. Вы можете опустить этот параметр, задав переменную среды `F5_USER`.
	validate_certs boolean	Варианты: no yes ←	Если `no`, сертификаты SSL не проверяются. Используйте только на сайтах, управляемых вами, с самозаверенными сертификатами. Вы можете опустить этот параметр, задав переменную среды `F5_VALIDATE_CERTS`.
server - / обязательно			Хост BIG-IP. Вы можете опустить этот параметр, задав переменную среды `F5_SERVER`.
server_port - добавлен в 2.2		По умолчанию: 443	Порт сервера BIG-IP. Вы можете опустить этот параметр, задав переменную среды `F5_SERVER_PORT`.
smtp_server -			Имя хоста SMTP-сервера в формате полностью квалифицированного доменного имени. Это значение необходимо при создании новой конфигурации SMTP.
smtp_server_password -			Пароль, требуемый SMTP-сервером при проверке пользователя.
smtp_server_port -			Указывает номер порта SMTP. При создании новой конфигурации SMTP по умолчанию используется значение `25`, когда `encryption` равно `none` или `tls`. По умолчанию используется `465`, когда выбрано `ssl`.
smtp_server_username -			Имя пользователя, требуемое SMTP-сервером при проверке пользователя.
state -		Варианты: present ← absent	При значении `present`, гарантирует существование конфигурации SMTP. При значении `absent`, гарантирует отсутствие конфигурации SMTP.
update_password -		Варианты: always ← on_create	Пароли хранятся в зашифрованном виде, поэтому модуль не может определить, совпадает ли предоставленный `smtp_server_password` с существующим паролем или нет. Этот параметр контролирует обновление учетных данных `smtp_server_password`. При значении `always`, пароль всегда будет обновляться. При значении `on_create`, пароль будет установлен только для вновь созданных конфигураций SMTP-сервера.
user - / обязательно			Имя пользователя для подключения к BIG-IP. Этот пользователь должен иметь административные привилегии на устройстве. Вы можете опустить этот параметр, задав переменную среды `F5_USER`.
validate_certs boolean добавлен в 2.0		Варианты: no yes ←	Если `no`, сертификаты SSL не проверяются. Используйте только на сайтах, управляемых вами, с самозаверенными сертификатами. Вы можете опустить этот параметр, задав переменную среды `F5_VALIDATE_CERTS`.

Примечания

Примечание

Дополнительную информацию об использовании Ansible для управления устройствами F5 Networks см. на сайте https://www.ansible.com/integrations/networks/f5.
Требуется пакет f5-sdk Python на хосте. Это так же просто, как pip install f5-sdk.
Требуется версия ПО 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
    password: secret
    server: lb.mydomain.com
    state: present
    user: admin
  delegate_to: localhost

Значения возврата

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

Ключ	Возвращаемое значение	Описание
authentication boolean	changed	Указывает, активны ли параметры аутентификации. Пример: True
encryption строка	changed	Новое значение параметра шифрования конфигурации SMTP. Пример: tls
from_address строка	changed	Новое значение параметра from_address конфигурации SMTP. Пример: no-reply@mydomain.com
local_host_name строка	changed	Новое значение параметра local_host_name конфигурации SMTP. Пример: smtp.mydomain.com
smtp_server строка	changed	Новое значение параметра smtp_server конфигурации SMTP. Пример: mail.mydomain.com
smtp_server_port целое число	changed	Новое значение параметра smtp_server_port конфигурации SMTP. Пример: 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.7/modules/bigip_smtp_module.html