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

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

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

Обзор

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

Требования

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

f5-sdk >= 3.0.16

Параметры

Параметр		Варианты/Значения по умолчанию	Комментарии
description - добавлено в 2.7			Описание монитора.
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		Значение по умолчанию: 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`.
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 boolean добавлено в 2.0		Варианты: no yes ←	Если `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.
Требуется версия ПО BIG-IP >= 12.
Модули F5 манипулируют только текущей конфигурацией продукта F5. Чтобы убедиться, что конфигурация, специфичная для BIG-IP, сохраняется на диске, обязательно включите хотя бы одну задачу, использующую модуль bigip_config для сохранения текущей конфигурации. Обратитесь к документации модуля для правильного использования модуля для сохранения текущей конфигурации.

Примеры

- 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

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

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

Ключ	Возвращаемое значение	Описание
description строка	changed	Описание монитора. Пример: Важный монитор
interval целое число	changed	Новый интервал проверки монитора. Пример: 2
ip строка	changed	Новый IP-адрес определения IP/порта. Пример: 10.12.13.14
parent строка	changed	Новая родительская шаблон монитора. Пример: tcp
port строка	changed	Новый порт определения IP/порта. Пример: admin@root.local
receive строка	changed	Новая строка приема для этого монитора. Пример: tcp строка для приема
send строка	changed	Новая строка отправки для этого монитора. Пример: tcp строка для отправки
time_until_up целое число	changed	Новое время, в течение которого система должна быть помечена как активная после первого успешного ответа. Пример: 2
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_tcp_module.html