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 Credentials, который может быть использован вместо перечисления данных входа в контроллер Avi.
controller строка	По умолчанию: ""	IP-адрес или имя хоста контроллера. Значение по умолчанию - переменная окружения `AVI_CONTROLLER`.
description -		Пользовательское описание объекта.
dns_monitor -		Настройки healthmonitordns для healthmonitor.
external_monitor -		Настройки healthmonitorexternal для healthmonitor.
failed_checks -		Количество непрерывных неудачных проверок состояния перед пометкой сервера как неработающего. Допустимые значения от 1 до 50. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как 2.
http_monitor -		Настройки healthmonitorhttp для healthmonitor.
https_monitor -		Настройки healthmonitorhttp для healthmonitor.
is_federated логическое добавлен в 2.4	Варианты: нет да	Это поле описывает область репликации объекта. Если поле установлено в false, объект виден внутри кластера контроллера и его связанных service-engines. Если поле установлено в true, объект реплицируется по всей федерации. Поле введено в 17.1.3. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как False.
monitor_port -		Использовать этот порт вместо порта, определенного для сервера в пуле. Если мониторинг успешно проходит на этом порту, трафик балансировки по-прежнему будет отправлен на порт сервера, определенный в пуле. Допустимые значения от 1 до 65535. Специальные значения 0 - 'использовать порт сервера'.
name - / обязательно		Напоминательное имя для этого монитора состояния.
password строка	По умолчанию: ""	Пароль пользователя Avi в контроллере Avi. Значение по умолчанию - переменная окружения `AVI_PASSWORD`.
receive_timeout -		Ожидается корректный ответ от сервера в пределах времени ожидания получения. Это время ожидания должно быть меньше интервала отправки. Если статус сервера регулярно меняется, рассмотрите возможность увеличения этого значения. Допустимые значения от 1 до 2400. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как 4. Единицы (сек).
send_interval -		Частота отправки мониторинга серверу в секундах. Допустимые значения от 1 до 3600. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как 10. Единицы (сек).
state -	Варианты: отсутствует наличие ←	Состояние, которое должно быть применено к сущности.
successful_checks -		Количество непрерывных успешных проверок состояния перед пометкой сервера как активного. Допустимые значения от 1 до 50. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как 2.
tcp_monitor -		Настройки healthmonitortcp для healthmonitor.
tenant строка	По умолчанию: "admin"	Имя арендатора, используемое для всех вызовов API Avi и контекста объекта.
tenant_ref -		Ссылка на объект типа арендатора.
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 -		Настройки healthmonitorudp для 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 словарь	успех, изменено	Объект HealthMonitor (api/healthmonitor)

Статус

Этот модуль не гарантирует обратную совместимость интерфейса. [превью]
Этот модуль поддерживается сообществом Ansible. [сообщество]

Авторы

Gaurav Rastogi (@grastogi23) <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.8/modules/avi_healthmonitor_module.html