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 логическое |
| Общий статус работоспособности члена GSLB определяется на основе комбинации ввода статуса контроллера и каналов данных. Обратите внимание, что статус каналов данных определяется по ассоциации профилей мониторинга работоспособности. Статус, предоставляемый только контроллером, определяется с помощью этой конфигурации. Значение по умолчанию, если оно не указано в API или модуле, интерпретируется контроллером Avi как True. |
| created_by - | Имя создателя. Поле введено в 17.1.2. | |
| description - | Определяемое пользователем описание объекта. | |
| domain_names - | Полное доменное имя gslb-сервиса. | |
| down_response - | Ответ клиенту при недоступности gslb-сервиса. | |
| enabled логическое |
| Включить или отключить gslb-сервис. Если gslb-сервис включен, то виртуальные IP-адреса отправляются в ответах DNS на основе достижимости и настроенного алгоритма. Если gslb-сервис отключен, то виртуальные IP-адреса больше не доступны в ответе DNS. Значение по умолчанию, если оно не указано в API или модуле, интерпретируется контроллером Avi как True. |
| groups - | Список пулов, принадлежащих данному gslb-сервису. | |
| health_monitor_refs - | Проверка работоспособности по health, применяя один или несколько мониторов работоспособности. Активные мониторы генерируют синтетический трафик из двигателя сервиса DNS и маркируют VS как доступным или недоступным на основе ответа. Это ссылка на объект типа healthmonitor. | |
| health_monitor_scope - | Зондирование монитора работоспособности может выполняться для всех членов или только для сторонних членов. Этот режим работы полезен для уменьшения числа зондирований мониторов работоспособности в случае гибридной ситуации. В таком случае члены 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 логическое |
| Это поле указывает, что этот объект дублируется по всей федерации 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 логическое добавлен в 2.5 |
| Включить сохранение сайта для gslbservice. Поле введено в 17.2.1. Значение по умолчанию, если оно не указано в API или модуле, интерпретируется контроллером Avi как False. |
| state - |
| Состояние, которое должно быть применено к сущности. |
| tenant строка | Значение по умолчанию: "admin" | Имя клиента, используемое для всех вызовов API Avi и контекста объекта. |
| tenant_ref - | Это ссылка на объект типа клиент. | |
| tenant_uuid строка | Значение по умолчанию: "" | UUID клиента, используемый для всех вызовов API Avi и контекста объекта. |
| ttl - | Значение TTL (в секундах) для записей, предоставляемых для этого gslb-сервиса сервисом DNS. Допустимые значения — 1-86400. Единицы (сек). | |
| url - | URL контроллера Avi объекта. | |
| use_edns_client_subnet логическое |
| Использовать подсеть IP-адреса клиента из опции EDNS в качестве исходного IP-адреса для определения местоположения клиента и алгоритма консистентного хэширования. Значение по умолчанию — true. Поле введено в 17.1.1. Значение по умолчанию, если оно не указано в API или модуле, интерпретируется контроллером Avi как True. |
| Имя пользователя строка | По умолчанию: "" | Имя пользователя, используемое для доступа к контроллеру Avi. Значение по умолчанию — переменная окружения AVI_USERNAME. |
| uuid - | Uuid службы gslb. | |
| сопоставление_шаблонов логическое |
| Включить сопоставление шаблонов для fqdn, если точное совпадение не найдено в таблице DNS, выбирается самое длинное совпадение путем сопоставления шаблонов fqdn в DNS запросе. По умолчанию значение ложь. Поле введено в 17.1.1. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как Ложь. |
Примечания
Примечание
- Дополнительную информацию об использовании 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
Возвращаемые значения
Общие возвращаемые значения документированы здесь, следующие — поля, уникальные для данного модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| объект словарь | успех, изменения | Объект GslbService (api/gslbservice) |
Статус
- Гарантия обратной совместимости интерфейса этого модуля не предоставляется. [превью]
- Этот модуль поддерживается сообществом Ansible. [сообщество]
Авторы
- Gaurav 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.8/modules/avi_gslbservice_module.html
