avi_gslb – Модуль для настройки Gslb Avi RESTful Объекта
Новая версия 2.4.
Краткое описание
- Этот модуль используется для конфигурации объекта Gslb
- больше примеров на https://github.com/avinetworks/devops
Требования
Ниже перечислены требования к хосту, на котором выполняется этот модуль.
- avisdk
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| api_context словарь добавлен в 2.5 | Контекст API Avi, включающий текущий идентификатор сессии и токен CSRF. Это позволяет пользователю выполнить однократный вход и повторно использовать сессию. | |
| api_version строка | Значение по умолчанию: "16.4.4" | Версия API Avi для использования в Avi API и объектах. |
| 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. | |
| 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 логическое добавлен в 2.4 |
| Это поле указывает, что этот объект дублируется в федерации gslb. Поле введено в 17.1.3. Значение по умолчанию, если оно не указано в API или модуле, интерпретируется контроллером Avi как True. |
| leader_cluster_uuid - / требуется | Отметить этот сайт как лидера конфигурации gslb. Этот сайт среди сайтов avi. | |
| maintenance_mode логическое добавлен в 2.5 |
| Это поле отключает операции конфигурации на лидере для всех федеративных объектов. Операции 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 - |
| Состояние, которое должно быть применено к сущности. |
| 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 - | Идентификатор представления используется в режиме изменения лидера для различения разграниченных групп, у которых есть одинаковое пространство имен gslb. Каждая разграниченная группа сможет работать независимо с помощью идентификатора представления. Значение по умолчанию, если оно не указано в API или модуле, интерпретируется контроллером Avi как 0. |
Примечания
Примечание
- Дополнительную информацию об использовании Ansible для управления устройствами сети Avi см. в 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 словарь | успех, изменено | Объект Gslb (api/gslb) |
Статус
- Этот модуль не гарантирует обратную совместимость. [предварительный просмотр]
- Этот модуль поддерживается сообществом Ansible. [сообщество]
Авторы
- Гаурав Растоги (@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_gslb_module.html
