azure.azcollection.azure_rm_virtualnetworkgateway – Управление шлюзами виртуальных сетей Azure
Примечание
Этот плагин входит в коллекцию azure.azcollection (версия 1.3.1).
Для его установки используйте: ansible-galaxy collection install azure.azcollection.
Для использования в книге задач укажите: azure.azcollection.azure_rm_virtualnetworkgateway.
Введено в версии 0.0.1: of azure.azcollection
Обзор
- Создание, обновление или удаление шлюза виртуальной сети (шлюза VPN).
- При создании шлюза VPN необходимо указать имя существующей виртуальной сети.
Требования
Ниже перечислены требования, необходимые на хосте, на котором выполняется этот модуль.
- python >= 2.7
- azure >= 2.0.0
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| ad_user строка | Имя пользователя Active Directory. Используется при аутентификации с пользователем Active Directory, а не с принципом службы. | ||
| adfs_authority_url строка добавлено в 0.0.1 of azure.azcollection | URL-адрес службы авторизации Azure AD. Используется при аутентификации с именем пользователя/паролем и собственной службой авторизации ADFS. | ||
| api_profile строка добавлено в 0.0.1 of azure.azcollection | По умолчанию: "latest" | Выбирает профиль API для использования при взаимодействии с Azure-сервисами. Значение по умолчанию latest подходит для общедоступных облаков; будущие значения позволят использовать Azure Stack. | |
| append_tags булево |
| Используется для управления тем, является ли поле тегов стандартным или просто добавляет к существующим тегам. При стандартном значении любые теги, отсутствующие в параметре тегов, будут удалены из метаданных объекта. | |
| auth_source строка добавлено в 0.0.1 of azure.azcollection |
| Управляет источником учетных данных для аутентификации. Также может быть задано через переменную окружения 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. | |
| bgp_settings строка | Настройки спикера BGP шлюза виртуальной сети. | ||
| asn строка / обязательно | ASN спикера BGP. | ||
| cert_validation_mode строка добавлено в 0.0.1 of azure.azcollection |
| Управляет поведением проверки сертификатов для Azure-точек конечных узлов. По умолчанию все модули проверяют серверный сертификат, но при использовании прокси HTTPS или при работе с Azure Stack может потребоваться отключить это поведение, передав ignore. Также может быть установлено через профиль файла учетных данных или переменную среды AZURE_CERT_VALIDATION. | |
| client_id строка | Идентификатор клиента Azure. Используется при аутентификации с принципом службы. | ||
| cloud_environment строка добавлено в 0.0.1 of azure.azcollection | По умолчанию: "AzureCloud" | Для облачных сред, отличных от общедоступного облака США, используется имя среды (как определено в Azure Python SDK, например, AzureChinaCloud, AzureUSGovernment) или URL-адрес точки конечного узла обнаружения метаданных (требуется для Azure Stack). Также может быть задан через профиль файла учетных данных или переменную среды AZURE_CLOUD_ENVIRONMENT. | |
| enable_bgp строка | По умолчанию: "нет" | Включена ли BGP для данного шлюза виртуальной сети. | |
| gateway_type строка |
| Тип этого шлюза виртуальной сети. | |
| ip_configurations строка | Список IP-конфигураций. | ||
| name строка / обязательно | Имя IP-конфигурации. | ||
| private_ip_allocation_method строка |
| Метод выделения частного IP-адреса. | |
| public_ip_address_name строка | Имя общедоступного IP-адреса. Используйте 'None', чтобы отключить общедоступный IP-адрес. | ||
| subnet строка | По умолчанию: "GatewaySubnet" | Идентификатор подсети шлюза для VPN. | |
| location строка | Действительное местоположение Azure. По умолчанию — местоположение группы ресурсов. | ||
| name строка / обязательно | Имя шлюза VPN. | ||
| password строка | Пароль пользователя Active Directory. Используется при аутентификации с пользователем Active Directory, а не с принципом службы. | ||
| profile строка | Профиль безопасности, найденный в файле ~/.azure/credentials. | ||
| resource_group строка / обязательно | Имя группы ресурсов, где существует или будет создан шлюз VPN. | ||
| secret строка | Секрет клиента Azure. Используется при аутентификации с принципом службы. | ||
| sku строка |
| Ссылка на ресурс VirtualNetworkGatewaySku, представляющий выбранную SKU для шлюза виртуальной сети. | |
| state строка |
| Состояние шлюза VPN. Используйте present для создания или обновления шлюза VPN и absent для удаления шлюза VPN. | |
| subscription_id строка | Ваш идентификатор подписки Azure. | ||
| tags словарь | Словарь пар "строка:строка" для назначения метаданных объекту. Метаданные теги объекта будут обновлены с предоставленными значениями. Чтобы удалить теги, установите параметр append_tags в значение false. | ||
| tenant строка | Идентификатор Azure-аренды. Используется при аутентификации с принципом службы. | ||
| virtual_network строка / обязательно | Существующая виртуальная сеть, к которой будет подключён шлюз VPN. Требуется при создании шлюза VPN. Может быть именем виртуальной сети. Должна находиться в той же группе ресурсов, что и шлюз VPN, если указана по имени. Может быть идентификатором ресурса виртуальной сети. Может быть словарем, содержащим name и resource_group виртуальной сети. псевдонимы: virtual_network_name | ||
| vpn_type строка |
| Тип этой виртуальной частной сети. | |
Примечания
Примечание
- Для аутентификации с 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 virtual network gateway without bgp settings
azure_rm_virtualnetworkgateway:
resource_group: myResourceGroup
name: myVirtualNetworkGateway
ip_configurations:
- name: testipconfig
private_ip_allocation_method: Dynamic
public_ip_address_name: testipaddr
virtual_network: myVirtualNetwork
tags:
common: "xyz"
- name: Create virtual network gateway with bgp
azure_rm_virtualnetworkgateway:
resource_group: myResourceGroup
name: myVirtualNetworkGateway
sku: vpn_gw1
ip_configurations:
- name: testipconfig
private_ip_allocation_method: Dynamic
public_ip_address_name: testipaddr
enable_bgp: yes
virtual_network: myVirtualNetwork
bgp_settings:
asn: 65515
bgp_peering_address: "169.254.54.209"
tags:
common: "xyz"
- name: Delete instance of virtual network gateway
azure_rm_virtualnetworkgateway:
resource_group: myResourceGroup
name: myVirtualNetworkGateway
state: absent
Возвращаемые значения
Общие возвращаемые значения описаны здесь, следующие поля уникальны для этого модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| id string | всегда | Идентификатор ресурса виртуального шлюза сети. Пример: /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworkGateways/myV irtualNetworkGateway |
Авторы
- Madhura Naniwadekar (@Madhura-CSI)
© 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/azure/azcollection/azure_rm_virtualnetworkgateway_module.html
