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 в качестве патча. |
| 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 boolean |
| Общий статус работоспособности элемента Gs определяется на основе комбинации входов состояния работоспособности контроллера и канала передачи данных. Обратите внимание, что состояние канала передачи данных определяется по ассоциации профилей мониторинга состояния. Только предоставленный контроллером статус определяется с помощью этой конфигурации. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как True. |
| created_by - | Имя создателя. Поле введено в 17.1.2. | |
| description - | Определяемое пользователем описание объекта. | |
| domain_names - | Полное доменное имя gslb-сервиса. | |
| down_response - | Ответ клиенту, когда gslb-сервис недоступен. | |
| enabled boolean |
| Включить или отключить gslb-сервис. Если gslb-сервис включен, виртуальные серверы отправляются в ответах DNS на основе достижимости и настроенного алгоритма. Если gslb-сервис отключен, виртуальные серверы больше не доступны в ответе DNS. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как True. |
| groups - | Список выбранных пулов, принадлежащих этому gslb-сервису. | |
| health_monitor_refs - | Проверка работоспособности vs с помощью одного или нескольких мониторов работоспособности. Активные мониторы генерируют синтетический трафик из движка сервиса 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 boolean |
| Это поле указывает, что этот объект дублируется в федерации 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 boolean добавлено в 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 boolean |
| Использовать подсеть IP-адреса клиента из опции EDNS в качестве исходного IP-адреса для геолокации клиента и алгоритма консистентного хеширования. По умолчанию true. Поле введено в 17.1.1. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как True. |
| Имя пользователя - | По умолчанию: "" | Имя пользователя, используемое для доступа к контроллеру Avi. Значение по умолчанию — переменная среды AVI_USERNAME. |
| uuid - | Uuid службы gslb. | |
| wildcard_match boolean |
| Включить сопоставление с подстановочными знаками для fqdn, если точное совпадение не найдено в таблице DNS, выбирается самое длинное совпадение, подставляя подстановочные знаки в fqdn в запросе DNS. По умолчанию false. Поле добавлено в версии 17.1.1. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как False. |
Примечания
Примечание
- Дополнительную информацию об использовании Ansible для управления устройствами Avi Network см. на сайте 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 словарь | успех, изменение | Объект GslbService (api/gslbservice) |
Статус
- Этот модуль не гарантирует обратную совместимость. [превью]
- Этот модуль поддерживается сообществом 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_gslbservice_module.html