bigip_monitor_gateway_icmp – Управляет мониторами ICMP шлюза F5 BIG-IP LTM
Новая в версии 2.8.
Краткое описание
- Управляет мониторами ICMP шлюза на BIG-IP.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| adaptive boolean |
| Указывает, включена ли адаптивная мониторинг времени отклика для этого монитора. Когда yes, монитор определяет состояние службы на основе того, насколько отклонение задержки запроса монитора для этой службы от среднего значения допустимо. Также будут применяться значения для allowed_divergence, adaptive_limit, и sampling_timespan. Когда disabled, монитор определяет состояние службы на основе настроек монитора interval, up_interval, time_until_up, и timeout. | |
| adaptive_limit integer | Указывает абсолютное число миллисекунд, которое не должно превышаться запросом монитора, независимо от allowed_divergence настройки, для успешного выполнения запроса.Это значение применяется независимо от значения allowed_divergence.Хотя это значение может быть сконфигурировано, когда adaptive равно no, оно не будет применено на системе, пока adaptive не будет yes. | ||
| allowed_divergence_type string |
| При создании нового монитора, если adaptive равно yes, значение по умолчанию — relative.Когда absolute, количество миллисекунд, на которое задержка запроса монитора может превышать среднюю задержку запроса монитора для проверяемой службы. В типичных случаях, если монитор обнаруживает три последовательных запроса, которые не удовлетворяют заданному значению задержки, узел или член пула помечаются как неисправные.Когда relative, процент отклонения, на который задержка запроса монитора может превышать среднюю задержку запроса монитора для проверяемой службы. | |
| allowed_divergence_value integer | При создании нового монитора, если adaptive равно yes, и type равно relative, значение по умолчанию — 25 процентов. | ||
| description string | Описание монитора. | ||
| interval integer | Указывает частоту проверки монитором системы в секундах, когда ресурс неисправен или его состояние неизвестно. | ||
| ip string | Часть IP/порт определения. Если этот параметр не задан при создании нового монитора, значение по умолчанию — '*'. | ||
| manual_resume boolean |
| Указывает, автоматически ли система изменяет состояние ресурса на enabled при следующей успешной проверке монитором. Если вы установите это значение в yes, вы должны вручную повторно включить ресурс, прежде чем система сможет использовать его для балансировки нагрузки.Когда yes, указывает, что необходимо вручную повторно включить ресурс после неудачной проверки монитором.Когда no, указывает, что система автоматически изменяет состояние ресурса на enabled при следующей успешной проверке монитором. | |
| name string / обязательно | Имя монитора. | ||
| parent string | Значение по умолчанию: "/Common/gateway_icmp" | Родительская шаблон этого шаблона монитора. После установки этого значения, его нельзя изменить. По умолчанию, это значение — родительский gateway_icmp на разделе Common. | |
| partition string | Значение по умолчанию: "Common" | Раздел устройства для управления ресурсами. | |
| port string | Адрес порта в определении IP/порт. Если этот параметр не задан при создании нового монитора, значение по умолчанию — '*'. Обратите внимание, что при указании IP-адреса необходимо указать значение от 1 до 65535. | ||
| provider dictionary добавлено в 2.5 | Объект словаря, содержащий данные подключения. | ||
| auth_provider string | Настраивает поставщика аутентификации для получения маркеров аутентификации с удаленного устройства. Этот параметр используется при работе с устройствами BIG-IQ. | ||
| password string / обязательно | Пароль для учетной записи пользователя, используемой для подключения к BIG-IP. Можно пропустить этот параметр, установив переменную окружения F5_PASSWORD. псевдонимы: pass, pwd | ||
| server string / обязательно | Хост BIG-IP. Можно пропустить этот параметр, установив переменную окружения F5_SERVER. | ||
| server_port integer | Значение по умолчанию: 443 | Порт сервера BIG-IP. Можно пропустить этот параметр, установив переменную окружения F5_SERVER_PORT. | |
| ssh_keyfile path | Указывает SSH-ключ для аутентификации подключения к удаленному устройству. Этот аргумент используется только для транспортов cli. Можно пропустить этот параметр, установив переменную окружения ANSIBLE_NET_SSH_KEYFILE. | ||
| timeout integer | Указывает тайм-аут в секундах для связи с сетевым устройством при подключении или отправке команд. Если тайм-аут истекает до завершения операции, модуль выдаст ошибку. | ||
| transport string |
| Настраивает транспортное подключение для подключения к удаленному устройству. | |
| user string / обязательно | Имя пользователя для подключения к BIG-IP. Этот пользователь должен иметь административные привилегии на устройстве. Можно пропустить этот параметр, установив переменную окружения F5_USER. | ||
| validate_certs boolean |
| Если no, сертификаты SSL не проверяются. Используйте это только на контролируемых вами сайтах с самозаверяющими сертификатами.Можно пропустить этот параметр, установив переменную окружения F5_VALIDATE_CERTS. | |
| sampling_timespan integer | Указывает длительность, в секундах, окна истории запросов, которое система использует для расчета средней задержки и стандартного отклонения запроса монитора. Хотя это значение можно настроить, когда adaptive равно no, оно не будет применено на системе, пока adaptive не будет yes. | ||
| state string |
| Если present, гарантирует, что монитор существует.Если absent, гарантирует удаление монитора. | |
| time_until_up integer | Указывает количество секунд ожидания после того, как ресурс впервые правильно отреагирует на монитор, прежде чем установить состояние ресурса как 'up'. В течение этого интервала все ответы от ресурса должны быть правильными. После истечения интервала, ресурс помечается как 'up'. Значение 0 означает, что ресурс помечается как up сразу после получения первого правильного ответа. | ||
| timeout целое число | Указывает количество секунд, в течение которого целевой объект должен ответить на запрос монитора. Если целевой объект отвечает в заданный период времени, он считается «активным». Если целевой объект не отвечает в течение заданного периода времени, он считается «неактивным». При установке этого значения в 0 (ноль) система использует интервал от родительского монитора. Обратите внимание, что timeout и time_until_up совместно контролируют, когда ресурс устанавливается в состояние «активный». | ||
| transparent логическое |
| Указывает, работает ли монитор в прозрачном режиме. Монитор в прозрачном режиме направляет трафик через связанные члены пула или узлы (обычно маршрутизатор или брандмауэр) к адресу с алиасом (то есть он зондирует комбинацию ip-port, указанную в мониторе).Если монитор не может успешно достичь адреса с алиасом, член пула или узел, через который отправлялся трафик монитора, помечается как неактивный. При создании нового монитора, если этот параметр не указан, то значение по умолчанию будет таким, какое предоставляет parent. | |
| up_interval целое число | Указывает интервал, используемый системой для проверки состояния, когда ресурс активен. Когда 0, система использует интервал, указанный в interval, для проверки состояния ресурса.При любом другом числе, позволяет указать другой интервал для проверки состояния активного ресурса. | ||
Примечания
Примечание
- Дополнительную информацию об использовании Ansible для управления устройствами F5 Networks см. на сайте https://www.ansible.com/integrations/networks/f5.
- Требуется версия ПО BIG-IP ≥ 12.
- Модули F5 манипулируют только активной конфигурацией продукта F5. Для сохранения конфигурации BIG-IP на диске необходимо включить по крайней мере одну задачу, использующую модуль bigip_config для сохранения активной конфигурации. Обратитесь к документации модуля для правильного использования модуля для сохранения активной конфигурации.
Примеры
- name: Create a monitor
bigip_monitor_gateway_icmp:
name: gw1
adaptive: no
interval: 1
time_until_up: 0
timeout: 3
provider:
password: secret
server: lb.mydomain.com
user: admin
delegate_to: localhost
Значения возврата
Общие значения возврата описаны в этом разделе, следующие поля уникальны для данного модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| adaptive логическое | изменён | Включено или выключено адаптивное поведение. Пример: True |
| adaptive_limit целое число | изменён | Абсолютное число миллисекунд, которое не должно превышаться зондом монитора. Пример: 200 |
| allowed_divergence_type строка | изменён | Тип расхождения, используемый для адаптивного мониторинга времени отклика. Пример: absolute |
| allowed_divergence_value целое число | изменён | Значение типа расхождения, используемого для адаптивного мониторинга времени отклика. Может быть percent или ms, в зависимости от того, используется ли relative или absolute. Пример: 25 |
| description строка | изменён | Описание монитора. Пример: Важный монитор |
| interval целое число | изменён | Новый интервал для выполнения проверки монитора. Пример: 2 |
| ip строка | изменён | Новый IP-адрес для определения IP/порт. Пример: 10.12.13.14 |
| parent строка | изменён | Новая родительская шаблон монитора. Пример: gateway-icmp |
| port строка | изменён | Порт-алиас или служба для проверки монитора от имени пулов или членов пулов, с которыми связан монитор. Пример: 80 |
| sampling_timespan целое число | изменён | Абсолютное число миллисекунд, которое не должно превышаться зондом монитора. Пример: 200 |
| time_until_up целое число | изменён | Новое время, в течение которого система помечается как активная после первого успешного ответа. Пример: 2 |
| timeout целое число | изменён | Новый таймаут, в течение которого удалённая система должна ответить на монитор. Пример: 10 |
| transparent логическое | изменён | Работает ли монитор в прозрачном режиме. |
| up_interval целое число | изменён | Интервал, используемый системой для проверки состояния ресурса при его активности. |
Статус
- Этот модуль не гарантирует обратной совместимости интерфейса. [превью]
- Этот модуль поддерживается партнером Ansible. [сертифицировано]
Авторы
- Tim Rupp (@caphrim007)
Подсказка
Если вы заметите какие-либо проблемы в этой документации, вы можете отредактировать этот документ, чтобы улучшить его.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.9/modules/bigip_monitor_gateway_icmp_module.html
