Spec-Zone.ru › Ansible

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

Примечание

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

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

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

Для использования в playbook укажите: 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
END_OF_DOCUMENT_MARKER

Параметры

Параметр

Комментарии

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

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

Если настроить name, необходимо установить параметры vm_index.

password

string

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

profile

string

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

resource_group

string / required

Имя группы ресурсов.

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

путь

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

Путь к X509-сертификату, используемому для создания сервисного принципала в формате PEM.

Сертификат должен быть присоединён к закрытому ключу.

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

Примечания

Примечание

  • Для аутентификации с Azure можно передать параметры, установить переменные среды, использовать профиль, сохранённый в ~/.azure/credentials, или выполнить вход перед запуском задач или сценария с помощью 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: 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

сложный

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

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

create_with_security_group

логическое

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

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

Пример: true

dns_servers

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

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

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

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

Пример: []

dns_settings

сложный

Настройки DNS в сетевом интерфейсе.

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

applied_dns_servers

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

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

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

Пример: []

dns_servers

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

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

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

Пример: []

internal_dns_name_label

строка

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

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

internal_fqdn

строка

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

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

enable_accelerated_networking

логическое

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

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

Пример: true

enable_ip_forwarding

логическое

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

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

Пример: true

id

строка

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

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

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

ip_configurations

сложный

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

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

application_gateway_backend_address_pools

строка

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

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

application_security_groups

строка

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

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

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

load_balancer_backend_address_pools

строка

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

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

name

строка

Имя конфигурации 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–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/azure/azcollection/azure_rm_vmssnetworkinterface_info_module.html

Spec-Zone.ru

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