Spec-Zone.ru › Ansible

Модуль community.network.avi_cloud — Модуль для настройки RESTful объекта Cloud Avi

Примечание

Этот модуль является частью коллекции community.network (версия 5.0.3).

У вас, возможно, уже установлена эта коллекция, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.

Чтобы установить её, используйте: ansible-galaxy collection install community.network. Для использования этого модуля требуются дополнительные компоненты. Подробности см. в разделе Требования.

Чтобы использовать его в плейбуке, укажите: community.network.avi_cloud.

  • Обзор
  • Требования
  • Параметры
  • Примечания
  • Примеры
  • Возвращаемые значения

Обзор

  • Этот модуль используется для настройки объекта Cloud
  • Дополнительные примеры на https://github.com/avinetworks/devops

Псевдонимы: network.avi.avi_cloud

Требования

Ниже перечислены требования, которые должны быть выполнены на хосте, где будет выполняться этот модуль.

  • avisdk
END_OF_DOCUMENT_MARKER

Параметры

Параметр

Комментарии

api_context

словарь

Контекст API Avi, включающий текущий идентификатор сеанса и CSRF-токен.

Это позволяет пользователю выполнить единый вход и повторно использовать сеанс.

api_version

строка

Версия API Avi для использования с Avi API и объектами.

По умолчанию: "16.4.4"

apic_configuration

строка

Настройки конфигурации apic для облака.

apic_mode

логическое значение

Флаг логического значения для установки apic_mode.

Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как False.

Варианты:

  • false
  • true

autoscale_polling_interval

строка

Интервал опроса cloudconnector для внешних групп автоматического масштабирования.

Поле добавлено в версии 18.2.2.

Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как 60.

avi_api_patch_op

строка

Операция исправления, используемая при использовании avi_api_update_method как patch.

Варианты:

  • "add"
  • "replace"
  • "delete"

avi_api_update_method

строка

Метод по умолчанию для обновления объекта — HTTP PUT.

Установка значения на patch переопределит это поведение и будет использовать HTTP PATCH.

Варианты:

  • "put" ← (по умолчанию)
  • "patch"

avi_credentials

словарь

Словарь учетных данных Avi, который можно использовать вместо перечисления данных входа в контроллер Avi.

api_version

строка

Версия контроллера Avi

По умолчанию: "16.4.4"

controller

строка

IP-адрес или SQDN контроллера Avi

csrftoken

строка

CSRF-токен API контроллера Avi для повторного использования существующего сеанса с идентификатором сеанса

По умолчанию: ""

password

строка

Пароль контроллера Avi

port

строка

Порт контроллера Avi

session_id

строка

Идентификатор сеанса API контроллера Avi для повторного использования существующего сеанса с csrftoken

По умолчанию: ""

tenant

строка

Тенент контроллера Avi

По умолчанию: "admin"

tenant_uuid

строка

UUID тенента контроллера Avi

По умолчанию: ""

timeout

строка

Таймаут запроса контроллера Avi

По умолчанию: 300

token

строка

Токен API контроллера Avi

По умолчанию: ""

username

строка

Имя пользователя контроллера Avi

avi_disable_session_cache_as_fact

логическое значение

Отключает кэширование информации о сеансе Avi в качестве факта.

Варианты:

  • false ← (по умолчанию)
  • true

aws_configuration

строка

Настройки конфигурации aws для облака.

azure_configuration

строка

Поле добавлено в версии 17.2.1.

cloudstack_configuration

string

Настройки Cloudstackconfiguration для облака.

controller

string

IP-адрес или имя хоста контроллера. Значение по умолчанию — переменная среды AVI_CONTROLLER.

custom_tags

string

Пользовательские теги для всех созданных ресурсов Avi в облачной инфраструктуре.

Поле добавлено в версии 17.1.5.

dhcp_enabled

boolean

Выберите схему управления IP-адресами.

Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как False.

Варианты:

  • false
  • true

dns_provider_ref

string

DNS-профиль для облака.

Это ссылка на объект типа ipamdnsproviderprofile.

docker_configuration

string

Настройки Dockerconfiguration для облака.

east_west_dns_provider_ref

string

DNS-профиль для сервисов east-west.

Это ссылка на объект типа ipamdnsproviderprofile.

east_west_ipam_provider_ref

string

IPAM-профиль для сервисов east-west.

Предупреждение — пожалуйста, используйте виртуальные подсети в этом IPAM-профиле, которые не конфликтуют с базовыми сетями или любыми наложенными сетями в кластере.

Например, в AWS и GCP 169.254.0.0/16 используется для хранения метаданных экземпляра.

Следовательно, он не должен использоваться в этом профиле.

Это ссылка на объект типа ipamdnsproviderprofile.

enable_vip_static_routes

boolean

Использовать статические маршруты для разрешения сети со стороны VIP во время размещения виртуальных сервисов.

Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как False.

Варианты:

  • false
  • true

gcp_configuration

string

Конфигурация Google Cloud Platform.

Поле добавлено в версии 18.2.1.

ip6_autocfg_enabled

boolean

Включить автоматическую конфигурацию IPv6.

Поле добавлено в версии 18.1.1.

Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как False.

Варианты:

  • false
  • true

ipam_provider_ref

string

IPAM-профиль для облака.

Это ссылка на объект типа ipamdnsproviderprofile.

license_tier

string

Указывает уровень лицензии по умолчанию, который будет использоваться новыми группами SE.

Это поле по умолчанию наследует значение из системной конфигурации.

Варианты перечисления - ENTERPRISE_16, ENTERPRISE_18.

Поле добавлено в версии 17.2.5.

license_type

string

Если тип лицензии не указан, то выбирается принудительное применение лицензии по умолчанию для типа облака.

Сопоставления по умолчанию: облако контейнеров — максимальное количество сессий, OpenStack и VMware — ядра, а Linux — сокеты.

Варианты перечисления - LIC_BACKEND_SERVERS, LIC_SOCKETS, LIC_CORES, LIC_HOSTS, LIC_SE_BANDWIDTH, LIC_METERED_SE_BANDWIDTH.

linuxserver_configuration

string

Настройки Linuxserverconfiguration для облака.

mesos_configuration

string

Поле устарело в версии 18.2.2.

mtu

string

Настройка MTU для облака.

Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как 1500.

name

string / required

Имя объекта.

nsx_configuration

string

Параметры конфигурации для менеджера NSX.

Поле добавлено в версии 17.1.1.

obj_name_prefix

string

Префикс по умолчанию для всех автоматически созданных объектов в этом облаке.

Этот префикс может быть переопределен шаблоном группы SE.

openstack_configuration

string

Настройки Openstackconfiguration для облака.

oshiftk8s_configuration

string

Настройки Oshiftk8sconfiguration для облака.

password

string

Пароль пользователя Avi в контроллере Avi. Значение по умолчанию — переменная окружения AVI_PASSWORD.

prefer_static_routes

boolean

Предпочитать статические маршруты маршрутам интерфейса во время размещения виртуальной службы.

Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как False.

Варианты:

  • false
  • true

proxy_configuration

string

Настройки конфигурации прокси для облака.

rancher_configuration

string

Настройки конфигурации Rancher для облака.

state

string

Состояние, которое должно быть применено к сущности.

Варианты:

  • "absent"
  • "present" ← (по умолчанию)

state_based_dns_registration

boolean

Записи DNS для виртуальных IP-адресов добавляются/удаляются на основе операционного состояния виртуальных IP-адресов.

Поле введено в версии 17.1.12.

Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как True.

Варианты:

  • false
  • true

tenant

string

Имя клиента, используемого для всех вызовов API Avi и контекста объекта.

По умолчанию: "admin"

tenant_ref

string

Ссылка на объект типа клиент.

tenant_uuid

string

UUID клиента, используемого для всех вызовов API Avi и контекста объекта.

По умолчанию: ""

url

string

URL контроллера Avi для объекта.

username

string

Имя пользователя для доступа к контроллеру Avi. Значение по умолчанию — переменная окружения AVI_USERNAME.

uuid

string

Уникальный идентификатор объекта.

vca_configuration

string

Настройки конфигурации Vcloud-air для облака.

vcenter_configuration

string

Настройки конфигурации Vcenter для облака.

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 как 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

словарь

Объект облака (api/cloud)

Возвращается при: успех, изменилось

Авторы

  • Gaurav Rastogi (@grastogi23)

Ссылки на коллекции

  • Отслеживание проблем
  • Репозиторий (источники)

© 2012–2018 Michael DeHaan
© 2018–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/community/network/avi_cloud_module.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API