Spec-Zone.ru › Ansible

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

Примечание

Этот модуль входит в коллекцию f5networks.f5_modules (версия 1.31.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 / required

Указывает имя монитора.

parent

string

Родительский шаблон этого шаблона монитора. После установки это значение изменить нельзя. По умолчанию это значение — родительский dns в разделе Common.

По умолчанию: "/Common/dns"

partition

string

Раздел устройства для управления ресурсами.

По умолчанию: "Common"

port

string

Номер порта в определении IP/порт.

Если этот параметр не указан при создании нового монитора, значение по умолчанию будет *.

Обратите внимание, что при указании IP-адреса необходимо использовать значение от 1 до 65535.

provider

словарь

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

Объект словаря, содержащий детали подключения.

auth_provider

строка

Настраивает поставщика авторизации для получения маркеров аутентификации от удаленного устройства.

Этот параметр действительно используется при работе с устройствами BIG-IQ.

no_f5_teem

логический тип

Если yes, данные телеметрии TEEM не отправляются на F5.

Вы можете опустить этот параметр, установив переменную среды F5_TELEMETRY_OFF.

Ранее используемая переменная F5_TEEM устарела, так как ее название вызывало путаницу.

Варианты:

  • false ← (по умолчанию)
  • true

password

псевдонимы: pass, pwd

строка / обязательный

Пароль учетной записи пользователя, используемой для подключения к BIG-IP или BIG-IQ.

Вы можете опустить этот параметр, установив переменную среды F5_PASSWORD.

server

строка / обязательный

Хост BIG-IP или хост BIG-IQ.

Вы можете опустить этот параметр, установив переменную среды F5_SERVER.

server_port

целое число

Порт сервера BIG-IP.

Вы можете опустить этот параметр, установив переменную среды F5_SERVER_PORT.

По умолчанию: 443

timeout

целое число

Указывает тайм-аут в секундах для связи с сетевым устройством при подключении или отправке команд. Если тайм-аут истечет до завершения операции, модуль вернёт ошибку.

transport

строка

Настраивает транспортное соединение для подключения к удалённому устройству.

Варианты:

  • "rest" ← (по умолчанию)

user

строка / обязательный

Имя пользователя для подключения к BIG-IP или BIG-IQ. Этот пользователь должен иметь административные привилегии на устройстве.

Вы можете опустить этот параметр, установив переменную среды F5_USER.

validate_certs

логический тип

Если no, сертификаты SSL не проверяются. Используйте это только на контролируемых вами сайтах, использующих самозаверяющие сертификаты.

Вы можете опустить этот параметр, установив переменную среды F5_VALIDATE_CERTS.

Варианты:

  • false
  • true ← (по умолчанию)

query_name

строка

Указывает имя запроса, которое монитор должен использовать в запросе DNS.

query_type

строка

Указывает тип запроса DNS, который отправляет монитор.

При создании нового монитора, если этот параметр не указан, значение по умолчанию - a.

Когда a, указывает, что монитор отправит запрос DNS типа A.

Когда aaaa, указывает, что монитор отправит запрос DNS типа AAAA.

Варианты:

  • "a"
  • "aaaa"

receive

строка

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

IP-адрес должен быть указан в формате точечной нотации или формате IPv6.

reverse

логический тип

Указывает, работает ли монитор в обратном режиме.

Когда монитор работает в обратном режиме, успешное совпадение строки приёма отмечает контролируемый объект как неработоспособный, а не работоспособный. Вы можете использовать этот режим только в случае настройки параметра receive.

Этот параметр несовместим с параметром time_until_up . Если time_until_up указан, он должен быть 0. Или, если он уже существует, он должен быть 0.

Варианты:

  • false
  • true

sampling_timespan

целое число

Указывает длительность, в секундах, окна истории зондирования, которое система использует для расчета среднего значения задержки и стандартного отклонения зонда монитора.

Хотя это значение можно настроить, когда adaptive равно false, оно не вступит в силу в системе, пока adaptive не будет равно true.

state

строка

Если present, гарантирует существование монитора.

Если absent, гарантирует удаление монитора.

Варианты:

  • "present" ← (по умолчанию)
  • "absent"
END_OF_DOCUMENT_MARKER

time_until_up

целое число

Указывает время в секундах после первого успешного ответа, прежде чем узел будет помечен как активный.

Значение 0 приведет к тому, что узел будет помечен как активный сразу после получения валидного ответа от узла.

Если этот параметр не указан при создании нового монитора, будет использовано значение по умолчанию 0.

timeout

целое число

Количество секунд, в течение которого узел или служба должны ответить на запрос монитора.

Если целевой объект отвечает в установленный период времени, он считается активным.

Если целевой объект не отвечает в установленный период времени, он считается неактивным.

Вы можете изменить это значение на любое число, однако оно должно быть в 3 раза больше значения параметра interval плюс 1 секунда.

Если этот параметр не указан при создании нового монитора, значение по умолчанию 16.

transparent

булево

Указывает, работает ли монитор в прозрачном режиме.

Мониторы в прозрачном режиме могут контролировать члены пула через брандмауэры.

При создании нового монитора, если этот параметр не указан, значение по умолчанию false.

Варианты:

  • false
  • true

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: false
    state: present
    provider:
      user: admin
      password: secret
      server: lb.mydomain.com
  delegate_to: localhost

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

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

Ключ

Описание

accept_rcode

string

RCODE, необходимый в ответе для статуса "включен".

Возвращается: changed

Пример: "no-error"

adaptive

boolean

Включена ли адаптивная функция или нет.

Возвращается: changed

Пример: true

adaptive_limit

integer

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

Возвращается: changed

Пример: 200

allowed_divergence_type

string

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

Возвращается: changed

Пример: "absolute"

allowed_divergence_value

integer

Значение типа расхождения, используемого для адаптивного мониторинга времени отклика.

Может быть percent или ms в зависимости от того, relative или absolute.

Возвращается: changed

Пример: 25

answer_section_contains

string

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

Возвращается: changed

Пример: "query-type"

description

string

Описание монитора.

Возвращается: changed

Пример: "Important Monitor"

interval

integer

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

Возвращается: changed

Пример: 2

ip

string

Новый IP-адрес определения IP/порт.

Возвращается: changed

Пример: "10.12.13.14"

manual_resume

string

Автоматически ли система изменяет статус ресурса на "включен" при следующей успешной проверке монитора.

Возвращается: changed

Пример: "query-type"

parent

string

Новый родительский шаблон монитора.

Возвращается: changed

Пример: "http"

port

string

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

Возвращается: changed

Пример: "80"

query_name

string

Имя запроса, которое монитор использует в DNS-запросе.

Возвращается: changed

Пример: "foo"

query_type

string

Тип DNS-запроса, который отправляет монитор. Либо a либо aaaa.

Возвращается: changed

Пример: "aaaa"

receive

string

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

Возвращается: changed

Пример: "2.3.2.4"

reverse

boolean

Работает ли монитор в обратном режиме.

Возвращается: changed

Пример: true

sampling_timespan

целое число

Абсолютное число миллисекунд, которое не должно превышаться зондом монитора.

Возвращено: изменённо

Пример: 200

time_until_up

целое число

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

Возвращено: изменённо

Пример: 2

timeout

целое число

Новый тайм-аут, в течение которого удалённая система должна ответить на запрос монитора.

Возвращено: изменённо

Пример: 10

transparent

логическое

Включить ли режим прозрачности для монитора.

Возвращено: изменённо

Пример: false

up_interval

целое число

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

Возвращено: изменённо

Пример: 0

Авторы

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

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

  • Система отслеживания ошибок
  • Главная страница
  • Репозиторий (исходный код)

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

Spec-Zone.ru

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