Spec-Zone.ru › Ansible 2.4

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

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

  • Обзор
  • Требования (к хосту, на котором выполняется модуль)
  • Параметры
  • Примеры
  • Возвращаемые значения
    • Статус

Обзор

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

Требования (к хосту, на котором выполняется модуль)

  • avisdk

Параметры

Параметр Обязательно По умолчанию Возможные значения Комментарии
api_version
нет
Версия API Avi для использования в Avi API и объектах.
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
(добавлен в 2.4)
нет
Этот параметр описывает область репликации объекта.
Если параметр установлен в false, объект виден внутри кластера контроллера и его связанных service-engine.
Если параметр установлен в true, объект реплицируется по всей федерации.
Параметр введен в 17.1.3.
Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как False.
monitor_port
нет
Используйте этот порт вместо порта, определенного для сервера в пуле.
Если мониторинг успешно проходит на этом порту, балансируемый трафик всё равно будет отправлен на порт сервера, определенный в пуле.
Допустимые значения: 1-65535.
Особые значения: 0 — использовать порт сервера.
name
да
Напоминательное имя этого монитора состояния.
password
нет
Пароль пользователя Avi в контроллере Avi. Значение по умолчанию — переменная окружения AVI_PASSWORD.
receive_timeout
нет
Ожидается действительный ответ от сервера в течение окна таймаута.
Этот таймаут должен быть меньше интервала отправки.
Если статус сервера регулярно меняется, рассмотрите возможность увеличения этого значения.
Допустимые значения: 1-300.
Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как 4.
send_interval
нет
Частота отправки мониторинга на сервер в секундах.
Допустимые значения: 1-3600.
Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как 10.
state
нет present
  • absent
  • present
Состояние, которое должно быть применено к объекту.
successful_checks
нет
Количество непрерывных успешных проверок состояния, прежде чем сервер будет помечен как активный.
Допустимые значения: 1-50.
Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как 2.
tcp_monitor
нет
Настройки tcp_monitor для healthmonitor.
tenant
нет admin
Имя используемого для всех вызовов Avi API и контекста объекта.
tenant_ref
нет
Ссылка на объект типа tenant.
tenant_uuid
нет
UUID используемого для всех вызовов Avi API и контекста объекта.
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 монитора состояния.

Примеры

- 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)
success, changed dict

Статус

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

Для получения помощи в разработке модулей, если вас это интересует, ознакомьтесь с Информацией о сообществе и участии в разработке, Тестирование Ansible и Разработка модулей.

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

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API