f5networks.f5_modules.bigip_smtp – Управляет настройками SMTP на BIG-IP
Примечание
Этот плагин входит в коллекцию f5networks.f5_modules (версия 1.6.0).
Для его установки используйте: ansible-galaxy collection install f5networks.f5_modules.
Для использования в книге задач, укажите: f5networks.f5_modules.bigip_smtp.
Добавлено в версии 1.0.0: модуля f5networks.f5_modules
Описание
- Позволяет настроить BIG-IP для отправки почты через SMTP-сервер, настраивая параметры SMTP-сервера.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| authentication boolean |
| Учётные данные могут быть установлены в конфигурации SMTP-сервера, даже если эта аутентификация не используется (например, для конфигураций разработки или внештатных изменений). Этот параметр действует как переключатель, чтобы сделать указанные параметры smtp_server_username и smtp_server_password активными или неактивными.При yes, параметры аутентификации активны.При no, параметры аутентификации неактивны. | |
| encryption string |
| Указывает, требует ли 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 | Объект словаря, содержащий данные подключения. | ||
| auth_provider string | Настраивает поставщика аутентификации для получения маркеров аутентификации от удалённого устройства. Этот параметр действительно используется при работе с устройствами BIG-IQ. | ||
| no_f5_teem boolean |
| Если 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 |
| Настраивает транспортное соединение для использования при подключении к удалённому устройству. | |
| user string / обязательно | Имя пользователя для подключения к BIG-IP. Этот пользователь должен иметь административные привилегии на устройстве. Вы можете пропустить этот параметр, установив переменную среды F5_USER. | ||
| validate_certs boolean |
| Если 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, гарантирует, что конфигурация SMTP существует.При absent, гарантирует, что конфигурация SMTP не существует. | |
| update_password string |
| Пароли хранятся зашифрованными, поэтому модуль не может определить, совпадает ли предоставленный 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–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/f5networks/f5_modules/bigip_smtp_module.html
