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

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

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

Краткое описание

Управляет мониторами F5 BIG-IP GTM https.

Параметры

Параметр		Варианты/Значения по умолчанию	Комментарии
cipher_list строка			Указывает список шифров для данного монитора. Элементы в списке шифров разделяются символом двоеточия `:`. При создании нового монитора, если этот параметр не указан, используется список по умолчанию `DEFAULT:+SHA:+3DES:+kEDH`.
client_cert строка			Указывает полный путь к клиенту сертификату, который монитор отправляет целевому SSL-серверу.
client_key строка			Указывает ключ для сертификата клиента, который монитор отправляет целевому SSL-серверу.
compatibility логическое		Варианты: no yes	Указывает, что, при включенном параметре, настройка SSL (в OpenSSL) установлена на значение all. При создании нового монитора, если это значение не указано, по умолчанию используется `yes`.
ignore_down_response логическое		Варианты: no yes	Указывает, что монитор допускает более одной попытки зондирования за интервал. При значении `yes`, указывает, что монитор игнорирует ответы о неработоспособности (down) в течение таймаута монитора. После достижения таймаута монитора без получения ответа о работоспособности (up), система помечает объект как неработоспособный. При значении `no`, указывает, что монитор немедленно помечает объект как неработоспособный при получении ответа о неработоспособности. При создании нового монитора, если этот параметр не указан, значение по умолчанию будет `no`.
interval целое число			Интервал, определяющий частоту выполнения экземпляра монитора этого шаблона. Если этот параметр не указан при создании нового монитора, значение по умолчанию будет 30. Это значение должно быть меньше значения `timeout`.
ip строка			Часть IP-адреса в определении IP/порт. Если этот параметр не указан при создании нового монитора, значение по умолчанию будет '*'. Если это значение является IP-адресом, то должно быть указано значение порта.
name строка / обязательно			Имя монитора.
parent строка		По умолчанию: "/Common/https"	Родительский шаблон для этого шаблона монитора. После установки этого значения, его нельзя изменить. По умолчанию это родительский шаблон в разделе `tcp` на разбиении `Common`.
partition строка		По умолчанию: "Common"	Раздел устройства для управления ресурсами.
password строка / обязательно			Пароль учетной записи пользователя, используемой для подключения к BIG-IP. Вы можете опустить этот параметр, установив переменную среды `F5_PASSWORD`. псевдонимы: pass, pwd
port строка			Адрес порта в определении IP/порт. Если этот параметр не указан при создании нового монитора, значение по умолчанию будет '*'. Обратите внимание, что при указании IP-адреса должно быть указано значение от 1 до 65535.
probe_timeout целое число			Указывает количество секунд, после которого система отменяет запрос зондирования к системе. При создании нового монитора, если этот параметр не указан, значение по умолчанию будет `5`.
provider словарь добавлен в 2.5			Объект словаря, содержащий сведения о подключении.
	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 строка	Варианты: cli rest ←	Настраивает транспортное соединение для подключения к удаленному устройству.
	user строка / обязательно		Имя пользователя для подключения к BIG-IP. Этот пользователь должен иметь административные права на устройстве. Вы можете опустить этот параметр, установив переменную среды `F5_USER`.
	validate_certs логическое	Варианты: no yes ←	Если `no`, сертификаты SSL не будут проверены. Используйте только на сайтах, контролируемых вами, с использованием самозаверяющих сертификатов. Вы можете опустить этот параметр, установив переменную среды `F5_VALIDATE_CERTS`.
receive строка			Строка приема для вызова монитора.
reverse логическое		Варианты: no yes	Указывает системе помечать целевой ресурс как неработоспособный, когда тест завершается успешно. Эта настройка полезна, например, если контент на главной странице вашего веб-сайта динамический и часто меняется, вы можете настроить обратный ECV-сервисный тест, который ищет строку Ошибка. Совпадение со строкой означает, что веб-сервер был недоступен. Для использования этого параметра необходимо указать значения для `send` и `receive`.
send строка			Строка отправки для вызова монитора. При создании нового монитора, если этот параметр не указан, по умолчанию будет использоваться `GET /\r\n`.
server строка / обязательно			Хост BIG-IP. Вы можете опустить этот параметр, установив переменную среды `F5_SERVER`.
server_port целое число добавлен в 2.2		По умолчанию: 443	Порт сервера BIG-IP. Вы можете опустить этот параметр, установив переменную среды `F5_SERVER_PORT`.
state строка		Варианты: present ← absent	При значении `present`, гарантирует, что монитор существует. При значении `absent`, гарантирует удаление монитора.
target_password строка			Указывает пароль, если контролируемый целевой ресурс требует аутентификации.

имя_пользователя_цели строка		Указывает имя пользователя, если контролируемая цель требует аутентификации.
таймаут целое число		Количество секунд, в течение которого узел или служба должны ответить на запрос монитора. Если цель отвечает в установленный период времени, она считается активной. Если цель не отвечает в установленный период времени, она считается неактивной. Вы можете изменить это число на любое значение, однако оно должно быть в 3 раза больше значения интервала в секундах плюс 1 секунда. Если этот параметр не указан при создании нового монитора, значение по умолчанию будет 120.
прозрачный логический тип	Варианты: нет да	Указывает, работает ли монитор в прозрачном режиме. Монитор в прозрачном режиме направляет трафик через ассоциированные члены пула или узлы (обычно маршрутизатор или брандмауэр) к алиасному пункту назначения (то есть, он исследует комбинацию `ip`-`port` , указанную в мониторе). Если монитор не может успешно достичь алиасного пункта назначения, член пула или узел, через который отправлялся трафик монитора, помечается как неактивный. При создании нового монитора, если этот параметр не указан, значение по умолчанию будет `no`.
обновить_пароль строка	Варианты: всегда ← при_создании	`always` обновит пароли, если `target_password` указан. `on_create` будет устанавливать пароль только для вновь созданных мониторов.
пользователь строка / обязательно		Имя пользователя для подключения к BIG-IP. У этого пользователя должны быть административные привилегии на устройстве. Этот параметр можно опустить, установив переменную среды `F5_USER`.
проверять_сертификаты логический тип добавлено в 2.0	Варианты: нет да ←	Если `no`, сертификаты SSL не проверяются. Используйте это только на сайтах, контролируемых вами, с самозаверенными сертификатами. Этот параметр можно опустить, установив переменную среды `F5_VALIDATE_CERTS`.

Примечания

Примечание

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

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

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

Ключ	Возвращённое значение	Описание
список_шифров строка	изменено	Новое значение для списка шифров. Пример: +3DES:+kEDH
сертификат_клиента строка	изменено	Новое значение параметра сертификата клиента. Пример: /Common/default
ключ_клиента строка	изменено	Новое значение параметра ключа клиента. Пример: /Common/default
совместимость логический тип	изменено	Новое значение параметра совместимости SSL. Пример: True
игнорировать_отклик_неактивности логический тип	изменено	Игнорировать ли отклик неактивности. Пример: True
интервал целое число	изменено	Новый интервал для выполнения проверки монитора. Пример: 2
ip строка	изменено	Новый IP-адрес определения IP/порта. Пример: 10.12.13.14
родительский строка	изменено	Новая родительская шаблон монитора. Пример: https
порт строка	изменено	Новый порт, на котором монитор проверяет ресурс. Пример: 8080
таймаут_пробы целое число	изменено	Новый таймаут, в течение которого система будет ожидать ответа от пробы монитора. Пример: 10
получить строка	изменено	Новая строка получения для этого монитора. Пример: tcp строка для получения
обратный логический тип	изменено	Новое значение для работы монитора в обратном режиме.
отправить строка	изменено	Новая отправляемая строка для этого монитора. Пример: tcp строка для отправки
таймаут целое число	изменено	Новый таймаут, в течение которого удалённая система должна ответить монитору. Пример: 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.8/modules/bigip_gtm_monitor_https_module.html