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

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

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

Описание

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

Требования

Ниже приведены требования к хосту, на котором выполняется этот модуль.

f5-sdk >= 3.0.16

Параметры

Параметр		Варианты/Значения по умолчанию	Комментарии
arguments -			Указывает любые аргументы командной строки, которые требуются скрипту.
description - добавлено в 2.7			Описание монитора.
external_program -			Указывает имя файла, используемого монитором. Чтобы сослаться на файл, необходимо сначала импортировать его, используя опции на экране Система > Управление файлами > Список файлов внешней программы мониторинга > Импорт. Система BIG-IP автоматически помещает файл в соответствующее место на файловой системе.
interval -			Интервал, определяющий частоту запуска экземпляра монитора этой шаблона. Если этот параметр не задан при создании нового монитора, значение по умолчанию будет 5. Это значение должно быть меньше значения `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		По умолчанию: null	Объект словаря, содержащий сведения о подключении.
	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 - / обязательно	Варианты: rest cli ←	Настраивает транспортное соединение для использования при подключении к удаленному устройству.
	user - / обязательно		Имя пользователя для подключения к BIG-IP. Этот пользователь должен иметь права администратора на устройстве. Вы можете опустить этот параметр, установив переменную среды `F5_USER`.
	validate_certs boolean	Варианты: no yes ←	Если `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 секунда. Если этот параметр не задан при создании нового монитора, значение по умолчанию будет `16`.
user - / обязательно			Имя пользователя для подключения к BIG-IP. Этот пользователь должен иметь права администратора на устройстве. Вы можете опустить этот параметр, установив переменную среды `F5_USER`.
validate_certs boolean добавлено в 2.0		Варианты: no yes ←	Если `no`, сертификаты SSL не проверяются. Используйте только на контролируемых вами сайтах с самоподписанными сертификатами. Вы можете опустить этот параметр, установив переменную среды `F5_VALIDATE_CERTS`.
variables -			Указывает любые переменные, которые требуются скрипту. Обратите внимание, что двойные кавычки в значениях будут подавлены.

Примечания

Примечание

Дополнительную информацию об использовании Ansible для управления устройствами F5 Networks см. на https://www.ansible.com/integrations/networks/f5.
Требуется пакет f5-sdk Python на хосте. Это так же просто, как pip install f5-sdk.
Требуется версия программного обеспечения BIG-IP >= 12.
Модули F5 управляют только текущей конфигурацией продукта F5. Чтобы убедиться, что конфигурация, специфичная для BIG-IP, сохранится на диске, обязательно включите по крайней мере одну задачу, использующую модуль bigip_config для сохранения текущей конфигурации. Обратитесь к документации модуля для правильного использования модуля для сохранения текущей конфигурации.

Примеры

- name: Create an external monitor
  bigip_monitor_external:
    name: foo
    password: secret
    server: lb.mydomain.com
    state: present
    user: admin
  delegate_to: localhost

- name: Create an external monitor with variables
  bigip_monitor_external:
    name: foo
    timeout: 10
    variables:
      var1: foo
      var2: bar
    password: secret
    server: lb.mydomain.com
    state: present
    user: admin
  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
    password: secret
    server: lb.mydomain.com
    state: present
    user: admin
  delegate_to: localhost

Значения возврата

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

Ключ	Возвращаемое	Описание
description строка	changed	Описание монитора. Пример: Важный монитор
interval целое число	changed	Новый интервал, в котором нужно выполнять проверку монитора. Пример: 2
ip строка	changed	Новый IP-адрес определения IP/порта. Пример: 10.12.13.14
parent строка	changed	Новая родительская шаблон монитора. Пример: external
timeout целое число	changed	Новый интервал ожидания, в котором удаленная система должна ответить на запрос монитора. Пример: 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.7/modules/bigip_monitor_external_module.html