community.network.avi_gslbservice – Модуль для настройки объекта GslbService Avi RESTful
Примечание
Этот плагин входит в коллекцию community.network (версия 1.3.0).
Для его установки используйте: ansible-galaxy collection install community.network.
Для использования в плейбуке укажите: community.network.avi_gslbservice.
Обзор
- Этот модуль используется для конфигурации объекта GslbService
- больше примеров по адресу https://github.com/avinetworks/devops
Требования
Ниже перечислены требования к хосту, на котором выполняется этот модуль.
- avisdk
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| api_context словарь | Контекст API Avi, включающий текущий идентификатор сеанса и маркер CSRF. Это позволяет пользователю выполнить единый вход и повторно использовать сеанс. | ||
| api_version строка | По умолчанию: "16.4.4" | Версия API Avi для использования с API Avi и объектами. | |
| application_persistence_profile_ref строка | Федеративная настройка сохранения приложения, связанная с функциональностью сохранения состояния сайта gslbservice. Это ссылка на объект типа applicationpersistenceprofile. Поле введено в 17.2.1. | ||
| avi_api_patch_op строка |
| Операция обновления для использования при использовании avi_api_update_method как patch. | |
| avi_api_update_method строка |
| Метод по умолчанию для обновления объекта — HTTP PUT. Установка значения на patch переопределит это поведение, чтобы использовать HTTP PATCH. | |
| avi_credentials словарь | Словарь учетных данных Avi, который можно использовать вместо перечисления данных входа в контроллер Avi. | ||
| api_version строка | По умолчанию: "16.4.4" | Версия контроллера Avi | |
| controller строка | IP-адрес или SQDN контроллера Avi | ||
| csrftoken строка | Маркер csrf API контроллера Avi для повторного использования существующего сеанса с идентификатором сеанса | ||
| password строка | Пароль контроллера 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 булево |
| Отключает кэширование информации о сеансе Avi как факта. | |
| controller строка | По умолчанию: "" | IP-адрес или имя хоста контроллера. Значение по умолчанию — переменная среды AVI_CONTROLLER. | |
| controller_health_status_enabled булево |
| Общий статус работоспособности члена Gs определяется на основе комбинации входов контроллера и состояния канала данных. Обратите внимание, что состояние канала данных определяется по ассоциации профилей мониторов состояния. Только состояние, предоставленное контроллером, определяется с помощью этой конфигурации. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как True. | |
| created_by строка | Имя создателя. Поле введено в 17.1.2. | ||
| description строка | Определяемое пользователем описание объекта. | ||
| domain_names строка | Полное доменное имя gslb-службы. | ||
| down_response строка | Ответ клиенту при недоступности gslb-службы. | ||
| enabled булево |
| Включить или отключить 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. | ||
| hm_off булево |
| Это внутреннее поле, используемое в се. Поле введено в 18.2.2. | |
| is_federated булево |
| Это поле указывает, что этот объект дублируется в федерации gslb. Поле введено в 17.1.3. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как True. | |
| min_members строка | Минимальное количество членов для распределения трафика. Допустимые значения — 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 строка | Алгоритм балансировки нагрузки выберет gslb-пул из списка доступных пулов gslb-службы. Варианты перечисления — GSLB_SERVICE_ALGORITHM_PRIORITY, GSLB_SERVICE_ALGORITHM_GEO. Поле введено в 17.2.3. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как GSLB_SERVICE_ALGORITHM_PRIORITY. | ||
| site_persistence_enabled булево |
| Включить сохранение состояния сайта для gslbservice. Поле введено в 17.2.1. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как False. | |
| state строка |
| Состояние, которое должно быть применено к сущности. | |
| tenant строка | По умолчанию: "admin" | Имя тенента, используемого для всех вызовов API Avi и контекста объекта. | |
| tenant_ref строка | Это ссылка на объект типа tenant. | ||
| tenant_uuid строка | По умолчанию: "" | UUID тенента, используемого для всех вызовов API Avi и контекста объекта. | |
| ttl строка | Значение ttl (в секундах) для записей, предоставляемых этой gslb-службой службой DNS. Допустимые значения — 0-86400. | ||
| url строка | URL контроллера Avi для объекта. | ||
| use_edns_client_subnet булево |
| Использовать подсеть IP-адреса клиента из опции EDNS в качестве исходного IP-адреса для геолокации клиента и алгоритма консистентного хеширования. По умолчанию — true. Поле введено в 17.1.1. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как True. | |
| Имя пользователя строка | По умолчанию: "" | Имя пользователя, используемое для доступа к контроллеру Avi. Значение по умолчанию — переменная среды AVI_USERNAME. | |
| uuid строка | Uuid службы gslb. | ||
| wildcard_match логическое |
| Включить сопоставление по шаблону «*» (wildcard) для fqdn, если точное совпадение не найдено в таблице DNS; выбирается самое длинное совпадение с использованием wildcard для fqdn в запросе DNS. По умолчанию значение ложь. Поле введено в 17.1.1. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как Ложь. | |
Примечания
Примечание
- Дополнительную информацию об использовании Ansible для управления устройствами Avi Network см. на странице https://www.ansible.com/ansible-avi-networks.
Примеры
- name: Example to create GslbService object
community.network.avi_gslbservice:
controller: 10.10.25.42
username: admin
password: something
state: present
name: sample_gslbservice
Возвращаемые значения
Общие возвращаемые значения описаны здесь, следующие поля уникальны для данного модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| obj словарь | успех, изменения | Объект GslbService (api/gslbservice) |
Авторы
- Гaurav 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.10/collections/community/network/avi_gslbservice_module.html
