f5networks.f5_modules.bigip_smtp модуль — Управляет настройками SMTP на BIG-IP

Примечание

Этот модуль входит в коллекцию f5networks.f5_modules (версия 1.31.0).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.

Чтобы установить её, используйте: ansible-galaxy collection install f5networks.f5_modules.

Чтобы использовать её в плейбуке, укажите: f5networks.f5_modules.bigip_smtp.

Новинка в f5networks.f5_modules 1.0.0

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

Обзор

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

Параметры

Параметр	Комментарии
authentication boolean	Данные аутентификации могут быть заданы в конфигурации SMTP-сервера, даже если аутентификация не используется (например, для конфигураций на этапе тестирования или внесения срочных изменений). Этот параметр служит переключателем для активации или деактивации указанных параметров `smtp_server_username` и `smtp_server_password`. При `true`, параметры аутентификации активны. При `false`, параметры аутентификации неактивны. Варианты: `false` `true`
encryption string	Указывает, требует ли SMTP-сервер зашифрованное соединение для отправки почты. Варианты: `"none"` `"ssl"` `"tls"`
from_address string	Адрес электронной почты, с которого отправляется письмо. Это адрес «От кого», который видит получатель.
local_host_name string	Имя хоста, используемое в заголовках SMTP в формате полностью квалифицированного доменного имени. Эта настройка не относится к имени хоста системы BIG-IP.
name string / обязательно	Указывает имя конфигурации SMTP-сервера.
partition string	Раздел устройства для управления ресурсами. По умолчанию: `"Common"`
provider словарь добавлено в f5networks.f5_modules 1.0.0	Объект типа словарь, содержащий данные подключения.
auth_provider string	Настраивает поставщика аутентификации для получения токенов аутентификации с удаленного устройства. Этот параметр действительно используется при работе с устройствами BIG-IQ.
no_f5_teem boolean	Если `yes`, данные телеметрии TEEM не отправляются в F5. Вы можете опустить этот параметр, установив переменную среды `F5_TELEMETRY_OFF`. Предыдущая переменная `F5_TEEM` устарела, так как ее название было неоднозначным. Варианты: `false` ← (по умолчанию) `true`
password псевдонимы: pass, pwd string / обязательно	Пароль учетной записи пользователя, используемой для подключения к BIG-IP или BIG-IQ. Вы можете опустить этот параметр, установив переменную среды `F5_PASSWORD`.
server string / обязательно	Хост BIG-IP или BIG-IQ. Вы можете опустить этот параметр, установив переменную среды `F5_SERVER`.
server_port целое число	Порт сервера BIG-IP. Вы можете опустить этот параметр, установив переменную среды `F5_SERVER_PORT`. По умолчанию: `443`
timeout целое число	Устанавливает таймаут в секундах для связи с сетевым устройством при подключении или отправке команд. Если таймаут истекает до завершения операции, модуль вернёт ошибку.
transport string	Настраивает транспортное соединение для подключения к удалённому устройству. Варианты: `"rest"` ← (по умолчанию)
user string / обязательно	Имя пользователя для подключения к BIG-IP или BIG-IQ. Этот пользователь должен иметь административные привилегии на устройстве. Вы можете опустить этот параметр, установив переменную среды `F5_USER`.
validate_certs boolean	Если `no`, сертификаты SSL не проверяются. Используйте только на сайтах, контролируемых лично, с использованием самозаверяющих сертификатов. Вы можете опустить этот параметр, установив переменную среды `F5_VALIDATE_CERTS`. Варианты: `false` `true` ← (по умолчанию)
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 не существует. Варианты: `"present"` ← (по умолчанию) `"absent"`
update_password string	Пароли хранятся в зашифрованном виде, поэтому модуль не может определить, совпадает ли предоставленный `smtp_server_password` с существующим паролем или отличается. Этот параметр управляет обновлением учетных данных `smtp_server_password`. В случае `always`, система всегда обновляет пароль. В случае `on_create`, система устанавливает пароль только для вновь созданных конфигураций SMTP-сервера. Варианты: `"always"` ← (по умолчанию) `"on_create"`

Примечания

Примечание

Дополнительную информацию об использовании 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	Новое значение `encryption` конфигурации SMTP. Возвращается: changed Пример: `"tls"`
from_address string	Новое значение `from_address` конфигурации SMTP. Возвращается: changed Пример: `"no-reply@mydomain.com"`
local_host_name string	Новое значение `local_host_name` конфигурации SMTP. Возвращается: changed Пример: `"smtp.mydomain.com"`
smtp_server string	Новое значение `smtp_server` конфигурации SMTP. Возвращается: changed Пример: `"mail.mydomain.com"`
smtp_server_port integer	Новое значение `smtp_server_port` конфигурации SMTP. Возвращается: changed Пример: `25`

Авторы

Tim Rupp (@caphrim007)

Ссылки на сборку

© 2012–2018 Michael DeHaan
© 2018–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/f5networks/f5_modules/bigip_smtp_module.html