f5networks.f5_modules.bigip_monitor_http – Управляет мониторами HTTP F5 BIG-IP LTM
Примечание
Этот плагин входит в коллекцию f5networks.f5_modules (версия 1.7.1).
Для его установки используйте: ansible-galaxy collection install f5networks.f5_modules.
Для использования в плейбуке укажите: f5networks.f5_modules.bigip_monitor_http.
Новое в версии 1.0.0: of f5networks.f5_modules
Описание
- Управляет мониторами HTTP F5 BIG-IP LTM.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| description строка | Описание монитора. | ||
| interval целое число | Интервал, определяющий частоту выполнения экземпляра монитора этой шаблона. Если этот параметр не указан при создании нового монитора, значение по умолчанию — 5. Это значение **должно** быть меньше timeout. | ||
| ip строка | Часть IP-адреса в определении IP/порт. Если этот параметр не указан при создании нового монитора, значение по умолчанию — «*». | ||
| name строка / обязательно | Имя монитора. | ||
| parent строка | По умолчанию: "/Common/http" | Родительский шаблон этого шаблона монитора. После установки этого значения его нельзя изменить. По умолчанию это родительский http на разбиении Common. | |
| partition строка | По умолчанию: "Common" | Разбиение устройства для управления ресурсами. | |
| port строка | Адрес порта в определении IP/порт. Если этот параметр не указан при создании нового монитора, значение по умолчанию — «*». Если указан IP-адрес, необходимо указать значение от 1 до 65535. | ||
| provider словарь добавлен в 1.0.0 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. | |
| receive строка | Строка приёма для вызова монитора. | ||
| receive_disable строка | Эта настройка работает как receive, за исключением того, что система помечает узел или члена пула как отключённый, когда его ответ соответствует строке receive_disable, но не receive. Чтобы использовать эту настройку, необходимо указать как receive_disable, так и receive. | ||
| reverse булево |
| Указывает, работает ли монитор в обратном режиме. Когда монитор работает в обратном режиме, соответствие строки приёма отмечает контролируемый объект как отключённый вместо включённого. Этот режим можно использовать только в том случае, если вы настроили параметр receive.Этот параметр несовместим с параметром time_until_up. Если time_until_up, он должен быть 0. В противном случае, если он уже существует, он должен быть 0. | |
| send строка | Строка отправки для вызова монитора. При создании нового монитора, если это значение не указано, используется значение по умолчанию GET /\r\n. | ||
| state строка |
| Когда present, гарантирует, что монитор существует.Когда absent, гарантирует, что монитор удалён. | |
| target_password строка | Указывает пароль, если контролируемый целевой объект требует аутентификации. | ||
| target_username строка | Указывает имя пользователя, если контролируемый целевой объект требует аутентификации. | ||
| time_until_up целое число | Устанавливает количество секунд после первого успешного ответа, прежде чем узел помечается как включённый. Значение 0 приводит к тому, что узел сразу помечается как включённый после получения корректного ответа от узла. Если этот параметр не указан при создании нового монитора, значение по умолчанию будет 0. | ||
| timeout целое число | Количество секунд, в течение которых узел или служба должны ответить на запрос монитора. Если целевой объект отвечает в течение заданного периода времени, он считается включённым. Если целевой объект не отвечает в течение заданного периода времени, он считается отключённым. Можно изменить на любое число, однако оно должно быть в 3 раза больше интервала в секундах плюс 1 секунда. Если этот параметр не указан при создании нового монитора, значение по умолчанию — 16. | ||
Примечания
Примечание
- Требуется версия программного обеспечения BIG-IP >= 12
- Дополнительная информация об использовании Ansible для управления устройствами F5 Networks доступна по адресу https://www.ansible.com/integrations/networks/f5.
- Требуется версия программного обеспечения BIG-IP >= 12.
- Модули F5 манипулируют только текущей конфигурацией продукта F5. Чтобы убедиться, что специфическая для BIG-IP конфигурация сохранится на диске, убедитесь, что включён хотя бы один шаг, который использует модуль f5networks.f5_modules.bigip_config, чтобы сохранить текущую конфигурацию. Обратитесь к документации модуля для правильного использования модуля для сохранения текущей конфигурации.
Примеры
- name: Create HTTP Monitor
bigip_monitor_http:
state: present
ip: 10.10.10.10
name: my_http_monitor
provider:
server: lb.mydomain.com
user: admin
password: secret
delegate_to: localhost
- name: Remove HTTP Monitor
bigip_monitor_http:
state: absent
name: my_http_monitor
provider:
server: lb.mydomain.com
user: admin
password: secret
delegate_to: localhost
- name: Include a username and password in the HTTP monitor
bigip_monitor_http:
state: absent
name: my_http_monitor
target_username: monitor_user
target_password: monitor_pass
provider:
server: lb.mydomain.com
user: admin
password: secret
delegate_to: localhost
Возвращаемые значения
Общие значения возврата описаны в здесь, следующие поля уникальны для этого модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| description string | изменённое | Описание монитора. Пример: Important_Monitor |
| interval integer | изменённое | Новый интервал, с которым следует выполнять проверку монитора. Пример: 2 |
| ip string | изменённое | Новый IP-адрес для определения IP/порта. Пример: 10.12.13.14 |
| parent string | изменённое | Новая родительская шаблон монитора. Пример: http |
| reverse boolean | изменённое | Определяет, работает ли монитор в обратном режиме. Пример: True |
| time_until_up integer | изменённое | Новое время, в течение которого система считается активной после первого успешного ответа. Пример: 2 |
| timeout integer | изменённое | Новый таймаут, в течение которого удалённая система должна ответить на монитор. Пример: 10 |
Авторы
- Tim Rupp (@caphrim007)
- Wojciech Wypior (@wojtek0806)
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/f5networks/f5_modules/bigip_monitor_http_module.html