bigip_gtm_monitor_https – Управляет мониторами https F5 BIG-IP GTM
Новая версия с 2.6.
Краткое описание
- Управляет мониторами https F5 BIG-IP GTM.
Требования
Ниже перечислены требования к хосту, на котором будет выполняться этот модуль.
- f5-sdk >= 3.0.16
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| cipher_list - | Указывает список шифров для этого монитора. Элементы в списке шифров разделяются символом двоеточия :. При создании нового монитора, если этот параметр не указан, используется список по умолчанию DEFAULT:+SHA:+3DES:+kEDH. | ||
| client_cert - | Указывает полный путь к клиенту сертификату, который монитор отправляет целевому серверу SSL. | ||
| client_key - | Указывает ключ для клиентского сертификата, который монитор отправляет целевому серверу SSL. | ||
| compatibility boolean |
| Указывает, что при включении настройка SSL (в OpenSSL) устанавливается в all. При создании нового монитора, если это значение не указано, по умолчанию будет yes.
| |
| ignore_down_response boolean |
| Указывает, что монитор допускает более одной попытки зондирования за интервал. Когда yes, указывает, что монитор игнорирует ответы о недоступности на период таймаута монитора. После того, как таймаут монитора истечет без получения ответа о доступности, система помечает объект как недоступный.Когда no, указывает, что монитор сразу помечает объект как недоступный при получении ответа о недоступности.Если параметр не указан при создании нового монитора, по умолчанию будет no. | |
| interval - | Интервал, определяющий частоту запуска экземпляра монитора данной шаблона. Если этот параметр не указан при создании нового монитора, значение по умолчанию будет 30. Это значение должно быть меньше значения timeout. | ||
| ip - | Часть IP/порт определения. Если параметр не указан при создании нового монитора, значение по умолчанию будет '*'. Если это значение — IP-адрес, необходимо указать число от port. | ||
| 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 | Значение по умолчанию: null | Объект типа dict, содержащий данные подключения. | |
| 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 - / обязательно |
| Настраивает транспортное подключение для использования при подключении к удаленному устройству. | |
| user - / обязательно | Имя пользователя для подключения к BIG-IP. Этот пользователь должен иметь административные привилегии на устройстве. Можно опустить этот параметр, установив переменную среды F5_USER. | ||
| validate_certs boolean |
| Если no, сертификаты SSL не проверяются. Используйте только на управляемых вами сайтах с самозаверяющими сертификатами.Можно опустить этот параметр, установив переменную среды F5_VALIDATE_CERTS. | |
| receive - | Строка получения для вызова монитора. | ||
| reverse boolean |
| Инструктирует систему пометить целевой ресурс как недоступный, когда тест успешен. Это настройка полезна, например, если содержимое домашней страницы вашего веб-сайта динамическое и часто меняется, вы можете настроить обратный ECV-проверка сервиса, который ищет строку Error. Совпадение с этой строкой означает, что веб-сервер был недоступен. Для использования этого параметра необходимо указать значения для send и receive. | |
| send - | Строка отправления для вызова монитора. При создании нового монитора, если параметр не указан, будет использоваться значение по умолчанию GET /\r\n. | ||
| server - / обязательно | Хост BIG-IP. Можно опустить этот параметр, установив переменную среды F5_SERVER. | ||
| server_port - добавлено в 2.2 | Значение по умолчанию: 443 | Порт сервера BIG-IP. Можно опустить этот параметр, установив переменную среды F5_SERVER_PORT. | |
| state - |
| Когда present, гарантирует, что монитор существует.Когда absent, гарантирует удаление монитора. | |
| target_password - | Указывает пароль, если для мониторируемого объекта требуется аутентификация. | ||
| target_username - | Указывает имя пользователя, если контролируемый целевой объект требует аутентификации. | ||
| timeout - | Количество секунд, в течение которого узел или служба должны ответить на запрос монитора. Если целевой объект отвечает в установленный период времени, он считается активным. Если целевой объект не отвечает в установленный период времени, он считается неактивным. Вы можете изменить это значение на любое, но оно должно быть в 3 раза больше значения интервала в секундах плюс 1 секунда. Если этот параметр не указан при создании нового монитора, значение по умолчанию будет 120. | ||
| transparent boolean |
| Указывает, работает ли монитор в прозрачном режиме. Монитор в прозрачном режиме направляет трафик через связанные члены пула или узлы (обычно маршрутизатор или брандмауэр) к алиасному пункту назначения (то есть он проверяет комбинацию ip-port указанную в мониторе).Если монитор не может успешно достичь алиасного пункта назначения, член пула или узел, через который отправлялся трафик монитора, помечаются как неактивные. При создании нового монитора, если этот параметр не указан, значение по умолчанию будет no. | |
| update_password - |
| always будет обновлять пароли, если target_password указан.on_create будет устанавливать пароль только для вновь созданных мониторов. | |
| user - / обязательно | Имя пользователя для подключения к BIG-IP. Этот пользователь должен иметь административные привилегии на устройстве. Вы можете опустить этот параметр, установив переменную среды F5_USER. | ||
| validate_certs boolean добавлен в 2.0 |
| Если no, сертификаты SSL не проверяются. Используйте это только на контролируемых вами сайтах, использующих самозаверяющие сертификаты.Вы можете опустить этот параметр, установив переменную среды F5_VALIDATE_CERTS. | |
Примечания
Примечание
- Дополнительную информацию об использовании Ansible для управления устройствами F5 Networks см. на https://www.ansible.com/integrations/networks/f5.
- Требуется пакет f5-sdk Python на хосте. Это так же просто, как
pip install f5-sdk. - Требуется версия программного обеспечения 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
password: secret
server: lb.mydomain.com
state: present
user: admin
delegate_to: localhost
- name: Remove HTTPS Monitor
bigip_gtm_monitor_https:
name: my_monitor
state: absent
server: lb.mydomain.com
user: admin
password: secret
delegate_to: localhost
- name: Add HTTPS monitor for all addresses, port 514
bigip_gtm_monitor_https:
name: my_monitor
server: lb.mydomain.com
user: admin
port: 514
password: secret
delegate_to: localhost
Возвращаемые значения
Общие возвращаемые значения документированы здесь, следующие — поля, уникальные для данного модуля:
| Ключ | Возвращаемое | Описание |
|---|---|---|
| cipher_list строка | changed | Новое значение для списка шифров. Пример: +3DES:+kEDH |
| client_cert строка | changed | Новое значение параметра клиентского сертификата. Пример: /Common/default |
| client_key строка | changed | Новое значение параметра клиентского ключа. Пример: /Common/default |
| compatibility boolean | changed | Новое значение параметра совместимости SSL. Пример: True |
| ignore_down_response boolean | 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 boolean | changed | Новое значение для режима работы монитора в обратном порядке. |
| send строка | changed | Новая строка отправки для данного монитора. Пример: tcp строка для отправки |
| timeout целое число | changed | Новый таймаут, через который удалённая система должна ответить монитору. Пример: 10 |
| transparent boolean | changed | Новое значение для режима работы монитора в прозрачном режиме. |
Состояние
- Данный модуль не гарантирует обратную совместимость. [превью]
- Данный модуль поддерживается партнёром Ansible. [сертифицирован]
Авторы
- Tim Rupp (@caphrim007)
Подсказка
Если вы заметили проблемы в этой документации, вы можете отредактировать этот документ, чтобы улучшить его.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.7/modules/bigip_gtm_monitor_https_module.html
