Модуль f5networks.f5_modules.bigip_monitor_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_monitor_smtp.

Добавлено в f5networks.f5_modules 1.1.0

Краткое описание
Параметры
Примечания
Примеры
Возвращаемые значения

Краткое описание

Управление SMTP-мониторами на BIG-IP.

Параметры

Параметр	Комментарии
app_service string	Служба iApp, связанная с этим профилем. Если служба не указана, по умолчанию используется None.
debug boolean	Определяет, отправляет ли монитор сообщения об ошибках и дополнительную информацию в файл журнала, созданный и помеченный специально для этого монитора. Если `true`, система перенаправляет сообщения об ошибках и дополнительную информацию в файл `/var/log/monitors/<monitor_name>-<node_name>-<port>.log`. Варианты: `false` `true`
description string	Описание монитора.
domain string	Указывает имя домена для проверки.
interval integer	Интервал, задающий частоту запуска экземпляра монитора на основе этого шаблона. Это значение должно быть меньше значения `timeout`. При создании нового монитора, если этот параметр не задан, будет использоваться значение по умолчанию `5`.
ip string	IP-адрес в определении IP/порта. Если при создании нового монитора этот параметр не задан, по умолчанию используется значение «*».
manual_resume boolean	Определяет, автоматически ли система изменяет состояние ресурса на включено при следующей успешной проверке монитора. Если для этого параметра задано значение `true`, необходимо вручную повторно включить ресурс, прежде чем система сможет использовать его для балансировки нагрузки соединений. При создании нового монитора, если этот параметр не задан, по умолчанию используется значение `false`. Если `true`, указывает, что после неудачной проверки монитора ресурс необходимо включить повторно вручную. Если `false`, указывает, что система автоматически изменяет состояние ресурса на включено при следующей успешной проверке монитора. Варианты: `false` `true`
name string / обязательный	Указывает имя монитора.
parent string	Родительский шаблон этого шаблона монитора. После установки этого значения изменить его нельзя. При создании нового монитора, если этот параметр не задан, по умолчанию используется системный монитор `smtp`.
partition string	Раздел устройства, в котором будут обслуживаться ресурсы. По умолчанию: `"Common"`
port string	Порт в определении IP/порта. Если при создании нового монитора этот параметр не задан, по умолчанию используется значение «*». Если указан IP-адрес, необходимо задать значение от 1 до 65535.
provider dictionary добавлено в f5networks.f5_modules 1.0.0	Объект dict, содержащий сведения о подключении.
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` ← (по умолчанию)
state string	Если `present`, обеспечивает наличие монитора. Если `absent`, обеспечивает удаление монитора. Варианты: `"present"` ← (по умолчанию) `"absent"`
time_until_up integer	Задаёт время в секундах после первого успешного ответа, по истечении которого узел будет помечен как доступный. Значение `0` приводит к немедленной пометке узла как доступного после получения от него корректного ответа. Если при создании нового монитора этот параметр не задан, по умолчанию используется значение `0`.
timeout integer	Количество секунд, в течение которых узел или служба должны ответить на запрос монитора. Если целевой объект отвечает в заданный период времени, он считается доступным. Если целевой объект не отвечает в заданный период времени, он считается недоступным. Это значение можно изменить на любое число, однако оно должно быть равным трёхкратному интервалу в секундах плюс 1 секунда. Если при создании нового монитора этот параметр не задан, по умолчанию используется значение `31`.
up_interval integer	Задаёт интервал выполнения проверки работоспособности системой, когда ресурс доступен. Если `0`, система использует интервал, указанный в `interval`, для проверки работоспособности ресурса. При любом другом числовом значении можно задать другой интервал для проверки работоспособности доступного ресурса. При создании нового монитора, если этот параметр не задан, будет использоваться значение по умолчанию `0`.

Примечания

Примечание

Дополнительные сведения об использовании Ansible для управления устройствами F5 Networks см. на странице https://www.ansible.com/integrations/networks/f5.
Требуется версия программного обеспечения BIG-IP >= 12.
Модули F5 изменяют только текущую конфигурацию продукта F5. Чтобы обеспечить сохранение конфигурации BIG-IP на диске, обязательно добавьте хотя бы одну задачу, использующую модуль f5networks.f5_modules.bigip_config для сохранения текущей конфигурации. Правила использования модуля для сохранения текущей конфигурации см. в документации модуля.

Примеры

- name: Create SMTP Monitor
  bigip_monitor_smtp:
    state: present
    ip: 10.10.10.10
    name: my_smtp_monitor
    domain: foo.com
    provider:
      server: lb.mydomain.com
      user: admin
      password: secret
  delegate_to: localhost

- name: Remove SMTP Monitor
  bigip_monitor_smtp:
    state: absent
    name: my_smtp_monitor
    provider:
      server: lb.mydomain.com
      user: admin
      password: secret
  delegate_to: localhost

Возвращаемые значения

Общие возвращаемые значения описаны здесь; ниже перечислены поля, уникальные для этого модуля:

Ключ	Описание
app_service string	Служба iApp, связанная с этим монитором. Возвращается: changed Пример: `"/Common/good_service.app/good_service"`
debug boolean	Определяет, отправляет ли монитор сообщения об ошибках и дополнительную информацию в файл журнала, созданный и помеченный специально для этого монитора. Возвращается: changed Пример: `false`
description string	Описание монитора. Возвращается: changed Пример: `"Important Monitor"`
domain string	Указывает имя домена для проверки. Возвращается: changed Пример: `"bigipinternal.com"`
interval integer	Новый интервал выполнения проверки монитора. Возвращается: changed Пример: `2`
ip string	Новый IP-адрес в определении IP/порта. Возвращается: changed Пример: `"10.12.13.14"`
manual_resume boolean	Определяет, автоматически ли система изменяет состояние ресурса на доступное при следующей успешной проверке монитора. Возвращается: changed Пример: `true`
parent string	Родительский монитор. Возвращается: changed Пример: `"/Common/foo_smtp"`
port string	Псевдоним порта или службы, которые монитор должен проверять от имени пулов или участников пула, с которыми он связан. Возвращается: changed Пример: `"80"`
time_until_up integer	Новое время ожидания, по истечении которого система помечается как доступная после первого успешного ответа. Возвращается: changed Пример: `2`
timeout integer	Новое время ожидания ответа удалённой системы на запрос монитора. Возвращается: changed Пример: `10`
up_interval integer	Интервал выполнения системой проверки работоспособности, когда ресурс доступен. Возвращается: changed Пример: `0`

Авторы

Wojciech Wypior (@wojtek0806)

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

© 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_monitor_smtp_module.html