Модуль azure.azcollection.azure_rm_vpnsite — Управление экземпляром Azure VpnSite
Примечание
Этот модуль входит в коллекцию azure.azcollection (версия 2.7.0).
Эта коллекция может быть уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install azure.azcollection. Для использования этого модуля необходимы дополнительные требования. Подробности см. в разделе Требования.
Для использования в плейбуке укажите: azure.azcollection.azure_rm_vpnsite.
Введено в azure.azcollection 1.5.0
Описание
- Создание, обновление и удаление экземпляра Azure VpnSite.
Требования
Ниже перечислены требования, необходимые на хосте, на котором выполняется этот модуль.
- 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, а не с субъектом безопасности. |
address_space dictionary | AddressSpace, содержащий массив диапазонов IP-адресов. |
|
address_prefixes list / elements=string |
Список блоков адресов, зарезервированных для этой виртуальной сети в нотации CIDR. |
adfs_authority_url string added in azure.azcollection 0.0.1 | URL-адрес центра проверки подлинности Azure AD. Используйте при аутентификации с помощью имени пользователя/пароля и имеете собственный центр проверки подлинности ADFS. |
api_profile string added in azure.azcollection 0.0.1 | Выбирает профиль API для использования при взаимодействии с службами Azure. Значение по умолчанию Default: |
append_tags boolean | Используется для управления тем, является ли поле тегов каноническим или просто добавляется к существующим тегам. В каноническом режиме любые теги, не найденные в параметре тегов, будут удалены из метаданных объекта. Choices:
|
auth_source string added in azure.azcollection 0.0.1 | Управляет источником учетных данных для аутентификации. Также может быть задана через переменную среды При значении При значении При значении При значении При значении Параметр Choices:
|
bgp_properties dictionary | Набор свойств bgp. |
|
asn integer |
ASN BGP-участника. |
|
bgp_peering_address string |
Адрес пиринга BGP и идентификатор BGP этого BGP-участника. |
|
bgp_peering_addresses list / elements=dictionary |
Адрес пиринга BGP с ID конфигурации IP для шлюза виртуальной сети. |
|
custom_bgp_ip_addresses list / elements=string |
Список пользовательских адресов пиринга BGP, которые принадлежат конфигурации IP. |
|
default_bgp_ip_addresses list / elements=string |
Список адресов пиринга BGP по умолчанию, которые принадлежат конфигурации IP. |
|
ipconfiguration_id string |
ID конфигурации IP, которая принадлежит шлюзу. |
|
tunnel_ip_addresses list / elements=string |
Список общедоступных IP-адресов туннеля, которые принадлежат конфигурации IP. |
|
peer_weight integer |
Вес, добавляемый к маршрутам, полученным от этого BGP-участника. |
cert_validation_mode string added in azure.azcollection 0.0.1 | Управляет поведением проверки сертификата для конечных точек Azure. По умолчанию все модули будут проверять серверный сертификат, но при использовании прокси-сервера HTTPS или для Azure Stack может потребоваться отключить это поведение, передав Choices:
|
client_id string | Идентификатор клиента Azure. Используйте при аутентификации с помощью субъекта безопасности или управляемой идентичности (msi). Также может быть задана через переменную среды |
cloud_environment string added in azure.azcollection 0.0.1 | Для облачных сред, отличных от общедоступного облака США, имя среды (как определено в Azure Python SDK, например, По умолчанию: |
device_properties dictionary | Свойства устройства. |
|
device_model string |
Модель устройства. |
|
device_vendor string |
Название поставщика устройства. |
|
link_speed_in_mbps integer |
Скорость канала. |
disable_instance_discovery boolean added in azure.azcollection 2.3.0 | Определяет, выполняется ли обнаружение экземпляра при попытке аутентификации. Установка в значение true полностью отключит обнаружение экземпляра и проверку подлинности. Эта функциональность предназначена для использования в сценариях, где конечная точка метаданных недоступна, например, в частных облаках или Azure Stack. Процесс обнаружения экземпляра включает получение метаданных подлинности с https://login.microsoft.com/ для проверки подлинности. Установив это значение в **True**, проверка подлинности отключена. В результате крайне важно убедиться, что настроенный хост подлинности действителен и заслуживает доверия. Устанавливается через профиль файла учетных данных или переменную среды Варианты:
|
ip_address string | IP-адрес для VPN-сайта. |
is_security_site boolean | Флаг IsSecuritySite. Варианты:
|
location string | Расположение VpnSite |
log_mode string | Аргумент родительского элемента. |
log_path string | Аргумент родительского элемента. |
name string / обязательно | Имя VpnSite. |
o365_policy dictionary | Политика Office365. |
|
break_out_categories dictionary |
Категории Office365 для разделения. |
|
allow boolean |
Флаг для управления категорией allow. Варианты:
|
|
default boolean |
Флаг для управления категорией default. Варианты:
|
|
optimize boolean |
Флаг для управления категорией optimize. Варианты:
|
password string | Пароль пользователя Active Directory. Используется при аутентификации с пользователем Active Directory вместо служебного принципала. |
profile string | Профиль безопасности, найденный в файле ~/.azure/credentials. |
resource_group string / обязательно | Имя группы ресурсов VpnSite. |
secret string | Служебный секрет Azure. Используется при аутентификации с помощью служебного принципала. |
site_key string | Ключ VPN-сайта, который можно использовать для подключений. |
state string | Укажите состояние VpnSite. Используйте Варианты:
|
subscription_id string | Ваш идентификатор подписки Azure. |
tags dictionary | Словарь пар «строка:строка» для присвоения метаданных объекту. Метаданные теги объекта будут обновлены с любыми предоставленными значениями. Для удаления тегов установите параметр 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_wan dictionary | Виртуальная сеть WAN, к которой принадлежит vpnSite. |
|
id string |
Идентификатор ресурса связанной виртуальной сети WAN. |
vpn_site_links list / elements=dictionary | Список всех vpn-ссылки. |
|
bgp_properties dictionary |
Набор свойств BGP. |
|
asn integer |
ASN спикера BGP. |
|
bgp_peering_address string |
Адрес BGP-пейринга и идентификатор BGP этого спикера BGP. |
|
fqdn string |
FQDN vpn-ссылки. |
|
ip_address string |
IP-адрес для vpn-ссылки. |
|
link_properties dictionary |
Свойства поставщика ссылок. |
|
link_provider_name string |
Имя поставщика ссылок. |
|
link_speed_in_mbps integer |
Скорость соединения. |
|
name string |
Имя ресурса, уникальное в группе ресурсов. Это имя можно использовать для доступа к ресурсу. |
x509_certificate_path 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 VpnSite
azure_rm_vpnsite:
resource_group: myResourceGroup
name: vpnSite_name
- name: Delete Vpn Site
azure_rm_vpnsite:
resource_group: myResourceGroup
name: vpnSite_name
Значения возврата
Общие значения возврата задокументированы здесь, следующие — поля, уникальные для данного модуля:
Ключ | Описание |
|---|---|
state сложное | Текущее состояние VPN-сайта. Возвращено: успех |
|
device_properties сложное |
Свойства устройства. Возвращено: всегда |
|
device_vendor строка |
Название поставщика устройства. Возвращено: всегда Пример: |
|
etag строка |
Уникальная неизменяемая строка, которая меняется при каждом обновлении ресурса. Возвращено: всегда Пример: |
|
id строка |
Идентификатор ресурса. Возвращено: всегда Пример: |
|
is_security_site булево |
Флаг IsSecuritySite. Возвращено: всегда Пример: |
|
location строка |
Расположение ресурса. Возвращено: всегда Пример: |
|
name строка |
Имя ресурса. Возвращено: всегда Пример: |
|
provisioning_state строка |
Состояние подготовки ресурса VPN-сайта. Возвращено: всегда Пример: |
|
tags словарь |
Теги ресурса. Возвращено: всегда Пример: |
|
type строка |
Тип ресурса. Возвращено: всегда Пример: |
|
virtual_wan сложное |
VirtualWAN, к которому принадлежит vpnSite. Возвращено: всегда |
|
id строка |
Идентификатор ресурса. Возвращено: всегда Пример: |
Ссылки на коллекцию
© 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_vpnsite_module.html