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

Примечание

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

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

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

Добавлено в версии 1.0.0: of f5networks.f5_modules

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

Описание

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

Параметры

Параметр		Варианты/Значения по умолчанию	Комментарии
arguments строка			Указывает любые аргументы командной строки, необходимые для скрипта.
description строка			Описание монитора.
external_program строка			Указывает имя файла, используемого монитором. Для ссылки на файл необходимо сначала импортировать его, используя опции на экране System > File Management > External Monitor Program File List > Import. Система 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 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 секунда. Если этот параметр не указан при создании нового монитора, значение по умолчанию будет `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 строка	изменено	Описание монитора. Пример: Важный монитор
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_monitor_external_module.html