f5networks.f5_modules.bigip_monitor_dns – Управление мониторами DNS на BIG-IP
Примечание
Этот плагин входит в коллекцию f5networks.f5_modules (версия 1.6.0).
Для его установки используйте: ansible-galaxy collection install f5networks.f5_modules.
Для использования в плейбуке укажите: f5networks.f5_modules.bigip_monitor_dns.
Введено в версии 1.0.0: модуля f5networks.f5_modules
Обзор
- Управление мониторами работоспособности DNS на BIG-IP.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| accept_rcode строка |
| Указывает требуемый код ответа (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" | Раздел устройства для управления ресурсами. | |
| port строка | Часть адреса порта в определении IP/порт. Если этот параметр не указан при создании нового монитора, значение по умолчанию будет *.Обратите внимание, что если вы указываете IP-адрес, вы должны использовать значение от 1 до 65535. | ||
| provider словарь добавлено в 1.0.0 f5networks.f5_modules | Объект словаря, содержащий сведения о подключении. | ||
| auth_provider строка | Настраивает поставщика аутентификации для получения маркеров аутентификации от удалённого устройства. Этот параметр действительно используется при работе с устройствами BIG-IQ. | ||
| no_f5_teem булево |
| Если yes, данные телеметрии TEEM не отправляются в F5.Вы можете опустить этот параметр, установив переменную среды F5_TEEM. | |
| password строка / обязательно | Пароль для учетной записи пользователя, используемой для подключения к BIG-IP. Вы можете опустить этот параметр, установив переменную среды F5_PASSWORD.Псевдонимы: pass, pwd | ||
| server строка / обязательно | Хост BIG-IP. Вы можете опустить этот параметр, установив переменную среды F5_SERVER. | ||
| server_port целое число | По умолчанию: 443 | Порт сервера BIG-IP. Вы можете опустить этот параметр, установив переменную среды F5_SERVER_PORT. | |
| timeout целое число | Указывает таймаут в секундах для связи с сетевым устройством для подключения или отправки команд. Если таймаут истечёт до завершения операции, модуль выдаст ошибку. | ||
| transport строка |
| Настраивает транспортное соединение, используемое при подключении к удалённому устройству. | |
| user строка / обязательно | Имя пользователя для подключения к BIG-IP. Этот пользователь должен иметь административные привилегии на устройстве. Вы можете опустить этот параметр, установив переменную среды F5_USER. | ||
| validate_certs булево |
| Если no, сертификаты SSL не проверяются. Используйте это только на лично контролируемых сайтах, использующих самозаверенные сертификаты.Вы можете опустить этот параметр, установив переменную среды F5_VALIDATE_CERTS. | |
| query_name строка | Указывает имя запроса, используемое монитором в запросе DNS. | ||
| query_type строка |
| Указывает тип запроса DNS, отправляемого монитором. При создании нового монитора, если этот параметр не указан, значение по умолчанию a.При a, монитор отправит запрос DNS типа A.При aaaa, монитор отправит запрос DNS типа AAAA. | |
| receive строка | Указывает IP-адрес, используемый монитором из разделов записей ресурсов ответа DNS. IP-адрес должен быть указан в точечной десятичной нотации или в нотации IPv6. | ||
| обратный boolean |
| Указывает, работает ли монитор в обратном режиме. Когда монитор находится в обратном режиме, успешное совпадение строки приёма помечает отслеживаемый объект как выключенный, а не включенный. Вы можете использовать этот режим только в том случае, если настроить параметр receive. Этот параметр несовместим с параметром time_until_up. Если указан time_until_up, он должен быть 0. В противном случае, если он уже существует, он должен быть 0. | |
| sampling_timespan integer | Указывает длительность, в секундах, окна истории зондирования, используемого системой для расчёта среднего значения задержки и стандартного отклонения зонда монитора. Хотя это значение можно настроить, когда adaptive равно no, оно не будет применяться к системе до тех пор, пока adaptive не будет равно yes. | ||
| состояние string |
| Если present, гарантирует, что монитор существует.Если absent, гарантирует, что монитор удалён. | |
| time_until_up integer | Указывает количество секунд после первого успешного ответа, прежде чем узел будет помечен как включённый. Значение 0 заставит узел быть помеченным как включённый сразу после получения от узла действительного ответа. Если этот параметр не указан при создании нового монитора, значение по умолчанию будет 0. | ||
| timeout integer | Количество секунд, в течение которого узел или служба должны ответить на запрос монитора. Если целевой объект отвечает в заданный период времени, он считается включённым. Если целевой объект не отвечает в заданный период времени, он считается выключенным. Вы можете изменить это на любое число, однако оно должно быть в 3 раза больше значения интервала в секундах плюс 1 секунда. Если этот параметр не указан при создании нового монитора, значение по умолчанию будет 16. | ||
| прозрачный boolean |
| Указывает, работает ли монитор в прозрачном режиме. Мониторы в прозрачном режиме могут отслеживать членов пула через брандмауэры. При создании нового монитора, если этот параметр не указан, значение по умолчанию будет no. | |
| 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: no
state: present
provider:
user: admin
password: secret
server: lb.mydomain.com
delegate_to: localhost
Значения возврата
Общие значения возврата описаны в данном месте, следующие поля уникальны для данного модуля:
| Ключ | Возвращаемое | Описание |
|---|---|---|
| accept_rcode string | изменено | RCODE, необходимый в ответе для статуса включён. Пример: no-error |
| адаптивный boolean | изменено | Включён ли адаптивный режим или нет. Пример: True |
| адаптивный_предел integer | изменено | Абсолютное число миллисекунд, которое не должно превышаться зондом монитора. Пример: 200 |
| разрешенный_тип_отклонения string | изменено | Тип отклонения, используемый для адаптивного мониторинга времени ответа. Пример: абсолютный |
| разрешенное_значение_отклонения integer | изменено | Значение типа отклонения, используемого для адаптивного мониторинга времени ответа. Может быть percent или ms в зависимости от того, используется ли relative или absolute.Пример: 25 |
| раздел_ответа_содержит string | изменено | Тип DNS-запроса, отправляемого монитором. Пример: тип-запроса |
| описание string | изменено | Описание монитора. Пример: Важный монитор |
| интервал integer | изменено | Новый интервал для выполнения проверки монитора. Пример: 2 |
| ip string | изменено | Новый IP-адрес определения IP/порта. Пример: 10.12.13.14 |
| ручное_возобновление string | изменено | Автоматически ли система изменяет статус ресурса на включённый при следующей успешной проверке монитора. Пример: тип-запроса |
| родитель string | изменено | Новая родительская шаблон монитора. Пример: http |
| порт string | изменено | Псевдоним порта или службы для монитора, проверяющего пулы или членов пулов, с которыми ассоциирован монитор. Пример: 80 |
| имя_запроса string | изменено | Имя запроса для использования монитором в DNS-запросе. Пример: foo |
| тип_запроса string | изменено | Тип DNS-запроса, отправляемый монитором. Либо a или aaaa.Пример: aaaa |
| приём string | изменено | IP-адрес, используемый монитором из разделов записей ресурсов DNS-ответа. Пример: 2.3.2.4 |
| обратный boolean | изменено | Работает ли монитор в обратном режиме. Пример: True |
| sampling_timespan integer | изменено | Абсолютное число миллисекунд, которое не должно превышаться зондом монитора. Пример: 200 |
| time_until_up integer | изменено | Новое время для пометки системы как включённой после первого успешного ответа. Пример: 2 |
| timeout integer | изменено | Новый таймаут, в течение которого удалённая система должна ответить на монитор. Пример: 10 |
| прозрачный boolean | изменено | Работает ли монитор в прозрачном режиме. |
| up_interval integer | изменено | Интервал, используемый системой для выполнения проверки работоспособности, когда ресурс включён. |
Авторы
- 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.10/collections/f5networks/f5_modules/bigip_monitor_dns_module.html
