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"	Раздел устройства для управления ресурсами.
password строка / обязательно			Пароль учетной записи пользователя для подключения к BIG-IP. Вы можете опустить этот параметр, установив переменную среды `F5_PASSWORD`. псевдонимы: pass, pwd
port строка			Адрес порта в определении IP/порта. Если этот параметр не указан при создании нового монитора, значение по умолчанию будет '*'. Обратите внимание, что если вы указываете IP-адрес, должно быть указано значение от 1 до 65535.
provider словарь добавлен в 2.5			Объект словаря, содержащий данные подключения.
	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 целое число	Значение по умолчанию: 10	Указывает таймаут в секундах для связи с сетевым устройством для подключения или отправки команд. Если таймаут превышен до завершения операции, модуль вернёт ошибку.
	transport строка	Варианты: cli rest ←	Настраивает транспортное соединение для использования при подключении к удаленному устройству.
	user строка / обязательно		Имя пользователя для подключения к BIG-IP. Этот пользователь должен иметь административные привилегии на устройстве. Вы можете опустить этот параметр, установив переменную среды `F5_USER`.
	validate_certs булево значение	Варианты: нет да ←	Если `no`, сертификаты SSL не проверяются. Используйте только на сайтах, которыми вы лично управляете, и которые используют самозаверяющие сертификаты. Вы можете опустить этот параметр, установив переменную среды `F5_VALIDATE_CERTS`.
server строка / обязательно			Хост BIG-IP. Вы можете опустить этот параметр, установив переменную среды `F5_SERVER`.
server_port целое число добавлен в 2.2		Значение по умолчанию: 443	Порт сервера BIG-IP. Вы можете опустить этот параметр, установив переменную среды `F5_SERVER_PORT`.
state строка		Варианты: present ← absent	Когда `present`, гарантирует, что монитор существует. Когда `absent`, гарантирует удаление монитора.
timeout целое число			Количество секунд, в течение которого узел или служба должны ответить на запрос монитора. Если целевой объект отвечает в установленный период времени, он считается активным. Если целевой объект не отвечает в установленный период времени, он считается неактивным. Вы можете изменить это число на любое желаемое значение, однако оно должно быть в 3 раза больше значения интервала в секундах плюс 1 секунда. Если этот параметр не указан при создании нового монитора, значение по умолчанию будет 120.
user строка / обязательно			Имя пользователя для подключения к BIG-IP. Этот пользователь должен иметь административные привилегии на устройстве. Вы можете опустить этот параметр, установив переменную среды `F5_USER`.
validate_certs булево значение добавлен в 2.0		Варианты: нет да ←	Если `no`, сертификаты SSL не проверяются. Используйте только на сайтах, которыми вы лично управляете, и которые используют самозаверяющие сертификаты. Вы можете опустить этот параметр, установив переменную среды `F5_VALIDATE_CERTS`.
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.8/modules/bigip_gtm_monitor_external_module.html