f5networks.f5_modules.bigip_monitor_tcp_half_open – Управляет мониторами F5 BIG-IP LTM TCP half-open

Примечание

Этот плагин входит в коллекцию f5networks.f5_modules (версия 1.7.1).

Для его установки используйте: ansible-galaxy collection install f5networks.f5_modules

Для использования в плейбуке укажите: f5networks.f5_modules.bigip_monitor_tcp_half_open

Новое в версии 1.0.0: из f5networks.f5_modules

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

Обзор

Управляет мониторами F5 BIG-IP LTM TCP half-open.

Параметры

Параметр		Варианты/Значения по умолчанию	Комментарии
description строка			Описание монитора.
interval целое число			Интервал, определяющий частоту выполнения экземпляра монитора этой шаблона. Если этот параметр не указан при создании нового монитора, значение по умолчанию — 5. Это значение должно быть меньше значения `timeout`.
ip строка			Часть IP-адреса в определении IP/port. Если этот параметр не указан при создании нового монитора, значение по умолчанию — '*'. Если это значение — IP-адрес, и `type` — `tcp` (значение по умолчанию), то необходимо указать значение `port`.
name строка / обязательный			Имя монитора.
parent строка		Значение по умолчанию: "/Common/tcp_half_open"	Родительский шаблон этого шаблона монитора. После установки этого значения его нельзя изменить. По умолчанию это значение — родительский `tcp_half_open` на разметке `Common`.
partition строка		Значение по умолчанию: "Common"	Разметка устройства для управления ресурсами.
port строка			Адрес порта в определении IP/port. Если этот параметр не указан при создании нового монитора, значение по умолчанию — '*'. Если указывается IP-адрес, необходимо указать значение от 1 до 65535.
provider словарь добавлен в 1.0.0 от f5networks.f5_modules			Объект словаря, содержащий данные подключения.
	auth_provider строка		Настраивает поставщика аутентификации для получения маркеров аутентификации с удаленного устройства. Этот параметр используется при работе с устройствами BIG-IQ.
	no_f5_teem булево	Варианты: нет да	Если `yes`, данные телеметрии TEEM не отправляются на F5. Можно пропустить этот параметр, задав переменную среды `F5_TEEM`.
	password строка / обязательный		Пароль учетной записи пользователя для подключения к BIG-IP. Можно пропустить этот параметр, задав переменную среды `F5_PASSWORD`. псевдонимы: pass, pwd
	server строка / обязательный		Хост BIG-IP. Можно пропустить этот параметр, задав переменную среды `F5_SERVER`.
	server_port целое число	Значение по умолчанию: 443	Порт сервера BIG-IP. Можно пропустить этот параметр, задав переменную среды `F5_SERVER_PORT`.
	timeout целое число		Указывает тайм-аут в секундах для связи с сетевым устройством для подключения или отправки команд. Если тайм-аут истекает до завершения операции, модуль выдаст ошибку.
	transport строка	Варианты: rest ←	Настраивает транспортное соединение для подключения к удаленному устройству.
	user строка / обязательный		Имя пользователя для подключения к BIG-IP. Этот пользователь должен иметь административные права на устройстве. Можно пропустить этот параметр, задав переменную среды `F5_USER`.
	validate_certs булево	Варианты: нет да ←	Если `no`, сертификаты SSL не проверяются. Используйте только на контролируемых вами сайтах с самоподписанными сертификатами. Можно пропустить этот параметр, задав переменную среды `F5_VALIDATE_CERTS`.
state строка		Варианты: present ← absent	При `present`, гарантирует существование монитора. При `absent`, гарантирует удаление монитора.
time_until_up целое число			Указывает количество секунд после первого успешного ответа, прежде чем узел будет помечен как активный. Значение `0` приведет к тому, что узел будет помечен как активный сразу после получения действительного ответа от узла. Если этот параметр не указан при создании нового монитора, значение по умолчанию — 0.
timeout целое число			Количество секунд, в течение которых узел или служба должны ответить на запрос монитора. Если целевой объект отвечает в установленный период времени, он считается активным. Если целевой объект не отвечает в установленный период времени, он считается неактивным. Можно изменить это значение на любое число, однако оно должно быть в 3 раза больше числа секунд в интервале плюс 1 секунда. Если этот параметр не указан при создании нового монитора, значение по умолчанию — 16.

Примечания

Примечание

Требуется версия программного обеспечения BIG-IP >= 12
Дополнительную информацию об использовании Ansible для управления устройствами F5 Networks см. в https://www.ansible.com/integrations/networks/f5.
Требуется версия программного обеспечения BIG-IP >= 12.
Модули F5 манипулируют только текущей конфигурацией продукта F5. Чтобы гарантировать сохранение конфигурации BIG-IP на диске, убедитесь, что включён хотя бы один шаг, использующий модуль f5networks.f5_modules.bigip_config для сохранения текущей конфигурации. Обратитесь к документации модуля для правильного использования модуля для сохранения текущей конфигурации.

Примеры

- name: Create TCP half-open Monitor
  bigip_monitor_tcp_half_open:
    state: present
    ip: 10.10.10.10
    name: my_tcp_monitor
    provider:
      server: lb.mydomain.com
      user: admin
      password: secret
  delegate_to: localhost

- name: Remove TCP half-open Monitor
  bigip_monitor_tcp_half_open:
    state: absent
    name: my_tcp_monitor
    provider:
      server: lb.mydomain.com
      user: admin
      password: secret
  delegate_to: localhost

- name: Add half-open monitor for all addresses, port 514
  bigip_monitor_tcp_half_open:
    port: 514
    name: my_tcp_monitor
    provider:
      password: secret
      server: lb.mydomain.com
      user: admin
  delegate_to: localhost

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

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

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

Авторы

Tim Rupp (@caphrim007)
Wojciech Wypior (@wojtek0806)

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/f5networks/f5_modules/bigip_monitor_tcp_half_open_module.html