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

Новая в версии 2.6.

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

Обзор

Управляет внешними мониторами GTM на 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 словарь добавлен в 2.5			Объект словаря, содержащий данные подключения.
	auth_provider строка		Настраивает поставщика аутентификации для получения токенов аутентификации от удаленного устройства. Этот параметр действительно используется при работе с устройствами BIG-IQ.
	password строка / обязательно		Пароль для учетной записи пользователя, используемой для подключения к BIG-IP. Этот параметр можно опустить, установив переменную среды `F5_PASSWORD`. псевдонимы: pass, pwd
	server строка / обязательно		Хост BIG-IP. Этот параметр можно опустить, установив переменную среды `F5_SERVER`.
	server_port целое число	По умолчанию: 443	Порт сервера BIG-IP. Этот параметр можно опустить, установив переменную среды `F5_SERVER_PORT`.
	ssh_keyfile путь		Указывает SSH-ключевой файл для аутентификации подключения к удаленному устройству. Этот аргумент используется только для транспортов cli. Этот параметр можно опустить, установив переменную среды `ANSIBLE_NET_SSH_KEYFILE`.
	timeout целое число		Указывает время ожидания в секундах для связи с сетевым устройством при подключении или отправке команд. Если время ожидания истечёт до завершения операции, модуль выдаст ошибку.
	transport строка	Варианты: cli 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 сохранится на диске, убедитесь, что включён хотя бы один этап, который использует модуль 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

Состояние

Этот модуль не гарантирует обратной совместимости интерфейса. [превью]
Этот модуль поддерживается партнёром Ansible. [сертифицировано]

Авторы

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.9/modules/bigip_gtm_monitor_external_module.html