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

Примечание

Этот плагин входит в коллекцию f5networks.f5_modules (версия 1.6.0).

Для его установки используйте: 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 of 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 строка	Варианты: rest ←	Настраивает транспортное соединение, используемое при подключении к удаленному устройству.
	user строка / обязательно		Имя пользователя для подключения к BIG-IP. Этот пользователь должен иметь права администратора на устройстве. Этот параметр можно опустить, установив переменную среды `F5_USER`.
	validate_certs логическое	Варианты: нет да ←	Если `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 целое число	changed	Новый интервал для проверки монитора. Пример: 2
ip строка	changed	Новый IP-адрес в определении IP/порт. Пример: 10.12.13.14
parent строка	changed	Новый родительский шаблон монитора. Пример: external
timeout целое число	changed	Новое время ожидания, в течение которого удалённая система должна ответить на монитор. Пример: 10

Авторы

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_gtm_monitor_external_module.html