f5networks.f5_modules.bigip_monitor_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_monitor_smtp.

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

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

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

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

Параметры

Параметр	Комментарии
app_service строка	Сервис iApp, который необходимо связать с этим профилем. Если сервис не указан, используется значение по умолчанию None.
debug логический	Указывает, отправляет ли монитор сообщения об ошибках и дополнительную информацию в файл журнала, созданный и помеченный специально для этого монитора. Когда `true` система перенаправляет сообщения об ошибках и дополнительную информацию в файл `/var/log/monitors/<monitor_name>-<node_name>-<port>.log`. Варианты: `false` `true`
description строка	Описание монитора.
domain строка	Указывает доменное имя для проверки.
interval целое число	Интервал, указывающий, как часто монитор, соответствующий этой шаблону, будет выполняться. Это значение должно быть меньше значения `timeout`. При создании нового монитора, если этот параметр не указан, используется значение по умолчанию `5`.
ip строка	Часть IP-адреса в определении IP/порт. Если этот параметр не указан при создании нового монитора, значение по умолчанию — ‘*’.
manual_resume логический	Указывает, автоматически ли система изменяет состояние ресурса на enabled при следующей успешной проверке монитора. Если вы установите это значение в `true`, вы должны вручную повторно включить ресурс, прежде чем система сможет использовать его для балансировки нагрузки. При создании нового монитора, если этот параметр не указан, значение по умолчанию `false`. Когда `true`, указывает, что вам необходимо вручную повторно включить ресурс после неудачной проверки монитора. Когда `false`, указывает, что система автоматически изменяет состояние ресурса на enabled при следующей успешной проверке монитора. Варианты: `false` `true`
name строка / обязательно	Указывает имя монитора.
parent строка	Родительский шаблон этого шаблона монитора. После установки этого значения его нельзя изменить. При создании нового монитора, если этот параметр не указан, по умолчанию используется монитор `smtp` системы.
partition строка	Раздел устройства для управления ресурсами. По умолчанию: `"Common"`
port строка	Адрес порта в определении IP/порт. Если этот параметр не указан при создании нового монитора, значение по умолчанию — ‘*’. Если вы указываете IP-адрес, вы должны указать значение от 1 до 65535.
provider словарь добавлено в f5networks.f5_modules 1.0.0	Объект словаря, содержащий данные подключения.
auth_provider строка	Настраивает поставщика аутентификации для получения маркеров аутентификации с удаленного устройства. Этот параметр используется при работе с устройствами BIG-IQ.
no_f5_teem логический	Если `yes`, данные телеметрии TEEM не отправляются в F5. Вы можете опустить этот параметр, установив переменную окружения `F5_TELEMETRY_OFF`. Ранее используемая переменная `F5_TEEM` устарела, так как ее имя вызывало путаницу. Варианты: `false` ← (по умолчанию) `true`
password псевдонимы: pass, pwd строка / обязательно	Пароль учетной записи пользователя, используемой для подключения к BIG-IP или BIG-IQ. Вы можете опустить этот параметр, установив переменную окружения `F5_PASSWORD`.
server строка / обязательно	Хост 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` ← (по умолчанию)
state string	Когда `present`, гарантирует существование монитора. Когда `absent`, гарантирует удаление монитора. Варианты: `"present"` ← (по умолчанию) `"absent"`
time_until_up integer	Указывает время в секундах после первого успешного ответа, прежде чем узел будет помечен как активный. Значение `0` заставит узел быть помеченным как активным сразу после получения действительного ответа от узла. Если этот параметр не указан при создании нового монитора, будет использовано значение по умолчанию `0`.
timeout integer	Количество секунд, в течение которых узел или служба должны ответить на запрос монитора. Если целевой объект отвечает в течение установленного периода времени, он считается активным. Если целевой объект не отвечает в течение установленного периода времени, он считается неактивным. Вы можете изменить это на любое число, однако оно должно быть в 3 раза больше числа секунд интервала плюс 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–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/f5networks/f5_modules/bigip_monitor_smtp_module.html