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

Примечание

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

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

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

Добавлено в версии 1.0.0: модуля f5networks.f5_modules

Обзор
Параметры
Примечания
Примеры
Возвращаемые значения

Обзор

Управляет внешними мониторами LTM на устройстве BIG-IP.

Параметры

Параметр		Варианты/Значения по умолчанию	Комментарии
arguments строка			Указывает любые аргументы командной строки, необходимые скрипту.
description строка			Описание монитора.
external_program строка			Указывает имя файла, используемого монитором. Для ссылки на файл необходимо сначала импортировать его, используя опции на экране Система > Управление файлами > Список внешних файлов монитора > Импорт. Система BIG-IP автоматически помещает файл в соответствующее место на файловой системе.
interval целое число			Интервал, определяющий частоту запуска экземпляра монитора этой шаблона. Если этот параметр не указан при создании нового монитора, значение по умолчанию будет 5. Это значение должно быть меньше значения `timeout`.
ip строка			Часть IP-адреса в определении IP/порт. Если этот параметр не указан при создании нового монитора, значение по умолчанию будет '*'.
name строка / обязательно			Указывает имя монитора.
parent строка		По умолчанию: "/Common/external"	Родительский шаблон для этого шаблона монитора. После установки этого значения его нельзя изменить. По умолчанию это значение является родительским `external` на раздела `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 строка	Варианты: rest ←	Настраивает транспортное соединение, используемое при подключении к удалённому устройству.
	user строка / обязательно		Имя пользователя для подключения к BIG-IP. Этот пользователь должен иметь административные привилегии на устройстве. Можно опустить этот параметр, задав переменную окружения `F5_USER`.
	validate_certs логическое значение	Варианты: нет да ←	Если `no`, сертификаты SSL не проверяются. Используйте только на контролируемых вами сайтах с самоподписанными сертификатами. Можно опустить этот параметр, задав переменную окружения `F5_VALIDATE_CERTS`.
state строка		Варианты: present ← absent	Когда `present`, гарантирует существование монитора. Когда `absent`, гарантирует удаление монитора.
timeout целое число			Количество секунд, в течение которого узел или служба должны ответить на запрос монитора. Если целевой объект отвечает в заданный период времени, он считается активным. Если целевой объект не отвечает в заданный период времени, он считается неактивным. Можно изменить это значение на любое число, однако оно должно быть в 3 раза больше значения интервала плюс 1 секунда. Если этот параметр не указан при создании нового монитора, значение по умолчанию будет `16`.
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_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_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_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

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

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

Ключ	Возвращаемое	Описание
description строка	changed	Описание монитора. Пример: Важный монитор
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_monitor_external_module.html