avi_gslb — Модуль для настройки RESTful объекта Gslb Avi

Новое в версии 2.4.

Описание
- Требования
Параметры
Примечания
Примеры
Возвращаемые значения
Статус
Техническое обслуживание
- Автор

Описание

Этот модуль используется для настройки объекта Gslb
Дополнительные примеры на https://github.com/avinetworks/devops

Требования

Ниже перечислены требования к хосту, на котором выполняется этот модуль.

avisdk

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
api_context (добавлено в 2.5)		Контекст API Avi, включающий текущий идентификатор сеанса и маркер CSRF. Это позволяет пользователю выполнить однократный вход и повторно использовать сеанс.
api_version	По умолчанию: "16.4.4"	Версия API Avi, используемая для вызовов API и работы с объектами Avi.
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, который может быть использован вместо указания данных входа в контроллер Avi.
clear_on_max_retries		Максимальное количество попыток, после которого удаленный сайт рассматривается как новый. При новом запуске загружаются все конфигурации. Допустимые значения: 1-1024. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как 20.
client_ip_addr_group (добавлено в 2.4)		Группа, указывающая, являются ли адреса IP-клиентов общедоступными или частными. Поле введено в 17.1.2.
controller	По умолчанию: ""	IP-адрес или имя хоста контроллера. Значение по умолчанию — переменная среды `AVI_CONTROLLER`.
description		Пользовательское описание объекта.
dns_configs		Конфигурация доменного имени поддомена для gslb. FQDN сервиса Gslb должен совпадать с одним из этих поддоменов.
is_federated bool (добавлено в 2.4)	Варианты: no yes	Это поле указывает, что этот объект реплицируется через федерацию gslb. Поле введено в 17.1.3. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как True.
leader_cluster_uuid обязательно		Отметить этот сайт как лидера конфигурации gslb. Этот сайт является одним из сайтов avi.
maintenance_mode bool (добавлено в 2.5)	Варианты: no yes	Это поле отключает операции конфигурации на лидере для всех федеративных объектов. Операции cud для gslb, gslbservice, gslbgeodbprofile и других федеративных объектов будут отклонены. Отключение rest-api помогает в сценариях обновления, когда мы не хотим синхронизации конфигурации с участником gslb, когда участник проходит обновление. Эта конфигурация программно блокирует лидера от принятия новой конфигурации gslb, когда участник проходит обновление. Поле введено в 17.2.1. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как False.
name обязательно		Имя объекта gslb.
password	По умолчанию: ""	Пароль пользователя Avi в контроллере Avi. Значение по умолчанию — переменная среды `AVI_PASSWORD`.
send_interval		Частота, с которой члены группы общаются. Допустимые значения: 1-3600. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как 15. Единицы (сек).
sites		Выберите участника сайта avi, принадлежащего этому gslb.
state	Варианты: absent present ←	Состояние, которое должно быть применено к объекту.
tenant	По умолчанию: "admin"	Имя клиента, используемого для всех вызовов API Avi и контекста объекта.
tenant_ref		Ссылка на объект типа клиент.
tenant_uuid	По умолчанию: ""	UUID клиента, используемого для всех вызовов API Avi и контекста объекта.
third_party_sites		Участник стороннего сайта, принадлежащий этому gslb. Поле введено в 17.1.1.
url		URL контроллера Avi для объекта.
username	По умолчанию: ""	Имя пользователя, используемого для доступа к контроллеру Avi. Значение по умолчанию — переменная среды `AVI_USERNAME`.
uuid		Uuid объекта gslb.
view_id		Идентификатор представления используется в режиме change-leader, чтобы различать разделенные группы, имеющие одинаковое пространство имен gslb. Каждая разделенная группа сможет работать независимо, используя идентификатор представления. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как 0.

Примечания

Примечание

Дополнительную информацию об использовании Ansible для управления устройствами Avi Network см. на странице https://www.ansible.com/ansible-avi-networks.

Примеры

- name: Example to create Gslb object
  avi_gslb:
    controller: 10.10.25.42
    username: admin
    password: something
    state: present
    name: sample_gslb

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

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

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

Статус

Этот модуль помечен как предварительный, что означает, что он не гарантирует обратную совместимость интерфейса.

Техническое обслуживание

Этот модуль помечен как сообщество, что означает, что он поддерживается сообществом Ansible. См. Техническое обслуживание и поддержка модулей для получения дополнительной информации.

Список других модулей, поддерживаемых сообществом Ansible, см. здесь.

Автор

Гaurav Rastogi (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.6/modules/avi_gslb_module.html