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

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

Обзор
- Требования
Параметры
Примечания
Примеры
Возвращаемые значения
Статус
Техническое обслуживание
- Автор

Обзор

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

Требования

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

f5-sdk >= 3.0.9
netaddr

Параметры

Параметр		Варианты/Значения по умолчанию	Комментарии
authentication bool		Варианты: 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)			Объект типа dict, содержащий данные подключения.
	password обязательно		Пароль учетной записи пользователя для подключения к BIG-IP. Вы можете опустить этот параметр, если переменная окружения `F5_PASSWORD` задана. псевдонимы: pass, pwd
	server обязательно		Хост BIG-IP. Вы можете опустить этот параметр, если переменная окружения `F5_SERVER` задана.
	server_port	Значение по умолчанию: 443	Порт сервера BIG-IP. Вы можете опустить этот параметр, если переменная окружения `F5_SERVER_PORT` задана.
	user обязательно		Имя пользователя для подключения к BIG-IP. Этот пользователь должен иметь административные привилегии на устройстве. Вы можете опустить этот параметр, если переменная окружения `F5_USER` задана.
	validate_certs bool	Варианты: no да ←	Если `no`, сертификаты SSL не будут проверены. Используйте только на сайтах, контролируемых лично, с самозаверенными сертификатами. Вы можете опустить этот параметр, если переменная окружения `F5_VALIDATE_CERTS` задана.
	timeout	Значение по умолчанию: 10	Указывает таймаут в секундах для связи с сетевым устройством для подключения или отправки команд. Если таймаут превышен до завершения операции, модуль выдаст ошибку.
	ssh_keyfile		Указывает SSH-ключевой файл для аутентификации подключения к удаленному устройству. Этот аргумент используется только для транспортов cli. Если значение не указано в задаче, будет использовано значение переменной окружения `ANSIBLE_NET_SSH_KEYFILE`.
	transport обязательно	Варианты: rest cli ←	Настраивает транспортное соединение для подключения к удаленному устройству.
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		Варианты: всегда ← при_создании	Пароли хранятся в зашифрованном виде, поэтому модуль не может узнать, является ли предоставленный `smtp_server_password` тем же или другим паролем, что и существующий. Этот параметр управляет обновлением учетных данных `smtp_server_password`. При значении `always` пароль всегда будет обновлён. При значении `on_create` пароль будет установлен только для вновь созданных конфигураций SMTP-сервера.
user обязательно			Имя пользователя для подключения к BIG-IP. Этот пользователь должен иметь административные привилегии на устройстве. Вы можете опустить этот параметр, если переменная окружения `F5_USER` задана.
validate_certs bool (добавлен в 2.0)		Варианты: no да ←	Если `no`, сертификаты SSL не будут проверены. Используйте только на сайтах, контролируемых лично, с самозаверенными сертификатами. Вы можете опустить этот параметр, если переменная окружения `F5_VALIDATE_CERTS` задана.

Примечания

Примечание

Требуется пакет Python netaddr на хосте. Это так же просто, как pip install netaddr.
Дополнительную информацию об использовании Ansible для управления устройствами F5 Networks см. на сайте https://www.ansible.com/integrations/networks/f5.
Требуется пакет Python f5-sdk на хосте. Это так же просто, как pip install f5-sdk.

Примеры

- 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 bool	изменённое	Указывает, активны ли параметры аутентификации. Пример: True
encryption string	изменённое	Новое значение параметра `encryption` конфигурации SMTP. Пример: tls
from_address string	изменённое	Новое значение параметра `from_address` конфигурации SMTP. Пример: no-reply@mydomain.com
local_host_name string	изменённое	Новое значение параметра `local_host_name` конфигурации SMTP. Пример: smtp.mydomain.com
smtp_server string	изменённое	Новое значение параметра `smtp_server` конфигурации SMTP. Пример: mail.mydomain.com
smtp_server_port int	изменённое	Новое значение параметра `smtp_server_port` конфигурации SMTP. Пример: 25

Статус

Этот модуль помечен как превью, что означает, что он не гарантирует обратную совместимость интерфейса.

Техническое обслуживание

Этот модуль помечен как сообщество, что означает, что его поддерживает сообщество Ansible. Подробнее см. Техническое обслуживание и поддержка модулей.

Список других модулей, поддерживаемых сообществом 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.6/modules/bigip_smtp_module.html