Spec-Zone.ru › Ansible

f5networks.f5_modules.bigip_monitor_icmp модуль — Управление мониторами ICMP F5 BIG-IP LTM

Примечание

Этот модуль входит в коллекцию f5networks.f5_modules (версия 1.31.0).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.

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

Чтобы использовать его в плейбуке, укажите: f5networks.f5_modules.bigip_monitor_icmp.

Новая функция в f5networks.f5_modules 1.1.0

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

Обзор

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

Параметры

Параметр

Комментарии

adaptive

boolean

Указывает, включен ли адаптивный мониторинг времени отклика для этого монитора.

Когда true, монитор определяет состояние службы на основе того, насколько сильно отклонение от средней задержки зонда монитора для этой службы может быть допустимым. Также будут применяться значения для allowed_divergence, adaptive_limit, и sampling_timespan.

Когда disabled, монитор определяет состояние службы на основе interval, up_interval, time_until_up, и timeout параметров монитора.

Варианты:

  • false
  • true

adaptive_limit

integer

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

Это значение применяется независимо от значения настройки allowed_divergence.

Хотя это значение может быть настроено, когда adaptive является false, оно не будет действовать в системе, пока adaptive не будет true.

allowed_divergence_type

string

При указании нового монитора, если adaptive является true, значение по умолчанию — relative.

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

Когда relative, процент отклонения, на которое задержка зонда монитора может превышать среднюю задержку зонда монитора для проверяемой службы.

Варианты:

  • "relative"
  • "absolute"

allowed_divergence_value

integer

При указании нового монитора, если adaptive является true, и type является relative, значение по умолчанию — 25 процентов.

app_service

string

Служба iApp, которая будет связана с этим профилем. Если служба не указана, значение по умолчанию — None.

description

string

Описание монитора.

interval

integer

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

ip

string

Указывает IP-адрес ресурса, который является назначением этого монитора.

Когда установлено значение *, устройство выполняет проверку работоспособности по IP-адресу узла.

Когда установлено значение <IP>, устройство выполняет проверку работоспособности по этому IP-адресу и помечает связанный узел как активный или неактивный в зависимости от ответа. Этот параметр устанавливается устройством по умолчанию, если он не определен при создании монитора.

Когда установлено значение <IP> и transparent является true, устройство выполняет проверку работоспособности по этому IP-адресу, маршрутизирует проверку через связанный IP-адрес узла и соответственно помечает связанный IP-адрес узла как активный или неактивный.

manual_resume

boolean

Указывает, автоматически ли система изменяет состояние ресурса на включено при следующей успешной проверке монитора.

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

Когда true, указывает, что вы должны вручную снова включить ресурс после неудачной проверки монитора.

Когда false, указывает, что система автоматически изменяет состояние ресурса на включено при следующей успешной проверке монитора.

Варианты:

  • false
  • true

name

string / required

Указывает имя монитора.

parent

string

Родительский шаблон этого шаблона монитора. После установки это значение нельзя изменить.

При создании нового монитора, если этот параметр не указан, значением по умолчанию является предоставленный системой монитор icmp.

partition

string

Раздел устройства для управления ресурсами.

Значение по умолчанию: "Common"

provider

dictionary

добавлено в f5networks.f5_modules 1.0.0

Объект dict, содержащий сведения о подключении.

auth_provider

string

Настраивает поставщика проверки подлинности для получения маркеров проверки подлинности от удаленного устройства.

Этот параметр действительно используется при работе с устройствами BIG-IQ.

no_f5_teem

boolean

Если yes, данные телеметрии TEEM не отправляются в F5.

Вы можете опустить этот параметр, установив переменную среды F5_TELEMETRY_OFF.

Ранее использовавшаяся переменная F5_TEEM устарела, так как ее название было запутанным.

Варианты:

  • false ← (по умолчанию)
  • true

пароль

псевдонимы: pass, pwd

строка / обязательный

Пароль от учетной записи пользователя, используемой для подключения к BIG-IP или BIG-IQ.

Вы можете опустить этот параметр, установив переменную среды F5_PASSWORD.

сервер

строка / обязательный

Хост BIG-IP или хост BIG-IQ.

Вы можете опустить этот параметр, установив переменную среды F5_SERVER.

server_port

целое число

Порт сервера BIG-IP.

Вы можете опустить этот параметр, установив переменную среды F5_SERVER_PORT.

Значение по умолчанию: 443

timeout

целое число

Устанавливает таймаут в секундах для связи с сетевым устройством при подключении или отправке команд. Если таймаут истечёт до завершения операции, модуль выдаст ошибку.

transport

строка

Настраивает транспортное соединение для подключения к удалённому устройству.

Доступные значения:

  • "rest" ← (по умолчанию)

пользователь

строка / обязательный

Имя пользователя для подключения к BIG-IP или BIG-IQ. Этот пользователь должен иметь административные права на устройстве.

Вы можете опустить этот параметр, установив переменную среды F5_USER.

validate_certs

логическое значение

Если no, сертификаты SSL не проверяются. Используйте только на контролируемых вами сайтах с самозаверяющимися сертификатами.

Вы можете опустить этот параметр, установив переменную среды F5_VALIDATE_CERTS.

Доступные значения:

  • false
  • true ← (по умолчанию)

sampling_timespan

целое число

Устанавливает длительность, в секундах, окна истории зондирования, используемого системой для расчёта средней задержки и стандартного отклонения зонда монитора.

Хотя это значение можно настроить, когда adaptive равно false, оно не будет применено на системе до тех пор, пока adaptive не станет true.

состояние

строка

Когда present, гарантирует, что монитор существует.

Когда absent, гарантирует удаление монитора.

Доступные значения:

  • "present" ← (по умолчанию)
  • "absent"

time_until_up

целое число

Устанавливает количество секунд ожидания после того, как ресурс впервые корректно отреагирует на монитор, прежде чем установить ресурс в состояние ‘включено’.

В течение этого интервала все ответы от ресурса должны быть корректными.

По истечении интервала ресурс помечается как ‘включён’.

Значение 0 означает, что ресурс помечается как включён сразу после получения первого правильного ответа.

timeout

целое число

Устанавливает количество секунд, в течение которого целевой ресурс должен ответить на запрос монитора.

Если целевой ресурс отвечает в установленный срок, он считается ‘включённым’. Если он не отвечает в установленный срок, он считается ‘выключенным’. Когда это значение установлено в 0 (ноль), система использует интервал из родительского монитора.

Обратите внимание, что timeout и time_until_up совместно управляют тем, когда ресурс устанавливается в состояние ‘включен’.

transparent

логическое значение

Указывает, работает ли монитор в прозрачном режиме.

Монитор в прозрачном режиме направляет трафик через соответствующие члены пула или узлы (обычно маршрутизатор или брандмауэр) к адресу, указанному в псевдониме (то есть он проверяет сочетание ip-port, указанное в мониторе).

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

При создании нового монитора, если этот параметр не задан, значение по умолчанию будет тем, что установлено в parent.

Доступные значения:

  • false
  • true

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: false
    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: true
    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

Значение типа расхождения, используемого для адаптивного мониторинга времени отклика.

Может быть percent или ms в зависимости от того, relative или absolute.

Возвращено: changed

Пример: 25

app_service

string

Служба iApp, связанная с этим монитором.

Возвращено: changed

Пример: "/Common/good_service.app/good_service"

description

string

Описание монитора.

Возвращено: changed

Пример: "Important Monitor"

interval

integer

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

Возвращено: changed

Пример: 2

ip

string

Новый IP-адрес определения IP/порт.

Возвращено: changed

Пример: "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

Пример: false

up_interval

integer

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

Возвращено: changed

Пример: 0

Авторы

  • Wojciech Wypior (@wojtek0806)

Ссылки на коллекцию

  • Система отслеживания ошибок
  • Домашняя страница
  • Репозиторий (исходные коды)

© 2012–2018 Michael DeHaan
© 2018–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/f5networks/f5_modules/bigip_monitor_icmp_module.html

Spec-Zone.ru

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