Spec-Zone.ru › Ansible

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

Примечание

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

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

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

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

Новая функция в azure.azcollection 2.4.0

  • Обзор
  • Требования
  • Параметры
  • Примечания
  • См. также
  • Примеры
  • Значения возврата

Обзор

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

Требования

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

  • 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, а не с главным субъектом безопасности.

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. Значение по умолчанию latest подходит для общедоступных облаков; будущие значения позволят использовать с Azure Stack.

Default: "latest"

auth_source

string

added in 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

added in 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

added in azure.azcollection 0.0.1

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

Default: "AzureCloud"

disable_instance_discovery

boolean

added in 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

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

password

string

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

profile

string

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

resource_group

string / required

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

secret

string

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

subscription_id

string

Ваш идентификатор подписки Azure.

теги

список / элементы=строка

Ограничить результаты, предоставив список тегов. Форматируйте теги как ‘ключ’ или ‘ключ:значение’.

арендатор

строка

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

отпечаток

строка

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

Отпечаток частного ключа, указанного в x509_certificate_path.

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

Требуется, если определён x509_certificate_path.

x509_certificate_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: 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 этого 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_info_module.html

Spec-Zone.ru

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