Модуль f5networks.f5_modules.bigip_smtp — управление параметрами SMTP на BIG-IP

Примечание

Этот модуль входит в коллекцию f5networks.f5_modules (версия 1.39.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-сервер, задав его параметры.

Параметры

Параметр	Комментарии
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 dictionary добавлено в 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 integer	Порт сервера BIG-IP. Этот параметр можно не указывать, задав переменную окружения `F5_SERVER_PORT`. По умолчанию: `443`
timeout integer	Задает время ожидания в секундах при подключении к сетевому устройству или отправке ему команд. Если время ожидания истекает до завершения операции, модуль выдает ошибку.
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`. Если выбрано `ssl`, по умолчанию используется `465`.
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	Активны ли параметры аутентификации. Возвращается: при изменении Пример: `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 integer	Новое значение `smtp_server_port` конфигурации SMTP. Возвращается: при изменении Пример: `25`

Авторы

Tim Rupp (@caphrim007)

Ссылки на коллекцию

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