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

Примечание

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

Для его установки используйте: 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 целое число			Указывает количество секунд, которое следует подождать после того, как ресурс впервые правильно ответил на запрос монитора, прежде чем установить состояние ресурса в 'up'. В течение этого интервала все ответы от ресурса должны быть корректными. По истечении интервала ресурс помечается как 'up'. Значение 0 означает, что ресурс помечается как 'up' сразу после получения первого правильного ответа.
timeout целое число			Указывает количество секунд, которое у цели есть для ответа на запрос монитора. Если цель отвечает в течение установленного времени, она считается 'up'. Если цель не отвечает в течение установленного времени, она считается 'down'. Если это значение равно 0 (ноль), система использует интервал от родительского монитора. Обратите внимание, что `timeout` и `time_until_up` объединяются для управления тем, когда ресурс устанавливается в состояние 'up'.
transparent boolean		Варианты: no yes	Указывает, работает ли монитор в прозрачном режиме. Монитор в прозрачном режиме перенаправляет трафик через связанные члены пула или узлы (обычно маршрутизатор или брандмауэр) к алиасному пункту назначения (то есть, он проверяет комбинацию `ip`-`port` указанную в мониторе). Если монитор не может успешно достичь алиасного пункта назначения, член пула или узел, через который проходил трафик монитора, помечаются как неисправные. При создании нового монитора, если этот параметр не указан, значение по умолчанию будет тем, которое задано в `parent`.

up_interval

integer

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

Когда 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 boolean	changed	Включена или выключена адаптивная настройка. Пример: True
adaptive_limit integer	changed	Абсолютное количество миллисекунд, которое не должно превышаться зондом мониторинга. Пример: 200
allowed_divergence_type string	changed	Тип расхождения, используемый для адаптивного мониторинга времени отклика. Пример: absolute
allowed_divergence_value integer	changed	Значение типа расхождения, используемого для адаптивного мониторинга времени отклика. Может быть `percent` или `ms`, в зависимости от того, используется ли `relative` или `absolute`. Пример: 25
app_service string	changed	Служба iApp, связанная с этим монитором. Пример: /Common/good_service.app/good_service
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	Интервал, используемый системой для проверки работоспособности ресурса, когда он доступен.

Авторы

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