community.network.avi_healthmonitor модуль — Модуль для настройки объекта HealthMonitor Avi RESTful

Примечание

Этот модуль входит в коллекцию community.network (версия 5.0.3).

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

Чтобы установить её, используйте: ansible-galaxy collection install community.network. Для использования этого модуля необходимы дополнительные требования, см. Требования для получения подробной информации.

Для использования в плейбуке укажите: community.network.avi_healthmonitor.

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

Обзор

Этот модуль используется для настройки объекта HealthMonitor
Больше примеров можно найти на странице https://github.com/avinetworks/devops

Псевдонимы: network.avi.avi_healthmonitor

Требования

Ниже приведены требования, необходимые на хосте, на котором выполняется этот модуль.

avisdk

END_OF_DOCUMENT_MARKER

Параметры

Параметр	Комментарии
api_context словарь	Контекст API Avi, включающий текущий идентификатор сессии и маркер CSRF. Это позволяет пользователю выполнить одно вход в систему и повторно использовать сессию.
api_version строка	Версия API Avi для использования с API Avi и объектами. Значение по умолчанию: `"16.4.4"`
avi_api_patch_op строка	Операция обновления, используемая при использовании avi_api_update_method как patch. Варианты: `"add"` `"replace"` `"delete"`
avi_api_update_method строка	Метод обновления объекта по умолчанию — HTTP PUT. Установка в значение patch переопределяет это поведение, используя HTTP PATCH. Варианты: `"put"` ← (по умолчанию) `"patch"`
avi_credentials словарь	Словарь учетных данных Avi, который можно использовать вместо перечисления данных входа в контроллер Avi.
api_version строка	Версия контроллера Avi Значение по умолчанию: `"16.4.4"`
controller строка	IP-адрес или SQDN контроллера
csrftoken строка	Маркер CSRF API контроллера Avi для повторного использования существующей сессии с идентификатором сессии Значение по умолчанию: `""`
password строка	Пароль контроллера Avi
port строка	Порт контроллера Avi
session_id строка	Идентификатор сессии API контроллера Avi для повторного использования существующей сессии с csrftoken Значение по умолчанию: `""`
tenant строка	Тенент контроллера Avi Значение по умолчанию: `"admin"`
tenant_uuid строка	UUID тенента контроллера Avi Значение по умолчанию: `""`
timeout строка	Таймаут запроса контроллера Avi Значение по умолчанию: `300`
token строка	Токен API контроллера Avi Значение по умолчанию: `""`
username строка	Имя пользователя контроллера Avi
avi_disable_session_cache_as_fact логический	Отключает кеширование информации о сессии Avi в качестве факта. Варианты: `false` ← (по умолчанию) `true`
controller строка	IP-адрес или имя хоста контроллера. Значение по умолчанию — переменная среды `AVI_CONTROLLER`
description строка	Пользовательское описание объекта.
dns_monitor строка	Настройки dns для мониторинга работоспособности.
external_monitor строка	Настройки external для мониторинга работоспособности.
failed_checks строка	Количество непрерывных сбоев мониторинга работоспособности до того, как сервер помечен как нерабочий. Допустимые значения: 1-50. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как 2.

http_monitor string	Настройки Healthmonitorhttp для healthmonitor.
https_monitor string	Настройки Healthmonitorhttp для healthmonitor.
is_federated boolean	Это поле описывает область репликации объекта. Если поле установлено в false, то объект виден в кластере контроллера и его связанных сервисных модулях. Если поле установлено в true, то объект реплицируется по всей федерации. Поле добавлено в версии 17.1.3. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как False. Варианты: `false` `true`
monitor_port string	Используйте этот порт вместо порта, определенного для сервера в пуле. Если монитор успешно подключается к этому порту, трафик с балансировкой нагрузки по-прежнему будет отправляться на порт сервера, определенный в пуле. Допустимые значения: 1-65535. Специальные значения: 0 - «использовать порт сервера».
name string / required	Удобное для пользователя имя этого монитора работоспособности.
password string	Пароль пользователя Avi в контроллере Avi. Значение по умолчанию — переменная среды `AVI_PASSWORD`.
radius_monitor string	Монитор работоспособности для radius. Поле добавлено в версии 18.2.3.
receive_timeout string	Ожидается получение правильного ответа от сервера в течение интервала времени ожидания приема. Это время ожидания должно быть меньше интервала отправки. Если состояние сервера регулярно переключается между рабочим и нерабочим, рассмотрите возможность увеличения этого значения. Допустимые значения: 1-2400. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как 4.
send_interval string	Частота, в секундах, с которой мониторы отправляются на сервер. Допустимые значения: 1-3600. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как 10.
sip_monitor string	Монитор работоспособности для sip. Поле добавлено в версиях 17.2.8, 18.1.3, 18.2.1.
state string	Состояние, которое должно быть применено к объекту. Варианты: `"absent"` `"present"` ← (default)
successful_checks string	Количество последовательных успешных проверок работоспособности, прежде чем сервер будет помечен как активный. Допустимые значения: 1-50. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как 2.
tcp_monitor string	Настройки Healthmonitortcp для healthmonitor.
tenant string	Имя клиента, используемого для всех вызовов Avi API и контекста объекта. По умолчанию: `"admin"`
tenant_ref string	Это ссылка на объект типа tenant.
tenant_uuid string	UUID клиента, используемого для всех вызовов Avi API и контекста объекта. По умолчанию: `""`
type string / required	Тип монитора работоспособности. Варианты перечисления - HEALTH_MONITOR_PING, HEALTH_MONITOR_TCP, HEALTH_MONITOR_HTTP, HEALTH_MONITOR_HTTPS, HEALTH_MONITOR_EXTERNAL, HEALTH_MONITOR_UDP, HEALTH_MONITOR_DNS, HEALTH_MONITOR_GSLB, HEALTH_MONITOR_SIP, HEALTH_MONITOR_RADIUS.
udp_monitor string	Настройки Healthmonitorudp для healthmonitor.
url string	URL-адрес контроллера Avi объекта.
username string	Имя пользователя, используемое для доступа к контроллеру Avi. Значение по умолчанию — переменная среды `AVI_USERNAME`.
uuid string	Uuid монитора работоспособности.

Примечания

Примечание

Для получения дополнительной информации об использовании Ansible для управления устройствами Avi Network см. https://www.ansible.com/ansible-avi-networks.

Примеры

- name: Create a HTTPS health monitor
  community.network.avi_healthmonitor:
    controller: 10.10.27.90
    username: admin
    password: AviNetworks123!
    https_monitor:
      http_request: HEAD / HTTP/1.0
      http_response_code:
        - HTTP_2XX
        - HTTP_3XX
    receive_timeout: 4
    failed_checks: 3
    send_interval: 10
    successful_checks: 3
    type: HEALTH_MONITOR_HTTPS
    name: MyWebsite-HTTPS

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

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

Ключ	Описание
obj словарь	Объект HealthMonitor (api/healthmonitor) Возвращается: успех, изменено

Авторы

Gaurav Rastogi (@grastogi23)

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

© 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/community/network/avi_healthmonitor_module.html