bigip_monitor_https – Управляет мониторами F5 BIG-IP LTM https
Новая версия с 2.5.
Обзор
- Управляет мониторами F5 BIG-IP LTM https.
Требования
Ниже перечислены требования к хосту, на котором выполняется этот модуль.
- f5-sdk >= 3.0.16
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| description - добавлен в 2.7 | Описание монитора. | ||
| interval - | Интервал, определяющий частоту выполнения экземпляра монитора этой шаблона. Если этот параметр не указан при создании нового монитора, значение по умолчанию будет 5. Это значение должно быть меньше значения timeout. | ||
| ip - | Часть IP-адреса определения IP/порта. Если этот параметр не указан при создании нового монитора, значение по умолчанию будет '*'. | ||
| name - / обязательно | Имя монитора. | ||
| parent - | Значение по умолчанию: "/Common/https" | Родительский шаблон этого шаблона монитора. После установки этого значения его нельзя изменить. По умолчанию это значение равно родительскому шаблону https на разделе Common. | |
| partition - | Значение по умолчанию: "Common" | Раздел устройства для управления ресурсами. | |
| password - / обязательно | Пароль для учетной записи пользователя, используемой для подключения к BIG-IP. Вы можете опустить этот параметр, установив переменную среды F5_PASSWORD. псевдонимы: pass, pwd | ||
| port - | Адрес порта в определении IP/порта. Если этот параметр не указан при создании нового монитора, значение по умолчанию будет '*'. Обратите внимание, что при указании IP-адреса необходимо указать значение от 1 до 65535 | ||
| provider - добавлен в 2.5 | Значение по умолчанию: null | Объект словаря, содержащий данные подключения. | |
| 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 - | Строка приема для вызова монитора. | ||
| receive_disable - | Эта настройка работает как receive, за исключением того, что система отмечает узел или члена пула отключённым, когда его ответ соответствует строке receive_disable, но не строке receive. Чтобы использовать эту настройку, вы должны указать receive_disable и receive. | ||
| send - | Строка отправки для вызова монитора. При создании нового монитора, если это значение не указано, будет использоваться значение по умолчанию GET /\\r\\n. | ||
| server - / обязательно | Хост BIG-IP. Вы можете опустить этот параметр, установив переменную среды F5_SERVER. | ||
| server_port - добавлен в 2.2 | Значение по умолчанию: 443 | Порт сервера BIG-IP. Вы можете опустить этот параметр, установив переменную среды F5_SERVER_PORT. | |
| state - добавлен в 2.5 |
| Если present, гарантирует, что монитор существует.Если absent, гарантирует удаление монитора. | |
| target_password - | Указывает пароль, если контролируемый целевой объект требует аутентификации. | ||
| target_username - | Указывает имя пользователя, если контролируемый целевой объект требует аутентификации. | ||
| time_until_up - | Устанавливает время в секундах после первого успешного ответа, прежде чем узел будет помечен как активный. Значение 0 приведет к тому, что узел будет помечен как активный сразу после получения от него валидного ответа. Если этот параметр не указан при создании нового монитора, значение по умолчанию будет 0. | ||
| timeout - | Количество секунд, в течение которого узел или служба должны ответить на запрос монитора. Если целевой объект отвечает в заданный период времени, он считается активным. Если целевой объект не отвечает в заданный период времени, он считается неактивным. Вы можете изменить это значение на любое, но оно должно быть в 3 раза больше интервала в секундах плюс 1 секунда. Если этот параметр не указан при создании нового монитора, значение по умолчанию будет 16. | ||
| user - / обязательно | Имя пользователя для подключения к BIG-IP. Этот пользователь должен иметь административные привилегии на устройстве. Вы можете опустить этот параметр, установив переменную среды F5_USER. | ||
| validate_certs boolean добавлен в 2.0 |
| Если no, сертификаты SSL не проверяются. Используйте только на контролируемых вами сайтах с самозаверенными сертификатами.Вы можете опустить этот параметр, установив переменную среды F5_VALIDATE_CERTS. | |
Примечания
Примечание
- Требуется версия ПО BIG-IP >= 12
- Дополнительную информацию об использовании 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 HTTPS Monitor
bigip_monitor_https:
state: present
ip: 10.10.10.10
server: lb.mydomain.com
user: admin
password: secret
name: my_http_monitor
delegate_to: localhost
- name: Remove HTTPS Monitor
bigip_monitor_https:
state: absent
server: lb.mydomain.com
user: admin
password: secret
name: my_http_monitor
delegate_to: localhost
Значения возврата
Общие значения возврата описаны здесь, следующие поля уникальны для данного модуля:
| Ключ | Возвращаемое | Описание |
|---|---|---|
| description строка | changed | Описание монитора. Пример: Важный монитор |
| interval целое число | changed | Новый интервал для проверки монитора. Пример: 2 |
| ip строка | changed | Новый IP-адрес для определения IP/порта. Пример: 10.12.13.14 |
| parent строка | changed | Новая родительская шаблон монитора. Пример: https |
| time_until_up целое число | changed | Новое время, в течение которого система будет считаться активной после первой успешной реакции. Пример: 2 |
| timeout целое число | changed | Новый таймаут, в течение которого удаленная система должна ответить на запрос монитора. Пример: 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.7/modules/bigip_monitor_https_module.html
