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 для использования с Avi API и объектами.
application_persistence_profile_ref - добавлен в 2.5			Федеративная настройка сохранения состояния приложения, связанная с функцией сохранения состояния сайта gslbservice. Это ссылка на объект типа applicationpersistenceprofile. Поле введено в 17.2.1.
avi_api_patch_op - добавлен в 2.5		Варианты: add replace delete	Операция патча, используемая при использовании avi_api_update_method как patch.
avi_api_update_method - добавлен в 2.5		Варианты: put ← patch	Метод по умолчанию для обновления объекта — HTTP PUT. Установка на patch переопределит это поведение, используя HTTP PATCH.
avi_credentials словарь добавлен в 2.5			Словарь Avi Credentials, который можно использовать вместо перечисления данных входа в Avi Controller.
	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 логическое добавлен в 2.6		Варианты: no yes	Отключает кеширование информации о сессии avi в качестве факта.
controller строка		Значение по умолчанию: ""	IP-адрес или имя хоста контроллера. Значение по умолчанию — переменная окружения `AVI_CONTROLLER`.
controller_health_status_enabled логическое		Варианты: no yes	Общий статус работоспособности члена Gs определяется на основе комбинации ввода статуса контроллера и состояния канала передачи данных. Обратите внимание, что состояние канала передачи данных определяется связыванием профилей мониторинга работоспособности. Только статус предоставленный контроллером определяется с помощью этой конфигурации. Значение по умолчанию при отсутствии в API или модуле интерпретируется контроллером Avi как True.
created_by -			Имя создателя. Поле введено в 17.1.2.
description -			Пользовательское описание объекта.
domain_names -			Полное доменное имя gslb-службы.
down_response -			Ответ клиенту при недоступности gslb-службы.
enabled логическое		Варианты: no yes	Включить или отключить gslb-службу. Если gslb-служба включена, виртуальные серверы отправляются в ответах DNS на основе достижимости и настроенного алгоритма. Если gslb-служба отключена, виртуальные серверы больше не доступны в ответе DNS. Значение по умолчанию при отсутствии в API или модуле интерпретируется контроллером Avi как True.
groups -			Список выбранных пулов, принадлежащих этой gslb-службе.
health_monitor_refs -			Проверка работоспособности по сравнению с мониторингом работоспособности с применением одного или нескольких мониторов работоспособности. Активные мониторы генерируют синтетический трафик из движка сервиса DNS и отмечают виртуальный сервер как рабочий или нерабочий на основе ответа. Это ссылка на объект типа 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 логическое добавлен в 2.9		Варианты: no yes	Это внутреннее поле, используемое в се. Поле введено в 18.2.2.
is_federated логическое		Варианты: no yes	Это поле указывает, что этот объект дублируется по всей федерации 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 - added in 2.5		Алгоритм распределения нагрузки выберет пул gslb в списке доступных пулов gslb-сервиса. Варианты перечисления — GSLB_SERVICE_ALGORITHM_PRIORITY, GSLB_SERVICE_ALGORITHM_GEO. Поле введено в 17.2.3. Значение по умолчанию, если не указано в API или модуле, Avi Controller интерпретирует как GSLB_SERVICE_ALGORITHM_PRIORITY.
site_persistence_enabled boolean added in 2.5	Варианты: no yes	Включить сайт-персистентность для gslbservice. Поле введено в 17.2.1. Значение по умолчанию, если не указано в API или модуле, Avi Controller интерпретирует как False.
state -	Варианты: absent present ←	Состояние, которое должно быть применено к объекту.
tenant string	По умолчанию: "admin"	Имя клиента, используемого для всех вызовов Avi API и контекста объекта.
tenant_ref -		Это ссылка на объект типа tenant.
tenant_uuid string	По умолчанию: ""	UUID клиента, используемого для всех вызовов Avi API и контекста объекта.
ttl -		Значение TTL (в секундах) для записей, предоставляемых для этого gslb-сервиса службой DNS. Допустимые значения — 0-86400.
url -		URL контроллера Avi для объекта.
use_edns_client_subnet boolean	Варианты: no yes	Использовать подсеть IP-адреса клиента из опции EDNS в качестве исходного IP-адреса для геолокации клиента и алгоритма консистентного хэширования. По умолчанию — true. Поле введено в 17.1.1. Значение по умолчанию, если не указано в API или модуле, Avi Controller интерпретирует как True.
username string	По умолчанию: ""	Имя пользователя, используемое для доступа к контроллеру Avi. Значение по умолчанию — переменная окружения `AVI_USERNAME`.
uuid -		UUID gslb-сервиса.
wildcard_match boolean	Варианты: no yes	Включить сопоставление по шаблону «» для имени хоста (FQDN), если точное совпадение не найдено в таблице DNS, выбирается самое длинное совпадение путем подстановки символа «» в FQDN в запросе DNS. По умолчанию — false. Поле введено в 17.1.1. Значение по умолчанию, если не указано в API или модуле, Avi Controller интерпретирует как False.

Примечания

Примечание

Дополнительную информацию об использовании 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

Возвращаемые значения

Общие возвращаемые значения описаны здесь, следующие поля уникальны для данного модуля:

Ключ	Возвращаемое значение	Описание
obj dictionary	success, changed	Объект GslbService (api/gslbservice)

Статус

Данный модуль не гарантирует обратную совместимость интерфейса. [preview]
Этот модуль поддерживается сообществом Ansible. [community]

Авторы

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.9/modules/avi_gslbservice_module.html