bigip_monitor_udp – Управляет мониторами udp F5 BIG-IP LTM
Новая в версии 2.5.
Обзор
- Управляет мониторами udp F5 BIG-IP LTM.
Требования
Ниже перечислены требования к хосту, на котором выполняется этот модуль.
- f5-sdk >= 3.0.16
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| описание - добавлено в 2.7 | Описание монитора. | ||
| интервал - | Интервал, определяющий частоту запуска экземпляра монитора этой шаблона. Если этот параметр не указан при создании нового монитора, значение по умолчанию будет 5. Это значение должно быть меньше значения timeout. | ||
| ip - | Часть IP-адреса в определении IP/порт. Если этот параметр не указан при создании нового монитора, значение по умолчанию будет '*'. | ||
| имя - / обязательно | Имя монитора. | ||
| родитель - | По умолчанию: "/Common/udp" | Родительский шаблон этого шаблона монитора. После установки этого значения его нельзя изменить. По умолчанию это значение — родительский udp на раздела Common. | |
| раздел - добавлено в 2.5 | По умолчанию: "Common" | Раздел устройства для управления ресурсами. | |
| пароль - / обязательно | Пароль для учетной записи пользователя, используемой для подключения к BIG-IP. Вы можете опустить этот параметр, установив переменную среды F5_PASSWORD. псевдонимы: pass, pwd | ||
| порт - | Адрес порта в определении IP/порт. Если этот параметр не указан при создании нового монитора, значение по умолчанию будет '*'. Обратите внимание, что если указан IP-адрес, значение должно быть от 1 до 65535. | ||
| поставщик - добавлено в 2.5 | По умолчанию: null | Объект dict, содержащий данные подключения. | |
| пароль - / обязательно | Пароль для учетной записи пользователя, используемой для подключения к BIG-IP. Вы можете опустить этот параметр, установив переменную среды F5_PASSWORD. псевдонимы: pass, pwd | ||
| сервер - / обязательно | Хост BIG-IP. Вы можете опустить этот параметр, установив переменную среды F5_SERVER. | ||
| порт_сервера - | По умолчанию: 443 | Порт сервера BIG-IP. Вы можете опустить этот параметр, установив переменную среды F5_SERVER_PORT. | |
| ssh_keyfile - | Указывает файл SSH-ключа для аутентификации подключения к удаленному устройству. Этот аргумент используется только для транспортов cli. Вы можете опустить этот параметр, установив переменную среды ANSIBLE_NET_SSH_KEYFILE. | ||
| таймаут - | По умолчанию: 10 | Устанавливает таймаут в секундах для связи с сетевым устройством при подключении или отправке команд. Если таймаут истекает до завершения операции, модуль выдаст ошибку. | |
| транспорт - / обязательно |
| Настраивает транспортное соединение для подключения к удаленному устройству. | |
| пользователь - / обязательно | Имя пользователя для подключения к BIG-IP. Этот пользователь должен иметь административные привилегии на устройстве. Вы можете опустить этот параметр, установив переменную среды F5_USER. | ||
| проверять_сертификаты boolean |
| Если no, сертификаты SSL не проверяются. Используйте только на сайтах, контролируемых лично, с самоподписанными сертификатами.Вы можете опустить этот параметр, установив переменную среды F5_VALIDATE_CERTS. | |
| получить - | Строка получения для вызова монитора. | ||
| получить_отключить - | Эта настройка работает как receive, за исключением того, что система помечает узел или члена пула как отключенный, когда его ответ соответствует строке receive_disable, но не receive. Чтобы использовать эту настройку, необходимо указать и receive_disable, и receive. | ||
| отправить - | Строка отправки для вызова монитора. При создании нового монитора, если это значение не указано, будет использовано значение по умолчанию default send string. | ||
| сервер - / обязательно | Хост BIG-IP. Вы можете опустить этот параметр, установив переменную среды F5_SERVER. | ||
| порт_сервера - добавлено в 2.2 | По умолчанию: 443 | Порт сервера BIG-IP. Вы можете опустить этот параметр, установив переменную среды F5_SERVER_PORT. | |
| состояние - добавлено в 2.5 |
| Если present, гарантирует, что монитор существует.Если absent, гарантирует удаление монитора. | |
| время_до_активации - | Устанавливает время в секундах после первого успешного ответа, прежде чем узел будет помечен как активный. Значение 0 приведет к тому, что узел будет помечен как активный сразу после получения валидного ответа от узла. Если этот параметр не указан при создании нового монитора, значение по умолчанию будет 0. | ||
| таймаут - | Количество секунд, в течение которого узел или служба должны ответить на запрос монитора. Если целевой ресурс отвечает в заданный период времени, он считается активным. Если целевой ресурс не отвечает в течение заданного периода времени, он считается неактивным. Вы можете изменить это число на любое желаемое значение, однако оно должно быть в 3 раза больше интервала в секундах плюс 1 секунда. Если этот параметр не указан при создании нового монитора, значение по умолчанию будет 16. | ||
| пользователь - / обязательно | Имя пользователя для подключения к BIG-IP. Этот пользователь должен иметь административные привилегии на устройстве. Вы можете опустить этот параметр, установив переменную среды F5_USER. | ||
| проверять_сертификаты 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 UDP Monitor
bigip_monitor_udp:
state: present
ip: 10.10.10.10
server: lb.mydomain.com
user: admin
password: secret
name: my_udp_monitor
delegate_to: localhost
- name: Remove UDP Monitor
bigip_monitor_udp:
state: absent
server: lb.mydomain.com
user: admin
password: secret
name: my_udp_monitor
delegate_to: localhost
Значения возврата
Общие значения возврата документированы здесь, следующие являются полями, уникальными для данного модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| description строка | changed | Описание монитора. Пример: Важный монитор |
| interval целое число | changed | Новый интервал, в котором выполняется проверка монитора. Пример: 2 |
| ip строка | changed | Новый IP-адрес IP/порт-определения. Пример: 10.12.13.14 |
| parent строка | changed | Новый родительский шаблон монитора. Пример: http |
| 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_udp_module.html
