avi_healthmonitor - Модуль для настройки объекта HealthMonitor Avi RESTful

Новая версия 2.3.

Обзор
- Требования
Параметры
Примечания
Примеры
Возвращаемые значения
Статус
- Автор

Обзор

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

Требования

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

avisdk

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
api_context (добавлен в 2.5)		Контекст API Avi, включающий текущий идентификатор сеанса и маркер CSRF. Это позволяет пользователю выполнить однократный вход и повторно использовать сеанс.
api_version	По умолчанию: 16.4.4	Версия API Avi для использования с API Avi и объектами.
avi_api_patch_op (добавлен в 2.5)	Варианты: add replace delete	Операция обновления для использования при использовании avi_api_update_method как patch.
avi_api_update_method (добавлен в 2.5)	Варианты: put ← patch	Метод по умолчанию для обновления объекта — HTTP PUT. Установка в patch переопределит это поведение для использования HTTP PATCH.
avi_credentials (добавлен в 2.5)		Словарь учетных данных Avi, который можно использовать вместо перечисления данных входа в Avi Controller.
controller	По умолчанию:	IP-адрес или имя хоста контроллера. Значение по умолчанию — переменная окружения `AVI_CONTROLLER`.
description		Пользовательское описание объекта.
dns_monitor		Параметры мониторинга DNS для healthmonitor.
external_monitor		Параметры внешнего мониторинга для healthmonitor.
failed_checks		Количество непрерывных сбоев проверок состояния перед тем, как сервер будет помечен как неисправный. Допустимые значения от 1 до 50. Значение по умолчанию, если не указано в API или модуле, интерпретируется Avi Controller как 2.
http_monitor		Параметры HTTP-мониторинга для healthmonitor.
https_monitor		Параметры HTTP-мониторинга для healthmonitor.
is_federated (добавлен в 2.4)	Варианты: no yes	Это поле описывает область репликации объекта. Если поле установлено в false, объект виден в кластере контроллера и его связанных service-engines. Если поле установлено в true, объект реплицируется по всей федерации. Поле введено в 17.1.3. Значение по умолчанию, если не указано в API или модуле, интерпретируется Avi Controller как False.
monitor_port		Используйте этот порт вместо порта, определенного для сервера в пуле. Если мониторинг завершается успешно на этом порте, трафик балансировки нагрузки по-прежнему будет направляться на порт сервера, определенный в пуле. Допустимые значения от 1 до 65535. Особые значения 0 — 'использовать порт сервера'.
name обязательно		Понятное имя для этого монитора состояния.
password	По умолчанию:	Пароль пользователя Avi в контроллере Avi. Значение по умолчанию — переменная окружения `AVI_PASSWORD`.
receive_timeout		Ожидается действительный ответ от сервера в течение окна таймаута получения. Этот таймаут должен быть меньше интервала отправки. Если состояние сервера регулярно меняется вверх и вниз, рассмотрите увеличение этого значения. Допустимые значения от 1 до 2400. Значение по умолчанию, если не указано в API или модуле, интерпретируется Avi Controller как 4. Единицы (сек).
send_interval		Частота отправки проверок состояния на сервер в секундах. Допустимые значения от 1 до 3600. Значение по умолчанию, если не указано в API или модуле, интерпретируется Avi Controller как 10. Единицы (сек).
state	Варианты: absent present ←	Состояние, которое должно быть применено к сущности.
successful_checks		Количество непрерывных успешных проверок состояния, прежде чем сервер будет помечен как активный. Допустимые значения от 1 до 50. Значение по умолчанию, если не указано в API или модуле, интерпретируется Avi Controller как 2.
tcp_monitor		Параметры TCP-мониторинга для healthmonitor.
tenant	По умолчанию: admin	Имя пользователя, используемого для всех вызовов API Avi и контекста объекта.
tenant_ref		Ссылка на объект типа tenant.
tenant_uuid	По умолчанию:	UUID пользователя, используемого для всех вызовов API Avi и контекста объекта.
type обязательно		Тип монитора состояния. Варианты перечисления — HEALTH_MONITOR_PING, HEALTH_MONITOR_TCP, HEALTH_MONITOR_HTTP, HEALTH_MONITOR_HTTPS, HEALTH_MONITOR_EXTERNAL, HEALTH_MONITOR_UDP, HEALTH_MONITOR_DNS, HEALTH_MONITOR_GSLB.
udp_monitor		Параметры UDP-мониторинга для healthmonitor.
url		URL контроллера Avi для объекта.
username	По умолчанию:	Имя пользователя для доступа к контроллеру Avi. Значение по умолчанию — переменная окружения `AVI_USERNAME`.
uuid		UUID монитора состояния.

Примечания

Примечание

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

Примеры

- name: Create a HTTPS health monitor
  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 dict	success, changed	Объект HealthMonitor (api/healthmonitor)

Статус

Этот модуль помечен как превью, что означает, что он не гарантирует обратную совместимость интерфейса.

Автор

Гaurav Rastogi (grastogi@avinetworks.com)

Подсказка

Если вы обнаружите какие-либо проблемы в этом документе, вы можете отредактировать этот документ, чтобы улучшить его.

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.5/modules/avi_healthmonitor_module.html