azure_rm_virtualnetworkgateway – Управление шлюзами виртуальных сетей Azure
Новая версия 2.8.
Обзор
- Создание, обновление или удаление шлюза виртуальной сети (VPN-шлюза).
- При создании VPN-шлюза необходимо указать имя существующей виртуальной сети.
Требования
Ниже перечислены требования к хосту, на котором выполняется этот модуль.
- 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 - | По умолчанию: "no" | Включить или отключить 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 строка | всегда | Идентификатор ресурса шлюза виртуальной сети. Пример: /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.9/modules/azure_rm_virtualnetworkgateway_module.html
