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)			Объект словаря, содержащий данные подключения.
	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`, сертификаты 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 (добавлен в 2.5)		Варианты: present ← absent	Когда `present`, гарантирует, что монитор существует. Когда `absent`, гарантирует удаление монитора.
time_until_up			Указывает количество времени в секундах после первого успешного ответа, прежде чем узел будет помечен как активный. Значение 0 приведет к тому, что узел будет помечен как активный сразу после получения действительного ответа от узла. Если этот параметр не указан при создании нового монитора, значение по умолчанию будет 0.
timeout			Количество секунд, в течение которого узел или служба должны ответить на запрос монитора. Если целевой ответ приходит в установленный промежуток времени, он считается активным. Если целевой ответ не приходит в установленный промежуток времени, он считается неактивным. Вы можете изменить это число на любое нужное, однако оно должно быть в 3 раза больше интервала в секундах плюс 1 секунда. Если этот параметр не указан при создании нового монитора, значение по умолчанию будет 16.
user обязательно			Имя пользователя для подключения к BIG-IP. Этот пользователь должен иметь административные привилегии на устройстве. Вы можете опустить этот параметр, если переменная окружения `F5_USER` установлена.
validate_certs bool (добавлен в 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

Состояние

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

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

Этот модуль помечен как сообщество, что означает, что он поддерживается сообществом 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_tcp_echo_module.html