bigip_monitor_https - Управляет мониторами https F5 BIG-IP LTM
Новое в версии 2.5.
Описание
- Управляет мониторами https F5 BIG-IP LTM.
Требования
Ниже перечислены требования к хосту, на котором будет выполняться этот модуль.
- f5-sdk >= 3.0.9
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| 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) | По умолчанию: None | Объект словаря, содержащий сведения о подключении. | |
| ssh_keyfile | Указывает SSH-ключевой файл для аутентификации подключения к удаленному устройству. Этот аргумент используется только для транспортов cli. Если значение не указано в задаче, будет использовано значение переменной окружения ANSIBLE_NET_SSH_KEYFILE. | ||
| timeout | По умолчанию: 10 | Устанавливает таймаут в секундах для связи с сетевым устройством при подключении или отправке команд. Если таймаут истекает до завершения операции, модуль выдаст ошибку. | |
| server обязательно | Хост BIG-IP. Вы можете опустить этот параметр, если переменная окружения F5_SERVER установлена. | ||
| user обязательно | Имя пользователя для подключения к BIG-IP. Этот пользователь должен иметь административные привилегии на устройстве. Вы можете опустить этот параметр, если переменная окружения F5_USER установлена. | ||
| server_port | По умолчанию: 443 | Порт сервера BIG-IP. Вы можете опустить этот параметр, если переменная окружения F5_SERVER_PORT установлена. | |
| password обязательно | Пароль учетной записи пользователя для подключения к BIG-IP. Вы можете опустить этот параметр, если переменная окружения F5_PASSWORD установлена.псевдонимы: pass, pwd | ||
| validate_certs |
| Если no, сертификаты SSL не будут проверяться. Используйте только на сайтах, контролируемых вами лично, использующих самозаверенные сертификаты. Вы можете опустить этот параметр, если переменная окружения F5_VALIDATE_CERTS установлена. | |
| transport обязательно |
| Настраивает транспортное подключение, которое будет использоваться при подключении к удаленному устройству. | |
| 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 (добавлено в 2.0) |
| Если no, сертификаты SSL не будут проверены. Используйте только на сайтах, контролируемых вами лично, использующих самозаверенные сертификаты. Вы можете опустить этот параметр, если переменная окружения F5_VALIDATE_CERTS установлена. | |
Примечания
Примечание
- Требуется версия ПО BIG-IP >= 12
- Дополнительную информацию об использовании Ansible для управления устройствами F5 Networks см. на странице https://www.ansible.com/integrations/networks/f5.
- На хосте требуется пакет Python f5-sdk. Это так же просто, как
pip install f5-sdk.
Примеры
- 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
Значения возврата
Общие значения возврата описаны здесь, следующие поля уникальны для этого модуля:
| Ключ | Возвращаемое | Описание |
|---|---|---|
| interval int | изменённое | Новый интервал, в котором следует выполнять проверку монитора. Пример: 2 |
| ip string | изменённое | Новый IP-адрес определения IP/порт. Пример: 10.12.13.14 |
| parent string | изменённое | Новая родительская шаблон монитора. Пример: https |
| time_until_up int | изменённое | Новое время, в течение которого система должна быть помечена как активная после первого успешного ответа. Пример: 2 |
| timeout int | изменённое | Новый таймаут, в течение которого удалённая система должна ответить на монитор. Пример: 10 |
Состояние
Этот модуль помечен как превью, что означает, что он не гарантирует обратной совместимости интерфейса.
Автор
- 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.5/modules/bigip_monitor_https_module.html
