Spec-Zone.ru › Ansible 2.11

f5networks.f5_modules.bigip_monitor_dns – Управление мониторами DNS на BIG-IP

Примечание

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

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

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

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

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

Обзор

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

Параметры

Параметр Варианты/Значения по умолчанию Комментарии
accept_rcode
строка
    Варианты:
  • no-error
  • anything
Указывает требуемый RCODE в ответе для статуса «включено».
При создании нового монитора, если этот параметр не указан, используется значение по умолчанию no-error.
Если no-error, статус узла будет помечен как «включено», если полученное сообщение DNS не содержит ошибок.
Если anything, статус узла будет помечен как «включено», независимо от RCODE в полученном сообщении DNS.
Если этот параметр установлен в anything, он проигнорирует строку receive, и обнулит её, если монитор обновляется.
adaptive
логическое значение
    Варианты:
  • 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 процента.
answer_section_contains
строка
    Варианты:
  • any-type
  • anything
  • query-type
Указывает тип запроса DNS, отправляемого монитором.
При создании нового монитора, если это значение не указано, используется значение по умолчанию query-type.
Если query-type, указывает, что ответ должен содержать по крайней мере один ответ, тип ресурсного записей которого соответствует типу запроса.
Если any-type, указывает, что сообщение DNS должно содержать по крайней мере один ответ.
Если anything, указывает, что пустой ответ достаточно для того, чтобы пометить статус узла как «включен».
description
строка
Описание монитора.
interval
целое число
Интервал, определяющий частоту выполнения экземпляра монитора данной шаблона.
Это значение обязательно должно быть меньше значения timeout.
При создании нового монитора, если этот параметр не указан, используется значение по умолчанию 5.
ip
строка
Часть IP-адреса в определении IP/порт.
Если этот параметр не указан при создании нового монитора, используется значение по умолчанию *.
manual_resume
логическое значение
    Варианты:
  • no
  • yes
Указывает, автоматически ли система изменяет статус ресурса на включено при следующем успешном проверочном цикле монитора.
Если yes, необходимо вручную повторно включить ресурс, прежде чем система сможет использовать его для балансировки нагрузки.
При создании нового монитора, если этот параметр не указан, значение по умолчанию равно no.
Если yes, указывает, что необходимо вручную повторно включить ресурс после неудачной проверки монитора.
Если no, указывает, что система автоматически изменяет статус ресурса на включено при следующем успешном проверочном цикле монитора.
name
строка / обязательно
Указывает имя монитора.
parent
строка
Значение по умолчанию:
"/Common/dns"
Родительский шаблон этого шаблона монитора. После установки этого значения его нельзя изменить. По умолчанию это родительский шаблон dns на разделителе Common.
partition
строка
Значение по умолчанию:
"Common"
Раздел устройства для управления ресурсами.
port
строка
Адрес порта в определении IP/порт.
Если этот параметр не указан при создании нового монитора, значение по умолчанию будет *.
Обратите внимание, что если вы указываете IP-адрес, вы должны использовать значение от 1 до 65535.
provider
словарь
добавлен в 1.0.0 f5networks.f5_modules
Объект словаря, содержащий сведения о подключении.
auth_provider
строка
Настраивает поставщика авторизации для получения маркеров аутентификации от удаленного устройства.
Этот параметр используется при работе с устройствами BIG-IQ.
no_f5_teem
логическое значение
    Варианты:
  • 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
логическое значение
    Варианты:
  • no
  • yes ←
Если no, сертификаты SSL не проверяются. Используйте только на контролируемых вами сайтах, использующих самоподписанные сертификаты.
Вы можете опустить этот параметр, установив переменную среды F5_VALIDATE_CERTS.
query_name
строка
Указывает имя запроса, которое монитор должен использовать в запросе DNS.
query_type
строка
    Варианты:
  • a
  • aaaa
Указывает тип запроса DNS, который отправляет монитор.
При создании нового монитора, если этот параметр не указан, значение по умолчанию a.
Если a, монитор отправит запрос DNS типа A.
Если aaaa, монитор отправит запрос DNS типа AAAA.
receive
строка
Указывает IP-адрес, который монитор использует из разделов с записями ресурса в ответе DNS.
IP-адрес должен быть указан в точечно-десятичном формате или формате IPv6.
обратный
логический
    Варианты:
  • нет
  • да
Указывает, работает ли монитор в обратном режиме.
Когда монитор работает в обратном режиме, успешное соответствие строки приёма помечает отслеживаемый объект как неактивный, а не активный. Этот режим можно использовать только если настроено значение параметра receive.
Этот параметр несовместим с параметром time_until_up. Если указан параметр time_until_up, он должен быть 0. В противном случае, если он уже существует, он должен быть 0.
sampling_timespan
целое число
Указывает длительность, в секундах, окна истории зонда, используемого системой для расчёта среднего времени ожидания и стандартного отклонения зонда монитора.
Хотя это значение можно настроить, когда adaptive равно no, оно не будет применяться к системе до тех пор, пока adaptive не будет равно yes.
состояние
строка
    Варианты:
  • present ←
  • отсутствует
Когда present, гарантирует существование монитора.
Когда absent, гарантирует удаление монитора.
time_until_up
целое число
Указывает время в секундах после первого успешного ответа, прежде чем узел будет помечен как активный.
Значение 0 приведет к тому, что узел будет помечен как активный сразу после получения от узла действительного ответа.
Если этот параметр не задан при создании нового монитора, будет использовано значение по умолчанию 0.
timeout
целое число
Количество секунд, в течение которого узел или служба должны ответить на запрос монитора.
Если целевой объект отвечает в установленный период времени, он считается активным.
Если целевой объект не отвечает в установленный период времени, он считается неактивным.
Можно изменить это значение на любое число, но оно должно быть в 3 раза больше числа интервалов в секундах плюс 1 секунда.
Если этот параметр не задан при создании нового монитора, значение по умолчанию будет 16.
прозрачный
логический
    Варианты:
  • нет
  • да
Указывает, работает ли монитор в прозрачном режиме.
Мониторы в прозрачном режиме могут отслеживать членов пула через брандмауэры.
При создании нового монитора, если этот параметр не задан, будет использовано значение по умолчанию no.
up_interval
целое число
Указывает интервал, используемый системой для проверки работоспособности, когда ресурс активен.
Если 0, система использует интервал, указанный в interval, для проверки работоспособности ресурса.
При любом другом числе вы можете указать другой интервал для проверки работоспособности активного ресурса.
При создании нового монитора, если этот параметр не задан, будет использовано значение по умолчанию 0.

Примечания

Примечание

  • Дополнительную информацию об использовании 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 DNS monitor
  bigip_monitor_dns:
    name: DNS-UDP-V6
    interval: 2
    query_name: localhost
    query_type: aaaa
    up_interval: 5
    adaptive: no
    state: present
    provider:
      user: admin
      password: secret
      server: lb.mydomain.com
  delegate_to: localhost

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

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

Ключ Возвращённое значение Описание
accept_rcode
строка
changed
RCODE, необходимый в ответе для статуса активного.

Пример:
no-error
adaptive
логический
changed
Включена или выключена адаптивная функция.

Пример:
True
adaptive_limit
целое число
changed
Абсолютное число миллисекунд, которое не может быть превышено зондом монитора.

Пример:
200
allowed_divergence_type
строка
changed
Тип расхождения, используемый для адаптивного мониторинга времени отклика.

Пример:
absolute
allowed_divergence_value
целое число
changed
Значение типа расхождения, используемого для адаптивного мониторинга времени отклика.
Может быть percent или ms в зависимости от того, relative или absolute.

Пример:
25
answer_section_contains
строка
changed
Тип DNS-запроса, отправляемый монитором.

Пример:
query-type
описание
строка
changed
Описание монитора.

Пример:
Важный монитор
interval
целое число
changed
Новый интервал для выполнения проверки монитора.

Пример:
2
ip
строка
changed
Новый IP-адрес определения IP/порта.

Пример:
10.12.13.14
manual_resume
строка
changed
Автоматически ли система изменяет статус ресурса на включённый при следующем успешном проверочном цикле монитора.

Пример:
query-type
parent
строка
changed
Новый родительский шаблон монитора.

Пример:
http
port
строка
changed
Псевдоним порта или службы для проверки монитором от имени пулов или членов пулов, с которыми связан монитор.

Пример:
80
query_name
строка
changed
Имя запроса, используемого монитором в DNS-запросе.

Пример:
foo
query_type
строка
changed
Тип DNS-запроса, отправляемого монитором. Либо a, либо aaaa.

Пример:
aaaa
receive
строка
changed
IP-адрес, используемый монитором из разделов записей ресурсов DNS-ответа.

Пример:
2.3.2.4
обратный
логический
changed
Работает ли монитор в обратном режиме.

Пример:
True
sampling_timespan
целое число
changed
Абсолютное число миллисекунд, которое не может быть превышено зондом монитора.

Пример:
200
time_until_up
целое число
changed
Новое время для маркировки системы как активной после первого успешного ответа.

Пример:
2
timeout
целое число
changed
Новый таймаут, в течение которого удалённая система должна ответить на монитор.

Пример:
10
прозрачный
логический
changed
Работает ли монитор в прозрачном режиме.

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



Авторы

  • Tim Rupp (@caphrim007)
  • 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_dns_module.html

Spec-Zone.ru

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