bigip_monitor_tcp_echo - Управляет мониторами F5 BIG-IP LTM tcp echo

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

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

Описание

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

Требования

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

f5-sdk >= 3.0.9

Параметры

Параметр		Варианты/Значения по умолчанию	Комментарии
interval			Интервал, определяющий частоту выполнения мониторинга данного шаблона. Если этот параметр не указан при создании нового монитора, значение по умолчанию будет 5. Это значение должно быть меньше значения `timeout`.
ip			Часть IP-адреса в определении IP/порт. Если этот параметр не указан при создании нового монитора, значение по умолчанию будет '*'. Если это значение — IP-адрес, и `type` является `tcp` (по умолчанию), то необходимо указать число `port`.
name обязательно			Имя монитора.
parent		По умолчанию: /Common/tcp_echo	Родительский шаблон этого шаблона монитора. После установки этого значения его изменить нельзя. По умолчанию это родительский `tcp_echo` на разделе `Common`.
partition (добавлено в 2.5)		По умолчанию: Common	Раздел устройства для управления ресурсами.
password обязательно			Пароль учетной записи пользователя для подключения к BIG-IP. Можно опустить этот параметр, если переменная окружения `F5_PASSWORD` установлена. псевдонимы: pass, pwd
provider (добавлено в 2.5)		По умолчанию: None	Объект словаря, содержащий данные подключения.
	ssh_keyfile		Указывает файл SSH-ключа для аутентификации подключения к удаленному устройству. Этот аргумент используется только для транспортов cli. Если значение не указано в задаче, вместо него будет использовано значение переменной окружения `ANSIBLE_NET_SSH_KEYFILE`.
	timeout	По умолчанию: 10	Устанавливает таймаут в секундах для связи с сетевым устройством при подключении или отправке команд. Если таймаут истечет до завершения операции, модуль выдаст ошибку.
	server обязательно		Хост BIG-IP. Можно опустить этот параметр, если переменная окружения `F5_SERVER` установлена.
	user обязательно		Имя пользователя для подключения к BIG-IP. Этот пользователь должен иметь административные привилегии на устройстве. Можно опустить этот параметр, если переменная окружения `F5_USER` установлена.
	server_port	По умолчанию: 443	Порт сервера BIG-IP. Можно опустить этот параметр, если переменная окружения `F5_SERVER_PORT` установлена.
	password обязательно		Пароль учетной записи пользователя для подключения к BIG-IP. Можно опустить этот параметр, если переменная окружения `F5_PASSWORD` установлена. псевдонимы: pass, pwd
	validate_certs	Варианты: нет да ←	Если `no`, сертификаты SSL не будут проверены. Используйте только на сайтах, контролируемых вами, с самозаверенными сертификатами. Можно опустить этот параметр, если переменная окружения `F5_VALIDATE_CERTS` установлена.
	transport обязательно	Варианты: rest cli ←	Настраивает транспортное соединение для подключения к удаленному устройству.
server обязательно			Хост BIG-IP. Можно опустить этот параметр, если переменная окружения `F5_SERVER` установлена.
server_port (добавлено в 2.2)		По умолчанию: 443	Порт сервера BIG-IP. Можно опустить этот параметр, если переменная окружения `F5_SERVER_PORT` установлена.
state (добавлено в 2.5)		Варианты: present ← absent	Когда `present`, гарантирует, что монитор существует. Когда `absent`, гарантирует удаление монитора.
time_until_up			Указывает время в секундах после первого успешного ответа, прежде чем узел будет помечен как активный. Значение 0 заставит узел быть помеченным как активный сразу после получения валидного ответа от узла. Если этот параметр не указан при создании нового монитора, значение по умолчанию будет 0.
timeout			Количество секунд, в течение которого узел или служба должны ответить на запрос мониторинга. Если целевой объект отвечает в установленный срок, он считается активным. Если целевой объект не отвечает в установленный срок, он считается неактивным. Можно изменить это число на любое, но оно должно быть в 3 раза больше числа интервалов в секундах плюс 1 секунда. Если этот параметр не указан при создании нового монитора, значение по умолчанию будет 16.
user обязательно			Имя пользователя для подключения к BIG-IP. Этот пользователь должен иметь административные привилегии на устройстве. Можно опустить этот параметр, если переменная окружения `F5_USER` установлена.
validate_certs (добавлено в 2.0)		Варианты: нет да ←	Если `no`, сертификаты SSL не будут проверены. Используйте только на сайтах, контролируемых вами, с самозаверенными сертификатами. Можно опустить этот параметр, если переменная окружения `F5_VALIDATE_CERTS` установлена.

Примечания

Примечание

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

Примеры

- name: Create TCP Echo Monitor
  bigip_monitor_tcp_echo:
    state: present
    server: lb.mydomain.com
    user: admin
    ip: 10.10.10.10
    password: secret
    name: my_tcp_monitor
  delegate_to: localhost

- name: Remove TCP Echo Monitor
  bigip_monitor_tcp_echo:
    state: absent
    server: lb.mydomain.com
    user: admin
    password: secret
    name: my_tcp_monitor
  delegate_to: localhost

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

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

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

Статус

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

Автор

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.5/modules/bigip_monitor_tcp_echo_module.html