avi_gslbhealthmonitor - Модуль для настройки GslbHealthMonitor Avi RESTful объекта
Новый в версии 2.4.
- Описание
- Требования (к хосту, на котором выполняется модуль)
- Параметры
- Примеры
- Возвращаемые значения
Описание
- Этот модуль используется для настройки объекта GslbHealthMonitor
- больше примеров на https://github.com/avinetworks/devops
Требования (к хосту, на котором выполняется модуль)
- avisdk
Параметры
| параметр | обязательно | значение по умолчанию | варианты | комментарии |
|---|---|---|---|---|
| api_version | нет | Версия API Avi для использования с Avi API и объектами. | ||
| controller | нет | IP-адрес или имя хоста контроллера. Значение по умолчанию — переменная окружения AVI_CONTROLLER. | ||
| description | нет | Пользовательское описание объекта. | ||
| dns_monitor | нет | Настройки healthmonitordns для gslbhealthmonitor. | ||
| external_monitor | нет | Настройки healthmonitorexternal для gslbhealthmonitor. | ||
| failed_checks | нет | Количество непрерывных неудачных проверок состояния, после которого сервер помечается как недоступный. Допустимые значения: 1-50. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как 2. | ||
| http_monitor | нет | Настройки healthmonitorhttp для gslbhealthmonitor. | ||
| https_monitor | нет | Настройки healthmonitorhttp для gslbhealthmonitor. | ||
| monitor_port | нет | Использование этого порта вместо порта, определенного для сервера в пуле. Если мониторинг успешно пройдет на этом порту, балансировка нагрузки все равно будет отправляться на порт сервера, определенный в пуле. Допустимые значения: 1-65535. Специальные значения: 0 - 'использовать порт сервера'. | ||
| name | да | Наглядное имя для этого монитора состояния. | ||
| password | нет | Пароль пользователя Avi в контроллере Avi. Значение по умолчанию — переменная окружения AVI_PASSWORD. | ||
| receive_timeout | нет | Действительный ответ от сервера ожидается в течение времени ожидания приема. Это время ожидания должно быть меньше времени ожидания отправки. Если статус сервера регулярно изменяется вверх и вниз, рассмотрите возможность увеличения этого значения. Допустимые значения: 1-300. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как 4. | ||
| send_interval | нет | Частота отправки мониторинга на сервер в секундах. Допустимые значения: 1-3600. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как 5. | ||
| state | нет | present |
| Состояние, которое должно быть применено к объекту. |
| successful_checks | нет | Количество непрерывных успешных проверок состояния, перед тем как сервер помечается как доступный. Допустимые значения: 1-50. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как 2. | ||
| tcp_monitor | нет | Настройки healthmonitortcp для gslbhealthmonitor. | ||
| tenant | нет | admin | Имя клиента, используемого для всех вызовов Avi API и контекста объекта. | |
| tenant_ref | нет | Ссылка на объект типа клиент. | ||
| 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 | нет | Настройки healthmonitorudp для gslbhealthmonitor. | ||
| url | нет | URL контроллера Avi объекта. | ||
| username | нет | Имя пользователя для доступа к контроллеру Avi. Значение по умолчанию — переменная окружения AVI_USERNAME. | ||
| uuid | нет | Uuid монитора состояния. |
Примеры
- name: Example to create GslbHealthMonitor object
avi_gslbhealthmonitor:
controller: 10.10.25.42
username: admin
password: something
state: present
name: sample_gslbhealthmonitor
Возвращаемые значения
Общие возвращаемые значения описаны здесь Возвращаемые значения, следующие поля уникальны для этого модуля:
| имя | описание | возвращается | тип | пример |
|---|---|---|---|---|
| obj | Объект GslbHealthMonitor (api/gslbhealthmonitor) | успех, изменено | dict |
Статус
Этот модуль помечен как бета-версия, что означает, что он не гарантирует обратную совместимость.
Для получения помощи в разработке модулей, если у вас есть желание, прочитайте Информация о сообществе и вклад, Тестирование 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_gslbhealthmonitor_module.html