Spec-Zone.ru › Ansible

модуль azure.azcollection.azure_rm_localnetworkgateway_info — получение или перечисление указанного шлюза локальной сети в группе ресурсов

Примечание

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

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

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

Чтобы использовать модуль в плейбуке, укажите: azure.azcollection.azure_rm_localnetworkgateway_info.

Добавлено в azure.azcollection 2.4.0

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

Краткое описание

  • Получает или перечисляет указанный шлюз локальной сети в группе ресурсов.

Требования

На узле, выполняющем этот модуль, должны быть установлены следующие компоненты.

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

Параметры

Параметр

Комментарии

ad_user

string

Имя пользователя Active Directory. Используйте при аутентификации от имени пользователя Active Directory, а не субъекта-службы.

adfs_authority_url

string

добавлено в azure.azcollection 0.0.1

URL-адрес центра Azure AD. Используйте при аутентификации по имени пользователя и паролю, если у вас собственный центр ADFS.

api_profile

string

добавлено в azure.azcollection 0.0.1

Выбирает профиль API для взаимодействия со службами Azure. Значение по умолчанию latest подходит для общедоступных облаков; будущие значения позволят использовать Azure Stack.

По умолчанию: "latest"

auth_source

string

добавлено в 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"

cert_validation_mode

string

добавлено в azure.azcollection 0.0.1

Определяет поведение проверки сертификатов для конечных точек Azure. По умолчанию все модули проверяют сертификат сервера, однако при использовании HTTPS-прокси или Azure Stack может потребоваться отключить эту проверку, передав ignore. Также можно задать через профиль файла учетных данных или переменную среды AZURE_CERT_VALIDATION.

Варианты:

  • "ignore"
  • "validate"

client_id

string

Идентификатор клиента Azure. Используйте при аутентификации с помощью субъекта-службы или управляемого удостоверения (msi).

Также можно задать с помощью переменной среды AZURE_CLIENT_ID.

cloud_environment

string

добавлено в azure.azcollection 0.0.1

Для облачных сред, отличных от общедоступного облака США, — имя среды (как определено в Azure Python SDK, например AzureChinaCloud, AzureUSGovernment) или URL-адрес конечной точки обнаружения метаданных (обязателен для Azure Stack). Также можно задать через профиль файла учетных данных или переменную среды AZURE_CLOUD_ENVIRONMENT.

По умолчанию: "AzureCloud"

disable_instance_discovery

boolean

добавлено в azure.azcollection 2.3.0

Определяет, будет ли выполняться обнаружение экземпляра при попытке аутентификации. При значении true обнаружение экземпляра и проверка центра авторизации будут полностью отключены. Эта возможность предназначена для сценариев, в которых невозможно подключиться к конечной точке метаданных, например в частных облаках или Azure Stack. Обнаружение экземпляра включает получение метаданных центра авторизации с сайта https://login.microsoft.com/ для проверки центра авторизации. Если установить значение **True**, проверка центра авторизации будет отключена. Поэтому крайне важно убедиться, что настроенный узел центра авторизации является допустимым и заслуживающим доверия.

Задается через профиль файла учетных данных или переменную среды AZURE_DISABLE_INSTANCE_DISCOVERY.

Варианты:

  • false ← (по умолчанию)
  • true

log_mode

string

Родительский аргумент.

log_path

string

Родительский аргумент.

name

string

Имя шлюза локальной сети.

oidc_token

string

добавлено в azure.azcollection 3.17.0

Токен OpenID Connect (OIDC) (JWT), напрямую используемый для аутентификации удостоверения рабочей нагрузки.

Этот токен обменивается с Azure AD с помощью федеративного удостоверения OIDC.

Полезно в системах CI (например, GitHub Actions, Azure DevOps), где платформа предоставляет токен OIDC напрямую.

Также можно задать с помощью переменной среды AZURE_FEDERATED_TOKEN.

oidc_token_file_path

path

добавлено в azure.azcollection 3.17.0

Путь к файлу с токеном OpenID Connect (OIDC) (JWT), используемым для аутентификации удостоверения рабочей нагрузки.

Файл должен содержать только необработанный токен.

Этот метод обычно используется на платформах, которые сохраняют токены OIDC в файлах.

Также можно задать с помощью переменной среды AZURE_FEDERATED_TOKEN_FILE.

password

string

Пароль пользователя Active Directory. Используйте при аутентификации от имени пользователя Active Directory, а не субъекта-службы.

profile

string

Профиль безопасности из файла ~/.azure/credentials.

resource_group

string / обязательный

Группа ресурсов шлюза локальной сети.

secret

string

Секрет клиента Azure. Используйте при аутентификации с помощью субъекта-службы.

subscription_id

string

Идентификатор вашей подписки Azure.

tags

list / элементы=string

Ограничивает результаты с помощью списка тегов. Указывайте теги в формате «ключ» или «ключ:значение».

tenant

string

Идентификатор клиента Azure. Используйте при аутентификации с помощью субъекта-службы.

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 или войти в систему перед запуском задач или плейбука с помощью az login.
  • Также возможна аутентификация с помощью субъекта-службы или пользователя Active Directory.
  • Для аутентификации через OIDC передайте client_id, tenant и oidc_token либо oidc_token_file_path или задайте переменные среды AZURE_CLIENT_ID, AZURE_TENANT и AZURE_FEDERATED_TOKEN либо AZURE_FEDERATED_TOKEN_FILE.
  • Для аутентификации с помощью субъекта-службы передайте 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: Gets the specified local network gateway in a resource group
  azure_rm_localnetworkgateway_info:
    resource_group: "{{ resource_group }}"
    name: "{{ local_networkgateway_name }}"

- name: Gets all the local network gateways in a resource group
  azure_rm_localnetworkgateway_info:
    resource_group: "{{ resource_group }}"

- name: Gets all the local network gateways in a resource group and filter by tags
  azure_rm_localnetworkgateway_info:
    resource_group: "{{ resource_group }}"
    tags:
      - foo

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

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

Ключ

Описание

state

complex

Текущее состояние ресурса шлюза локальной сети Azure.

Возвращается: всегда

bgp_settings

complex

Параметры BGP-динамика шлюза локальной сети.

Возвращается: при успехе

asn

integer

Номер автономной системы (ASN) BGP-динамика.

Возвращается: всегда

Пример: 10

bgp_peering_address

string

Адрес пиринга BGP и идентификатор BGP-динамика.

Возвращается: всегда

Пример: "10.0.0.3"

peer_weight

integer

Вес, добавляемый к маршрутам, полученным от этого BGP-динамика.

Возвращается: всегда

Пример: 0

etag

string

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

Возвращается: всегда

Пример: "b5a32693-2e75-49e0-9137-ded19db658d6"

fqdn

string

Полное доменное имя шлюза локальной сети.

Возвращается: всегда

Пример: "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 / элементы=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–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/azure/azcollection/azure_rm_localnetworkgateway_info_module.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API