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		По умолчанию: "Общие"	Раздел устройства для управления ресурсами.
password string / обязательно			Пароль учетной записи пользователя для подключения к BIG-IP. Вы можете опустить этот параметр, установив переменную среды `F5_PASSWORD`. псевдонимы: pass, pwd
provider dictionary добавлено в 2.5			Объект словаря, содержащий данные подключения.
	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	По умолчанию: 10	Указывает таймаут в секундах для связи с сетевым устройством для подключения или отправки команд. Если таймаут истечет до завершения операции, модуль вернет ошибку.
	transport string	Варианты: cli rest ←	Настраивает транспортное соединение для подключения к удаленному устройству.
	user string / обязательно		Имя пользователя для подключения к BIG-IP. Этот пользователь должен иметь административные привилегии на устройстве. Вы можете опустить этот параметр, установив переменную среды `F5_USER`.
	validate_certs boolean	Варианты: no yes ←	Если `no`, сертификаты SSL не проверяются. Используйте только на сайтах, которыми вы лично контролируете, использующих самоподписанные сертификаты. Вы можете опустить этот параметр, установив переменную среды `F5_VALIDATE_CERTS`.
server string / обязательно			Хост BIG-IP. Вы можете опустить этот параметр, установив переменную среды `F5_SERVER`.
server_port integer добавлено в 2.2		По умолчанию: 443	Порт сервера BIG-IP. Вы можете опустить этот параметр, установив переменную среды `F5_SERVER_PORT`.
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-серверов.
user string / обязательно			Имя пользователя для подключения к 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.
Требуется версия ПО 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 логическое значение	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.8/modules/bigip_smtp_module.html