Spec-Zone.ru › Ansible 2.9

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

  • Описание
  • Требования
  • Параметры
  • Примечания
  • Примеры
  • Значения возврата
  • Статус

Описание

  • Этот модуль используется для настройки объекта 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
Операция изменения (patch) для использования при использовании 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.
api_version
-
По умолчанию:
"16.4.4"
Версия контроллера Avi
controller
-
IP-адрес или SQDN контроллера Avi
csrftoken
-
Токен csrftoken API контроллера Avi для повторного использования существующего сеанса с идентификатором сеанса
password
-
Пароль пользователя Avi в контроллере 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
логическое
добавлено в 2.6
    Варианты:
  • no
  • yes
Отключает кэширование информации о сеансе avi в качестве факта.
controller
строка
По умолчанию:
""
IP-адрес или имя хоста контроллера. Значение по умолчанию — переменная среды AVI_CONTROLLER.
description
-
Пользовательское описание объекта.
dns_monitor
-
Настройки dns healthmonitor для healthmonitor.
external_monitor
-
Настройки external healthmonitor для healthmonitor.
failed_checks
-
Количество непрерывных неудачных проверок работоспособности перед пометкой сервера как неработоспособного.
Допустимые значения от 1 до 50.
Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как 2.
http_monitor
-
Настройки http healthmonitor для healthmonitor.
https_monitor
-
Настройки http healthmonitor для healthmonitor.
is_federated
логическое
добавлено в 2.4
    Варианты:
  • no
  • yes
Этот параметр описывает область репликации объекта.
Если параметр установлен в false, то объект виден в кластере контроллеров и его связанных серверных узлах.
Если параметр установлен в true, то объект реплицируется по всей федерации.
Параметр добавлен в 17.1.3.
Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как False.
monitor_port
-
Использование этого порта вместо порта, определенного для сервера в пуле.
Если мониторинг успешно выполняется на этом порту, сбалансированный трафик по-прежнему будет отправлен на порт сервера, определенный в пуле.
Допустимые значения от 1 до 65535.
Особые значения: 0 - 'использовать порт сервера'.
name
- / обязательно
Наглядное имя для этого монитора работоспособности.
password
строка
По умолчанию:
""
Пароль пользователя Avi в контроллере Avi. Значение по умолчанию — переменная среды AVI_PASSWORD.
radius_monitor
-
добавлено в 2.9
Монитор работоспособности для radius.
Поле введено в 18.2.3.
receive_timeout
-
Ответ сервера ожидается в течение интервала времени receive_timeout.
Этот таймаут должен быть меньше интервала отправки.
Если статус сервера регулярно изменяется, рассмотрите возможность увеличения этого значения.
Допустимые значения от 1 до 2400.
Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как 4.
send_interval
-
Частота отправки мониторинга на сервер в секундах.
Допустимые значения от 1 до 3600.
Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как 10.
sip_monitor
-
добавлено в 2.9
Монитор работоспособности для sip.
Поле введено в 17.2.8, 18.1.3, 18.2.1.
state
-
    Варианты:
  • absent
  • present ←
Состояние, которое должно быть применено к сущности.
successful_checks
-
Количество непрерывных успешных проверок работоспособности перед пометкой сервера как работоспособного.
Допустимые значения от 1 до 50.
Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как 2.
tcp_monitor
-
Настройки tcp healthmonitor для healthmonitor.
tenant
строка
По умолчанию:
"admin"
Имя тенанта, используемого для всех вызовов API Avi и контекста объекта.
tenant_ref
-
Ссылка на объект типа tenant.
tenant_uuid
строка
По умолчанию:
""
UUID тенанта, используемого для всех вызовов API Avi и контекста объекта.
тип
- / обязательно
Тип монитора состояния.
Варианты перечисления - 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 для монитора состояния.
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)


Статус

  • Отсутствует гарантия обратной совместимости интерфейса этого модуля. [превью]
  • Этот модуль поддерживается сообществом 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.9/modules/avi_healthmonitor_module.html

Spec-Zone.ru

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