avi_gslbservice - Модуль для настройки объекта GslbService Avi RESTful
Новый в версии 2.4.
Обзор
- Этот модуль используется для настройки объекта GslbService.
- Дополнительные примеры на https://github.com/avinetworks/devops
Требования
Ниже перечислены требования к хосту, на котором будет выполняться этот модуль.
- avisdk
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| api_context (добавлен в 2.5) | Контекст API Avi, включающий текущий идентификатор сеанса и CSRF-токен. Это позволяет пользователю выполнить единый вход и повторно использовать сеанс. | |
| api_version | Значение по умолчанию: "16.4.4" | Версия API Avi для использования с API Avi и объектами. |
| application_persistence_profile_ref (добавлен в 2.5) | Федеративная конфигурация сохранения состояния приложения, связанная с функциональностью сохранения состояния сайта gslbservice. Это ссылка на объект типа applicationpersistenceprofile. Поле добавлено в 17.2.1. | |
| avi_api_patch_op (добавлен в 2.5) |
| Операция патча для использования при использовании avi_api_update_method как patch. |
| avi_api_update_method (добавлен в 2.5) |
| Метод по умолчанию для обновления объекта - HTTP PUT. Установка в значение patch переопределит это поведение, чтобы использовать HTTP PATCH. |
| avi_credentials (добавлен в 2.5) | Словарь учетных данных Avi, который может использоваться вместо перечисления данных входа в контроллер Avi. | |
| controller | Значение по умолчанию: "" | IP-адрес или имя хоста контроллера. Значение по умолчанию - переменная среды AVI_CONTROLLER. |
| controller_health_status_enabled bool |
| Общий статус работоспособности участника Gs определяется на основе комбинации ввода статуса контроллера и канального пути. Обратите внимание, что статус канального пути определяется ассоциацией профилей мониторинга работоспособности. Только предоставленный статус контроллера определяется с помощью этой настройки. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как True. |
| created_by | Имя создателя. Поле добавлено в 17.1.2. | |
| description | Пользовательское описание объекта. | |
| domain_names | Полное доменное имя службы gslb. | |
| down_response | Ответ клиенту, когда служба gslb недоступна. | |
| enabled bool |
| Включить или отключить службу gslb. Если служба gslb включена, виртуальные IP-адреса отправляются в ответах DNS на основе доступности и настроенного алгоритма. Если служба gslb отключена, виртуальные IP-адреса больше не доступны в ответе DNS. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как True. |
| groups | Выберите список пулов, принадлежащих этой службе gslb. | |
| health_monitor_refs | Проверка работоспособности с помощью одного или нескольких мониторов работоспособности. Активные мониторы генерируют синтетический трафик из движка DNS-сервиса и помечают VS как активный или неактивный на основе ответа. Это ссылка на объект типа healthmonitor. | |
| health_monitor_scope | Зондирование монитора работоспособности может выполняться для всех членов или только для сторонних членов. Этот режим работы полезен для уменьшения числа зондирований монитора работоспособности в случае гибридной среды. В таком случае члены avi могут иметь статус, определяемый контроллером, в то время как не-avi члены могут быть проверены с помощью зондирования монитора работоспособности в канальном уровне. Варианты перечисления - GSLB_SERVICE_HEALTH_MONITOR_ALL_MEMBERS, GSLB_SERVICE_HEALTH_MONITOR_ONLY_NON_AVI_MEMBERS. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как GSLB_SERVICE_HEALTH_MONITOR_ALL_MEMBERS. | |
| is_federated bool |
| Это поле указывает, что этот объект дублируется в федерации gslb. Поле добавлено в 17.1.3. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как True. |
| min_members (добавлен в 2.5) | Минимальное количество членов для распределения трафика. Допустимые значения: 1-65535. Специальные значения: 0 - 'выкл'. Поле добавлено в 17.2.4. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как 0. | |
| name обязательно | Имя службы gslb. | |
| num_dns_ip | Количество IP-адресов этой службы gslb, которые будут возвращены службой DNS. Введите 0, чтобы вернуть все IP-адреса. Допустимые значения: 1-20. Специальные значения: 0 - 'вернуть все IP-адреса'. | |
| password | Значение по умолчанию: "" | Пароль пользователя Avi в контроллере Avi. Значение по умолчанию - переменная среды AVI_PASSWORD. |
| pool_algorithm (добавлен в 2.5) | Алгоритм балансировки нагрузки выберет пул gslb в списке доступных пулов службы gslb. Варианты перечисления - GSLB_SERVICE_ALGORITHM_PRIORITY, GSLB_SERVICE_ALGORITHM_GEO. Поле добавлено в 17.2.3. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как GSLB_SERVICE_ALGORITHM_PRIORITY. | |
| site_persistence_enabled bool (добавлен в 2.5) |
| Включить сохранение состояния сайта для gslbservice. Поле добавлено в 17.2.1. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как False. |
| state |
| Состояние, которое должно быть применено к сущности. |
| tenant | Значение по умолчанию: "admin" | Имя арендатора, используемого для всех вызовов API Avi и контекста объекта. |
| tenant_ref | Это ссылка на объект типа tenant. | |
| tenant_uuid | Значение по умолчанию: "" | UUID арендатора, используемого для всех вызовов API Avi и контекста объекта. |
| ttl | Значение TTL (в секундах) для записей, предоставляемых для этой службы gslb службой DNS. Допустимые значения: 1-86400. Единицы (СЕК). | |
| url | URL контроллера Avi объекта. | |
| use_edns_client_subnet bool |
| Использовать подсеть IP-адреса клиента из параметра EDNS в качестве исходного IP-адреса для геолокации клиента и алгоритма консистентного хэширования. Значение по умолчанию - true. Поле добавлено в 17.1.1. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как True. |
| username | Значение по умолчанию: "" | Имя пользователя для доступа к контроллеру Avi. Значение по умолчанию - переменная среды AVI_USERNAME. |
| uuid | UUID службы gslb. | |
| wildcard_match bool |
| Включить соответствие по шаблону «*» для доменного имени, если точное соответствие не найдено в таблице DNS, в запросе DNS выбирается наибольшее соответствие с помощью шаблона «*» для доменного имени. Значение по умолчанию - false. Поле добавлено в 17.1.1. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как False. |
Примечания
Примечание
- Для получения дополнительной информации об использовании Ansible для управления устройствами сети Avi см. https://www.ansible.com/ansible-avi-networks.
Примеры
- name: Example to create GslbService object
avi_gslbservice:
controller: 10.10.25.42
username: admin
password: something
state: present
name: sample_gslbservice
Возвращаемые значения
Общие возвращаемые значения описаны здесь, следующие поля уникальны для данного модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| obj dict | success, changed | Объект GslbService (api/gslbservice) |
Статус
Данный модуль помечен как превью, что означает, что он не гарантирует обратную совместимость интерфейса.
Техническое обслуживание
Данный модуль помечен как общественный, что означает, что он поддерживается сообществом Ansible. Подробнее см. поддержку и техническое обслуживание модулей.
Список других модулей, поддерживаемых сообществом Ansible, см. здесь.
Автор
- 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.6/modules/avi_gslbservice_module.html
