Spec-Zone.ru › Ansible

Модуль azure.azcollection.azure_rm_vmssnetworkinterface_info — получение сведений о сетевом интерфейсе в масштабируемом наборе виртуальных машин

Примечание

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

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

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

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

Добавлено в azure.azcollection 1.15.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

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

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

Если задан параметр name, необходимо также задать параметр vm_index.

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.

tenant

string

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

thumbprint

string

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

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

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

Обязателен, если задан x509_certificate_path.

vm_index

string

Индекс виртуальной машины, например vm_index=0.

vmss_name

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

Имя масштабируемого набора виртуальных машин.

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 information by the network name
  azure_rm_vmssnetworkinterface_info:
    resource_group: myResourceGroup
    name: nic001
    vmss_name: testVMSS
    vm_index: 0

- name: Get all network interface information in virtual machine scale set
  azure_rm_vmssnetworkinterface_info:
    resource_group: myResourceGroup
    vmss_name: testVMSS

- name: Get all network interface information in the same virtual machine index.
  azure_rm_vmssnetworkinterface_info:
    resource_group: myResourceGroup
    vmss_name: testVMSS
    vm_index: 1

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

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

Ключ

Описание

vmss_networkinterfaces

complex

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

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

create_with_security_group

boolean

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

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

Пример: true

dns_servers

list / elements=string

DNS-серверы, которые должен использовать сетевой интерфейс.

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

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

Пример: []

dns_settings

complex

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

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

applied_dns_servers

list / elements=string

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

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

Пример: []

dns_servers

list / elements=string

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

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

Пример: []

internal_dns_name_label

string

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

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

internal_fqdn

string

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

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

enable_accelerated_networking

boolean

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

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

Пример: true

enable_ip_forwarding

boolean

Включить ли IP-переадресацию.

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

Пример: true

id

string

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

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

Пример: "/subscriptions/xxx-xxx/resourceGroups/RG/providers/Microsoft.Compute/virtualMachineScaleSets/fredvmss/virtualMachines/1/networkInterfaces/nic01"

ip_configurations

complex

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

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

application_gateway_backend_address_pools

string

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

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

application_security_groups

string

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

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

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

load_balancer_backend_address_pools

string

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

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

name

string

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

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

Пример: "defaultIpConfiguration"

primary

boolean

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

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

Пример: true

private_ip_address

string

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

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

Пример: "10.3.0.5"

private_ip_allocation_method

string

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

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

Пример: "Dynamic"

public_ip_address

string

Имя публичного IP-адреса. Значение None, если IP-адрес отключён.

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

public_ip_allocation_method

string

Метод выделения публичного IP-адреса.

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

location

string

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

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

Пример: "eastus"

mac_address

string

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

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

Пример: "00-0D-3A-17-EC-36"

name

string

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

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

Пример: "nic01"

provisioning_state

string

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

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

Пример: "Succeeded"

resource_group

string

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

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

Пример: "RG"

security_group

string

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

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

Пример: "/subscriptions/xxx-xxx/resourceGroups/RG/providers/Microsoft.Network/networkSecurityGroups/nic01"

subnet

string

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

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

Пример: "default"

tags

dictionary

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

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

Пример: {"key1": "value1"}

virtual_network

dictionary

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

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

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

Пример: {"name": "vnet01", "resource_group": "RG"}

Авторы

  • 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_vmssnetworkinterface_info_module.html

Spec-Zone.ru

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