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

Примечание

Этот плагин входит в коллекцию community.network (версия 2.0.1).

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

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

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

Обзор

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

Требования

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

avisdk

Параметры

Параметр		Варианты/Значения по умолчанию	Комментарии
api_context словарь			Контекст API Avi, включающий текущий идентификатор сессии и маркер CSRF. Это позволяет пользователю выполнить однократный вход и повторно использовать сессию.
api_version строка		По умолчанию: "16.4.4"	Версия API Avi для использования в Avi API и объектах.
avi_api_patch_op строка		Варианты: add replace delete	Операция обновления для использования при использовании avi_api_update_method в качестве обновления.
avi_api_update_method строка		Варианты: put ← patch	Метод по умолчанию для обновления объекта — HTTP PUT. Установка в patch переопределит это поведение для использования HTTP PATCH.
avi_credentials словарь			Словарь учетных данных Avi, который можно использовать вместо перечисления данных входа в Avi Controller.
	api_version строка	По умолчанию: "16.4.4"	Версия контроллера Avi
	controller строка		IP-адрес или SQDN контроллера
	csrftoken строка		Токен csrf контроллера Avi для повторного использования существующей сессии с идентификатором сессии
	password строка		Пароль контроллера Avi
	port строка		Порт контроллера Avi
	session_id строка		Идентификатор сессии API контроллера Avi для повторного использования существующей сессии с csrftoken
	tenant строка	По умолчанию: "admin"	Тенент контроллера Avi
	tenant_uuid строка		UUID тенента контроллера Avi
	timeout строка	По умолчанию: 300	Таймаут запроса контроллера Avi
	token строка		Токен API контроллера Avi
	username строка		Имя пользователя контроллера Avi
avi_disable_session_cache_as_fact логическое		Варианты: нет ← да	Отключает кеширование информации о сессии avi в качестве факта.
controller строка		По умолчанию: ""	IP-адрес или имя хоста контроллера. Значение по умолчанию — переменная среды `AVI_CONTROLLER`.
description строка			Определяемое пользователем описание объекта.
dns_monitor строка			Настройки мониторинга dns для healthmonitor.
external_monitor строка			Настройки внешнего мониторинга для healthmonitor.
failed_checks строка			Количество непрерывных сбоев мониторинга производительности перед тем, как сервер будет помечен как неисправный. Допустимые значения: 1-50. Значение по умолчанию, если оно не указано в API или модуле, интерпретируется контроллером Avi как 2.
http_monitor строка			Настройки мониторинга http для healthmonitor.
https_monitor строка			Настройки мониторинга http для healthmonitor.
is_federated логическое		Варианты: нет да	Это поле описывает область репликации объекта. Если поле установлено в false, объект виден в кластере контроллера и его связанных серверных узлах. Если поле установлено в true, объект реплицируется через федерацию. Поле введено в версии 17.1.3. Значение по умолчанию, если оно не указано в API или модуле, интерпретируется контроллером Avi как False.
monitor_port строка			Используйте этот порт вместо порта, определенного для сервера в пуле. Если мониторинг успешно пройдет на этом порту, балансировка нагрузки по-прежнему будет отправляться на порт сервера, определенный в пуле. Допустимые значения: 1-65535. Особые значения 0 — 'использовать порт сервера'.
name строка / обязательный			Наглядное имя для этого монитора производительности.
password строка		По умолчанию: ""	Пароль пользователя Avi в контроллере Avi. Значение по умолчанию — переменная среды `AVI_PASSWORD`.
radius_monitor строка			Монитор производительности для radius. Поле введено в версии 18.2.3.
receive_timeout строка			Действительный ответ от сервера ожидается в течение окна таймаута приема. Этот таймаут должен быть меньше интервала отправки. Если статус сервера регулярно меняется вверх и вниз, рассмотрите возможность увеличения этого значения. Допустимые значения: 1-2400. Значение по умолчанию, если оно не указано в API или модуле, интерпретируется контроллером Avi как 4.
send_interval строка			Частота, в секундах, с которой мониторинг отправляется на сервер. Допустимые значения: 1-3600. Значение по умолчанию, если оно не указано в API или модуле, интерпретируется контроллером Avi как 10.
sip_monitor строка			Монитор производительности для sip. Поле введено в версиях 17.2.8, 18.1.3, 18.2.1.
state строка		Варианты: отсутствует есть ←	Состояние, которое должно быть применено к сущности.
successful_checks строка			Количество непрерывных успешных проверок производительности перед тем, как сервер будет помечен как рабочий. Допустимые значения: 1-50. Значение по умолчанию, если оно не указано в API или модуле, интерпретируется контроллером Avi как 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, HEALTH_MONITOR_SIP, HEALTH_MONITOR_RADIUS.
udp_monitor строка			Настройки мониторинга udp для 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
  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) <grastogi@avinetworks.com>

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/community/network/avi_healthmonitor_module.html