azure.azcollection.azure_rm_virtualnetworkgateway – Управление шлюзами Azure виртуальной сети
Примечание
Этот плагин является частью коллекции azure.azcollection (версии 1.4.0).
Для его установки используйте: ansible-galaxy collection install azure.azcollection.
Для использования в плейбуке укажите: azure.azcollection.azure_rm_virtualnetworkgateway.
Новое в версии 0.0.1: из azure.azcollection
Обзор
- Создание, обновление или удаление шлюза виртуальной сети (VPN-шлюз).
- При создании VPN-шлюза необходимо указать имя существующей виртуальной сети.
Требования
Ниже перечислены требования, необходимые на хосте, на котором выполняется этот модуль.
- python >= 2.7
- azure >= 2.0.0
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| ad_user строка | Имя пользователя Active Directory. Используйте при аутентификации с пользователем Active Directory, а не с принципалом службы. | ||
| adfs_authority_url строка добавлено в 0.0.1 из azure.azcollection | URL-адрес авторизации Azure AD. Используйте при аутентификации с именем пользователя/паролем и собственной службой ADFS. | ||
| api_profile строка добавлено в 0.0.1 из azure.azcollection | Значение по умолчанию: "latest" | Выбирает профиль API для использования при общении с Azure-сервисами. Значение по умолчанию latest подходит для общедоступных облаков; будущие значения позволят использовать Azure Stack. | |
| append_tags логическое значение |
| Управляет тем, является ли поле тегов каноническим или просто добавляет к существующим тегам. Когда каноническое, любые теги, отсутствующие в параметре тегов, будут удалены из метаданных объекта. | |
| auth_source строка добавлено в 0.0.1 из 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 из azure.azcollection |
| Управление поведением проверки сертификатов для Azure-точек конечного доступа. По умолчанию все модули проверяют сертификат сервера, но когда используется HTTPS-прокси или соединение с Azure Stack, может потребоваться отключить это поведение, передав ignore. Также можно задать через профиль файла учетных данных или переменную среды AZURE_CERT_VALIDATION. | |
| client_id строка | Идентификатор клиента Azure. Используйте при аутентификации с принципалом службы. | ||
| cloud_environment строка добавлено в 0.0.1 из 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-шлюз, при указании по имени. Может быть идентификатором ресурса виртуальной сети. Может быть словарем, содержащим имя и группу_ресурсов виртуальной сети. псевдонимы: 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 |
Авторы
- Madhura Naniwadekar (@Madhura-CSI)
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/azure/azcollection/azure_rm_virtualnetworkgateway_module.html
