f5networks.f5_modules.bigip_gtm_monitor_https – Управляет мониторами HTTPS F5 BIG-IP GTM

Примечание

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

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

Для использования в книге задач укажите: f5networks.f5_modules.bigip_gtm_monitor_https.

Новая версия 1.0.0: модуля f5networks.f5_modules

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

Обзор

Управляет мониторами HTTPS F5 BIG-IP GTM (теперь BIG-IP DNS).

Параметры

Параметр		Варианты/Значения по умолчанию	Комментарии
cipher_list строка			Указывает список шифров для этого монитора. Элементы в списке шифров разделены символом двоеточие `:`. При создании нового монитора, если этот параметр не указан, используется список по умолчанию `DEFAULT:+SHA:+3DES:+kEDH`.
client_cert строка			Указывает полный путь к клиенту сертификату, который монитор отправляет целевому серверу SSL.
client_key строка			Указывает ключ для сертификата клиента, который монитор отправляет целевому серверу SSL.
compatibility булево		Варианты: нет да	При включении устанавливает значение параметра SSL (в OpenSSL) на all. При создании нового монитора, если это значение не указано, значение по умолчанию `yes`.
ignore_down_response булево		Варианты: нет да	Указывает, что монитор допускает более одной попытки зондирования за интервал. Если `yes`, указывает, что монитор игнорирует ответы о неработоспособности в течение времени таймаута монитора. После истечения таймаута монитора без получения ответа о работоспособности, система помечает объект как неработоспособный. Если `no`, указывает, что монитор немедленно помечает объект как неработоспособный при получении ответа о неработоспособности. При создании нового монитора, если этот параметр не указан, значение по умолчанию `no`.
interval целое число			Интервал, определяющий частоту выполнения мониторного экземпляра данной шаблона. Если этот параметр не указан при создании нового монитора, значение по умолчанию будет 30. Это значение должно быть меньше `timeout` значения.
ip строка			IP-адрес, часть определения IP/порта. Если этот параметр не указан при создании нового монитора, значение по умолчанию — '*'. Если это значение — IP-адрес, необходимо указать значение `port`.
name строка / обязательно			Имя монитора.
parent строка		По умолчанию: "/Common/https"	Родительский шаблон этого мониторного шаблона. После установки этого значения его изменить нельзя. По умолчанию это родительский шаблон `https` на `Common` разделе.
partition строка		По умолчанию: "Common"	Раздел устройства для управления ресурсами.
port строка			Порт, часть определения IP/порта. Если этот параметр не указан при создании нового монитора, значение по умолчанию — '*'. При указании IP-адреса необходимо указать значение от 1 до 65535.
probe_timeout целое число			Указывает количество секунд, после которого система отключает запрос зондирования к системе. При создании нового монитора, если этот параметр не указан, значение по умолчанию `5`.
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`.
receive строка			Строка приёма для вызова монитора.
reverse булево		Варианты: нет да	Инструктирует систему помечать целевой ресурс как неработоспособный, когда тест успешен. Эта настройка полезна, например, если содержимое домашней страницы вашего веб-сайта динамично и часто изменяется, вы можете настроить обратный ECV-проверка, которая ищет строку Error. Совпадение с этой строкой означает, что веб-сервер был неработоспособен. Для использования этого параметра необходимо указать значения для `send` и `receive`.
send строка			Строка отправки для вызова монитора. При создании нового монитора, если этот параметр не указан, будет использовано значение по умолчанию `GET /\r\n`.
state строка		Варианты: present ← absent	Когда `present`, гарантирует существование монитора. Когда `absent`, гарантирует удаление монитора.
target_password строка			Указывает пароль, если контролируемый целевой объект требует аутентификации.
target_username строка			Указывает имя пользователя, если контролируемый целевой объект требует аутентификации.
timeout целое число			Количество секунд, в течение которых узел или служба должны ответить на запрос монитора. Если целевой объект отвечает в течение установленного периода времени, он считается работоспособным. Если целевой объект не отвечает в течение установленного периода времени, он считается неработоспособным. Вы можете изменить это значение на любое число, однако оно должно быть в 3 раза больше интервала плюс 1 секунда. Если этот параметр не указан при создании нового монитора, значение по умолчанию будет 120.
transparent булево		Варианты: нет да	Указывает, работает ли монитор в прозрачном режиме. Монитор в прозрачном режиме направляет трафик через ассоциированные члены пула или узлы (обычно маршрутизатор или брандмауэр) к алиасному пункту назначения (то есть, зондирует комбинацию `ip` - `port`, указанную в мониторе). Если монитор не может успешно достичь алиасного пункта назначения, член пула или узел, через который был отправлен трафик монитора, помечаются как неработоспособные. При создании нового монитора, если этот параметр не указан, значение по умолчанию `no`.
update_password строка		Варианты: всегда ← при_создании	`always` обновит пароли, если `target_password` указан. `on_create` установит пароль только для новых мониторов.

Примечания

Примечание

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

Примеры

- name: Create a GTM HTTPS monitor
  bigip_gtm_monitor_https:
    name: my_monitor
    ip: 1.1.1.1
    port: 80
    send: my send string
    receive: my receive string
    state: present
    provider:
      user: admin
      password: secret
      server: lb.mydomain.com
  delegate_to: localhost

- name: Remove HTTPS Monitor
  bigip_gtm_monitor_https:
    name: my_monitor
    state: absent
    provider:
      user: admin
      password: secret
      server: lb.mydomain.com
  delegate_to: localhost

- name: Add HTTPS monitor for all addresses, port 514
  bigip_gtm_monitor_https:
    name: my_monitor
    provider:
      user: admin
      password: secret
      server: lb.mydomain.com
    port: 514
  delegate_to: localhost

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

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

Ключ	Возвращаемое значение	Описание
cipher_list строка	changed	Новое значение списка шифров. Пример: +3DES:+kEDH
client_cert строка	changed	Новое значение настройки клиентского сертификата. Пример: /Common/default
client_key строка	changed	Новое значение настройки клиентского ключа. Пример: /Common/default
compatibility булево	changed	Новое значение настройки совместимости SSL. Пример: True
ignore_down_response булево	changed	Игнорировать ответ о недоступности или нет. Пример: True
interval целое число	changed	Новый интервал, в котором выполняется проверка монитора. Пример: 2
ip строка	changed	Новый IP-адрес определения IP/порта. Пример: 10.12.13.14
parent строка	changed	Новая родительская шаблон монитора. Пример: https
port строка	changed	Новый порт, на котором монитор проверяет ресурс. Пример: 8080
probe_timeout целое число	changed	Новый таймаут, в котором система будет ожидать ответа зондирования монитора. Пример: 10
receive строка	changed	Новая строка приёма для этого монитора. Пример: tcp строка для приёма
reverse булево	changed	Новое значение для работы монитора в обратном режиме.
send строка	changed	Новая строка отправки для этого монитора. Пример: tcp строка для отправки
timeout целое число	changed	Новый таймаут, в течение которого удаленная система должна ответить монитору. Пример: 10
transparent булево	changed	Новое значение для работы монитора в прозрачном режиме.

Авторы

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.10/collections/f5networks/f5_modules/bigip_gtm_monitor_https_module.html