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

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

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

Синопсис

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

Требования

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

f5-sdk >= 3.0.16

Параметры

Параметр		Варианты/Значения по умолчанию	Комментарии
description - добавлено в 2.7			Описание монитора.
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		По умолчанию: 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`.
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 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

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

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

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

Статус

Гарантируется обратная совместимость данного модуля. [preview]
Этот модуль поддерживается партнером Ansible. [certified]

Авторы

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_echo_module.html