Spec-Zone.ru › Ansible

Модуль azure.azcollection.azure_rm_networkinterface_info – Получение сведений о сетевых интерфейсах

Примечание

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

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

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

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

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

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

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

  • Получение сведений об указанном сетевом интерфейсе или обо всех сетевых интерфейсах в группе ресурсов.

Требования

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

  • 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

добавлено в 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; в противном случае будет использована подписка Azure 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: Get facts for one network interface
  azure_rm_networkinterface_info:
    resource_group: myResourceGroup
    name: nic001

- name: Get network interfaces within a resource group
  azure_rm_networkinterface_info:
    resource_group: myResourceGroup

- name: Get network interfaces by tag
  azure_rm_networkinterface_info:
    resource_group: myResourceGroup
    tags:
      - testing
      - foo:bar

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

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

Ключ

Описание

networkinterfaces

complex

Список словарей сетевых интерфейсов. Каждый словарь содержит параметры, которые можно передать модулю azure.azcollection.azure_rm_networkinterface.

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

create_with_security_group

boolean

Указывает, следует ли создать группу безопасности по умолчанию вместе с NIC. Применяется только при создании новой NIC.

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

Пример: false

dns_servers

list / elements=string

Какие DNS-серверы должна использовать NIC для поиска.

Список IP-адресов.

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

Пример: []

dns_settings

complex

Параметры DNS сетевого интерфейса.

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

applied_dns_servers

list / elements=string

Если виртуальная машина, использующая эту NIC, входит в набор доступности, этот список будет содержать объединение всех DNS-серверов со всех NIC, входящих в набор доступности. Это свойство задается для каждой из этих виртуальных машин.

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

Пример: []

dns_servers

list / elements=string

Список IP-адресов DNS-серверов.

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

Пример: []

internal_dns_name_label

string

Относительное DNS-имя этой NIC, используемое для внутреннего взаимодействия между виртуальными машинами в одной виртуальной сети.

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

internal_fqdn

string

Полное DNS-имя, поддерживающее внутреннее взаимодействие между виртуальными машинами в одной виртуальной сети.

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

enable_accelerated_networking

boolean

Указывает, следует ли создать сетевой интерфейс с функцией ускоренной работы сети.

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

Пример: false

enable_ip_forwarding

boolean

Включено ли перенаправление IP-пакетов

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

Пример: false

id

string

Идентификатор сетевого интерфейса.

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

Пример: "/subscriptions/xxxx-xxxxx/resourceGroups/testRG/providers/Microsoft.Network/networkInterfaces/nic01"

ip_configurations

complex

Список конфигураций IP, если их несколько.

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

application_gateway_backend_address_pools

list / elements=string

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

Список существующих пулов внутренних адресов шлюза приложений, связанных с сетевым интерфейсом.

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

application_security_groups

list / elements=string

Список групп безопасности приложений.

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

Пример: ["/subscriptions/<subsid>/resourceGroups/<rg>/providers/Microsoft.Network/applicationSecurityGroups/myASG"]

load_balancer_backend_address_pools

list / elements=string

Список существующих пулов внутренних адресов балансировщика нагрузки, связанных с сетевым интерфейсом.

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

name

string

Имя конфигурации IP.

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

Пример: "default"

primary

boolean

Является ли конфигурация IP основной в списке.

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

Пример: true

private_ip_address

string

Частный IP-адрес для конфигурации IP.

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

Пример: "10.10.0.4"

private_ip_allocation_method

string

Метод назначения частного IP-адреса.

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

Пример: "Dynamic"

public_ip_address

string

Имя общедоступного IP-адреса. Для отключенного IP-адреса — None.

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

public_ip_allocation_method

string

Метод назначения общедоступного IP-адреса.

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

location

string

Расположение Azure.

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

Пример: "eastus"

mac_address

string

MAC-адрес сетевого интерфейса.

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

name

string

Имя сетевого интерфейса.

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

Пример: "nic01"

provisioning_state

string

Состояние подготовки сетевого интерфейса.

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

Пример: "Succeeded"

resource_group

string

Имя группы ресурсов, в которой находится сетевой интерфейс.

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

Пример: "testRG"

security_group

string

Идентификатор ресурса группы безопасности, с которой будет связан сетевой интерфейс.

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

subnet

string

Имя существующей подсети в указанной виртуальной сети.

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

Пример: "sub01"

tags

dictionary

Теги сетевого интерфейса.

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

Пример: {"key1": "value1", "key2": "value2"}

virtual_network

complex

Существующая виртуальная сеть, с которой будет связан сетевой интерфейс.

Это словарь, содержащий name и resource_group виртуальной сети.

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

name

string

Имя виртуальной сети, связанной с сетевым интерфейсом.

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

Пример: "vnetnic01"

resource_gorup

string

Имя группы ресурсов, существующей в виртуальной сети.

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

Пример: "testRG"

subnet_id

string

Идентификатор подсети.

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

Пример: "/subscriptions/xxx-xxxx/resourceGroups/testRG/providers/Microsoft.Network/virtualNetworks/nic01/subnets/sub01"

subscription_id

string

Идентификатор подписки виртуальной сети.

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

Пример: "xxxxxxx-xxxxxxxxxxxxx"

Авторы

  • Chris Houseknecht (@chouseknecht)
  • Matt Davis (@nitzmahone)

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

  • Отслеживание проблем
  • Главная страница
  • Репозиторий (исходный код)

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

Spec-Zone.ru

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