Модуль f5networks.f5_modules.bigip_monitor_dns — управление DNS-мониторами на BIG-IP

Примечание

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

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

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

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

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

Краткое описание
Параметры
Примечания
Примеры
Возвращаемые значения

Краткое описание

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

Параметры

Параметр	Комментарии
accept_rcode string	Указывает RCODE, который должен содержаться в ответе, чтобы статус считался активным. При создании нового монитора, если этот параметр не указан, используется значение по умолчанию `no-error`. Если задано `no-error`, статус узла отмечается как активный, если полученное DNS-сообщение не содержит ошибок. Если задано `anything`, статус узла отмечается как активный независимо от RCODE в полученном DNS-сообщении. Если для этого параметра задано `anything`, строка `receive` игнорируется и обнуляется при обновлении монитора. Варианты: `"no-error"` `"anything"`
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` процентов.
answer_section_contains string	Указывает тип DNS-запроса, отправляемого монитором. При создании нового монитора, если это значение не указано, используется значение по умолчанию `query-type`. Если задано `query-type`, указывает, что ответ должен содержать хотя бы одну запись, тип ресурса которой соответствует типу запроса. Если задано `any-type`, указывает, что DNS-сообщение должно содержать хотя бы один ответ. Если задано `anything`, для отметки узла как активного достаточно пустого ответа. Варианты: `"any-type"` `"anything"` `"query-type"`
description string	Описание монитора.
interval integer	Интервал, определяющий частоту запуска экземпляра монитора на основе этого шаблона. Это значение должно быть меньше значения `timeout`. При создании нового монитора, если этот параметр не указан, используется значение по умолчанию `5`.
ip string	IP-адрес в определении IP-адреса и порта. Если при создании нового монитора этот параметр не указан, по умолчанию используется значение `*`.
manual_resume boolean	Указывает, изменяет ли система автоматически статус ресурса на включён при следующей успешной проверке монитора. Если задано `true`, необходимо вручную повторно включить ресурс, прежде чем система сможет использовать его для балансировки нагрузки подключений. При создании нового монитора, если этот параметр не указан, по умолчанию используется значение `false`. Если задано `true`, необходимо вручную повторно включить ресурс после неудачной проверки монитора. Если задано `false`, система автоматически изменяет статус ресурса на включён при следующей успешной проверке монитора. Варианты: `false` `true`
name string / обязательный	Указывает имя монитора.
parent string	Родительский шаблон этого шаблона монитора. После установки это значение нельзя изменить. По умолчанию используется родительский шаблон `dns` в разделе `Common`. По умолчанию: `"/Common/dns"`
partition string	Раздел устройства для управления ресурсами. По умолчанию: `"Common"`
port string	Порт в определении IP-адреса и порта. Если при создании нового монитора этот параметр не указан, по умолчанию используется значение `*`. Обратите внимание: если указан IP-адрес, необходимо использовать значение от 1 до 65535.
provider dictionary добавлено в f5networks.f5_modules 1.0.0	Словарь с параметрами подключения.
auth_provider string	Настраивает поставщика аутентификации для получения токенов аутентификации с удалённого устройства. Этот параметр используется главным образом при работе с устройствами BIG-IQ.
no_f5_teem boolean	Если задано `yes`, телеметрические данные TEEM не отправляются в F5. Этот параметр можно не указывать, задав переменную среды `F5_TELEMETRY_OFF`. Ранее использовавшаяся переменная `F5_TEEM` объявлена устаревшей, поскольку её имя было неоднозначным. Варианты: `false` ← (по умолчанию) `true`
password псевдонимы: pass, pwd string / обязательный	Пароль учётной записи пользователя, используемой для подключения к BIG-IP или BIG-IQ. Этот параметр можно не указывать, задав переменную среды `F5_PASSWORD`.
server string / обязательный	Узел BIG-IP или BIG-IQ. Этот параметр можно не указывать, задав переменную среды `F5_SERVER`.
server_port integer	Порт сервера BIG-IP. Этот параметр можно не указывать, задав переменную среды `F5_SERVER_PORT`. По умолчанию: `443`
timeout integer	Задаёт время ожидания в секундах при взаимодействии с сетевым устройством — для подключения или отправки команд. Если время ожидания истечёт до завершения операции, модуль завершится с ошибкой.
transport string	Настраивает транспортное соединение, используемое для подключения к удалённому устройству. Варианты: `"rest"` ← (по умолчанию)
user string / обязательный	Имя пользователя для подключения к BIG-IP или BIG-IQ. Этот пользователь должен иметь права администратора на устройстве. Этот параметр можно не указывать, задав переменную среды `F5_USER`.
validate_certs boolean	Если задано `no`, сертификаты SSL не проверяются. Используйте этот параметр только на контролируемых вами сайтах с самоподписанными сертификатами. Этот параметр можно не указывать, задав переменную среды `F5_VALIDATE_CERTS`. Варианты: `false` `true` ← (по умолчанию)
query_name string	Указывает имя запроса, которое монитор использует в DNS-запросе.
query_type string	Указывает тип DNS-запроса, отправляемого монитором. При создании нового монитора, если этот параметр не указан, используется значение по умолчанию `a`. Если задано `a`, монитор отправляет DNS-запрос типа A. Если задано `aaaa`, монитор отправляет DNS-запрос типа AAAA. Варианты: `"a"` `"aaaa"`
receive string	Указывает IP-адрес, который монитор использует из разделов записей ресурсов DNS-ответа. IP-адрес следует указывать в десятичной точечной нотации или нотации IPv6.
reverse boolean	Указывает, работает ли монитор в обратном режиме. В обратном режиме успешное совпадение строки ответа отмечает проверяемый объект как недоступный, а не как доступный. Этот режим можно использовать только при настройке параметра `receive`. Этот параметр несовместим с параметром `time_until_up`. Если задано `time_until_up`, оно должно иметь значение `0`. Если параметр уже существует, он должен иметь значение `0`. Варианты: `false` `true`
sampling_timespan integer	Указывает продолжительность окна истории проб в секундах, которое система использует для расчёта средней задержки и стандартного отклонения пробы монитора. Это значение можно настроить, когда `adaptive` имеет значение `false`, однако оно вступит в силу в системе только при значении `adaptive`, равном `true`.
state string	Если задано `present`, обеспечивает наличие монитора. Если задано `absent`, обеспечивает удаление монитора. Варианты: `"present"` ← (по умолчанию) `"absent"`
time_until_up integer	Указывает время в секундах после первого успешного ответа, по истечении которого узел будет отмечен как активный. Значение 0 означает, что узел будет отмечен как активный сразу после получения корректного ответа от узла. Если при создании нового монитора этот параметр не указан, по умолчанию используется значение `0`.
timeout integer	Количество секунд, в течение которых узел или служба должны ответить на запрос монитора. Если целевой объект отвечает в течение заданного периода, он считается доступным. Если целевой объект не отвечает в течение заданного периода, он считается недоступным. Можно задать любое значение, однако оно должно быть равно трём интервалам в секундах плюс одной секунде. Если при создании нового монитора этот параметр не указан, по умолчанию используется значение `16`.
transparent boolean	Указывает, работает ли монитор в прозрачном режиме. Мониторы в прозрачном режиме могут проверять участников пула через межсетевые экраны. При создании нового монитора, если этот параметр не указан, по умолчанию используется значение `false`. Варианты: `false` `true`
up_interval integer	Указывает интервал, который система использует для проверки работоспособности активного ресурса. Если задано `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: false
    state: present
    provider:
      user: admin
      password: secret
      server: lb.mydomain.com
  delegate_to: localhost

Возвращаемые значения

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

Ключ	Описание
accept_rcode string	RCODE, требуемый в ответе для состояния «работает». Возвращается: при изменении Пример: `"no-error"`
adaptive boolean	Включен ли адаптивный режим. Возвращается: при изменении Пример: `true`
adaptive_limit integer	Абсолютное количество миллисекунд, которое не должен превышать пробный запрос монитора. Возвращается: при изменении Пример: `200`
allowed_divergence_type string	Тип отклонения, используемый для адаптивного мониторинга времени отклика. Возвращается: при изменении Пример: `"absolute"`
allowed_divergence_value integer	Значение типа отклонения, используемого для адаптивного мониторинга времени отклика. Может быть `percent` или `ms` в зависимости от того, является ли значение `relative` или `absolute`. Возвращается: при изменении Пример: `25`
answer_section_contains string	Тип DNS-запроса, отправляемого монитором. Возвращается: при изменении Пример: `"query-type"`
description string	Описание монитора. Возвращается: при изменении Пример: `"Important Monitor"`
interval integer	Новый интервал запуска проверки монитором. Возвращается: при изменении Пример: `2`
ip string	Новый IP-адрес в определении IP/порта. Возвращается: при изменении Пример: `"10.12.13.14"`
manual_resume string	Определяет, будет ли система автоматически менять статус ресурса на «включен» после следующей успешной проверки монитором. Возвращается: при изменении Пример: `"query-type"`
parent string	Новый родительский шаблон монитора. Возвращается: при изменении Пример: `"http"`
port string	Псевдоним порта или службы, которые монитор проверяет для связанных с ним пулов или участников пулов. Возвращается: при изменении Пример: `"80"`
query_name string	Имя запроса, которое монитор использует в DNS-запросе. Возвращается: при изменении Пример: `"foo"`
query_type string	Тип DNS-запроса, отправляемого монитором. Это может быть `a` или `aaaa`. Возвращается: при изменении Пример: `"aaaa"`
receive string	IP-адрес, который монитор использует из разделов записей ресурсов DNS-ответа. Возвращается: при изменении Пример: `"2.3.2.4"`
reverse boolean	Работает ли монитор в обратном режиме. Возвращается: при изменении Пример: `true`
sampling_timespan integer	Абсолютное количество миллисекунд, которое не должен превышать пробный запрос монитора. Возвращается: при изменении Пример: `200`
time_until_up integer	Новое время, по истечении которого система помечается как работающая после первого успешного ответа. Возвращается: при изменении Пример: `2`
timeout integer	Новый период ожидания ответа удаленной системы на запрос монитора. Возвращается: при изменении Пример: `10`
transparent boolean	Работает ли монитор в прозрачном режиме. Возвращается: при изменении Пример: `false`
up_interval integer	Интервал, используемый системой для проверки работоспособности ресурса, когда он доступен. Возвращается: при изменении Пример: `0`

Авторы

Tim Rupp (@caphrim007)
Wojciech Wypior (@wojtek0806)

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

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