f5networks.f5_modules.bigip_monitor_gateway_icmp – Управляет мониторами ICMP шлюзов F5 BIG-IP LTM
Примечание
Этот плагин входит в коллекцию f5networks.f5_modules (версия 1.7.1).
Для его установки используйте: ansible-galaxy collection install f5networks.f5_modules
Для использования в плейбуке укажите: f5networks.f5_modules.bigip_monitor_gateway_icmp
Новое в версии 1.0.0: of f5networks.f5_modules
Обзор
- Управляет мониторами ICMP шлюзов на BIG-IP LTM.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| adaptive boolean |
| Указывает, включено ли адаптивное отслеживание времени отклика для этого монитора. Когда yes, монитор определяет состояние службы, основываясь на том, насколько отклоняется задержка зонда монитора от среднего значения для этой службы. Кроме того, будут применены значения для allowed_divergence, adaptive_limit, sampling_timespan. Когда disabled, монитор определяет состояние службы на основе настроек монитора interval, up_interval, time_until_up, и timeout. | |
| adaptive_limit целое число | Указывает абсолютное значение в миллисекундах, которое не должно превышаться зондом монитора, независимо от настройки allowed_divergence, для успешного выполнения проверки.Это значение применяется независимо от значения настройки allowed_divergence. Хотя это значение можно настроить, когда adaptive равно no, оно не будет действовать на системе до тех пор, пока adaptive не будет равно yes. | ||
| allowed_divergence_type строка |
| При создании нового монитора, если adaptive равно yes, значение по умолчанию равно relative. Когда absolute, количество миллисекунд, на которое задержка зонда монитора может превышать среднюю задержку зонда монитора для прощупываемой службы. В типичных случаях, если монитор обнаруживает три подряд пробы, которые не соответствуют установленным значениям задержки, то член пула или узел помечаются как неработоспособный.Когда relative, процент отклонения, на который задержка зонда монитора может превышать среднюю задержку зонда монитора для прощупываемой службы. | |
| allowed_divergence_value целое число | При создании нового монитора, если adaptive равно yes, и type равно relative, значение по умолчанию равно 25 процентам. | ||
| description строка | Описание монитора. | ||
| interval целое число | Указывает частоту проверки монитора системой (в секундах), когда ресурс недоступен или его состояние неизвестно. | ||
| ip строка | IP-адрес, часть определения IP/порт. Если этот параметр не указан при создании нового монитора, значение по умолчанию равно '*'. | ||
| manual_resume boolean |
| Указывает, автоматически ли система изменяет статус ресурса на enabled при следующей успешной проверке монитора. Если вы установите этот параметр в yes, вы должны вручную повторно включить ресурс, прежде чем система сможет использовать его для балансировки нагрузки.Когда yes, указывает, что вы должны вручную повторно включить ресурс после неудачной проверки монитора.Когда no, указывает, что система автоматически изменяет статус ресурса на enabled при следующей успешной проверке монитора. | |
| name строка / обязательно | Имя монитора. | ||
| parent строка | Значение по умолчанию: "/Common/gateway_icmp" | Родительская шаблон этого шаблона монитора. После установки этого значения его нельзя изменить. По умолчанию это родительский элемент gateway_icmp в разделе Common. | |
| partition строка | Значение по умолчанию: "Common" | Раздел устройства для управления ресурсами. | |
| port строка | Порт, часть определения IP/порт. Если этот параметр не указан при создании нового монитора, значение по умолчанию равно '*'. Если вы указываете IP-адрес, используйте значение от 1 до 65535. | ||
| provider словарь добавлен в 1.0.0 f5networks.f5_modules | Объект словаря, содержащий сведения о подключении. | ||
| auth_provider строка | Настраивает поставщика авторизации для получения маркеров аутентификации от удаленного устройства. Этот параметр используется, главным образом, при работе с устройствами BIG-IQ. | ||
| no_f5_teem boolean |
| Если 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 boolean |
| Если no, сертификаты SSL не проверяются. Используйте только на контролируемых вами сайтах с самозаверенными сертификатами.Вы можете опустить этот параметр, установив переменную среды F5_VALIDATE_CERTS. | |
| sampling_timespan целое число | Указывает длительность (в секундах) окна истории зондов, используемого системой для вычисления средней задержки и стандартного отклонения зонда монитора. Хотя это значение можно настроить, когда adaptive равно no, оно не будет действовать на системе до тех пор, пока adaptive не будет равно yes. | ||
| state строка |
| Если present, гарантирует, что монитор существует.Если absent, гарантирует удаление монитора. | |
| time_until_up целое число | Указывает количество секунд, которое система должна ждать после первой успешной реакции ресурса на монитор, прежде чем установить состояние ресурса как 'up'. В течение этого интервала все ответы от ресурса должны быть правильными. По истечении интервала ресурс помечается как 'up'. Значение 0 означает, что ресурс помечается как 'up' сразу после получения первого правильного ответа. | ||
| timeout целое число | Указывает количество секунд, в течение которых целевой объект имеет на ответ на запрос монитора. Если целевой объект отвечает в установленный период времени, он считается 'up'. Если целевой объект не отвечает в установленный период времени, он считается 'down'. Если это значение установлено в 0 (ноль), система использует интервал от родительского монитора. Обратите внимание, что timeout и time_until_up вместе определяют, когда ресурс устанавливается в состояние 'up'. | ||
| transparent boolean |
| Указывает, работает ли монитор в прозрачном режиме. Монитор в прозрачном режиме направляет трафик через ассоциированные члены пула или узлы (обычно маршрутизатор или брандмауэр) к адресу назначения (т.е. он проверяет комбинацию ip-port указанную в мониторе).Если монитор не может успешно достичь адреса назначения, член пула или узел, через который направлялся трафик монитора, помечается как неработоспособный. При создании нового монитора, если этот параметр не указан, то значение по умолчанию будет таким, какое предоставляет parent. | |
| up_interval целое число | Устанавливает интервал для проверки работоспособности ресурса, когда ресурс в режиме 'up'. Если 0, система использует интервал, указанный в interval, для проверки работоспособности ресурса.При любом другом числе вы можете указать другой интервал для проверки работоспособности ресурса, который в режиме 'up'. | ||
Примечания
Примечание
- Дополнительную информацию об использовании Ansible для управления устройствами F5 Networks см. на странице https://www.ansible.com/integrations/networks/f5.
- Требуется версия программного обеспечения BIG-IP >= 12.
- Модули F5 изменяют только текущую конфигурацию продукта F5. Чтобы убедиться, что специфичная для BIG-IP конфигурация сохраняется на диске, убедитесь, что включена хотя бы одна задача, использующая модуль f5networks.f5_modules.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 boolean | changed | Включен или выключен адаптивный режим. Пример: True |
| adaptive_limit integer | changed | Абсолютное количество миллисекунд, которое не должно превышаться зондом монитора. Пример: 200 |
| allowed_divergence_type string | changed | Тип расхождения, используемый для адаптивного мониторинга времени отклика. Пример: absolute |
| allowed_divergence_value integer | changed | Значение типа расхождения, используемого для адаптивного мониторинга времени отклика. Может быть percent или ms в зависимости от того, relative или absolute. Пример: 25 |
| description string | changed | Описание монитора. Пример: Важный монитор |
| interval integer | changed | Новый интервал, с которым будет выполняться проверка монитора. Пример: 2 |
| ip string | changed | Новый IP-адрес IP/порт определения. Пример: 10.12.13.14 |
| parent string | changed | Новый родительский шаблон монитора. Пример: gateway-icmp |
| port string | changed | Псевдоним порта или службы для проверки монитором от имени пулов или членов пулов, с которыми связан монитор. Пример: 80 |
| sampling_timespan integer | changed | Абсолютное количество миллисекунд, которое не должно превышаться зондом монитора. Пример: 200 |
| time_until_up integer | changed | Новое время, в течение которого система будет считаться активной после первого успешного ответа. Пример: 2 |
| timeout integer | changed | Новый тайм-аут, в течение которого удаленная система должна ответить на монитор. Пример: 10 |
| transparent boolean | changed | Работает ли монитор в прозрачном режиме. |
| up_interval integer | changed | Интервал, используемый системой для проверки состояния, когда ресурс активен. |
Авторы
- Tim Rupp (@caphrim007)
© 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_gateway_icmp_module.html
