azure_rm_virtualnetworkgateway – Управление шлюзами Azure виртуальной сети
Новое в версии 2.8.
Описание
- Создать, обновить или удалить шлюз виртуальной сети (VPN Gateway). При создании VPN Gateway необходимо указать имя существующей виртуальной сети.
Требования
Ниже перечислены требования к хосту, на котором выполняется этот модуль.
- python >= 2.7
- azure >= 2.0.0
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| ad_user строка | Имя пользователя Active Directory. Используйте при аутентификации пользователем Active Directory, а не служебным принципалом. | ||
| adfs_authority_url строка добавлен в 2.6 | URL авторизации Azure AD. Используйте при аутентификации с помощью имени пользователя/пароля и собственной авторизацией ADFS. | ||
| api_profile строка добавлен в 2.5 | По умолчанию: "latest" | Выбирает профиль API для взаимодействия с Azure-сервисами. Значение по умолчанию latest, подходит для общедоступных облаков; будущие значения позволят использовать с Azure Stack. | |
| append_tags логический тип |
| Управление тем, является ли поле тегов каноническим или просто добавляется к существующим тегам. При каноническом поле, любые теги, отсутствующие в параметре тегов, будут удалены из метаданных объекта. | |
| auth_source строка добавлен в 2.5 |
| Управление источником учетных данных для аутентификации. Если не указано, будет использована переменная среды ANSIBLE_AZURE_AUTH_SOURCE, по умолчанию auto, если переменная не определена.auto будет следовать стандартному приоритету параметров модуля -> переменные среды -> профиль по умолчанию в файле учетных данных ~/.azure/credentials. При установке в cli, учетные данные будут взяты из профиля Azure CLI по умолчанию.Также может быть установлена через переменную среды ANSIBLE_AZURE_AUTH_SOURCE. При установке в msi, хост-машина должна быть Azure-ресурсом с включённым расширением MSI. subscription_id или переменная среды AZURE_SUBSCRIPTION_ID могут использоваться для определения идентификатора подписки, если ресурсу предоставлен доступ к нескольким подпискам, в противном случае выбирается первая подписка.msi был добавлен в Ansible 2.6. | |
| bgp_settings - | Настройки спикера BGP шлюза виртуальной сети. | ||
| asn - / обязательно | ASN спикера BGP. | ||
| cert_validation_mode строка добавлен в 2.5 |
| Управление поведением проверки сертификата для Azure-точек входа. По умолчанию все модули проверяют сертификат сервера, но при использовании прокси HTTPS или подключении к Azure Stack, возможно, потребуется отключить это поведение, передав ignore. Также может быть установлена через профиль в файле учетных данных или переменную среды AZURE_CERT_VALIDATION. | |
| client_id строка | Идентификатор Azure клиента. Используйте при аутентификации с помощью служебного принципала. | ||
| cloud_environment строка добавлен в 2.4 | По умолчанию: "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-адреса. Отсутствует для отключения IP-адреса. | ||
| subnet - | По умолчанию: "GatewaySubnet" | Идентификатор подсети шлюза для VPN. | |
| location - | Действительное расположение Azure. По умолчанию — расположение группы ресурсов. | ||
| name - / обязательно | Имя VPN шлюза. | ||
| password - | Пароль пользователя Active Directory. Используйте при аутентификации пользователем Active Directory, а не служебным принципалом. | ||
| profile строка | Профиль безопасности, найденный в файле ~/.azure/credentials. | ||
| resource_group - / обязательно | Имя группы ресурсов, где существует или будет создан VPN Gateway. | ||
| secret строка | Секрет Azure клиента. Используйте при аутентификации с помощью служебного принципала. | ||
| sku - |
| Ссылка на ресурс VirtualNetworkGatewaySku, представляющий выбранный SKU для шлюза виртуальной сети. | |
| state - |
| Утверждение состояния VPN Gateway. Используйте 'present' для создания или обновления VPN Gateway и 'absent' для удаления VPN Gateway. | |
| subscription_id строка | Ваш идентификатор Azure подписки. | ||
| tags словарь | Словарь пар строка:строка для назначения метаданных объекту. Метаданные теги объекта будут обновлены любыми предоставленными значениями. Чтобы удалить теги, установите параметр append_tags в false. | ||
| tenant строка | Идентификатор Azure арендатора. Используйте при аутентификации с помощью служебного принципала. | ||
| virtual_network - / обязательно | Существующая виртуальная сеть, с которой будет связан VPN Gateway. Необходимо при создании VPN Gateway. Может быть именем виртуальной сети. Убедитесь, что ваша виртуальная сеть находится в той же группе ресурсов, что и VPN Gateway, когда вы передаете только имя. Может быть идентификатором ресурса виртуальной сети. Может быть словарем, содержащим 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 строка | всегда | Идентификатор ресурса шлюза виртуальной сети Пример: /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworkGateways/myV irtualNetworkGateway |
Статус
- Этот модуль не гарантирует обратную совместимость интерфейса. [предварительная версия]
- Этот модуль поддерживается партнером Ansible. [сертифицированный]
Авторы
- 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.8/modules/azure_rm_virtualnetworkgateway_module.html
