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 булево |
| Указывает, что при включении настройка параметров SSL (в OpenSSL) устанавливается в значение all. При создании нового монитора, если значение не указано, используется значение по умолчанию yes. | |
| ignore_down_response булево |
| Указывает, что монитор допускает более одной попытки зондирования за интервал. При yes, указывает, что монитор игнорирует ответы о недоступности в течение времени ожидания монитора. После достижения времени ожидания монитора без получения ответа о доступности, система отмечает объект как недоступный.При no, указывает, что монитор сразу отмечает объект как недоступный при получении ответа о недоступности.При создании нового монитора, если этот параметр не указан, значение по умолчанию будет no. | |
| interval целое число | Интервал, определяющий частоту выполнения экземпляра монитора по этой шаблону. Если этот параметр не указан при создании нового монитора, значение по умолчанию будет 30. Это значение должно быть меньше значения timeout. | ||
| ip строка | IP-адрес, часть определения IP/порт. Если этот параметр не указан при создании нового монитора, значение по умолчанию будет '*'. Если это значение - IP-адрес, то должно быть указано значение типа port. | ||
| name строка / обязательно | Имя монитора. | ||
| parent строка | Значение по умолчанию: "/Common/https" | Родительский шаблон этого шаблона монитора. После установки этого значения, его нельзя изменить. По умолчанию это значение - родительский шаблон tcp на разделяемой Common разделяемой. | |
| partition строка | Значение по умолчанию: "Common" | Раздел устройства для управления ресурсами. | |
| port строка | Порт, часть определения IP/порт. Если этот параметр не указан при создании нового монитора, значение по умолчанию будет '*'. Обратите внимание, что при указании IP-адреса необходимо указать значение от 1 до 65535. | ||
| probe_timeout целое число | Указывает количество секунд, после которого система отменяет запрос зондирования к системе. При создании нового монитора, если этот параметр не указан, значение по умолчанию будет 5. | ||
| provider словарь добавлено в 2.5 | Объект словаря, содержащий сведения о подключении. | ||
| auth_provider строка | Настраивает поставщика аутентификации для получения маркеров аутентификации от удаленного устройства. Этот параметр действительно используется при работе с устройствами BIG-IQ. | ||
| 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 целое число | Указывает время ожидания в секундах для связи с сетевым устройством для подключения или отправки команд. Если время ожидания истечет до завершения операции, модуль выдаст ошибку. | ||
| transport строка |
| Настраивает транспортное подключение для использования при подключении к удаленному устройству. | |
| user строка / обязательно | Имя пользователя для подключения к BIG-IP. Этот пользователь должен иметь административные привилегии на устройстве. Вы можете опустить этот параметр, установив переменную окружения F5_USER. | ||
| validate_certs булево |
| Если no, сертификаты SSL не проверяются. Используйте это только на контролируемых вами сайтах с самозаверяющимися сертификатами.Вы можете опустить этот параметр, установив переменную окружения F5_VALIDATE_CERTS. | |
| receive строка | Строка приема для вызова монитора. | ||
| reverse булево |
| Инструктирует систему отметить целевой ресурс как недоступный, когда тест успешно завершен. Эта настройка полезна, например, если контент на домашней странице вашего веб-сайта динамичен и часто меняется, вы можете настроить обратный контроль ECV, который ищет строку Ошибка. Совпадение с этой строкой означает, что веб-сервер был недоступен. Для использования этого параметра, необходимо указать значения send и receive. | |
| send строка | Строка отправки для вызова монитора. При создании нового монитора, если этот параметр не указан, будет использоваться значение по умолчанию GET /\r\n. | ||
| state строка |
| При present, гарантирует, что монитор существует.При absent, гарантирует удаление монитора. | |
| target_password строка | Указывает пароль, если контролируемый целевой объект требует аутентификации. | ||
| target_username строка | Указывает имя пользователя, если контролируемый целевой объект требует аутентификации. | ||
| timeout целое число | Количество секунд, в течение которого узел или служба должны ответить на запрос монитора. Если цель отвечает в установленный срок, она считается доступной. Если цель не отвечает в установленный срок, она считается недоступной. Вы можете изменить это число на любое, однако оно должно быть в 3 раза больше числа секунд интервала плюс 1 секунду. Если этот параметр не указан при создании нового монитора, значение по умолчанию будет 120. | ||
| transparent boolean |
| Указывает, работает ли монитор в прозрачном режиме. Монитор в прозрачном режиме направляет трафик через соответствующих участников пула или узлы (обычно маршрутизатор или брандмауэр) к алиасному пункту назначения (то есть, он исследует комбинацию ip-port указанную в мониторе).Если монитор не может успешно достичь алиасного пункта назначения, участник пула или узел, через который был отправлен трафик монитора, помечается как отключённый. При создании нового монитора, если этот параметр не задан, значение по умолчанию будет no. | |
| update_password string |
| always будет обновлять пароли, если target_password указано.on_create будет устанавливать пароль только для вновь созданных мониторов. | |
Примечания
Примечание
- Для получения дополнительной информации об использовании 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
Возвращаемые значения
Общие возвращаемые значения описаны здесь, ниже перечислены поля, уникальные для этого модуля:
| Ключ | Возвращаемое | Описание |
|---|---|---|
| cipher_list string | changed | Новое значение для списка шифров. Пример: +3DES:+kEDH |
| client_cert string | changed | Новое значение параметра клиентского сертификата. Пример: /Common/default |
| client_key string | changed | Новое значение параметра клиентского ключа. Пример: /Common/default |
| compatibility boolean | changed | Новое значение параметра совместимости SSL. Пример: True |
| ignore_down_response boolean | changed | Игнорировать ответ о отключении или нет. Пример: True |
| interval integer | changed | Новый интервал для проверки монитора. Пример: 2 |
| ip string | changed | Новый IP-адрес для определения IP/порта. Пример: 10.12.13.14 |
| parent string | changed | Новый родительский шаблон монитора. Пример: https |
| port string | changed | Новый порт, на котором монитор проверяет ресурс. Пример: 8080 |
| probe_timeout integer | changed | Новый таймаут для проверки монитора системой. Пример: 10 |
| receive string | changed | Новое значение строки приёма для этого монитора. Пример: tcp string to receive |
| reverse boolean | changed | Новое значение для режима работы монитора в обратном направлении. |
| send string | changed | Новое значение строки отправки для этого монитора. Пример: tcp string to send |
| timeout integer | changed | Новый таймаут для ответа удаленной системы на монитор. Пример: 10 |
| transparent boolean | changed | Новое значение для режима работы монитора в прозрачном режиме. |
Статус
- Этот модуль не гарантирует обратную совместимость. [превью]
- Этот модуль поддерживается партнером 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.9/modules/bigip_gtm_monitor_https_module.html
