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

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

Описание
- Требования
Параметры
Примечания
Примеры
Возвращаемые значения
Статус
Техническое обслуживание
- Автор

Описание

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

Требования

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

f5-sdk >= 3.0.9

Параметры

Параметр		Варианты/Значения по умолчанию	Комментарии
arguments			Указывает любые аргументы командной строки, необходимые скрипту.
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)			Объект словаря, содержащий данные подключения.
	password обязательно		Пароль для учетной записи пользователя, используемой для подключения к BIG-IP. Вы можете опустить этот параметр, если переменная среды `F5_PASSWORD` установлена. псевдонимы: pass, pwd
	server обязательно		Хост BIG-IP. Вы можете опустить этот параметр, если переменная среды `F5_SERVER` установлена.
	server_port	По умолчанию: 443	Порт сервера BIG-IP. Вы можете опустить этот параметр, если переменная среды `F5_SERVER_PORT` установлена.
	user обязательно		Имя пользователя для подключения к BIG-IP. Этот пользователь должен иметь административные права на устройстве. Вы можете опустить этот параметр, если переменная среды `F5_USER` установлена.
	validate_certs bool	Варианты: no yes ←	Если `no`, сертификаты SSL не будут проверены. Используйте только на сайтах, контролируемых лично, с самозаверяющими сертификатами. Вы можете опустить этот параметр, если переменная среды `F5_VALIDATE_CERTS` установлена.
	timeout	По умолчанию: 10	Указывает таймаут в секундах для связи с сетевым устройством для подключения или отправки команд. Если таймаут превышен до завершения операции, модуль выдаст ошибку.
	ssh_keyfile		Указывает SSH-ключ для аутентификации подключения к удаленному устройству. Этот аргумент используется только для транспортов cli. Если значение не указано в задаче, вместо него будет использовано значение переменной среды `ANSIBLE_NET_SSH_KEYFILE`.
	transport обязательно	Варианты: rest cli ←	Настраивает транспортное подключение для использования при подключении к удаленному устройству.
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 bool (добавлен в 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.

Примеры

- 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

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

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

Ключ	Возвращаемое значение	Описание
interval int	изменённое	Новый интервал для выполнения проверки монитора. Пример: 2
ip string	изменённое	Новый IP-адрес определения IP/порт. Пример: 10.12.13.14
parent string	изменённое	Новая родительская шаблон монитора. Пример: external
timeout int	изменённое	Новый таймаут, в течение которого удалённая система должна ответить на запрос монитора. Пример: 10

Статус

Этот модуль помечен как превью, что означает, что он не гарантирует обратную совместимость.

Техническое обслуживание

Этот модуль помечен как сообщество, что означает, что он поддерживается сообществом Ansible. Подробнее см. Техническое обслуживание и поддержка модулей.

Список других модулей, которые также поддерживаются сообществом Ansible, см. здесь.

Автор

Tim Rupp (@caphrim007)

Подсказка

Если вы заметили какие-либо проблемы в этой документации, вы можете отредактировать этот документ, чтобы улучшить его.

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.6/modules/bigip_monitor_external_module.html