Модуль azure.azcollection.azure_rm_localnetworkgateway — Управление Azure Local Network Gateway в группе ресурсов

Примечание

Этот модуль входит в коллекцию azure.azcollection (версия 2.7.0).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.

Для установки используйте: ansible-galaxy collection install azure.azcollection. Для использования этого модуля необходимы дополнительные требования, см. Требования для получения подробностей.

Для использования в playbook укажите: azure.azcollection.azure_rm_localnetworkgateway.

Новый в azure.azcollection 2.4.0

Описание
Требования
Параметры
Примечания
См. также
Примеры
Возвращаемые значения

Описание

Создание, обновление или удаление Azure Local Network Gateway в группе ресурсов

Требования

Ниже перечислены требования к хосту, на котором выполняется этот модуль.

python >= 2.7
На хосте, на котором выполняется этот модуль, должна быть установлена коллекция azure.azcollection через galaxy
Все пакеты Python, указанные в файле requirements.txt коллекции, должны быть установлены с помощью pip на хосте, на котором выполняются модули из azure.azcollection.
Полные инструкции по установке можно найти по адресу https://galaxy.ansible.com/azure/azcollection

Параметры

Параметр	Комментарии
ad_user строка	Имя пользователя Active Directory. Используется при аутентификации с пользователем Active Directory, а не с сервисным принципалом.
adfs_authority_url строка добавлено в azure.azcollection 0.0.1	URL-адрес полномочий Azure AD. Используется при аутентификации с именем пользователя/паролем и собственными полномочиями ADFS.
api_profile строка добавлено в azure.azcollection 0.0.1	Выбирает профиль API для использования при взаимодействии с Azure-сервисами. Значение по умолчанию `latest` подходит для общедоступных облаков; будущие значения позволят использовать Azure Stack. По умолчанию: `"latest"`
append_tags логический тип	Управляет тем, является ли поле тегов каноническим или просто добавляется к существующим тегам. При каноническом значении все теги, отсутствующие в параметре тегов, будут удалены из метаданных объекта. Варианты: `false` `true` ← (по умолчанию)
auth_source строка добавлено в azure.azcollection 0.0.1	Управляет источником учетных данных для аутентификации. Также может быть задан через переменную окружения `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. Варианты: `"auto"` ← (по умолчанию) `"cli"` `"credential_file"` `"env"` `"msi"`
bgp_settings словарь	Настройки спикера BGP локального шлюза.
asn целое число	ASN спикера BGP.
bgp_peering_address строка	Адрес и идентификатор BGP-соединения спикера BGP.
peer_weight целое число	Вес маршрутов, полученных от этого BGP-спикера.
cert_validation_mode строка добавлено в azure.azcollection 0.0.1	Управляет поведением проверки сертификата для Azure-точек конечного доступа. По умолчанию все модули проверяют серверный сертификат, но при использовании HTTPS-прокси или взаимодействии с Azure Stack может потребоваться отключить эту функцию, передав `ignore`. Также может быть установлено через профиль файла учетных данных или переменную среды `AZURE_CERT_VALIDATION`. Варианты: `"ignore"` `"validate"`
client_id строка	Идентификатор клиента Azure. Используется при аутентификации с помощью сервисного принципала или управляемой учетной записи (msi). Также может быть установлен через переменную окружения `AZURE_CLIENT_ID`.
cloud_environment строка добавлено в azure.azcollection 0.0.1	Для облачных сред, отличных от общедоступного облака США, имя среды (определяется Azure Python SDK, например, `AzureChinaCloud`, `AzureUSGovernment`), или URL-адрес точки конечного доступа для обнаружения метаданных (необходим для Azure Stack). Также может быть установлен через профиль файла учетных данных или переменную среды `AZURE_CLOUD_ENVIRONMENT`. По умолчанию: `"AzureCloud"`
disable_instance_discovery логический тип добавлено в azure.azcollection 2.3.0	Определяет, будет ли выполнено обнаружение экземпляра при попытке аутентификации. Установка этого значения в true полностью отключит как обнаружение экземпляра, так и проверку полномочий. Эта функция предназначена для использования в сценариях, где точка конечного доступа к метаданным недоступна, например, в частных облаках или Azure Stack. Процесс обнаружения экземпляра предполагает получение метаданных полномочий с https://login.microsoft.com/ для проверки полномочий. Установив это значение в True, проверка полномочий отключается. В результате крайне важно убедиться, что указанный хост полномочий является действительным и заслуживает доверия. Настраивается через профиль файла учетных данных или переменную окружения `AZURE_DISABLE_INSTANCE_DISCOVERY`. Варианты: `false` ← (по умолчанию) `true`
fqdn строка	FQDN локального шлюза.
gateway_ip_address строка	IP-адрес локального шлюза.

local_network_address_space dictionary	Пространство адресов локальной сетевой площадки.
address_prefixes list / elements=string	Список блоков адресов, зарезервированных для этой виртуальной сети в нотации CIDR.
location string	Расположение локального шлюза сети.
log_mode string	Родительский аргумент.
log_path string	Родительский аргумент.
name string / обязательно	Имя локального шлюза сети.
password string	Пароль пользователя Active Directory. Используется при аутентификации с пользователем Active Directory, а не с принципалом службы.
profile string	Профиль безопасности, найденный в файле ~/.azure/credentials.
resource_group string / обязательно	Группа ресурсов локального шлюза сети.
secret string	Секрет Azure клиента. Используется при аутентификации с принципалом службы.
state string	Используйте `present` для создания или обновления локального шлюза сети. Используйте `absent` для удаления локального шлюза сети. Варианты: `"absent"` `"present"` ← (по умолчанию)
subscription_id string	Ваш идентификатор подписки Azure.
tags dictionary	Словарь пар строка:строка для присвоения метаданных объекту. Метаданные теги объекта будут обновлены всеми предоставленными значениями. Для удаления тегов установите опцию append_tags в false. В настоящее время зоны Azure DNS и службы Traffic Manager также не позволяют использовать пробелы в теге. Azure Front Door не поддерживает использование Azure Automation и Azure CDN поддерживают только 15 тегов для ресурсов.
tenant string	Идентификатор Azure Tenant. Используется при аутентификации с принципалом службы.
thumbprint string добавлено в azure.azcollection 1.14.0	Отпечаток частного ключа, указанного в x509_certificate_path. Используется при аутентификации с принципалом службы. Необходимо, если определен x509_certificate_path.
x509_certificate_path path добавлено в azure.azcollection 1.14.0	Путь к X509 сертификату, используемому для создания принципала службы в формате PEM. Сертификат должен быть присоединен к закрытому ключу. Используется при аутентификации с принципалом службы.

Примечания

Примечание

Для аутентификации с Azure можно передавать параметры, устанавливать переменные среды, использовать профиль, сохранённый в ~/.azure/credentials, или войти в систему перед запуском задач или playbook с помощью 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 a new local network gateway
  azure_rm_localnetworkgateway:
    resource_group: "{{ resource_group }}"
    name: "localgateway-name"
    local_network_address_space:
      address_prefixes:
        - 10.0.0.0/24
        - 20.0.0.0/24
    fqdn: fredtest.com
    tags:
      key: value
    bgp_settings:
      asn: 8
      bgp_peering_address: 10.3.0.1
      peer_weight: 3

- name: Delete local network gateway
  azure_rm_localnetworkgateway:
    resource_group: "{{ resource_group }}"
    name: "localgateway-name"
    state: absent

END_OF_DOCUMENT_MARKER

Возвращаемые значения

Общие возвращаемые значения описаны здесь, следующие поля уникальны для этого модуля:

Ключ	Описание
state complex	Текущее состояние ресурса Azure Local Network Gateway. Возвращается: всегда
bgp_settings complex	Параметры BGP-спикера локального шлюза сети. Возвращается: успешно
asn integer	ASN BGP-спикера. Возвращается: всегда Пример: `10`
bgp_peering_address string	Адрес пиринга BGP и идентификатор BGP этого BGP-спикера. Возвращается: всегда Пример: `"10.0.0.3"`
peer_weight integer	Вес, добавляемый к маршрутам, полученным от этого BGP-спикера. Возвращается: всегда Пример: `0`
etag string	Уникальная строка только для чтения, которая изменяется при каждом обновлении ресурса. Возвращается: всегда Пример: `"b5a32693-2e75-49e0-9137-ded19db658d6"`
fqdn string	FQDN локального шлюза сети. Возвращается: всегда Пример: `"testfqdn.com"`
gateway_ip_address string	IP-адрес локального шлюза сети. Возвращается: всегда Пример: `"10.1.1.1"`
id string	Идентификатор ресурса. Возвращается: всегда Пример: `"/subscriptions/xxxx-xxxx/resourceGroups/testRG/providers/Microsoft.Network/localNetworkGateways/testgateway"`
local_network_address_space complex	Адресное пространство локального сетевого узла. Возвращается: успешно
address_prefixes list / elements=string	Список блоков адресов, зарезервированных для этой виртуальной сети в нотации CIDR. Возвращается: всегда Пример: `["10.0.0.0/24", "20.0.0.0/24"]`
location string	Местоположение ресурса. Возвращается: всегда Пример: `"eastus"`
name string	Имя ресурса. Возвращается: всегда Пример: `"testgateway"`
provisioning_state string	Состояние подготовки ресурса локального шлюза сети. Возвращается: всегда Пример: `"Succeeded"`
tags string	Теги ресурса. Возвращается: всегда Пример: `"{'key1': 'value1', 'key2': 'value2'}"`
type string	Тип ресурса. Возвращается: всегда Пример: `"Microsoft.Network/localNetworkGateways"`

Авторы

xuzhang3 (@xuzhang3)
Fred Sun (@Fred-sun)

Ссылки на коллекцию

© 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_localnetworkgateway_module.html