community.network.avi_gslbservice – Модуль для настройки объекта GslbService Avi RESTful
Примечание
Этот плагин входит в коллекцию community.network (версия 2.0.1).
Для его установки используйте: 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 Controller. | ||
| api_version строка | Значение по умолчанию: "16.4.4" | Версия контроллера Avi | |
| controller строка | IP-адрес или SQDN контроллера Avi | ||
| csrftoken строка | Маркер API контроллера Avi csrftoken для повторного использования существующей сессии с идентификатором сессии | ||
| 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 как Истина. | |
| created_by строка | Имя создателя. Поле введено в 17.1.2. | ||
| description строка | Пользовательское описание объекта. | ||
| domain_names строка | Полное доменное имя gslb-сервиса. | ||
| down_response строка | Ответ клиенту при отключении gslb-сервиса. | ||
| enabled булево |
| Включить или отключить gslb-сервис. Если gslb-сервис включен, то виртуальные серверы отправляются в ответах DNS на основе доступности и настроенного алгоритма. Если gslb-сервис отключен, то виртуальные серверы больше не доступны в ответе DNS. Значение по умолчанию, если оно не указано в API или модуле, интерпретируется контроллером Avi как Истина. | |
| 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 как Истина. | |
| 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 как Ложь. | |
| 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-адреса для геолокации клиента и алгоритма консистентного хэширования. Значение по умолчанию — истина. Поле введено в 17.1.1. Значение по умолчанию, если оно не указано в API или модуле, интерпретируется контроллером Avi как Истина. | |
| Имя пользователя строка | Значение по умолчанию: "" | Имя пользователя, используемое для доступа к контроллеру Avi. Значение по умолчанию — переменная окружения AVI_USERNAME. | |
| uuid строка | Uuid службы gslb. | ||
| wildcard_match логическое значение |
| Включить сопоставление по шаблону для fqdn, если точное совпадение не найдено в таблице dns, выбирается самое длинное совпадение путём применения сопоставления по шаблону к fqdn в запросе dns. По умолчанию значение равно false. Поле введено в 17.1.1. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как False. | |
Примечания
Примечание
- Дополнительную информацию об использовании Ansible для управления устройствами сети Avi см. на странице 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) |
Авторы
- Gaurav Rastogi (@grastogi23) <grastogi@avinetworks.com>
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/community/network/avi_gslbservice_module.html
