Модуль f5networks.f5_modules.bigip_monitor_tcp_echo — управление TCP echo-мониторами F5 BIG-IP LTM
Примечание
Этот модуль входит в коллекцию f5networks.f5_modules (версия 1.39.0).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install f5networks.f5_modules.
Чтобы использовать её в плейбуке, укажите: f5networks.f5_modules.bigip_monitor_tcp_echo.
Добавлено в f5networks.f5_modules 1.0.0
Краткое описание
- Управление TCP echo-мониторами F5 BIG-IP LTM.
Параметры
Параметр | Комментарии |
|---|---|
description string | Описание монитора. |
interval integer | Интервал, задающий частоту запуска экземпляра монитора этого шаблона. Если при создании нового монитора этот параметр не указан, используется значение по умолчанию 5. Это значение должно быть меньше значения |
ip string | IP-адрес в определении IP/порта. Если при создании нового монитора этот параметр не указан, используется значение по умолчанию ‘*’. |
name string / обязательный | Имя монитора. |
parent string | Родительский шаблон этого шаблона монитора. После установки это значение нельзя изменить. По умолчанию используется родительский объект По умолчанию: |
partition string | Раздел устройства, в котором будут управляться ресурсы. По умолчанию: |
provider dictionary добавлено в f5networks.f5_modules 1.0.0 | Объект dict, содержащий сведения для подключения. |
|
auth_provider string |
Настраивает поставщика аутентификации для получения токенов аутентификации с удалённого устройства. Этот параметр используется при работе с устройствами BIG-IQ. |
|
no_f5_teem boolean |
Если Этот параметр можно не указывать, задав переменную среды Ранее использовавшаяся переменная Варианты:
|
|
password псевдонимы: pass, pwd string / обязательный |
Пароль учётной записи пользователя, используемой для подключения к BIG-IP или BIG-IQ. Этот параметр можно не указывать, задав переменную среды |
|
server string / обязательный |
Узел BIG-IP или BIG-IQ. Этот параметр можно не указывать, задав переменную среды |
|
server_port integer |
Порт сервера BIG-IP. Этот параметр можно не указывать, задав переменную среды По умолчанию: |
|
timeout integer |
Задаёт время ожидания в секундах при взаимодействии с сетевым устройством — для подключения или отправки команд. Если время ожидания истечёт до завершения операции, модуль выдаст ошибку. |
|
transport string |
Настраивает транспортное соединение, используемое при подключении к удалённому устройству. Варианты:
|
|
user string / обязательный |
Имя пользователя для подключения к BIG-IP или BIG-IQ. У этого пользователя должны быть права администратора на устройстве. Этот параметр можно не указывать, задав переменную среды |
|
validate_certs boolean |
Если Этот параметр можно не указывать, задав переменную среды Варианты:
|
state string | Если Если Варианты:
|
time_until_up integer | Задаёт время в секундах после первого успешного ответа, по истечении которого узел будет считаться доступным. Значение |
timeout integer | Количество секунд, в течение которых узел или служба должны ответить на запрос монитора. Если целевой объект ответит в течение заданного периода, он считается доступным. Если целевой объект не ответит в течение заданного периода, он считается недоступным. Можно указать любое значение, однако оно должно быть равно тройному значению интервала в секундах плюс 1 секунда. Если при создании нового монитора этот параметр не указан, по умолчанию используется значение 16. |
Примечания
Примечание
- Требуется версия ПО BIG-IP >= 12
- Дополнительную информацию об использовании Ansible для управления устройствами F5 Networks см. на странице https://www.ansible.com/integrations/networks/f5.
- Требуется версия ПО BIG-IP >= 12.
- Модули F5 изменяют только текущую конфигурацию продукта F5. Чтобы обеспечить сохранение специфичной для BIG-IP конфигурации на диск, включите как минимум одну задачу, использующую модуль f5networks.f5_modules.bigip_config для сохранения текущей конфигурации. Инструкции по правильному использованию модуля для сохранения текущей конфигурации см. в документации модуля.
Примеры
- name: Create TCP Echo Monitor
bigip_monitor_tcp_echo:
state: present
ip: 10.10.10.10
name: my_tcp_monitor
provider:
password: secret
server: lb.mydomain.com
user: admin
delegate_to: localhost
- name: Remove TCP Echo Monitor
bigip_monitor_tcp_echo:
state: absent
name: my_tcp_monitor
provider:
server: lb.mydomain.com
user: admin
password: secret
delegate_to: localhost
Возвращаемые значения
Общие возвращаемые значения описаны здесь; ниже перечислены поля, уникальные для этого модуля:
Ключ | Описание |
|---|---|
description string | Описание монитора. Возвращается: при изменении Пример: |
interval integer | Новый интервал запуска проверки монитора. Возвращается: при изменении Пример: |
ip string | Новый IP-адрес в определении IP/порта. Возвращается: при изменении Пример: |
parent string | Новый родительский шаблон монитора. Возвращается: при изменении Пример: |
time_until_up integer | Новое время, по истечении которого система будет считаться доступной после первого успешного ответа. Возвращается: при изменении Пример: |
timeout integer | Новое время ожидания ответа удалённой системы на запрос монитора. Возвращается: при изменении Пример: |
Ссылки на коллекцию
© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/f5networks/f5_modules/bigip_monitor_tcp_echo_module.html
