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

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

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

Обзор

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

Требования

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

f5-sdk >= 3.0.16

Параметры

Параметр		Варианты/Значения по умолчанию	Комментарии
accept_rcode -		Варианты: no-error anything	Указывает код RCODE, необходимый в ответе для установления статуса «включено». При создании нового монитора, если этот параметр не указан, значение по умолчанию равно `no-error`. Если значение `no-error`, указывает, что статус узла будет помечен как «включено», если полученное сообщение DNS не содержит ошибки. Если значение `anything`, указывает, что статус узла будет помечен как «включено» независимо от кода RCODE в полученном сообщении DNS. Если этот параметр установлен на `anything`, он проигнорирует строку `receive`, и обнулит её, если монитор обновляется.
adaptive boolean		Варианты: 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 boolean		Варианты: no yes	Указывает, автоматически ли система меняет статус ресурса на включено при следующем успешном проверочном ходе монитора. Если вы установите этот параметр в `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		Значение по умолчанию: null	Объект dict, содержащий данные подключения.
	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 - / обязательно	Варианты: rest cli ←	Настраивает транспортное соединение, используемое при подключении к удаленному устройству.
	user - / обязательно		Имя пользователя для подключения к BIG-IP. Этот пользователь должен иметь административные привилегии на устройстве. Этот параметр можно опустить, установив переменную окружения `F5_USER`.

	validate_certs boolean	Выборы: no да ←	Если `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.
reverse boolean		Выборы: no yes	Указывает, работает ли монитор в обратном режиме. Когда монитор работает в обратном режиме, совпадение успешного ответа отмечает контролируемый объект как неактивный, а не активный. Вы можете использовать этот режим только в том случае, если вы настроите опцию `receive`. Этот параметр несовместим с параметром `time_until_up` . Если `time_until_up` указан, он должен быть `0`. Или, если он уже существует, он должен быть `0`.
sampling_timespan -			Указывает длительность, в секундах, окна истории зондирования, которое система использует для расчета средней задержки и стандартного отклонения зондирования монитора. Хотя это значение можно настроить, когда `adaptive` равно `no`, оно не будет действовать на системе, пока `adaptive` не будет `yes`.
server - / обязательно			Хост BIG-IP. Вы можете опустить этот параметр, установив переменную среды `F5_SERVER`.
server_port - добавлен в 2.2		По умолчанию: 443	Порт сервера BIG-IP. Вы можете опустить этот параметр, установив переменную среды `F5_SERVER_PORT`.
state -		Выборы: present ← absent	Когда `present`, гарантирует, что монитор существует. Когда `absent`, гарантирует удаление монитора.
time_until_up -			Указывает количество времени в секундах после первого успешного ответа, прежде чем узел будет помечен как активный. Значение 0 приведет к тому, что узел будет помечен как активный сразу после получения действительного ответа от узла. Если этот параметр не указан при создании нового монитора, значение по умолчанию будет `0`.
timeout -			Количество секунд, в течение которого узел или служба должны ответить на запрос монитора. Если целевой объект отвечает в установленный период времени, он считается активным. Если целевой объект не отвечает в установленный период времени, он считается неактивным. Вы можете изменить это число на любое желаемое значение, но оно должно быть в 3 раза больше числа интервалов в секундах плюс 1 секунда. Если этот параметр не указан при создании нового монитора, значение по умолчанию будет `16`.
transparent boolean		Выборы: no yes	Указывает, работает ли монитор в прозрачном режиме. Мониторы в прозрачном режиме могут контролировать членов пула через брандмауэры. При создании нового монитора, если этот параметр не указан, значение по умолчанию будет `no`.
up_interval -			Указывает интервал, используемый системой для проверки состояния при активации ресурса. Если `0`, указывает, что система использует интервал, указанный в `interval`, для проверки состояния ресурса. При любом другом значении разрешает указание другого интервала для проверки состояния активного ресурса. При создании нового монитора, если этот параметр не указан, используется значение по умолчанию `0`.
user - / обязательно			Имя пользователя для подключения к BIG-IP. Этот пользователь должен иметь административные привилегии на устройстве. Вы можете опустить этот параметр, установив переменную среды `F5_USER`.
validate_certs boolean добавлен в 2.0		Выборы: no да ←	Если `no`, сертификаты SSL не проверяются. Используйте это только на сайтах, находящихся под вашим контролем, использующих самоподписанные сертификаты. Вы можете опустить этот параметр, установив переменную среды `F5_VALIDATE_CERTS`.

Примечания

Примечание

Дополнительную информацию об использовании Ansible для управления устройствами F5 Networks см. на сайте https://www.ansible.com/integrations/networks/f5.
Требуется пакет f5-sdk Python на хосте. Это так же просто, как pip install f5-sdk.
Требуется версия ПО 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
    password: secret
    server: lb.mydomain.com
    state: present
    user: admin
  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.7/modules/bigip_monitor_dns_module.html