f5networks.f5_modules.bigip_gtm_monitor_external – Управляет внешними мониторами GTM на BIG-IP

Примечание

Этот плагин является частью коллекции f5networks.f5_modules (версия 1.7.1).

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

Для использования в плейбуке укажите: f5networks.f5_modules.bigip_gtm_monitor_external.

Новый в версии 1.0.0: of f5networks.f5_modules

Описание
Параметры
Примечания
Примеры
Значения возврата

Описание

Управляет внешними мониторами GTM (сейчас BIG-IP DNS) на BIG-IP.

Параметры

Параметр		Варианты/Значения по умолчанию	Комментарии
arguments строка			Указывает любые аргументы командной строки, необходимые скрипту.
external_program строка			Указывает имя файла для использования монитором. Для ссылки на файл необходимо сначала импортировать его, используя опции на экране Система > Управление файлами > Список внешних программ мониторинга > Импорт. Система BIG-IP автоматически разместит файл в соответствующем месте на файловой системе.
interval целое число			Интервал, определяющий частоту выполнения экземпляра монитора этой шаблона. Если этот параметр не задан при создании нового монитора, значение по умолчанию будет 30. Это значение должно быть меньше значения `timeout`.
ip строка			Часть IP-адреса определения IP/порта. Если этот параметр не задан при создании нового монитора, значение по умолчанию будет '*'.
name строка / обязательно			Указывает имя монитора.
parent строка		По умолчанию: "/Common/external"	Родительский шаблон этого шаблона монитора. После установки этого значения его нельзя изменить. По умолчанию это значение является родительским `http` в разделе `Common`.
partition строка		По умолчанию: "Common"	Раздел устройства для управления ресурсами.
port строка			Адрес порта, часть определения IP/порта. Если этот параметр не задан при создании нового монитора, значение по умолчанию будет '*'. Обратите внимание, что при указании IP-адреса вы должны использовать значение от 1 до 65535.
provider словарь добавлено в 1.0.0 от f5networks.f5_modules			Объект словаря, содержащий данные подключения.
	auth_provider строка		Настраивает поставщика авторизации для получения маркеров аутентификации с удаленного устройства. Этот параметр действительно используется при работе с устройствами BIG-IQ.
	no_f5_teem логическое значение	Варианты: no yes	Если `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 строка	Варианты: rest ←	Настраивает транспортное подключение для использования при подключении к удаленному устройству.
	user строка / обязательно		Имя пользователя для подключения к BIG-IP. Этот пользователь должен иметь административные привилегии на устройстве. Вы можете опустить этот параметр, задав переменную среды `F5_USER`.
	validate_certs логическое значение	Варианты: no yes ←	Если `no`, сертификаты SSL не проверяются. Используйте это только на контролируемых вами сайтах с самозаверяющими сертификатами. Вы можете опустить этот параметр, задав переменную среды `F5_VALIDATE_CERTS`.
state строка		Варианты: present ← absent	Когда `present`, гарантирует существование монитора. Когда `absent`, гарантирует удаление монитора.
timeout целое число			Количество секунд, в течение которых узел или служба должны ответить на запрос монитора. Если целевой ответ поступает в установленный период времени, он считается активным. Если целевой ответ не поступает в установленный период времени, он считается неактивным. Вы можете изменить это на любое число, однако оно должно быть в 3 раза больше интервала в секундах плюс 1 секунда. Если этот параметр не задан при создании нового монитора, значение по умолчанию будет 120.
variables словарь			Указывает любые переменные, необходимые скрипту. Двойные кавычки в значениях будут подавлены.

Примечания

Примечание

Дополнительную информацию об использовании Ansible для управления устройствами F5 Networks см. на https://www.ansible.com/integrations/networks/f5.
Требуется версия ПО BIG-IP >= 12.
Модули F5 изменяют только рабочую конфигурацию продукта F5. Чтобы гарантировать сохранение специфичных для BIG-IP конфигураций в файле, убедитесь, что включен хотя бы один таск, использующий модуль f5networks.f5_modules.bigip_config для сохранения рабочей конфигурации. Обратитесь к документации модуля за правильным использованием модуля для сохранения рабочей конфигурации.

Примеры

- name: Create an external monitor
  bigip_gtm_monitor_external:
    name: foo
    state: present
    provider:
      user: admin
      password: secret
      server: lb.mydomain.com
  delegate_to: localhost

- name: Create an external monitor with variables
  bigip_gtm_monitor_external:
    name: foo
    timeout: 10
    variables:
      var1: foo
      var2: bar
    state: present
    provider:
      user: admin
      password: secret
      server: lb.mydomain.com
  delegate_to: localhost

- name: Add a variable to an existing set
  bigip_gtm_monitor_external:
    name: foo
    timeout: 10
    variables:
      var1: foo
      var2: bar
      cat: dog
    state: present
    provider:
      user: admin
      password: secret
      server: lb.mydomain.com
  delegate_to: localhost

Значения возврата

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

Ключ	Возвращаемое значение	Описание
interval целое число	изменилось	Новый интервал для выполнения проверки монитора. Пример: 2
ip строка	изменилось	Новый IP-адрес определения IP/порта. Пример: 10.12.13.14
parent строка	изменилось	Новый родительский шаблон монитора. Пример: external
timeout целое число	изменилось	Новое время ожидания, в течение которого удаленная система должна ответить на монитор. Пример: 10

Авторы

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

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