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 булево		Варианты: нет да	Указывает, включено ли адаптивное мониторинг времени отклика для этого монитора. При значении `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` процентов.
answer_section_contains строка		Варианты: любой-тип любое тип-запроса	Указывает тип DNS-запроса, который отправляет монитор. При создании нового монитора, если это значение не указано, используется значение по умолчанию `query-type`. При значении `query-type`, указывает, что ответ должен содержать как минимум один ответ, тип ресурса записи которого соответствует типу запроса. При значении `any-type`, указывает, что DNS-сообщение должно содержать как минимум один ответ. При значении `anything`, указывает, что пустой ответ достаточно для того, чтобы отметить статус узла как "включено".
description строка			Описание монитора.
interval целое число			Интервал, определяющий, как часто экземпляр монитора этой шаблона будет выполняться. Это значение должно быть меньше значения `timeout`. При создании нового монитора, если этот параметр не указан, используется значение по умолчанию `5`.
ip строка			Часть IP-адреса в определении IP/порт. Если этот параметр не указан при создании нового монитора, используется значение по умолчанию `*`.
manual_resume булево		Варианты: нет да	Указывает, автоматически ли система изменяет статус ресурса на включено при следующем успешном проверочном тесте монитора. Если вы установите этот параметр в `yes`, вы должны вручную повторно включить ресурс, прежде чем система сможет использовать его для балансировки нагрузки подключений. При создании нового монитора, если этот параметр не указан, значение по умолчанию `no`. При значении `yes`, указывает, что вы должны вручную повторно включить ресурс после неудачного проверочного теста монитора. При значении `no`, указывает, что система автоматически изменяет статус ресурса на включено при следующем успешном проверочном тесте монитора.
name - / обязательно			Указывает имя монитора.
parent строка		Значение по умолчанию: "/Common/dns"	Родительский шаблон этого шаблона монитора. После установки этого значения его нельзя изменить. По умолчанию это родительский элемент `dns` на раздела `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`.
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		Варианты: нет да	Указывает, работает ли монитор в обратном режиме. Когда монитор работает в обратном режиме, успешное соответствие строки receive помечает контролируемый объект как недоступный, а не как доступный. Вы можете использовать этот режим только если настроили параметр `receive`. Этот параметр несовместим с параметром `time_until_up`. Если `time_until_up` указан, он должен быть `0`. Или, если он уже существует, он должен быть `0`.
sampling_timespan integer			Указывает длину, в секундах, окна истории зондирования, используемого системой для расчета среднего значения задержки и стандартного отклонения зондирования монитора. Хотя это значение может быть настроено, когда `adaptive` равно `no`, оно не будет применяться к системе до тех пор, пока `adaptive` не станет `yes`.
server string / обязательно			Хост BIG-IP. Вы можете опустить этот параметр, установив переменную окружения `F5_SERVER`.
server_port integer добавлен в 2.2		По умолчанию: 443	Порт сервера BIG-IP. Вы можете опустить этот параметр, установив переменную окружения `F5_SERVER_PORT`.
state string		Варианты: present ← absent	Когда `present`, гарантирует, что монитор существует. Когда `absent`, гарантирует удаление монитора.
time_until_up integer			Указывает время в секундах после первого успешного ответа, прежде чем узел будет помечен как активный. Значение 0 приведет к тому, что узел будет помечен как активный сразу после получения действительного ответа от узла. Если этот параметр не указан при создании нового монитора, значение по умолчанию будет `0`.
timeout integer			Количество секунд, в течение которых узел или служба должны ответить на запрос монитора. Если целевой объект отвечает в течение заданного времени, он считается активным. Если целевой объект не отвечает в течение заданного времени, он считается неактивным. Вы можете изменить это число на любое нужное, однако оно должно быть в 3 раза больше числа секунд интервала плюс 1 секунда. Если этот параметр не указан при создании нового монитора, значение по умолчанию будет `16`.
transparent boolean		Варианты: нет да	Указывает, работает ли монитор в прозрачном режиме. Мониторы в прозрачном режиме могут контролировать членов пула через брандмауэры. При создании нового монитора, если этот параметр не указан, значение по умолчанию будет `no`.
up_interval integer			Указывает интервал, используемый системой для проверки состояния, когда ресурс активен. Когда `0`, указывает, что система использует интервал, указанный в `interval`, для проверки состояния ресурса. Любое другое число позволяет указать другой интервал для проверки состояния ресурса, когда он активен. При создании нового монитора, если этот параметр не указан, будет использовано значение по умолчанию `0`.
user string / обязательно			Имя пользователя для подключения к BIG-IP. Этот пользователь должен иметь административные привилегии на устройстве. Вы можете опустить этот параметр, установив переменную окружения `F5_USER`.
validate_certs boolean добавлен в 2.0		Варианты: нет да ←	Если `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 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.8/modules/bigip_monitor_dns_module.html