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 для использования с Avi API и объектами.
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 для healthmonitor.
external_monitor -		Настройки внешнего мониторинга для healthmonitor.
failed_checks -		Количество непрерывных проваленных проверок состояния, прежде чем сервер будет помечен как неисправный. Допустимые значения от 1 до 50. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как 2.
http_monitor -		Настройки HTTP-мониторинга для healthmonitor.
https_monitor -		Настройки HTTP-мониторинга для healthmonitor.
is_federated boolean добавлен в 2.4	Варианты: no yes	Это поле описывает область распространения объекта. Если поле установлено в false, то объект виден в кластере контроллера и связанных с ним движках сервисов. Если поле установлено в true, то объект дублируется по всей федерации. Поле введено в 17.1.3. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как False.
monitor_port -		Используйте этот порт вместо порта, определенного для сервера в пуле. Если мониторинг выполняется успешно на этом порту, трафик с балансировкой нагрузки по-прежнему будет направляться на порт сервера, определенный в пуле. Допустимые значения от 1 до 65535. Особые значения 0 - 'использовать порт сервера'.
name - / обязательно		Пользовательское имя для этого монитора состояния.
password -	По умолчанию: ""	Пароль пользователя Avi в контроллере Avi. Значение по умолчанию - переменная среды `AVI_PASSWORD`.
receive_timeout -		Ответ от сервера ожидается в течение временного интервала receive timeout. Этот интервал должен быть меньше интервала send interval. Если статус сервера регулярно меняется наверх и вниз, рассмотрите возможность увеличения этого значения. Допустимые значения от 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 для 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 -		Настройки мониторинга 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
  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)

Статус

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

Авторы

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