bigip_monitor_external – Управляет внешними мониторами LTM на BIG-IP
Новая в версии 2.6.
Краткое описание
- Управляет внешними мониторами LTM на BIG-IP.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| arguments строка | Указывает любые аргументы командной строки, необходимые скрипту. | ||
| description строка добавлен в 2.7 | Описание монитора. | ||
| external_program строка | Указывает имя файла, используемого монитором. Для ссылки на файл необходимо сначала импортировать его, используя опции в меню Система > Управление файлами > Список внешних программ мониторинга > Импорт. Система BIG-IP автоматически поместит файл в соответствующее место на файловой системе. | ||
| interval целое число | Интервал, определяющий частоту запуска экземпляра монитора этой шаблона. Если этот параметр не указан при создании нового монитора, то значение по умолчанию будет 5. Это значение **должно** быть меньше значения timeout. | ||
| ip строка | Часть IP-адреса в определении IP/порт. Если этот параметр не указан при создании нового монитора, то значение по умолчанию будет '*'. | ||
| name строка / обязательно | Указывает имя монитора. | ||
| parent строка | По умолчанию: "/Common/external" | Родительский шаблон этого шаблона монитора. После установки этого значения его нельзя изменить. По умолчанию это значение является http родительским шаблоном на Common раздела. | |
| partition строка | По умолчанию: "Common" | Раздел устройства для управления ресурсами. | |
| port строка | Адрес порта в определении IP/порт. Если этот параметр не указан при создании нового монитора, то значение по умолчанию будет '*'. Обратите внимание, что при указании IP-адреса должно быть указано значение от 1 до 65535. | ||
| provider словарь добавлен в 2.5 | Объект словаря, содержащий сведения о подключении. | ||
| auth_provider строка | Настраивает поставщика аутентификации для получения маркеров аутентификации от удаленного устройства. Этот параметр используется при работе с устройствами BIG-IQ. | ||
| 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 целое число | Указывает таймаут в секундах для связи с сетевым устройством для подключения или отправки команд. Если таймаут превышен до завершения операции, модуль вернет ошибку. | ||
| transport строка |
| Настраивает транспортное соединение для подключения к удаленному устройству. | |
| user строка / обязательно | Имя пользователя для подключения к BIG-IP. Этот пользователь должен иметь административные привилегии на устройстве. Вы можете опустить этот параметр, установив переменную среды F5_USER. | ||
| validate_certs логическое значение |
| Если no, сертификаты SSL не проверяются. Используйте только на сайтах, контролируемых лично, с самоподписанными сертификатами.Вы можете опустить этот параметр, установив переменную среды F5_VALIDATE_CERTS. | |
| state строка |
| Когда present, гарантирует, что монитор существует.Когда absent, гарантирует удаление монитора. | |
| timeout целое число | Количество секунд, в течение которых узел или служба должны ответить на запрос монитора. Если целевой объект отвечает в установленный период времени, он считается активным. Если целевой объект не отвечает в установленный период времени, он считается неактивным. Вы можете изменить это число на любое значение, но оно должно быть в 3 раза больше интервала в секундах плюс 1 секунда. Если этот параметр не указан при создании нового монитора, то значение по умолчанию будет 16. | ||
| variables словарь | Указывает любые переменные, необходимые скрипту. Обратите внимание, что двойные кавычки в значениях будут подавлены. | ||
Примечания
Примечание
- Дополнительную информацию об использовании Ansible для управления устройствами F5 Networks см. на странице https://www.ansible.com/integrations/networks/f5.
- Требуется версия ПО BIG-IP >= 12.
- Модули F5 изменяют только текущую конфигурацию продукта F5. Чтобы убедиться, что конфигурация BIG-IP сохранится на диске, необходимо включить, как минимум, одну задачу, которая использует модуль bigip_config для сохранения текущей конфигурации. Обратитесь к документации модуля для правильного использования модуля для сохранения текущей конфигурации.
Примеры
- name: Create an external monitor
bigip_monitor_external:
name: foo
state: present
provider:
user: admin
password: secret
server: lb.mydomain.com
delegate_to: localhost
- name: Create an external monitor with variables
bigip_monitor_external:
name: foo
timeout: 10
variables:
var1: foo
var2: bar
state: present
provider:
user: admin
password: secret
server: lb.mydomain.com
delegate_to: localhost
- name: Add a variable to an existing set
bigip_monitor_external:
name: foo
timeout: 10
variables:
var1: foo
var2: bar
cat: dog
state: present
provider:
user: admin
password: secret
server: lb.mydomain.com
delegate_to: localhost
Значения возврата
Общие значения возврата описаны в этом месте, следующие являются полями, уникальными для данного модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| description строка | изменённое | Описание монитора. Пример: Важный монитор |
| interval целое число | изменённое | Новый интервал для проверки монитора. Пример: 2 |
| ip строка | изменённое | Новый IP-адрес определения IP/порта. Пример: 10.12.13.14 |
| parent строка | изменённое | Новая родительская шаблон монитора. Пример: external |
| timeout целое число | изменённое | Новый таймаут, в течение которого удаленная система должна ответить на монитор. Пример: 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.9/modules/bigip_monitor_external_module.html