f5networks.f5_modules.bigip_monitor_tcp модуль — Управление мониторами F5 BIG-IP LTM TCP

Примечание

Этот модуль является частью коллекции f5networks.f5_modules (версия 1.31.0).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.

Для установки используйте: ansible-galaxy collection install f5networks.f5_modules.

Для использования в плейбуке укажите: f5networks.f5_modules.bigip_monitor_tcp.

Добавлен в f5networks.f5_modules 1.0.0

Обзор
Параметры
Примечания
Примеры
Значения возврата

Обзор

Управляет мониторами F5 BIG-IP LTM TCP через iControl REST API.

Параметры

Параметр	Комментарии
description string	Описание монитора.
interval integer	Интервал, указывающий, как часто будет выполняться экземпляр монитора этого шаблона. Если этот параметр не указан при создании нового монитора, используется значение по умолчанию 5. Это значение должно быть меньше значения `timeout`.
ip aliases: alias_address string	IP-адрес в определении IP/порт. Если этот параметр не указан при создании нового монитора, используется значение по умолчанию ‘’. Если это значение является IP-адресом, и `type` равен `tcp` (значение по умолчанию), то необходимо указать `port` номер. В интерфейсе управления BIG IP это поле называется Alias Address*.
name string / required	Имя монитора.
parent string	Родительский шаблон этого шаблона монитора. После установки это значение нельзя изменить. По умолчанию это значение является родительским `tcp` в разделе `Common`. По умолчанию: `"/Common/tcp"`
partition string	Раздел устройства для управления ресурсами. По умолчанию: `"Common"`
port aliases: alias_service_port string	Порт в определении IP/порт. Если этот параметр не указан при создании нового монитора, используется значение по умолчанию ‘’. При указании IP-адреса необходимо указать значение от 1 до 65535. Этот аргумент не поддерживается для типов TCP Echo. В интерфейсе управления BIG IP это поле называется Alias Service Port*.
provider dictionary добавлено в f5networks.f5_modules 1.0.0	Объект dict, содержащий данные подключения.
auth_provider string	Настраивает поставщика авторизации для получения маркеров аутентификации от удаленного устройства. Этот параметр используется при работе с устройствами BIG-IQ.
no_f5_teem boolean	Если `yes`, данные телеметрии TEEM не отправляются в F5. Вы можете пропустить этот параметр, установив переменную среды `F5_TELEMETRY_OFF`. Ранее использовавшаяся переменная `F5_TEEM` устарела, так как ее имя было непонятным. Варианты: `false` ← (по умолчанию) `true`
password aliases: pass, pwd string / required	Пароль для учетной записи пользователя, используемой для подключения к BIG-IP или BIG-IQ. Вы можете пропустить этот параметр, установив переменную среды `F5_PASSWORD`.
server string / required	Хост BIG-IP или хост BIG-IQ. Вы можете пропустить этот параметр, установив переменную среды `F5_SERVER`.
server_port integer	Порт сервера BIG-IP. Вы можете пропустить этот параметр, установив переменную среды `F5_SERVER_PORT`. По умолчанию: `443`
timeout integer	Указывает время ожидания в секундах для связи с сетевым устройством для подключения или отправки команд. Если время ожидания превышено до завершения операции, модуль выдаст ошибку.
transport string	Настраивает транспортное соединение, которое будет использоваться при подключении к удаленному устройству. Варианты: `"rest"` ← (по умолчанию)
user string / required	Имя пользователя для подключения к BIG-IP или BIG-IQ. Этот пользователь должен иметь права администратора на устройстве. Вы можете пропустить этот параметр, установив переменную среды `F5_USER`.
validate_certs boolean	Если `no`, SSL-сертификаты не проверяются. Используйте это только на лично контролируемых сайтах, использующих самозаверяющие сертификаты. Вы можете пропустить этот параметр, установив переменную среды `F5_VALIDATE_CERTS`. Варианты: `false` `true` ← (по умолчанию)
receive string	Строка ответа для вызова монитора.

receive_disable string	Строка Receive Disable для вызова монитора. Эта настройка работает как `receive`, за исключением того, что система помечает узел или члена пула как отключенный, когда его ответ соответствует строке `receive_disable`, но не `receive`. Чтобы использовать эту настройку, вы должны указать как `receive_disable`, так и `receive`.
send string	Строка отправки для вызова монитора.
state string	Когда `present`, гарантирует существование монитора. Когда `absent`, гарантирует удаление монитора. Варианты: `"present"` ← (по умолчанию) `"absent"`
time_until_up integer	Указывает количество секунд после первого успешного ответа, прежде чем узел будет помечен как активный. Значение `0` заставляет узел быть помеченным как активным сразу после получения действительного ответа от узла. Если этот параметр не указан при создании нового монитора, значение по умолчанию равно `0`.
timeout integer	Количество секунд, в течение которых узел или служба должны ответить на запрос монитора. Если целевой объект отвечает в заданный период времени, он считается активным. Если целевой объект не отвечает в течение заданного периода времени, он считается неактивным. Вы можете изменить это число на любое желаемое число, однако оно должно быть в 3 раза больше интервала в секундах плюс 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 Monitor
  bigip_monitor_tcp:
    state: present
    name: my_tcp_monitor
    send: tcp string to send
    receive: tcp string to receive
    provider:
      server: lb.mydomain.com
      user: admin
      password: secret
  delegate_to: localhost

- name: Remove TCP Monitor
  bigip_monitor_tcp:
    state: absent
    name: my_tcp_monitor
    provider:
      server: lb.mydomain.com
      user: admin
      password: secret
  delegate_to: localhost

Значения возврата

Общие значения возврата документированы здесь, следующие — поля, уникальные для данного модуля:

Ключ	Описание
description строка	Описание монитора. Возвращено: изменённо Пример: `"Important Monitor"`
interval целое число	Новый интервал, с которым будет выполняться проверка монитора. Возвращено: изменённо Пример: `2`
ip строка	Новый IP-адрес определения IP/порт. Возвращено: изменённо Пример: `"10.12.13.14"`
parent строка	Новая родительская шаблон монитора. Возвращено: изменённо Пример: `"tcp"`
port строка	Новый порт определения IP/порт. Возвращено: изменённо Пример: `"admin@root.local"`
receive строка	Новая строка Приёма для данного монитора. Возвращено: изменённо Пример: `"tcp string to receive"`
receive_disable строка	Новая строка Отключить Приём для данного монитора. Возвращено: изменённо Пример: `"tcp string to receive"`
send строка	Новая строка Отправки для данного монитора. Возвращено: изменённо Пример: `"tcp string to send"`
time_until_up целое число	Новое время, в течение которого система будет отмечена как активная после первого успешного ответа. Возвращено: изменённо Пример: `2`
timeout целое число	Новый таймаут, в течение которого удалённая система должна ответить на монитор. Возвращено: изменённо Пример: `10`

Авторы

Tim Rupp (@caphrim007)
Wojciech Wypior (@wojtek0806)

Ссылки на коллекцию

© 2012–2018 Michael DeHaan
© 2018–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/f5networks/f5_modules/bigip_monitor_tcp_module.html