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 целое число			Указывает абсолютное значение в миллисекундах, которое не должно превышаться запросом монитора, независимо от настройки `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/порт определения. Если этот параметр не указан при создании нового монитора, значение по умолчанию будет '*'.
manual_resume boolean		Варианты: нет да	Указывает, автоматически ли система изменяет статус ресурса на включен при следующей успешной проверке монитора. Если вы установите этот параметр в `yes`, вы должны вручную повторно включить ресурс, прежде чем система сможет использовать его для балансировки нагрузки. При `yes`, указывает, что вам необходимо вручную повторно включить ресурс после неудачной проверки монитора. При `no`, указывает, что система автоматически изменяет статус ресурса на включен при следующей успешной проверке монитора.
name строка / обязательно			Имя монитора.
parent строка		Значение по умолчанию: "/Common/gateway_icmp"	Родительская шаблон этого шаблона монитора. После установки этого значения его изменить нельзя. По умолчанию это значение — родительский `gateway_icmp` на разделе `Common`.
partition строка		Значение по умолчанию: "Common"	Раздел устройства для управления ресурсами.
password строка / обязательно			Пароль учетной записи пользователя для подключения к BIG-IP. Вы можете опустить этот параметр, установив переменную окружения `F5_PASSWORD`. псевдонимы: pass, pwd
port строка			Адрес порта в определении IP/порт. Если этот параметр не указан при создании нового монитора, значение по умолчанию будет '*'. Обратите внимание, что если вы указываете IP-адрес, необходимо указать значение от 1 до 65535.
provider словарь добавлено в 2.5			Объект словаря, содержащий сведения о подключении.
	password строка / обязательно		Пароль учетной записи пользователя для подключения к BIG-IP. Вы можете опустить этот параметр, установив переменную окружения `F5_PASSWORD`. псевдонимы: pass, pwd
	server строка / обязательно		Хост BIG-IP. Вы можете опустить этот параметр, установив переменную окружения `F5_SERVER`.
	server_port целое число	Значение по умолчанию: 443	Порт сервера BIG-IP. Вы можете опустить этот параметр, установив переменную окружения `F5_SERVER_PORT`.
	ssh_keyfile путь		Указывает SSH-ключевой файл для аутентификации подключения к удаленному устройству. Этот аргумент используется только для транспортов cli. Вы можете опустить этот параметр, установив переменную окружения `ANSIBLE_NET_SSH_KEYFILE`.
	timeout целое число	Значение по умолчанию: 10	Указывает таймаут в секундах для связи с сетевым устройством при подключении или отправке команд. Если таймаут истечёт до завершения операции, модуль выдаст ошибку.
	transport строка	Варианты: cli rest ←	Настраивает транспортное соединение для подключения к удалённому устройству.
	user строка / обязательно		Имя пользователя для подключения к BIG-IP. Этот пользователь должен иметь административные привилегии на устройстве. Вы можете опустить этот параметр, установив переменную окружения `F5_USER`.
	validate_certs boolean	Варианты: нет да ←	Если `no`, сертификаты SSL не проверяются. Используйте только на контролируемых вами сайтах с самоподписанными сертификатами. Вы можете опустить этот параметр, установив переменную окружения `F5_VALIDATE_CERTS`.
sampling_timespan целое число			Указывает длину, в секундах, окна истории запросов, используемого системой для расчёта средней задержки и стандартного отклонения запроса монитора. Хотя это значение можно настроить, когда `adaptive` равно `no`, оно не будет применено на системе, пока `adaptive` не станет `yes`.
server строка / обязательно			Хост BIG-IP. Вы можете опустить этот параметр, установив переменную окружения `F5_SERVER`.
server_port целое число добавлено в 2.2		Значение по умолчанию: 443	Порт сервера BIG-IP. Вы можете опустить этот параметр, установив переменную окружения `F5_SERVER_PORT`.
state строка		Варианты: present ← absent	Когда `present`, гарантирует, что монитор существует. Когда `absent`, гарантирует удаление монитора.

time_until_up целое число		Указывает количество секунд ожидания после того, как ресурс впервые корректно ответит на запрос монитора, прежде чем установить ресурс в состояние 'up'. В течение этого интервала все ответы от ресурса должны быть корректными. По истечении интервала ресурс помечается как 'up'. Значение 0 означает, что ресурс помечается как 'up' сразу после получения первого корректного ответа.
timeout целое число		Указывает количество секунд, отведенное целевому ресурсу для ответа на запрос монитора. Если целевой ресурс отвечает в течение заданного времени, он считается 'up'. Если целевой ресурс не отвечает в течение заданного времени, он считается 'down'. Если это значение установлено в 0 (ноль), система использует интервал из родительского монитора. Обратите внимание, что `timeout` и `time_until_up` совместно управляют моментом, когда ресурс устанавливается в состояние 'up'.
transparent логическое	Варианты: no yes	Указывает, работает ли монитор в прозрачном режиме. Монитор в прозрачном режиме направляет трафик через связанные с ним члены пула или узлы (обычно маршрутизатор или брандмауэр) к алиасному пункту назначения (то есть, он проверяет комбинацию `ip`-`port`, указанную в мониторе). Если монитор не может успешно достичь алиасного пункта назначения, член пула или узел, через который был отправлен трафик монитора, помечается как 'down'. При создании нового монитора, если этот параметр не задан, то значение по умолчанию будет таким, как указано в `parent`.
up_interval целое число		Указывает интервал, который система использует для проверки работоспособности, когда ресурс находится в состоянии 'up'. Когда `0`, система использует интервал, указанный в `interval`, для проверки работоспособности ресурса. В любом другом случае, позволяет задать другой интервал для проверки работоспособности ресурса, находящегося в состоянии 'up'.
user строка / обязательно		Имя пользователя для подключения к BIG-IP. Этот пользователь должен иметь административные права на устройстве. Этот параметр можно опустить, установив переменную среды `F5_USER`.
validate_certs логическое добавлено в 2.0	Варианты: no yes ←	Если `no`, сертификаты SSL не проверяются. Используйте только на сайтах, контролируемых вами лично, которые используют самозаверяющие сертификаты. Этот параметр можно опустить, установив переменную среды `F5_VALIDATE_CERTS`.

Примечания

Примечание

Дополнительную информацию об использовании 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 логическое	changed	Включена ли адаптация. Пример: True
adaptive_limit целое число	changed	Абсолютное число миллисекунд, которое не должно превышаться зондом монитора. Пример: 200
allowed_divergence_type строка	changed	Тип расхождения, используемый для адаптивного мониторинга времени отклика. Пример: absolute
allowed_divergence_value целое число	changed	Значение типа расхождения, используемого для адаптивного мониторинга времени отклика. Может быть `percent` или `ms` в зависимости от того, используется ли `relative` или `absolute`. Пример: 25
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	Новое время, в течение которого система помечается как 'up' после первого успешного ответа. Пример: 2
timeout целое число	changed	Новый таймаут, в течение которого удаленная система должна ответить на запрос монитора. Пример: 10
transparent логическое	changed	Работает ли монитор в прозрачном режиме.
up_interval целое число	changed	Интервал, используемый системой для проверки работоспособности, когда ресурс находится в состоянии 'up'.

Статус

Этот модуль не гарантирует обратную совместимость интерфейса. [превью]
Этот модуль поддерживается партнером 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.8/modules/bigip_monitor_gateway_icmp_module.html