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.16
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| description - добавлен в 2.7 | Описание монитора. | ||
| 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 | По умолчанию: 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. | |
| 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 раза больше значения параметра interval плюс 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 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
Значения возврата
Общие значения возврата описаны здесь, следующие являются полями, уникальными для этого модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| description строка | changed | Описание монитора. Пример: Важный монитор |
| interval целое число | changed | Новый интервал для выполнения проверки монитора. Пример: 2 |
| ip строка | changed | Новый IP адрес IP/порт определения. Пример: 10.12.13.14 |
| parent строка | changed | Новая родительская шаблон монитора. Пример: tcp |
| 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_tcp_half_open_module.html
