bigip_monitor_tcp_half_open - Управляет мониторами F5 BIG-IP LTM tcp half-open
Новое в версии 2.4.
Описание
- Управляет мониторами F5 BIG-IP LTM tcp half-open.
Требования
Ниже приведены требования к хосту, на котором будет выполняться этот модуль.
- f5-sdk >= 3.0.9
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| interval | Интервал, определяющий частоту запуска экземпляра монитора этой темы. Если этот параметр не указан при создании нового монитора, значение по умолчанию будет 5. Это значение должно быть меньше значения timeout. | ||
| ip | Часть IP-адреса определения IP/порта. Если этот параметр не указан при создании нового монитора, значение по умолчанию будет '*'. Если это значение — IP-адрес, и type равен tcp (по умолчанию), то необходимо указать число port. | ||
| name обязательно | Имя монитора. | ||
| parent | По умолчанию: "/Common/tcp_half_open" | Родительская тема этого шаблона монитора. После установки этого значения его нельзя изменить. По умолчанию это родительский tcp_half_open на Common разделе. | |
| partition (добавлен в 2.5) | По умолчанию: "Common" | Раздел устройства для управления ресурсами. | |
| password обязательно | Пароль учетной записи пользователя для подключения к BIG-IP. Можно опустить этот параметр, если установлена переменная окружения F5_PASSWORD. псевдонимы: pass, pwd | ||
| port (добавлен в 2.5) | Адрес порта для определения IP/порта. Если этот параметр не указан при создании нового монитора, значение по умолчанию будет '*'. Обратите внимание, что если указан IP-адрес, необходимо указать значение от 1 до 65535. | ||
| provider (добавлен в 2.5) | Объект словаря, содержащий данные подключения. | ||
| password обязательно | Пароль учетной записи пользователя для подключения к BIG-IP. Можно опустить этот параметр, если установлена переменная окружения F5_PASSWORD. псевдонимы: pass, pwd | ||
| server обязательно | Хост BIG-IP. Можно опустить этот параметр, если установлена переменная окружения F5_SERVER. | ||
| server_port | По умолчанию: 443 | Порт сервера BIG-IP. Можно опустить этот параметр, если установлена переменная окружения F5_SERVER_PORT. | |
| user обязательно | Имя пользователя для подключения к BIG-IP. Этот пользователь должен иметь административные привилегии на устройстве. Можно опустить этот параметр, если установлена переменная окружения F5_USER. | ||
| validate_certs bool |
| Если no, сертификаты SSL не будут проверены. Используйте только на сайтах, контролируемых вами, с самозаверенными сертификатами. Можно опустить этот параметр, если установлена переменная окружения F5_VALIDATE_CERTS. | |
| timeout | По умолчанию: 10 | Устанавливает таймаут в секундах для связи с сетевым устройством для подключения или отправки команд. Если таймаут превышен до завершения операции, модуль выдаст ошибку. | |
| ssh_keyfile | Указывает SSH-ключ для аутентификации подключения к удаленному устройству. Этот аргумент используется только для транспортов cli. Если значение не указано в задаче, вместо него используется значение переменной окружения ANSIBLE_NET_SSH_KEYFILE. | ||
| transport обязательно |
| Настраивает транспортное соединение для подключения к удаленному устройству. | |
| server обязательно | Хост BIG-IP. Можно опустить этот параметр, если установлена переменная окружения F5_SERVER. | ||
| server_port (добавлен в 2.2) | По умолчанию: 443 | Порт сервера BIG-IP. Можно опустить этот параметр, если установлена переменная окружения F5_SERVER_PORT. | |
| state (добавлен в 2.5) |
| Когда present, гарантирует, что монитор существует.Когда absent, гарантирует удаление монитора. | |
| time_until_up | Устанавливает время в секундах после первого успешного ответа, прежде чем узел будет помечен как активный. Значение 0 приведет к тому, что узел будет помечен как активный сразу после получения корректного ответа от узла. Если этот параметр не указан при создании нового монитора, значение по умолчанию будет 0. | ||
| timeout | Количество секунд, в течение которого узел или служба должны ответить на запрос монитора. Если цель отвечает в установленный период времени, она считается активной. Если цель не отвечает в установленный период времени, она считается неактивной. Вы можете изменить это число на любое необходимое, однако оно должно быть в 3 раза больше интервала в секундах плюс 1 секунда. Если этот параметр не указан при создании нового монитора, значение по умолчанию будет 16. | ||
| user обязательно | Имя пользователя для подключения к BIG-IP. Этот пользователь должен иметь административные привилегии на устройстве. Можно опустить этот параметр, если установлена переменная окружения F5_USER. | ||
| validate_certs bool (добавлен в 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 TCP half-open Monitor
bigip_monitor_tcp_half_open:
state: present
ip: 10.10.10.10
server: lb.mydomain.com
user: admin
password: secret
name: my_tcp_monitor
delegate_to: localhost
- name: Remove TCP half-open Monitor
bigip_monitor_tcp_half_open:
state: absent
server: lb.mydomain.com
user: admin
password: secret
name: my_tcp_monitor
delegate_to: localhost
- name: Add half-open monitor for all addresses, port 514
bigip_monitor_tcp_half_open:
server: lb.mydomain.com
user: admin
port: 514
password: secret
name: my_tcp_monitor
delegate_to: localhost
Возвращаемые значения
Общие возвращаемые значения документированы здесь, следующие поля уникальны для этого модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| interval int | изменённое | Новый интервал, в котором следует запускать проверку монитора. Пример: 2 |
| ip string | изменённое | Новый IP-адрес определения IP/порт. Пример: 10.12.13.14 |
| parent string | изменённое | Новая родительская шаблон монитора. Пример: tcp |
| time_until_up int | изменённое | Новое время, в течение которого система должна быть помечена как активная после первого успешного ответа. Пример: 2 |
| timeout int | изменённое | Новый тайм-аут, в течение которого удалённая система должна ответить на запрос монитора. Пример: 10 |
Статус
Этот модуль помечен как превью, что означает, что его интерфейс не гарантируется как обратной совместимости.
Техническое обслуживание
Этот модуль помечен как сообщество, что означает, что он поддерживается сообществом Ansible. Дополнительную информацию см. в разделе Техническое обслуживание и поддержка модулей.
Список других модулей, также поддерживаемых сообществом 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.6/modules/bigip_monitor_tcp_half_open_module.html