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	По умолчанию: ""	IP-адрес или имя хоста контроллера. Значение по умолчанию - переменная окружения `AVI_CONTROLLER`.
description		Пользовательское описание объекта.
dns_monitor		Настройки dns_monitor для healthmonitor.
external_monitor		Настройки external_monitor для healthmonitor.
failed_checks		Количество непрерывных неудачных проверок состояния перед пометкой сервера как недоступного. Допустимые значения: 1-50. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как 2.
http_monitor		Настройки http_monitor для healthmonitor.
https_monitor		Настройки https_monitor для healthmonitor.
is_federated bool (добавлено в 2.4)	Варианты: no yes	Это поле описывает область репликации объекта. Если поле установлено в false, то объект виден внутри контроллера-кластера и его связанных service-узлов. Если поле установлено в 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	Варианты: absent present ←	Состояние, которое должно быть применено к сущности.
successful_checks		Количество непрерывных успешных проверок состояния, прежде чем сервер помечается как активный. Допустимые значения: 1-50. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как 2.
tcp_monitor		Настройки tcp_monitor для 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_monitor для healthmonitor.
url		URL контроллера Avi для объекта.
username	По умолчанию: ""	Имя пользователя для доступа к контроллеру Avi. Значение по умолчанию - переменная окружения `AVI_USERNAME`.
uuid		UUID монитора состояния.

Примечания

Примечание

Дополнительную информацию об использовании Ansible для управления устройствами сети Avi см. на странице 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	успех, изменения	Объект HealthMonitor (api/healthmonitor)

Статус

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

Техническое обслуживание

Этот модуль помечен как сообщество, что означает, что он поддерживается сообществом Ansible. См. Техническое обслуживание и поддержка модулей для получения дополнительной информации.

Список других модулей, которые также поддерживаются сообществом Ansible, см. на странице здесь.

Автор

Г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.6/modules/avi_healthmonitor_module.html