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 для использования с API Avi и объектами. |
| 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 dict | успех, изменения | Объект Gslb (api/gslb) |
Статус
Этот модуль помечен как превью, что означает, что он не гарантирует обратную совместимость интерфейса.
Автор
- Гौरव रस्तोगी (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.5/modules/avi_gslb_module.html
