Модуль community.network.avi_gslbservice — Модуль для настройки объекта GslbService Avi RESTful
Примечание
Этот модуль является частью коллекции community.network (версия 5.0.3).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install community.network. Для использования этого модуля необходимы дополнительные требования. Подробности см. в разделе Требования.
Для использования в книге задач укажите: community.network.avi_gslbservice.
Описание
- Этот модуль используется для настройки объекта GslbService
- Дополнительные примеры можно найти по адресу https://github.com/avinetworks/devops
Псевдонимы: network.avi.avi_gslbservice
Требования
Ниже перечислены требования, необходимые на хосте, на котором выполняется этот модуль.
- avisdk
Параметры
Параметр | Комментарии |
|---|---|
api_context словарь | Контекст API Avi, включающий текущий идентификатор сессии и токен CSRF. Это позволяет пользователю выполнить единый вход и повторно использовать сессию. |
api_version строка | Версия API Avi для использования с API Avi и объектами. По умолчанию: |
application_persistence_profile_ref строка | Федеративное сохранение состояния приложения, связанное с функциональностью сохранения состояния сайта gslbservice. Это ссылка на объект типа applicationpersistenceprofile. Поле введено в 17.2.1. |
avi_api_patch_op строка | Операция исправления, используемая при использовании avi_api_update_method как исправление. Варианты:
|
avi_api_update_method строка | Метод обновления объекта по умолчанию — HTTP PUT. Установка в «patch» переопределит это поведение, чтобы использовать HTTP PATCH. Варианты:
|
avi_credentials словарь | Словарь учетных данных Avi, который можно использовать вместо перечисления данных входа в контроллер Avi. |
|
api_version строка |
Версия контроллера Avi По умолчанию: |
|
controller строка |
IP-адрес или SQDN контроллера |
|
csrftoken строка |
Токен csrf контроллера API Avi для повторного использования существующей сессии с идентификатором сессии По умолчанию: |
|
password строка |
Пароль контроллера Avi |
|
port строка |
Порт контроллера Avi |
|
session_id строка |
Идентификатор сессии API контроллера Avi для повторного использования существующей сессии с csrftoken По умолчанию: |
|
tenant строка |
Тенент контроллера Avi По умолчанию: |
|
tenant_uuid строка |
UUID тенента контроллера Avi По умолчанию: |
|
timeout строка |
Таймаут запроса контроллера Avi По умолчанию: |
|
token строка |
Токен API контроллера Avi По умолчанию: |
|
username строка |
Имя пользователя контроллера Avi |
avi_disable_session_cache_as_fact логическое | Отключает кэширование информации о сессии avi в качестве факта. Варианты:
|
controller строка | IP-адрес или имя хоста контроллера. Значение по умолчанию — переменная окружения |
controller_health_status_enabled логическое | Общий статус здоровья члена Gs определяется на основе комбинации входов статуса здоровья контроллера и канала передачи данных. Обратите внимание, что статус канала передачи данных определяется путем связывания профилей монитора состояния. Статус, предоставляемый только контроллером, определяется с помощью этой конфигурации. Значение по умолчанию, если оно не указано в API или модуле, интерпретируется контроллером Avi как True. Варианты:
|
created_by строка | Имя создателя. Поле введено в 17.1.2. |
description string | Пользовательское описание объекта. |
domain_names string | Полностью квалифицированное доменное имя службы GSLB. |
down_response string | Ответ на запрос клиента, когда служба GSLB недоступна. |
enabled boolean | Включить или отключить службу GSLB. Если служба GSLB включена, то VIP-адреса отправляются в DNS-ответах на основе доступности и настроенного алгоритма. Если служба GSLB отключена, то VIP-адреса больше не доступны в DNS-ответе. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как True. Варианты:
|
groups string | Выберите список пулов, принадлежащих этой службе GSLB. |
health_monitor_refs string | Проверка работоспособности VS путем применения одного или нескольких мониторов работоспособности. Активные мониторы генерируют синтетический трафик от механизма службы DNS и помечают VS как активный или неактивный в зависимости от ответа. Это ссылка на объект типа healthmonitor. |
health_monitor_scope string | Проверка монитора работоспособности может выполняться для всех участников или только для сторонних участников. Этот режим работы полезен для уменьшения количества проверок монитора работоспособности в случае гибридного сценария. В этом случае участники 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 boolean | Это внутреннее поле, используемое в se. Поле добавлено в версии 18.2.2. Варианты:
|
is_federated boolean | Это поле указывает, что этот объект реплицируется по федерации GSLB. Поле добавлено в версии 17.1.3. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как True. Варианты:
|
min_members string | Минимальное количество участников для распределения трафика. Допустимые значения: 1-65535. Специальные значения: 0 - «отключено». Поле добавлено в версии 17.2.4. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как 0. |
name string / required | Имя для службы GSLB. |
num_dns_ip string | Количество IP-адресов этой службы GSLB, которые будут возвращены службой DNS. Введите 0, чтобы вернуть все IP-адреса. Допустимые значения: 1-20. Специальные значения: 0 - «вернуть все IP-адреса». |
password string | Пароль пользователя Avi в контроллере Avi. Значение по умолчанию — переменная среды |
pool_algorithm string | Алгоритм балансировки нагрузки выберет пул GSLB в списке доступных пулов службы GSLB. Варианты перечисления - GSLB_SERVICE_ALGORITHM_PRIORITY, GSLB_SERVICE_ALGORITHM_GEO. Поле добавлено в версии 17.2.3. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как GSLB_SERVICE_ALGORITHM_PRIORITY. |
site_persistence_enabled boolean | Включить сохранение состояния сессии для gslbservice. Поле добавлено в версии 17.2.1. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как False. Варианты:
|
state string | Состояние, которое должно быть применено к объекту. Варианты:
|
tenant string | Имя арендатора, используемого для всех вызовов Avi API и контекста объекта. По умолчанию: |
tenant_ref string | Это ссылка на объект типа tenant. |
tenant_uuid string | UUID арендатора, используемого для всех вызовов Avi API и контекста объекта. По умолчанию: |
ttl string | Значение TTL (в секундах) для записей, обслуживаемых для этой службы GSLB службой DNS. Допустимые значения: 0-86400. |
url string | URL контроллера Avi для объекта. |
use_edns_client_subnet boolean | Использовать подсеть IP-адреса клиента из опции EDNS в качестве исходного IP-адреса для геолокации клиента и алгоритма консистентного хэширования. По умолчанию значение — true. Поле введено в версии 17.1.1. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как True. Варианты:
|
username string | Имя пользователя, используемое для доступа к контроллеру Avi. Значение по умолчанию — переменная окружения |
uuid string | UUID службы gslb. |
wildcard_match boolean | Включить сопоставление с подстановочными знаками для доменного имени, если точное совпадение не найдено в таблице DNS, выбирается наибольшее совпадение с использованием подстановочных знаков для доменного имени в запросе 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 dictionary | Объект gslbService (api/gslbservice) Возвращаемое значение: success, changed |
Ссылки на сборку
© 2012–2018 Michael DeHaan
© 2018–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/community/network/avi_gslbservice_module.html