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

Новое в версии 1.4.

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

Обзор

Управляет мониторами F5 BIG-IP LTM tcp через API iControl SOAP.

Требования

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

f5-sdk >= 3.0.9

Параметры

Параметр		Варианты/Значения по умолчанию	Комментарии
interval			Интервал, определяющий частоту запуска экземпляра монитора этой шаблона. Если этот параметр не задан при создании нового монитора, значение по умолчанию будет 5. Это значение должно быть меньше значения `timeout`.
ip			Часть IP-адреса определения IP/порта. Если этот параметр не задан при создании нового монитора, значение по умолчанию будет '*'. Если это значение — IP-адрес, и `type` значение `tcp` (по умолчанию), то необходимо указать число `port`.
name обязательно			Имя монитора.
parent		По умолчанию: /Common/tcp	Родительский шаблон этого шаблона монитора. После установки этого значения его нельзя изменить. По умолчанию это родительский шаблон `tcp` на разделителе `Common`.
partition (добавлен в 2.5)		По умолчанию: Common	Раздел устройства для управления ресурсами.
password обязательно			Пароль учетной записи пользователя, используемой для подключения к BIG-IP. Вы можете опустить этот параметр, если переменная окружения `F5_PASSWORD` задана. псевдонимы: pass, pwd
port			Адрес порта в определении IP/порта. Если этот параметр не задан при создании нового монитора, значение по умолчанию будет '*'. Обратите внимание, что при указании IP-адреса необходимо указать значение от 1 до 65535. Этот аргумент не поддерживается для типов TCP Echo.
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 да ←	Если `no`, сертификаты SSL не будут проверены. Используйте только на сайтах, контролируемых лично, с использованием самозаверяемых сертификатов. Вы можете опустить этот параметр, если переменная окружения `F5_VALIDATE_CERTS` задана.
	transport обязательно	Варианты: rest cli ←	Настраивает транспортное подключение для подключения к удаленному устройству.
receive			Строка приема для вызова монитора.
send			Строка отправки для вызова монитора.
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 да ←	Если `no`, сертификаты SSL не будут проверены. Используйте только на сайтах, контролируемых лично, с использованием самозаверяемых сертификатов. Вы можете опустить этот параметр, если переменная окружения `F5_VALIDATE_CERTS` задана.

Примечания

Примечание

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

Примеры

- name: Create TCP Monitor
  bigip_monitor_tcp:
    state: present
    server: lb.mydomain.com
    user: admin
    password: secret
    name: my_tcp_monitor
    type: tcp
    send: tcp string to send
    receive: tcp string to receive
  delegate_to: localhost

- name: Remove TCP Monitor
  bigip_monitor_tcp:
    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
port string	изменённое	Новый порт для определения IP/порт. Пример: admin@root.local
receive string	изменённое	Новая строка приема для этого монитора. Пример: tcp строка для приема
send 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_module.html