Spec-Zone.ru › Ansible 2.10

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

Примечание

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

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

Для использования в плейбуке укажите: f5networks.f5_modules.bigip_monitor_gateway_icmp.

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

  • Описание
  • Параметры
  • Примечания
  • Примеры
  • Возвращаемые значения

Описание

  • Управляет мониторами ICMP шлюза на BIG-IP LTM.

Параметры

Параметр Варианты/Значения по умолчанию Комментарии
adaptive
boolean
    Варианты:
  • no
  • yes
Указывает, включено ли адаптивное отслеживание времени отклика для этого монитора.
Когда 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
    Варианты:
  • relative
  • absolute
При указании нового монитора, если adaptive равно yes, значение по умолчанию равно relative.
Когда absolute, это число миллисекунд, на которое задержка запроса монитора может превышать среднюю задержку запроса монитора для прощупываемой службы. В типичных случаях, если монитор обнаружит три подряд запроса, которые не соответствуют заданному вами значению задержки, то член пула или узел отмечается как неактивный.
Когда relative, это процентное отклонение, на которое задержка запроса монитора может превышать среднюю задержку запроса монитора для прощупываемой службы.
allowed_divergence_value
integer
При указании нового монитора, если adaptive равно yes, и type равно relative, значение по умолчанию равно 25 процентам.
description
string
Описание монитора.
interval
integer
Указывает частоту проверки монитором системы в секундах, когда ресурс неактивный или статус ресурса неизвестен.
ip
string
Часть IP-адреса в определении IP/порт. Если этот параметр не указан при создании нового монитора, значение по умолчанию равно '*'.
manual_resume
boolean
    Варианты:
  • no
  • yes
Указывает, автоматически ли система изменяет статус ресурса на enabled при следующей успешной проверке монитором.
Если вы установите этот параметр в значение yes, вы должны вручную снова включить ресурс, прежде чем система сможет использовать его для балансировки нагрузки.
Если yes, указывает, что вы должны вручную повторно включить ресурс после неудачной проверки монитора.
Если no, указывает, что система автоматически изменяет статус ресурса на enabled при следующей успешной проверке монитором.
name
string / обязательно
Имя монитора.
parent
string
Значение по умолчанию:
"/Common/gateway_icmp"
Родительская шаблон этого шаблона монитора. После установки этого значения его нельзя изменить. По умолчанию это родительский шаблон в разделе Common.
partition
string
Значение по умолчанию:
"Common"
Раздел устройства для управления ресурсами.
port
string
Адрес порта в определении IP/порт. Если этот параметр не указан при создании нового монитора, значение по умолчанию равно '*'. При указании IP-адреса, вы должны использовать значение от 1 до 65535.
provider
dictionary
добавлен в 1.0.0 модуля f5networks.f5_modules
Объект словаря, содержащий данные о соединении.
auth_provider
string
Настраивает поставщика аутентификации для получения токенов аутентификации с удаленного устройства.
Этот параметр используется в основном при работе с устройствами BIG-IQ.
no_f5_teem
boolean
    Варианты:
  • no
  • yes
Если yes, данные телеметрии TEEM не отправляются в F5.
Можно пропустить этот параметр, установив переменную среды F5_TEEM.
password
string / обязательно
Пароль учетной записи пользователя, используемой для подключения к BIG-IP.
Можно пропустить этот параметр, установив переменную среды F5_PASSWORD.

псевдонимы: pass, pwd
server
string / обязательно
Хост BIG-IP.
Можно пропустить этот параметр, установив переменную среды F5_SERVER.
server_port
integer
Значение по умолчанию:
443
Порт сервера BIG-IP.
Можно пропустить этот параметр, установив переменную среды F5_SERVER_PORT.
timeout
integer
Указывает таймаут в секундах для связи с сетевым устройством при подключении или отправке команд. Если таймаут истекает до завершения операции, модуль выдаст ошибку.
transport
string
    Варианты:
  • rest ←
Настраивает транспортное соединение для подключения к удаленному устройству.
user
string / обязательно
Имя пользователя для подключения к BIG-IP. Этот пользователь должен иметь права администратора на устройстве.
Можно пропустить этот параметр, установив переменную среды F5_USER.
validate_certs
boolean
    Варианты:
  • no
  • yes ←
Если no, сертификаты SSL не проверяются. Используйте только на сайтах под личным контролем, использующих самозаверяемые сертификаты.
Можно пропустить этот параметр, установив переменную среды F5_VALIDATE_CERTS.
sampling_timespan
integer
Указывает длительность, в секундах, окна истории запросов, которое система использует для расчета средней задержки и стандартного отклонения запроса монитора.
Хотя это значение можно настроить при adaptive, равном no, оно не будет применяться к системе до тех пор, пока adaptive не будет равно yes.
state
string
    Варианты:
  • present ←
  • absent
Когда present, гарантирует, что монитор существует.
Когда absent, гарантирует удаление монитора.
time_until_up
integer
Указывает количество секунд, которое нужно ждать после того, как ресурс впервые правильно ответит на запрос монитора, прежде чем установить статус ресурса в 'up'.
В течение этого интервала все ответы от ресурса должны быть корректными.
После истечения интервала ресурс отмечается как 'up'.
Значение 0 означает, что ресурс отмечается как активный сразу после получения первого правильного ответа.
timeout
integer
Указывает количество секунд, в течение которых целевое устройство должно ответить на запрос монитора.
Если целевое устройство отвечает в заданный период времени, оно считается активным. Если целевое устройство не отвечает в заданный период времени, оно считается неактивным. Когда это значение установлено в 0 (ноль), система использует интервал из родительского монитора.
Обратите внимание, что timeout и time_until_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 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–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_gateway_icmp_module.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API