Spec-Zone.ru › Ansible

Модуль azure.azcollection.azure_rm_virtualwan — Управление экземпляром Azure VirtualWan

Примечание

Этот модуль является частью коллекции azure.azcollection (версия 2.7.0).

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

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

Чтобы использовать его в плейбуке, укажите: azure.azcollection.azure_rm_virtualwan.

Новое в azure.azcollection 1.5.0

  • Описание
  • Требования
  • Параметры
  • Примечания
  • См. также
  • Примеры
  • Значения возврата

Описание

  • Создание, обновление и удаление экземпляра Azure VirtualWan.

Требования

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

  • python >= 2.7
  • На хосте, выполняющем этот модуль, должна быть установлена коллекция azure.azcollection через galaxy
  • Все пакеты Python, перечисленные в файле requirements.txt коллекции, должны быть установлены через pip на хосте, на котором выполняются модули из azure.azcollection
  • Полные инструкции по установке можно найти по адресу https://galaxy.ansible.com/azure/azcollection

Параметры

Параметр

Комментарии

ad_user

string

Имя пользователя Active Directory. Используйте при аутентификации с пользователем Active Directory, а не с субъектом безопасности.

adfs_authority_url

string

added in azure.azcollection 0.0.1

URL-адрес узла Azure AD. Используйте при аутентификации с помощью имени пользователя/пароля и собственным узлом ADFS.

allow_branch_to_branch_traffic

boolean

True, если разрешен трафик между филиалами.

Choices:

  • false
  • true

allow_vnet_to_vnet_traffic

boolean

True если разрешен трафик между виртуальными сетями.

Choices:

  • false
  • true

api_profile

string

added in azure.azcollection 0.0.1

Выбирает профиль API для использования при взаимодействии с службами Azure. Значение по умолчанию latest подходит для общедоступных облаков; будущие значения позволят использовать с Azure Stack.

Default: "latest"

append_tags

boolean

Используется для управления тем, является ли поле тегов каноническим или просто добавляется к существующим тегам.

В каноническом режиме любые теги, не найденные в параметре тегов, будут удалены из метаданных объекта.

Choices:

  • false
  • true ← (default)

auth_source

string

added in azure.azcollection 0.0.1

Управляет источником учетных данных, используемых для аутентификации.

Также может быть установлено через переменную окружения ANSIBLE_AZURE_AUTH_SOURCE.

При установке в auto (по умолчанию) приоритет имеет параметры модуля -> env -> credential_file -> cli.

При установке в env, учетные данные будут считываться из переменных среды

При установке в credential_file, он будет считывать профиль из ~/.azure/credentials.

При установке в cli, учетные данные будут получены из профиля Azure CLI. subscription_id или переменная окружения AZURE_SUBSCRIPTION_ID могут использоваться для идентификации идентификатора подписки, если присутствует более одного, в противном случае используется подписка az cli по умолчанию.

При установке в msi, хост-машина должна быть ресурсом Azure с включенным расширением MSI. subscription_id или переменная окружения AZURE_SUBSCRIPTION_ID могут использоваться для идентификации идентификатора подписки, если ресурсу предоставлен доступ к более чем одной подписке, в противном случае выбирается первая подписка.

Параметр msi был добавлен в Ansible 2.6.

Choices:

  • "auto" ← (default)
  • "cli"
  • "credential_file"
  • "env"
  • "msi"

cert_validation_mode

string

added in azure.azcollection 0.0.1

Управляет поведением проверки сертификата для конечных точек Azure. По умолчанию все модули будут проверять серверный сертификат, но при использовании прокси-сервера HTTPS или для Azure Stack может потребоваться отключить это поведение, передав ignore. Также может быть установлено через профиль файла учетных данных или переменную среды AZURE_CERT_VALIDATION.

Choices:

  • "ignore"
  • "validate"

client_id

string

Идентификатор клиента Azure. Используйте при аутентификации с помощью субъекта безопасности или управляемой идентификации (msi).

Также может быть установлено через переменную окружения AZURE_CLIENT_ID.

cloud_environment

string

added in azure.azcollection 0.0.1

Для облачных сред, отличных от общедоступного облака США, имя среды (как определено в Azure Python SDK, например, AzureChinaCloud, AzureUSGovernment) или URL-адрес конечной точки обнаружения метаданных (требуется для Azure Stack). Также может быть установлено через профиль файла учетных данных или переменную среды AZURE_CLOUD_ENVIRONMENT.

Default: "AzureCloud"

disable_instance_discovery

boolean

added in azure.azcollection 2.3.0

Определяет, будет ли выполняться обнаружение экземпляров при попытке аутентификации. Установка этого параметра в true полностью отключит как обнаружение экземпляров, так и проверку подлинности. Эта функция предназначена для использования в сценариях, когда конечная точка метаданных недоступна, например, в частных облаках или Azure Stack. Процесс обнаружения экземпляров включает в себя получение метаданных узла из https://login.microsoft.com/ для проверки узла. Установив это значение в **True**, проверка узла отключается. В результате важно убедиться, что настроенный узел авторизации действителен и заслуживает доверия.

Устанавливается через профиль файла учетных данных или переменную среды AZURE_DISABLE_INSTANCE_DISCOVERY.

Choices:

  • false ← (default)
  • true

disable_vpn_encryption

boolean

Включение или отключение шифрования VPN.

Choices:

  • false
  • true

location

string

Расположение виртуальной WAN.

log_mode

string

Родительский аргумент.

log_path

string

Аргумент родительского элемента.

name

string / обязательно

Имя виртуальной сети VirtualWAN, которое извлекается.

office365_local_breakout_category

string

Указывает категорию локального разрыва Office365.

Значение по умолчанию — None.

Варианты:

  • "Optimize"
  • "OptimizeAndAllow"
  • "All"
  • "None"

password

string

Пароль пользователя Active Directory. Используется при аутентификации с пользователем Active Directory, а не с принципалом службы.

profile

string

Профиль безопасности, найденный в файле ~/.azure/credentials.

resource_group

string / обязательно

Имя группы ресурсов VirtualWan.

secret

string

Секретный ключ клиента Azure. Используется при аутентификации с принципалом службы.

state

string

Утвердить состояние VirtualWan.

Используйте present для создания или обновления VirtualWan и absent для удаления.

Варианты:

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

subscription_id

string

Ваш идентификатор подписки Azure.

tags

словарь

Словарь пар «строка:строка» для назначения метаданных объекту.

Метаданные тегов объекта будут обновлены с любыми предоставленными значениями.

Чтобы удалить метки, установите параметр append_tags в значение false.

В настоящее время Azure DNS-зоны и службы Traffic Manager также не позволяют использовать пробелы в метке.

Azure Front Door не поддерживает использование

Azure Automation и Azure CDN поддерживают только 15 тегов для ресурсов.

tenant

string

Идентификатор Azure-аренды. Используется при аутентификации с принципалом службы.

thumbprint

string

добавлено в azure.azcollection 1.14.0

Отпечаток цифровой подписи приватного ключа, указанного в x509_certificate_path.

Используется при аутентификации с принципалом службы.

Требуется, если определен x509_certificate_path.

virtual_hubs

список / элементы=словарь

Список VirtualHub в VirtualWAN.

id

string

Идентификатор ресурса виртуального шлюза.

virtual_wan_type

string

Тип VirtualWAN.

Варианты:

  • "Basic"
  • "Standard"

vpn_sites

список / элементы=словарь

Список VpnSites в VirtualWAN.

id

string

Идентификатор ресурса VPN-сайта.

x509_certificate_path

путь

добавлено в azure.azcollection 1.14.0

Путь к X509-сертификату, используемому для создания принципала службы в формате PEM.

Сертификат должен быть добавлен к закрытому ключу.

Используется при аутентификации с принципалом службы.

Примечания

Примечание

  • Для аутентификации с Azure можно передать параметры, установить переменные среды, использовать профиль, хранящийся в файле ~/.azure/credentials, или войти в систему перед запуском задач или книги команд с помощью az login.
  • Аутентификация также возможна с использованием принципала службы или пользователя Active Directory.
  • Для аутентификации с помощью принципала службы передайте subscription_id, client_id, secret и tenant или установите переменные среды AZURE_SUBSCRIPTION_ID, AZURE_CLIENT_ID, AZURE_SECRET и AZURE_TENANT.
  • Для аутентификации с помощью пользователя Active Directory передайте ad_user и password или установите AZURE_AD_USER и AZURE_PASSWORD в среде.
  • В качестве альтернативы учетные данные можно сохранить в ~/.azure/credentials. Это ini-файл, содержащий раздел [default] и следующие ключи: subscription_id, client_id, secret и tenant или subscription_id, ad_user и password. Также можно добавить дополнительные профили. Укажите профиль, передав profile или установив AZURE_PROFILE в среде.

См. также

См. также

Вход в Azure CLI

Как войти в систему, используя команду az login.

Примеры

- name: Create a VirtualWan
  azure_rm_virtualwan:
    resource_group: myResouceGroup
    name: testwan
    disable_vpn_encryption: true
    allow_branch_to_branch_traffic: true
    allow_vnet_to_vnet_traffic: true
    virtual_wan_type: Standard

- name: Delete the VirtualWan
  azure_rm_virtualwan:
    resource_group: myResouceGroup
    name: testwan
    state: absent

Возвращаемые значения

Общие возвращаемые значения описаны здесь, следующие поля уникальны для этого модуля:

Ключ

Описание

state

complex

Текущее состояние виртуальной WAN.

Возвращается: success

allow_branch_to_branch_traffic

boolean

True, если разрешен трафик между ветвями.

Возвращается: всегда

Пример: true

allow_vnet_to_vnet_traffic

boolean

True, если разрешен трафик между виртуальными сетями.

Возвращается: всегда

Пример: true

disable_vpn_encryption

boolean

Включать или отключать шифрование VPN.

Возвращается: всегда

Пример: true

etag

string

Уникальная строка только для чтения, которая изменяется при каждом обновлении ресурса.

Возвращается: всегда

Пример: "52def36b-84b6-49aa-a825-16ba167fc559"

id

string

Идентификатор ресурса.

Возвращается: всегда

Пример: "/subscriptions/xxx-xxx/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualWans/virtual_wan_name"

location

string

Местоположение ресурса виртуальной WAN.

Возвращается: всегда

Пример: "eastus"

name

string

Имя ресурса.

Возвращается: всегда

Пример: "virtualwanb57dc9555691"

office365_local_breakout_category

string

Категория локального выхода в Office.

Возвращается: всегда

Пример: "None"

provisioning_state

string

Состояние подготовки ресурса виртуальной WAN.

Возвращается: всегда

Пример: "Succeeded"

tags

dictionary

Теги ресурса.

Возвращается: всегда

Пример: {"key1": "value1"}

type

string

Тип ресурса.

Возвращается: всегда

Пример: "Microsoft.Network/virtualWans"

virtual_hubs

complex

Список VirtualHubs в VirtualWAN.

Возвращается: всегда

id

string

Идентификатор виртуальных концентраторов.

Возвращается: всегда

Пример: "/subscriptions/xxx-xxx/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualHubs/test"

virtual_wan_type

string

Тип VirtualWAN.

Возвращается: всегда

Пример: "Standard"

vpn_sites

list / elements=string

Список VpnSites в VirtualWAN.

Возвращается: всегда

id

string

Идентификатор ресурса vpn sites.

Возвращается: всегда

Пример: "/subscriptions/xxx-xxx/resourceGroups/resource_group/providers/Microsoft.Network/vpnSites/test1"

Авторы

  • Fred-Sun (@Fred-Sun)

Справочные ссылки коллекции

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

© 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/azure/azcollection/azure_rm_virtualwan_module.html

Spec-Zone.ru

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