f5networks.f5_modules.bigip_monitor_smtp – Управление мониторами SMTP на BIG-IP
Примечание
Этот плагин входит в состав коллекции f5networks.f5_modules (версия 1.6.0).
Для его установки используйте: ansible-galaxy collection install f5networks.f5_modules.
Для использования в плейбуке укажите: f5networks.f5_modules.bigip_monitor_smtp.
Новое в версии 1.1.0: of f5networks.f5_modules
Обзор
- Управление мониторами SMTP на BIG-IP.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| app_service строка | Сервис iApp, который необходимо связать с данным профилем. Если сервис не указан, используется значение по умолчанию None. | ||
| debug логический тип |
| Указывает, отправляет ли монитор сообщения об ошибках и дополнительную информацию в лог-файл, созданный и помеченный специально для данного монитора. Когда yes, система перенаправляет сообщения об ошибках и дополнительную информацию в файл /var/log/monitors/<monitor_name>-<node_name>-<port>.log. | |
| description строка | Описание монитора. | ||
| domain строка | Указывает имя домена для проверки. | ||
| interval целое число | Интервал, определяющий частоту выполнения экземпляра монитора данного шаблона. Это значение должно быть меньше значения timeout. При создании нового монитора, если этот параметр не указан, будет использоваться значение по умолчанию 5. | ||
| ip строка | Часть IP-адреса в определении IP/порт. Если этот параметр не указан при создании нового монитора, значение по умолчанию — '*'. | ||
| manual_resume логический тип |
| Указывает, автоматически ли система изменяет статус ресурса на enabled при следующем успешном проверочном цикле монитора. Если вы установите этот параметр в yes, вам необходимо вручную повторно включить ресурс, прежде чем система сможет использовать его для подключений балансировки нагрузки.При создании нового монитора, если этот параметр не указан, значение по умолчанию — no.Когда yes, указывает, что необходимо вручную повторно включить ресурс после неудачной проверки монитора.Когда no, указывает, что система автоматически изменяет статус ресурса на enabled при следующем успешном проверочном цикле монитора. | |
| name строка / обязательный | Указывает имя монитора. | ||
| parent строка | Родительский шаблон данного шаблона монитора. После установки этого значения его изменить нельзя. При создании нового монитора, если этот параметр не указан, значение по умолчанию — системный монитор smtp. | ||
| partition строка | Значение по умолчанию: "Common" | Раздел устройства для управления ресурсами. | |
| port строка | Адрес порта в определении IP/порт. Если этот параметр не указан при создании нового монитора, значение по умолчанию — '*'. Если указывается IP-адрес, необходимо указать значение от 1 до 65535. | ||
| provider словарь добавлен в 1.0.0 of f5networks.f5_modules | Объект словаря, содержащий сведения о подключении. | ||
| auth_provider строка | Настраивает поставщика аутентификации для получения маркеров аутентификации с удаленного устройства. Этот параметр используется при работе с устройствами BIG-IQ. | ||
| no_f5_teem логический тип |
| Если yes, данные телеметрии TEEM не отправляются в F5.Можно опустить этот параметр, установив переменную окружения F5_TEEM. | |
| password строка / обязательный | Пароль для учетной записи пользователя, используемой для подключения к BIG-IP. Можно опустить этот параметр, установив переменную окружения F5_PASSWORD.псевдонимы: pass, pwd | ||
| server строка / обязательный | Хост BIG-IP. Можно опустить этот параметр, установив переменную окружения F5_SERVER. | ||
| server_port целое число | Значение по умолчанию: 443 | Порт сервера BIG-IP. Можно опустить этот параметр, установив переменную окружения F5_SERVER_PORT. | |
| timeout целое число | Устанавливает таймаут в секундах для связи с сетевым устройством при подключении или отправке команд. Если таймаут истечет до завершения операции, модуль вернёт ошибку. | ||
| transport строка |
| Настраивает транспортное соединение для использования при подключении к удалённому устройству. | |
| user строка / обязательный | Имя пользователя для подключения к BIG-IP. Пользователь должен иметь административные привилегии на устройстве. Можно опустить этот параметр, установив переменную окружения F5_USER. | ||
| validate_certs логический тип |
| Если no, сертификаты SSL не проверяются. Используйте только на сайтах под вашим контролем, использующих самозаверяющие сертификаты.Можно опустить этот параметр, установив переменную окружения F5_VALIDATE_CERTS. | |
| state строка |
| Когда present, обеспечивает существование монитора.Когда absent, обеспечивает удаление монитора. | |
| time_until_up целое число | Указывает количество секунд после первой успешной реакции, прежде чем узел будет помечен как активный. Значение 0 заставит узел быть помеченным как активный сразу после получения корректного ответа от узла.Если этот параметр не указан при создании нового монитора, то значение по умолчанию будет 0. | ||
| timeout целое число | Количество секунд, в течение которого узел или служба должны ответить на запрос монитора. Если целевой объект отвечает в заданный период времени, он считается активным. Если целевой объект не отвечает в заданный период времени, он считается неактивным. Вы можете изменить это на любое число, однако оно должно быть в 3 раза больше числа секунд интервала плюс 1 секунда. Если этот параметр не указан при создании нового монитора, значение по умолчанию будет 31. | ||
| up_interval целое число | Указывает интервал, используемый системой для проверки работоспособности, когда ресурс активен. Когда 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, связанный с данным монитором. Пример: /Common/good_service.app/good_service |
| debug boolean | изменённое | Указывает, отправляет ли монитор сообщения об ошибках и дополнительную информацию в файл журнала, созданный и помеченный специально для этого монитора. |
| description string | изменённое | Описание монитора. Пример: Важный монитор |
| domain string | изменённое | Указывает имя домена для проверки. Пример: bigipinternal.com |
| interval integer | изменённое | Новый интервал для проверки монитора. Пример: 2 |
| ip string | изменённое | Новый IP-адрес определения IP/порта. Пример: 10.12.13.14 |
| manual_resume boolean | изменённое | Указывает, автоматически ли система изменяет статус ресурса на «включён» при следующей успешной проверке монитора. Пример: True |
| parent string | изменённое | Родительский монитор. Пример: /Common/foo_smtp |
| port string | изменённое | Псевдоним порта или службы для проверки монитором от имени пулов или членов пулов, с которыми ассоциирован монитор. Пример: 80 |
| time_until_up integer | изменённое | Новое время, в течение которого система помечает систему как активную после первого успешного ответа. Пример: 2 |
| timeout integer | изменённое | Новый интервал ожидания, в течение которого удалённая система должна ответить на запрос монитора. Пример: 10 |
| up_interval integer | изменённое | Интервал, используемый системой для проверки работоспособности, когда ресурс активен. |
Авторы
- Wojciech Wypior (@wojtek0806)
© 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_monitor_smtp_module.html
