avi_cloud – Модуль для настройки облачного объекта Avi RESTful
Новая версия с 2.4.
Описание
- Этот модуль используется для настройки облачного объекта
- больше примеров по адресу https://github.com/avinetworks/devops
Требования
Ниже перечислены требования к хосту, на котором выполняется этот модуль.
- avisdk
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| api_context словарь добавлено в 2.5 | Контекст API Avi, включающий текущий идентификатор сеанса и токен CSRF. Это позволяет пользователю выполнить единый вход и повторно использовать сеанс. | ||
| api_version строка | По умолчанию: "16.4.4" | Версия API Avi для использования с API Avi и объектами. | |
| apic_configuration - | Настройки apicconfiguration для облака. | ||
| apic_mode логический тип |
| Логический флаг для установки apic_mode. Значение по умолчанию, если оно не указано в API или модуле, интерпретируется контроллером Avi как False. | |
| autoscale_polling_interval - добавлено в 2.9 | Интервал опроса Cloudconnector для внешних групп автомасштабирования. Поле введено в 18.2.2. Значение по умолчанию, если оно не указано в API или модуле, интерпретируется контроллером Avi как 60. | ||
| avi_api_patch_op - добавлено в 2.5 |
| Операция исправления, используемая при использовании avi_api_update_method как исправления. | |
| avi_api_update_method - добавлено в 2.5 |
| Метод по умолчанию для обновления объекта — HTTP PUT. Установка в patch переопределит это поведение, чтобы использовать HTTP PATCH. | |
| avi_credentials словарь добавлено в 2.5 | Словарь Avi Credentials, который можно использовать вместо перечисления данных входа в контроллер Avi. | ||
| api_version - | По умолчанию: "16.4.4" | Версия контроллера Avi | |
| controller - | IP-адрес или SQDN контроллера Avi | ||
| csrftoken - | Токен csrftoken API контроллера Avi для повторного использования существующего сеанса с идентификатором сеанса | ||
| password - | Пароль контроллера Avi | ||
| port - | Порт контроллера Avi | ||
| session_id - | Идентификатор сеанса API контроллера Avi для повторного использования существующего сеанса с csrftoken | ||
| tenant - | По умолчанию: "admin" | Tenant контроллера Avi | |
| tenant_uuid - | UUID Tenant контроллера Avi | ||
| timeout - | По умолчанию: 300 | Время ожидания запроса контроллера Avi | |
| token - | Токен API контроллера Avi | ||
| username - | Имя пользователя контроллера Avi | ||
| avi_disable_session_cache_as_fact логический тип добавлено в 2.6 |
| Отключает кеширование информации о сеансе avi в качестве факта. | |
| aws_configuration - | Настройки awsconfiguration для облака. | ||
| azure_configuration - добавлено в 2.5 | Поле введено в 17.2.1. | ||
| cloudstack_configuration - | Настройки cloudstackconfiguration для облака. | ||
| controller строка | По умолчанию: "" | IP-адрес или имя хоста контроллера. Значение по умолчанию — переменная среды AVI_CONTROLLER. | |
| custom_tags - добавлено в 2.5 | Пользовательские метки для всех созданных avi ресурсов в облачной инфраструктуре. Поле введено в 17.1.5. | ||
| dhcp_enabled логический тип |
| Выберите схему управления IP-адресами. Значение по умолчанию, если оно не указано в API или модуле, интерпретируется контроллером Avi как False. | |
| dns_provider_ref - | Профиль DNS для облака. Это ссылка на объект типа ipamdnsproviderprofile. | ||
| docker_configuration - | Настройки dockerconfiguration для облака. | ||
| east_west_dns_provider_ref - | Профиль DNS для сетей east-west. Это ссылка на объект типа ipamdnsproviderprofile. | ||
| east_west_ipam_provider_ref - | Профиль Ipam для сетей east-west. Предупреждение — используйте виртуальные подсети в этом профиле ipam, которые не конфликтуют с подсетями основы или любыми накладными сетями в кластере. Например, в aws и gcp используется 169.254.0.0/16 для хранения метаданных экземпляра. Следовательно, он не должен использоваться в этом профиле. Это ссылка на объект типа ipamdnsproviderprofile. | ||
| enable_vip_static_routes логический тип |
| Использовать статические маршруты для разрешения сети со стороны vip во время размещения виртуальной службы. Значение по умолчанию, если оно не указано в API или модуле, интерпретируется контроллером Avi как False. | |
| gcp_configuration - добавлено в 2.9 | Настройка Google Cloud Platform. Поле введено в 18.2.1. | ||
| ip6_autocfg_enabled логический тип добавлено в 2.9 |
| Включить автоматическую настройку ipv6. Поле введено в 18.1.1. Значение по умолчанию, если оно не указано в API или модуле, интерпретируется контроллером Avi как False. | |
| ipam_provider_ref - | Профиль Ipam для облака. Это ссылка на объект типа ipamdnsproviderprofile. | ||
| license_tier - добавлено в 2.5 | Указывает уровень лицензии по умолчанию, который будет использоваться новыми се группами. Это поле по умолчанию наследует значение из системной конфигурации. Варианты перечисления — 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_configuration для облака. | ||
| mesos_configuration - | Поле устарело в версии 18.2.2. | ||
| mtu - | Настройка MTU для облака. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как 1500. | ||
| name - / обязательно | Имя объекта. | ||
| nsx_configuration - | Параметры конфигурации для менеджера nsx. Поле добавлено в версии 17.1.1. | ||
| obj_name_prefix - | Префикс по умолчанию для всех автоматически созданных объектов в этом облаке. Этот префикс можно переопределить в шаблоне se-группы. | ||
| 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 логическое добавлено в 2.5 |
| Записи DNS для виртуальных IP-адресов добавляются/удаляются на основе операционного состояния виртуальных IP-адресов. Поле добавлено в версии 17.1.12. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как True. | |
| tenant строка | По умолчанию: "admin" | Имя клиента, используемого для всех вызовов API Avi и контекста объекта. | |
| tenant_ref - | Ссылка на объект типа tenant. | ||
| tenant_uuid строка | По умолчанию: "" | UUID клиента, используемого для всех вызовов API Avi и контекста объекта. | |
| url - | URL контроллера Avi для объекта. | ||
| username строка | По умолчанию: "" | Имя пользователя, используемое для доступа к контроллеру Avi. Значение по умолчанию — переменная среды AVI_USERNAME. | |
| uuid - | Уникальный идентификатор объекта. | ||
| vca_configuration - | Настройки vcloudairconfiguration для облака. | ||
| vcenter_configuration - | Настройки vcenterconfiguration для облака. | ||
| vtype - / обязательно | Тип облака. Варианты перечисления - 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
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) |
Статус
- Этот модуль не гарантирует обратной совместимости интерфейса. [превью]
- Этот модуль поддерживается сообществом Ansible. [community]
Авторы
- 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.9/modules/avi_cloud_module.html