community.network.avi_cloud – Модуль для настройки облачного объекта Avi RESTful
Примечание
Этот плагин входит в коллекцию community.network (версия 2.0.1).
Для его установки используйте: ansible-galaxy collection install community.network.
Чтобы использовать его в плейбуке, укажите: community.network.avi_cloud.
Обзор
- Этот модуль используется для настройки облачного объекта
- Больше примеров на https://github.com/avinetworks/devops
Требования
Ниже перечислены требования к хосту, на котором выполняется этот модуль.
- avisdk
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| api_context словарь | Контекст API Avi, включающий текущий ID сессии и CSRF-токен. Это позволяет пользователю выполнить единый вход и повторно использовать сессию. | ||
| api_version строка | По умолчанию: "16.4.4" | Версия API Avi, используемая для API Avi и объектов. | |
| apic_configuration строка | Настройки apicconfiguration для облака. | ||
| apic_mode логический тип |
| Логический флаг для установки apic_mode. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как False. | |
| autoscale_polling_interval строка | Интервал опроса Cloudconnector для внешних групп автоматического масштабирования. Поле введено в 18.2.2. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как 60. | ||
| avi_api_patch_op строка |
| Операция исправления, используемая при использовании avi_api_update_method как patch. | |
| avi_api_update_method строка |
| Метод по умолчанию для обновления объекта — HTTP PUT. Установка в patch переопределит это поведение, чтобы использовать HTTP PATCH. | |
| avi_credentials словарь | Словарь Avi Credentials, который можно использовать вместо перечисления данных входа в контроллер Avi. | ||
| api_version строка | По умолчанию: "16.4.4" | Версия контроллера Avi | |
| controller строка | IP-адрес или SQDN контроллера Avi | ||
| csrftoken строка | CSRF-токен API контроллера Avi для повторного использования существующей сессии с ID сессии | ||
| password строка | Пароль пользователя Avi в контроллере Avi | ||
| port строка | Порт контроллера Avi | ||
| session_id строка | ID сессии API контроллера Avi для повторного использования существующей сессии с CSRF-токен | ||
| tenant строка | По умолчанию: "admin" | Аренда контроллера Avi | |
| tenant_uuid строка | UUID аренды контроллера Avi | ||
| timeout строка | По умолчанию: 300 | Тайм-аут запроса контроллера Avi | |
| token строка | Токен API контроллера Avi | ||
| username строка | Имя пользователя контроллера Avi | ||
| avi_disable_session_cache_as_fact логический тип |
| Отключает кеширование информации о сессии avi в качестве факта. | |
| aws_configuration строка | Настройки awsconfiguration для облака. | ||
| azure_configuration строка | Поле введено в 17.2.1. | ||
| cloudstack_configuration строка | Настройки cloudstackconfiguration для облака. | ||
| controller строка | По умолчанию: "" | IP-адрес или имя хоста контроллера. Значение по умолчанию — переменная среды AVI_CONTROLLER. | |
| custom_tags строка | Пользовательские теги для всех созданных ресурсом avi в облачной инфраструктуре. Поле введено в 17.1.5. | ||
| dhcp_enabled логический тип |
| Выберите схему управления IP-адресами. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как False. | |
| dns_provider_ref строка | Профиль DNS для облака. Это ссылка на объект типа ipamdnsproviderprofile. | ||
| docker_configuration строка | Настройки dockerconfiguration для облака. | ||
| east_west_dns_provider_ref строка | Профиль DNS для сетей «восток-запад». Это ссылка на объект типа ipamdnsproviderprofile. | ||
| east_west_ipam_provider_ref строка | Профиль Ipam для сетей «восток-запад». Предупреждение — используйте виртуальные подсети в этом профиле Ipam, которые не конфликтуют с подсетями нижнего уровня или любыми наложенными сетями в кластере. Например, в aws и gcp для хранения метаданных экземпляра используется 169.254.0.0/16. Поэтому его не следует использовать в этом профиле. Это ссылка на объект типа ipamdnsproviderprofile. | ||
| enable_vip_static_routes логический тип |
| Использовать статические маршруты для разрешения сети со стороны виртуального IP-адреса (VIP) при размещении виртуальной службы. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как False. | |
| gcp_configuration строка | Настройка платформы Google Cloud. Поле введено в 18.2.1. | ||
| ip6_autocfg_enabled логический тип |
| Включить автоматическую конфигурацию IPv6. Поле введено в 18.1.1. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как False. | |
| ipam_provider_ref строка | Профиль Ipam для облака. Это ссылка на объект типа ipamdnsproviderprofile. | ||
| license_tier строка | Указывает уровень лицензии по умолчанию, который будет использоваться новыми группами се. Это поле по умолчанию наследует значение из системной конфигурации. Варианты перечисления — ENTERPRISE_16, ENTERPRISE_18. Поле введено в 17.2.5. | ||
| license_type строка | Если тип лицензии не указан, выбирается политика по умолчанию для принудительного применения лицензии для типа облака. Значения по умолчанию: для контейнерного облака — максимальное количество се, для OpenStack и VMware — количество ядер, для Linux — количество сокетов. Варианты перечисления — LIC_BACKEND_SERVERS, LIC_SOCKETS, LIC_CORES, LIC_HOSTS, LIC_SE_BANDWIDTH, LIC_METERED_SE_BANDWIDTH. | ||
| linuxserver_configuration строка | Настройки linuxserverconfiguration для облака. | ||
| mesos_configuration строка | Поле устарело в 18.2.2. | ||
| mtu строка | Настройка MTU для облака. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как 1500. | ||
| name строка / обязательно | Имя объекта. | ||
| nsx_configuration строка | Настройки параметров для менеджера nsx. Поле введено в 17.1.1. | ||
| obj_name_prefix строка | Префикс по умолчанию для всех автоматически создаваемых объектов в этом облаке. Этот префикс можно переопределить с помощью шаблона группы се. | ||
| openstack_configuration строка | Настройки openstackconfiguration для облака. | ||
| oshiftk8s_configuration строка | Настройки oshiftk8sconfiguration для облака. | ||
| password строка | По умолчанию: "" | Пароль пользователя Avi в контроллере Avi. Значение по умолчанию — переменная среды AVI_PASSWORD. | |
| prefer_static_routes логический тип |
| Предпочитать статические маршруты маршрутам интерфейса при размещении виртуальной службы. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как False. | |
| proxy_configuration строка | Настройки proxyconfiguration для облака. | ||
| rancher_configuration строка | Настройки rancherconfiguration для облака. | ||
| state строка |
| Состояние, которое должно быть применено к сущности. | |
| state_based_dns_registration boolean |
| Записи DNS для виртуальных IP-адресов добавляются/удаляются в зависимости от операционного состояния виртуальных IP-адресов. Поле добавлено в версии 17.1.12. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как True. | |
| tenant string | По умолчанию: "admin" | Имя клиента, используемого для всех вызовов API Avi и контекста объекта. | |
| tenant_ref string | Это ссылка на объект типа клиент. | ||
| tenant_uuid string | По умолчанию: "" | UUID клиента, используемого для всех вызовов API Avi и контекста объекта. | |
| url string | URL контроллера Avi для объекта. | ||
| username string | По умолчанию: "" | Имя пользователя, используемое для доступа к контроллеру Avi. Значение по умолчанию — переменная среды AVI_USERNAME. | |
| uuid string | Уникальный идентификатор объекта. | ||
| vca_configuration string | Настройки vcloudairconfiguration для облака. | ||
| vcenter_configuration string | Настройки vcenterconfiguration для облака. | ||
| vtype string / required | Тип облака. Варианты перечисления - CLOUD_NONE, CLOUD_VCENTER, CLOUD_OPENSTACK, CLOUD_AWS, CLOUD_VCA, CLOUD_APIC, CLOUD_MESOS, CLOUD_LINUXSERVER, CLOUD_DOCKER_UCP, CLOUD_RANCHER, CLOUD_OSHIFT_K8S, CLOUD_AZURE, CLOUD_GCP. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как CLOUD_NONE. | ||
Примечания
Примечание
- Дополнительную информацию об использовании Ansible для управления устройствами сети Avi см. на странице https://www.ansible.com/ansible-avi-networks.
Примеры
- name: Create a VMware cloud with write access mode
community.network.avi_cloud:
username: '{{ username }}'
controller: '{{ controller }}'
password: '{{ password }}'
apic_mode: false
dhcp_enabled: true
enable_vip_static_routes: false
license_type: LIC_CORES
mtu: 1500
name: vCenter Cloud
prefer_static_routes: false
tenant_ref: admin
vcenter_configuration:
datacenter_ref: /api/vimgrdcruntime/datacenter-2-10.10.20.100
management_network: /api/vimgrnwruntime/dvportgroup-103-10.10.20.100
password: password
privilege: WRITE_ACCESS
username: user
vcenter_url: 10.10.20.100
vtype: CLOUD_VCENTER
Возвращаемые значения
Общие возвращаемые значения описаны здесь, следующие поля уникальны для данного модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| obj словарь | успех, изменения | Объект облака (api/cloud) |
Авторы
- Gaurav Rastogi (@grastogi23) <grastogi@avinetworks.com>
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/community/network/avi_cloud_module.html
