community.network.avi_cloud – Модуль для настройки облачного объекта Avi RESTful
Примечание
Этот плагин входит в коллекцию community.network (версия 1.3.0).
Для его установки используйте: ansible-galaxy collection install community.network.
Чтобы использовать его в книге задач, укажите: community.network.avi_cloud.
Обзор
- Этот модуль используется для настройки облачного объекта
- больше примеров на https://github.com/avinetworks/devops
Требования
Ниже приведены требования к хосту, на котором выполняется этот модуль.
- avisdk
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| api_context словарь | Контекст API Avi, включающий текущий идентификатор сеанса и маркер CSRF. Это позволяет пользователю выполнить одно входное подключение и повторно использовать сеанс. | ||
| api_version строка | Значение по умолчанию: "16.4.4" | Версия API Avi, используемая для API Avi и объектов. | |
| apic_configuration строка | Настройки конфигурации apic для облака. | ||
| apic_mode логическое значение |
| Логический флаг для установки apic_mode. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как False. | |
| autoscale_polling_interval строка | Интервал опроса Cloudconnector для внешних групп автомасштабирования. Поле введено в 18.2.2. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как 60. | ||
| avi_api_patch_op строка |
| Операция исправления, используемая при использовании avi_api_update_метода как исправление. | |
| avi_api_update_method строка |
| Метод по умолчанию для обновления объекта — HTTP PUT. Установление в patch переопределяет это поведение для использования HTTP PATCH. | |
| avi_credentials словарь | Словарь учетных данных Avi, который можно использовать вместо перечисления данных входа в контроллер Avi. | ||
| api_version строка | Значение по умолчанию: "16.4.4" | Версия контроллера Avi | |
| controller строка | IP-адрес или SQDN контроллера Avi | ||
| csrftoken строка | Маркер API контроллера Avi csrftoken для повторного использования существующего сеанса с идентификатором сеанса | ||
| password строка | Пароль пользователя Avi в контроллере 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 логическое значение |
| Отключает кэширование информации о сеансе avi как факта. | |
| aws_configuration строка | Настройки конфигурации aws для облака. | ||
| azure_configuration строка | Поле введено в 17.2.1. | ||
| cloudstack_configuration строка | Настройки конфигурации cloudstack для облака. | ||
| controller строка | Значение по умолчанию: "" | IP-адрес или имя хоста контроллера. Значение по умолчанию — переменная среды AVI_CONTROLLER. | |
| custom_tags строка | Пользовательские теги для всех созданных в облачной инфраструктуре ресурсов Avi. Поле введено в 17.1.5. | ||
| dhcp_enabled логическое значение |
| Выберите схему управления IP-адресами. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как False. | |
| dns_provider_ref строка | Профиль DNS для облака. Это ссылка на объект типа ipamdnsproviderprofile. | ||
| docker_configuration строка | Настройки конфигурации Docker для облака. | ||
| 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 логическое значение |
| Использовать статические маршруты для разрешения сети стороны VIP во время размещения виртуальных сервисов. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как False. | |
| gcp_configuration строка | Конфигурация Google Cloud Platform. Поле введено в 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 строка | Если тип лицензии не указан, выбирается стандартное принудительное применение лицензии для типа облака. Стандартные сопоставления: контейнерное облако — max ses, OpenStack и VMware — cores, Linux — sockets. Варианты перечисления — LIC_BACKEND_SERVERS, LIC_SOCKETS, LIC_CORES, LIC_HOSTS, LIC_SE_BANDWIDTH, LIC_METERED_SE_BANDWIDTH. | ||
| linuxserver_configuration строка | Настройки конфигурации linuxserver для облака. | ||
| mesos_configuration строка | Поле устарело в 18.2.2. | ||
| mtu строка | Настройка MTU для облака. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как 1500. | ||
| name строка / обязательно | Имя объекта. | ||
| nsx_configuration строка | Параметры конфигурации для менеджера NSX. Поле введено в 17.1.1. | ||
| obj_name_prefix строка | Префикс по умолчанию для всех автоматически созданных объектов в этом облаке. Этот префикс можно переопределить с помощью шаблона группы се. | ||
| openstack_configuration строка | Настройки конфигурации OpenStack для облака. | ||
| oshiftk8s_configuration строка | Настройки конфигурации Oshiftk8s для облака. | ||
| password строка | Значение по умолчанию: "" | Пароль пользователя Avi в контроллере Avi. Значение по умолчанию — переменная среды AVI_PASSWORD. | |
| prefer_static_routes логическое значение |
| Предпочитать статические маршруты по сравнению с маршрутами интерфейса при размещении виртуальных сервисов. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как False. | |
| proxy_configuration строка | Настройки конфигурации прокси для облака. | ||
| rancher_configuration строка | Настройки конфигурации Rancher для облака. | ||
| state строка |
| Состояние, которое должно быть применено к сущности. | |
| state_based_dns_registration boolean |
| DNS-записи для виртуальных IP-адресов добавляются/удаляются в зависимости от операционного состояния виртуальных IP-адресов. Поле введено в версии 17.1.12. Значение по умолчанию, если не указано в API или модуле, Avi Controller интерпретирует как True. | |
| tenant string | По умолчанию: "admin" | Имя клиента, используемое для всех вызовов API Avi и контекста объекта. | |
| tenant_ref string | Ссылка на объект типа tenant. | ||
| 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 / обязательно | Тип облака. Варианты перечисления — 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 Controller интерпретирует как CLOUD_NONE. | ||
Примечания
Примечание
- Дополнительную информацию об использовании Ansible для управления устройствами Avi Network см. на странице 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 словарь | success, changed | Объект облака (api/cloud) |
Авторы
- 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.10/collections/community/network/avi_cloud_module.html
