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

Примечание

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

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

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

Новое в версии 1.0.0: of 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) в значение все. При создании нового монитора, если это значение не указано, по умолчанию используется `yes`.
ignore_down_response логический тип		Варианты: нет да	Указывает, что монитор позволяет более одной попытки зондирования в рамках интервала. Когда `yes`, указывает, что монитор игнорирует ответы о провале (down) в течение срока действия таймаута монитора. После достижения таймаута монитора без получения ответа о доступности (up) система помечает объект как недоступный. Когда `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-проверка службы, которая ищет строку «Ошибка». Совпадение с этой строкой означает, что веб-сервер был недоступен. Чтобы использовать этот параметр, необходимо указать значения для `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 строка	изменено	Новое значение для списка шифров. Пример: +3DES:+kEDH
client_cert строка	изменено	Новое значение настройки клиента сертификата. Пример: /Common/default
client_key строка	изменено	Новое значение настройки ключа клиента. Пример: /Common/default
compatibility логическое значение	изменено	Новое значение настройки совместимости SSL. Пример: True
ignore_down_response логическое значение	изменено	Игнорировать ли ответ о недоступности. Пример: True
interval целое число	изменено	Новый интервал для выполнения проверки монитора. Пример: 2
ip строка	изменено	Новый IP-адрес определения IP/порта. Пример: 10.12.13.14
parent строка	изменено	Новая родительская шаблон монитора. Пример: https
port строка	изменено	Новый порт, на котором монитор проверяет ресурс. Пример: 8080
probe_timeout целое число	изменено	Новый таймаут, в течение которого система будет ожидать ответа от зонда монитора. Пример: 10
receive строка	изменено	Новая строка приема для этого монитора. Пример: tcp string to receive
reverse логическое значение	изменено	Новое значение для режима работы монитора в обратном порядке.
send строка	изменено	Новая строка отправки для этого монитора. Пример: tcp string to send
timeout целое число	изменено	Новый таймаут, в течение которого удаленная система должна ответить на запрос монитора. Пример: 10
transparent логическое значение	изменено	Новое значение для режима прозрачности монитора.

Авторы

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