Spec-Zone.ru › Ansible

Модуль f5networks.f5_modules.bigip_gtm_monitor_tcp_half_open — Управляет мониторами TCP-соединений с половинным открытием F5 BIG-IP GTM

Примечание

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

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

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

Чтобы использовать его в книге задач, укажите: f5networks.f5_modules.bigip_gtm_monitor_tcp_half_open.

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

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

Обзор

  • Управляет мониторами TCP-соединений с половинным открытием F5 BIG-IP GTM (сейчас BIG-IP DNS).

Параметры

Параметр

Комментарии

ignore_down_response

boolean

Указывает, что монитор допускает более одной попытки зондирования за интервал.

Когда true, указывает, что монитор игнорирует ответы о недоступности в течение времени ожидания монитора. После истечения времени ожидания монитора без получения ответа о доступности система помечает объект как недоступный.

Когда false, указывает, что монитор немедленно помечает объект как недоступный при получении ответа о недоступности.

При создании нового монитора, если этот параметр не указан, будет использовано значение по умолчанию false.

Варианты:

  • false
  • true

interval

integer

Указывает, в секундах, частоту, с которой система выполняет проверку монитора, когда ресурс недоступен или его состояние неизвестно.

При создании нового монитора, если этот параметр не указан, значение по умолчанию будет 30. Это значение должно быть меньше значения timeout.

ip

string

Часть определения IP-адрес/порт в формате IP-адрес. Если этот параметр не указан при создании нового монитора, значение по умолчанию будет ‘*’.

name

string / required

Имя монитора.

parent

string

Родительский шаблон этого шаблона монитора. После установки это значение не может быть изменено. По умолчанию это значение — родительский tcp_half_open в разделе Common.

По умолчанию: "/Common/tcp_half_open"

partition

string

Раздел устройства для управления ресурсами.

По умолчанию: "Common"

port

string

Часть определения IP-адрес/порт в формате номер порта. Если этот параметр не указан при создании нового монитора, значение по умолчанию будет ‘*’. Обратите внимание, что при использовании IP-адреса необходимо указать значение от 1 до 65535.

probe_attempts

integer

Указывает количество попыток зондирования хост-сервера системой, после которых система считает хост-сервер недоступным.

При создании нового монитора, если этот параметр не указан, значение по умолчанию будет 3.

probe_interval

integer

Указывает количество секунд, которые процесс big3d ожидает перед отправкой последующей попытки зондирования при сбое зондирования и запросе нескольких попыток зондирования.

При создании нового монитора, если этот параметр не указан, значение по умолчанию будет 1.

probe_timeout

integer

Указывает количество секунд, по истечении которых система завершает запрос зондирования к системе по таймауту.

При создании нового монитора, если этот параметр не указан, значение по умолчанию будет 5.

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

псевдонимы: 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 / обязательно

Имя пользователя для подключения к BIG-IP или BIG-IQ. Этот пользователь должен иметь административные права на устройстве.

Вы можете опустить этот параметр, установив переменную среды F5_USER.

validate_certs

boolean

Если no, сертификаты SSL не проверяются. Используйте только на сайтах, контролируемых лично, с самозаверяющими сертификатами.

Вы можете опустить этот параметр, установив переменную среды F5_VALIDATE_CERTS.

Варианты:

  • false
  • true ← (по умолчанию)

state

string

При present, гарантируется существование монитора.

При absent, гарантируется удаление монитора.

Варианты:

  • "present" ← (по умолчанию)
  • "absent"

timeout

integer

Устанавливает количество секунд, в течение которого целевой объект должен ответить на запрос монитора.

Если целевой объект отвечает в течение установленного периода, он считается активным.

Если целевой объект не отвечает в течение установленного периода, он считается неактивным.

Если это значение установлено в 0 (ноль), система использует интервал из родительского монитора.

При создании нового монитора, если этот параметр не указан, значение по умолчанию будет 120.

transparent

boolean

Указывает, работает ли монитор в прозрачном режиме.

Монитор в прозрачном режиме направляет трафик через ассоциированных членов пула или узлов (обычно маршрутизатор или брандмауэр) к алиасному пункту назначения (то есть, он проверяет комбинацию ip-port, указанную в мониторе).

Если монитор не может успешно достичь алиасного пункта назначения, член пула или узел, через который направлялся трафик монитора, помечается как неактивный.

При создании нового монитора, если этот параметр не указан, значение по умолчанию будет false.

Варианты:

  • false
  • true

Примечания

Примечание

  • Требуется версия ПО 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 half-open Monitor
  bigip_gtm_monitor_tcp_half_open:
    state: present
    ip: 10.10.10.10
    name: my_monitor
    provider:
      user: admin
      password: secret
      server: lb.mydomain.com
  delegate_to: localhost

- name: Remove TCP half-open Monitor
  bigip_gtm_monitor_tcp_half_open:
    state: absent
    name: my_monitor
    provider:
      user: admin
      password: secret
      server: lb.mydomain.com
  delegate_to: localhost

- name: Add half-open monitor for all addresses, port 514
  bigip_gtm_monitor_tcp_half_open:
    port: 514
    name: my_monitor
    provider:
      user: admin
      password: secret
      server: lb.mydomain.com
  delegate_to: localhost

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

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

Ключ

Описание

interval

целое число

Новый интервал для выполнения проверки монитора.

Возвращается: изменён

Пример: 2

ip

строка

Новый IP-адрес определения IP/порта.

Возвращается: изменён

Пример: "10.12.13.14"

parent

строка

Новая родительская шаблон монитора.

Возвращается: изменён

Пример: "tcp_half_open"

probe_attempts

целое число

Новое количество попыток, которые система предпримет при проверке зонда монитора.

Возвращается: изменён

Пример: 10

probe_interval

целое число

Новый интервал, в течение которого система будет проверять зонд монитора.

Возвращается: изменён

Пример: 10

probe_timeout

целое число

Новый таймаут, в течение которого система будет ожидать ответа зонда монитора.

Возвращается: изменён

Пример: 10

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_gtm_monitor_tcp_half_open_module.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API