f5networks.f5_modules.bigip_monitor_icmp – Управляет мониторами ICMP F5 BIG-IP LTM

Примечание

Этот плагин входит в коллекцию f5networks.f5_modules (версия 1.7.1).

Для его установки используйте: ansible-galaxy collection install f5networks.f5_modules.

Для использования в книге задач укажите: f5networks.f5_modules.bigip_monitor_icmp.

Новое в версии 1.1.0: модуля f5networks.f5_modules

Обзор
Параметры
Примечания
Примеры
Значения возврата

Обзор

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

Параметры

Параметр		Варианты/Значения по умолчанию	Комментарии
adaptive boolean		Варианты: no yes	Указывает, включено ли адаптивное отслеживание времени отклика для данного монитора. Когда `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 строка		Варианты: relative absolute	При создании нового монитора, если `adaptive` равно `yes`, значение по умолчанию — `relative`. При `absolute`, количество миллисекунд, на которое задержка зонда монитора может превышать среднюю задержку зонда монитора для проверяемого сервиса. В типичных случаях, если монитор обнаруживает три подряд проверки, которые не удовлетворяют заданному значению задержки, элемент пула или узел помечаются как нерабочие. При `relative`, процент отклонения, на который задержка зонда монитора может превышать среднюю задержку зонда монитора для проверяемого сервиса.
allowed_divergence_value целое число			При создании нового монитора, если `adaptive` равно `yes`, и `type` равно `relative`, значение по умолчанию — `25` процентов.
app_service строка			Сервис iApp, который нужно ассоциировать с этим профилем. Если сервис не указан, значение по умолчанию — None.
description строка			Описание монитора.
interval целое число			Указывает частоту проверки монитором в секундах, когда ресурс недоступен или его статус неизвестен.
ip строка			Указывает IP-адрес ресурса, являющегося целевым для этого монитора. При значении * устройство выполняет проверку работоспособности IP-адреса узла. При значении <IP> устройство выполняет проверку работоспособности по этому IP-адресу и помечает связанный узел как активный или неактивный в зависимости от ответа. Этот параметр устанавливается устройством по умолчанию, если не определен при создании монитора. При значении <IP> и `transparent` равно `yes`, устройство выполняет проверку работоспособности по этому IP-адресу, направляя проверку через IP-адрес связанного узла и помечает связанный IP-адрес узла как активный или неактивный в соответствии с результатом.
manual_resume boolean		Варианты: no yes	Указывает, автоматически ли система изменяет статус ресурса на enabled при следующей успешной проверке монитора. Если вы установите этот параметр в `yes`, вам нужно вручную снова включить ресурс, прежде чем система сможет использовать его для балансировки нагрузки. При `yes`, указывает, что вам нужно вручную повторно включить ресурс после неудачной проверки монитора. При `no`, указывает, что система автоматически изменяет статус ресурса на enabled при следующей успешной проверке монитора.
name строка / обязательно			Указывает имя монитора.
parent строка			Родительская шаблон этого шаблона монитора. После установки этого значения его нельзя изменить. При создании нового монитора, если этот параметр не указан, значение по умолчанию — системный монитор `icmp`.
partition строка		По умолчанию: "Common"	Раздел устройства для управления ресурсами.
provider словарь добавлен в 1.0.0 f5networks.f5_modules			Объект словаря, содержащий данные подключения.
	auth_provider строка		Настраивает поставщика аутентификации для получения маркеров аутентификации от удаленного устройства. Этот параметр действительно используется при работе с устройствами BIG-IQ.
	no_f5_teem boolean	Варианты: no yes	Если `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 строка	Варианты: rest ←	Настраивает транспортное соединение для использования при подключении к удаленному устройству.
	user строка / обязательно		Имя пользователя для подключения к BIG-IP. Этот пользователь должен иметь административные привилегии на устройстве. Вы можете опустить этот параметр, установив переменную среды `F5_USER`.
	validate_certs boolean	Варианты: no yes ←	Если `no`, сертификаты SSL не будут проверены. Используйте только на контролируемых вами сайтах, использующих самозаверяющие сертификаты. Вы можете опустить этот параметр, установив переменную среды `F5_VALIDATE_CERTS`.
sampling_timespan целое число			Указывает длину, в секундах, окна истории зонда, используемого системой для расчета средней задержки и стандартного отклонения зонда монитора. Хотя это значение можно настроить, когда `adaptive` равно `no`, оно не будет применено на системе до тех пор, пока `adaptive` не будет равно `yes`.
state строка		Варианты: present ← absent	При значении `present`, гарантирует, что монитор существует. При значении `absent`, гарантирует удаление монитора.
time_until_up целое число			Указывает количество секунд, которые нужно подождать после того, как ресурс впервые правильно отреагировал на монитор, прежде чем установить статус ресурса в «активный». В течение этого интервала все ответы от ресурса должны быть корректными. После истечения интервала ресурс помечается как «активный». Значение 0 означает, что ресурс помечается как активный сразу после получения первого правильного ответа.
timeout целое число			Указывает количество секунд, в течение которых целевой объект должен ответить на запрос монитора. Если целевой объект отвечает в установленный период, он считается «активным». Если целевой объект не отвечает в установленный период, он считается «неактивным». При значении 0 система использует интервал из родительского монитора. Обратите внимание, что `timeout` и `time_until_up` совместно контролируют, когда ресурс устанавливается в состояние «активный».
transparent boolean		Варианты: no yes	Указывает, работает ли монитор в прозрачном режиме. Монитор в прозрачном режиме направляет трафик через связанные члены пула или узлы (обычно маршрутизатор или брандмауэр) к целевому адресу (то есть он проверяет комбинацию `ip`-`port` , указанную в мониторе). Если монитор не может успешно достичь целевого адреса, элемент пула или узел, через который был отправлен трафик монитора, помечается как неактивный. При создании нового монитора, если этот параметр не указан, значение по умолчанию будет тем, что предоставляет `parent`.

up_interval

целое число

Указывает интервал, используемый системой для проверки работоспособности ресурса, когда он доступен.

Когда значение 0, система использует интервал, указанный в interval, для проверки работоспособности ресурса.

В любом другом случае, позволяет указать другой интервал для проверки работоспособности доступного ресурса.

Примечания

Примечание

Дополнительную информацию об использовании Ansible для управления устройствами F5 Networks см. на странице https://www.ansible.com/integrations/networks/f5.
Требуется версия ПО BIG-IP >= 12.
Модули F5 манипулируют только текущей конфигурацией продукта F5. Для сохранения конфигурации BIG-IP на диске необходимо включить по крайней мере одну задачу, использующую модуль f5networks.f5_modules.bigip_config, для сохранения текущей конфигурации. Обратитесь к документации модуля для правильного использования модуля для сохранения текущей конфигурации.

Примеры

- name: Create an ICMP monitor
  bigip_monitor_icmp:
    name: icmp1
    adaptive: no
    interval: 1
    time_until_up: 0
    timeout: 3
    provider:
      password: secret
      server: lb.mydomain.com
      user: admin
  delegate_to: localhost

- name: Update an ICMP monitor
  bigip_monitor_icmp:
    name: icmp1
    manual_resume: yes
    interval: 5
    provider:
      password: secret
      server: lb.mydomain.com
      user: admin
  delegate_to: localhost

- name: Remove an ICMP monitor
  bigip_monitor_icmp:
    name: icmp1
    state: absent
    provider:
      password: secret
      server: lb.mydomain.com
      user: admin
  delegate_to: localhost

Значения возврата

Общие значения возврата описаны в этом разделе, ниже перечислены поля, уникальные для данного модуля:

Ключ	Возвращаемое значение	Описание
adaptive логический	changed	Включена ли адаптивная функция. Пример: True
adaptive_limit целое число	changed	Абсолютное значение в миллисекундах, которое не должно превышаться зондом мониторинга. Пример: 200
allowed_divergence_type строка	changed	Тип отклонения, используемый для адаптивного мониторинга времени отклика. Пример: absolute
allowed_divergence_value целое число	changed	Значение типа отклонения, используемого для адаптивного мониторинга времени отклика. Может быть `percent` или `ms` в зависимости от того, `relative` или `absolute`. Пример: 25
app_service строка	changed	Служба iApp, связанная с этим монитором. Пример: /Common/good_service.app/good_service
description строка	changed	Описание монитора. Пример: Важный монитор
interval целое число	changed	Новый интервал для запуска проверки монитора. Пример: 2
ip строка	changed	Новый IP-адрес определения IP/порта. Пример: 10.12.13.14
parent строка	changed	Новая родительская шаблон монитора. Пример: gateway-icmp
port строка	changed	Псевдоним порта или службы для проверки монитором от имени пулов или членов пулов, с которыми связан монитор. Пример: 80
sampling_timespan целое число	changed	Абсолютное значение в миллисекундах, которое не должно превышаться зондом мониторинга. Пример: 200
time_until_up целое число	changed	Новое время, в течение которого система будет помечена как доступная после первого успешного ответа. Пример: 2
timeout целое число	changed	Новый таймаут, в течение которого удаленная система должна ответить на запрос монитора. Пример: 10
transparent логический	changed	Работает ли монитор в прозрачном режиме.
up_interval целое число	changed	Интервал, используемый системой для проверки работоспособности ресурса, когда он доступен.

Авторы

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_icmp_module.html