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

Новая версия 2.7.

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

Описание

Управляет мониторами 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 словарь добавлено в 2.5			Объект словаря, содержащий данные подключения.
	auth_provider строка		Настраивает поставщика авторизации для получения маркеров аутентификации от удаленного устройства. Этот параметр используется при работе с устройствами BIG-IQ.
	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 целое число		Указывает таймаут в секундах для связи с сетевым устройством при подключении или отправке команд. Если таймаут истечет до завершения операции, модуль вернет ошибку.
	transport строка	Варианты: cli rest ←	Настраивает транспортное соединение для подключения к удаленному устройству.
	user строка / обязательно		Имя пользователя для подключения к BIG-IP. Этот пользователь должен иметь административные привилегии на устройстве. Вы можете опустить этот параметр, установив переменную окружения `F5_USER`.

	validate_certs boolean	Варианты: no yes ←	Если `no`, сертификаты SSL не проверяются. Используйте только на сайтах, контролируемых вами лично, с использованием самозаверенных сертификатов. Вы можете опустить этот параметр, установив переменную окружения `F5_VALIDATE_CERTS`.
query_name string			Указывает имя запроса, которое монитор должен использовать в запросе DNS.
query_type string		Варианты: a aaaa	Указывает тип запроса DNS, который отправляет монитор. При создании нового монитора, если этот параметр не указан, значение по умолчанию — `a`. Если `a`, указывает, что монитор отправит запрос DNS типа A. Если `aaaa`, указывает, что монитор отправит запрос DNS типа AAAA.
receive string			Указывает IP-адрес, который монитор использует из секций записей ресурсов ответа DNS. IP-адрес должен быть указан в точечной десятичной нотации или нотации IPv6.
reverse boolean		Варианты: no yes	Указывает, работает ли монитор в режиме обратного поиска. Когда монитор находится в режиме обратного поиска, успешное совпадение строки приёма помечает контролируемый объект как выключенный вместо включенного. Вы можете использовать этот режим только в том случае, если вы настраиваете параметр `receive`. Этот параметр несовместим с параметром `time_until_up`. Если `time_until_up` указан, он должен быть `0`. Или, если он уже существует, он должен быть `0`.
sampling_timespan integer			Указывает длину, в секундах, окна истории зондирования, которое система использует для расчета среднего значения задержки и стандартного отклонения зондирования монитора. Хотя это значение можно настроить, когда `adaptive` равно `no`, оно не будет действовать в системе до тех пор, пока `adaptive` не будет равно `yes`.
state string		Варианты: present ← absent	Когда `present`, гарантирует, что монитор существует. Когда `absent`, гарантирует удаление монитора.
time_until_up integer			Указывает время в секундах после первого успешного ответа, прежде чем узел будет помечен как активный. Значение 0 приведет к тому, что узел будет помечен как активный сразу после получения действительного ответа от узла. Если этот параметр не указан при создании нового монитора, значение по умолчанию будет `0`.
timeout integer			Количество секунд, в течение которого узел или служба должны ответить на запрос монитора. Если целевой объект отвечает в течение заданного периода времени, он считается активным. Если целевой объект не отвечает в течение заданного периода времени, он считается неактивным. Вы можете изменить это число на любое, но оно должно быть в 3 раза больше интервала в секундах плюс 1 секунда. Если этот параметр не указан при создании нового монитора, значение по умолчанию будет `16`.
transparent boolean		Варианты: no yes	Указывает, работает ли монитор в прозрачном режиме. Мониторы в прозрачном режиме могут отслеживать членов пула через брандмауэры. При создании нового монитора, если этот параметр не указан, значение по умолчанию будет `no`.
up_interval integer			Указывает интервал, используемый системой для проверки состояния ресурса, когда ресурс активен. Если `0`, указывает, что система использует интервал, указанный в `interval` для проверки состояния ресурса. При любом другом числе, позволяет указать другой интервал для проверки состояния ресурса, который активен. Если этот параметр не указан при создании нового монитора, будет использовано значение по умолчанию `0`.

Примечания

Примечание

Дополнительную информацию об использовании Ansible для управления устройствами F5 Networks см. на https://www.ansible.com/integrations/networks/f5.
Требуется версия ПО BIG-IP ≥ 12.
Модули F5 изменяют только рабочую конфигурацию продукта F5. Чтобы гарантировать, что конфигурация, специфичная для BIG-IP, сохранится на диске, убедитесь, что вы включили хотя бы одну задачу, использующую модуль 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 строка	изменён	Требуемый код ответа (RCODE) для статуса «включено». Пример: no-error
adaptive логическое	изменён	Включён ли адаптивный режим. Пример: True
adaptive_limit целое число	изменён	Максимальное количество миллисекунд, которое не должно превышать запрос монитора. Пример: 200
allowed_divergence_type строка	изменён	Тип расхождения, используемый для мониторинга адаптивного времени отклика. Пример: absolute
allowed_divergence_value целое число	изменён	Значение типа расхождения, используемого для мониторинга адаптивного времени отклика. Может быть `percent` или `ms` в зависимости от того, используется ли `relative` или `absolute`. Пример: 25
answer_section_contains строка	изменён	Тип DNS запроса, который отправляет монитор. Пример: query-type
description строка	изменён	Описание монитора. Пример: Важный монитор
interval целое число	изменён	Новый интервал для выполнения проверки монитора. Пример: 2
ip строка	изменён	Новый IP адрес для определения IP/порт. Пример: 10.12.13.14
manual_resume строка	изменён	Автоматически ли система изменяет статус ресурса на «включено» при следующей успешной проверке монитора. Пример: query-type
parent строка	изменён	Новая родительская шаблон монитора. Пример: http
port строка	изменён	Псевдоним порта или службы, которую монитор проверяет от имени пулов или членов пулов, к которым относится монитор. Пример: 80
query_name строка	изменён	Имя запроса, используемого монитором в запросе DNS. Пример: foo
query_type строка	изменён	Тип DNS запроса, который отправляет монитор. Либо `a` либо `aaaa`. Пример: aaaa
receive строка	изменён	IP адрес, используемый монитором из секций записей ресурсов ответа DNS. Пример: 2.3.2.4
reverse логическое	изменён	Работает ли монитор в обратном режиме. Пример: True
sampling_timespan целое число	изменён	Абсолютное число миллисекунд, которое не должно превышать запрос монитора. Пример: 200
time_until_up целое число	изменён	Новое время для маркировки системы как «включено» после первого успешного ответа. Пример: 2
timeout целое число	изменён	Новый таймаут, в течение которого удалённая система должна ответить на запрос монитора. Пример: 10
transparent логическое	изменён	Работает ли монитор в прозрачном режиме.
up_interval целое число	изменён	Интервал, используемый системой для проверки работоспособности, когда ресурс активен.

Статус

Этот модуль не гарантирует обратную совместимость интерфейса. [превью]
Этот модуль поддерживается партнёром Ansible. [сертифицирован]

Авторы

Tim Rupp (@caphrim007)
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.9/modules/bigip_monitor_dns_module.html