azure.azcollection.azure_rm_networkinterface_info – Получение фактов о сетевом интерфейсе
Примечание
Этот плагин входит в состав коллекции azure.azcollection (версия 1.4.0).
Для его установки используйте: ansible-galaxy collection install azure.azcollection.
Чтобы использовать его в плейбуке, укажите: azure.azcollection.azure_rm_networkinterface_info.
Новое в версии 0.1.2: из azure.azcollection
Обзор
- Получить факты о конкретном сетевом интерфейсе или обо всех сетевых интерфейсах в группе ресурсов.
Требования
Ниже перечислены требования, необходимые на хосте, на котором выполняется данный модуль.
- python >= 2.7
- azure >= 2.0.0
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| ad_user строка | Имя пользователя Active Directory. Используйте при аутентификации с пользователем Active Directory, а не с сервисным принципалом. | |
| adfs_authority_url строка добавлен в 0.0.1 из azure.azcollection | URL-адрес авторитета Azure AD. Используйте при аутентификации с именем пользователя/паролем и собственным авторитетом ADFS. | |
| api_profile строка добавлен в 0.0.1 из azure.azcollection | Значение по умолчанию: "latest" | Выбирает профиль API для взаимодействия с Azure-сервисами. Значение по умолчанию latest подходит для публичных облаков; будущие значения позволят использовать с Azure Stack. |
| auth_source строка добавлен в 0.0.1 из azure.azcollection |
| Управляет источником данных для аутентификации. Также может быть задан через переменную среды 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. |
| cert_validation_mode строка добавлен в 0.0.1 из azure.azcollection |
| Управляет поведением проверки сертификатов для Azure-узлов. По умолчанию все модули проверяют серверный сертификат, но при использовании прокси HTTPS или при работе с Azure Stack может потребоваться отключить это поведение, передав ignore. Также может быть задано в файле профиля или переменной среды AZURE_CERT_VALIDATION. |
| client_id строка | Идентификатор клиента Azure. Используйте при аутентификации с сервисным принципалом. | |
| cloud_environment строка добавлен в 0.0.1 из azure.azcollection | Значение по умолчанию: "AzureCloud" | Для облачных сред, отличных от общедоступного облака США, имя среды (как определено в Azure Python SDK, например, AzureChinaCloud, AzureUSGovernment), или URL-адрес точки доступа для обнаружения метаданных (требуется для Azure Stack). Также может быть задано в файле профиля или переменной среды AZURE_CLOUD_ENVIRONMENT. |
| name строка | Показывать результаты только для конкретного сетевого интерфейса. | |
| password строка | Пароль пользователя Active Directory. Используйте при аутентификации с пользователем Active Directory, а не с сервисным принципалом. | |
| profile строка | Профиль безопасности, найденный в файле ~/.azure/credentials. | |
| resource_group строка | Имя группы ресурсов, содержащей сетевой интерфейс(ы). Требуется при поиске по имени. | |
| secret строка | Секрет клиента Azure. Используйте при аутентификации с сервисным принципалом. | |
| subscription_id строка | Идентификатор вашей подписки Azure. | |
| tags строка | Ограничить результаты, указав список тегов. Формат тегов - 'ключ' или 'ключ:значение'. | |
| tenant строка | Идентификатор Azure-тенанта. Используйте при аутентификации с сервисным принципалом. |
Примечания
Примечание
- Для аутентификации с 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 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
Возвращаемые значения
Общие возвращаемые значения описаны здесь, следующие поля уникальны для данного модуля:
| Ключ | Возвращаемое значение | Описание | ||
|---|---|---|---|---|
| azure_networkinterfaces список / элементы=строка | всегда | Список словарей сетевых интерфейсов. Пример: [{'dns_settings': {'applied_dns_servers': [], 'dns_servers': [], 'internal_dns_name_label': None, 'internal_fqdn': None}, 'enable_ip_forwarding': False, 'etag': 'W/"59726bfc-08c4-44ed-b900-f6a559876a9d"', 'id': '/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroup/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nic003', 'ip_configuration': {'name': 'default', 'private_ip_address': '10.10.0.4', 'private_ip_allocation_method': 'Динамический', 'public_ip_address': {'id': '/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroup/myResourceGroup/providers/Microsoft.Network/publicIPAddresses/publicip001', 'name': 'publicip001'}, 'subnet': {'id': '/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroup/myResourceGroup/providers/Microsoft.Network/virtualNetworks/vnet001/subnets/subnet001', 'name': 'subnet001', 'virtual_network_name': 'vnet001'}}, 'location': 'westus', 'mac_address': None, 'name': 'nic003', 'network_security_group': {'id': '/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroup/myResourceGroup/providers/Microsoft.Network/networkSecurityGroups/secgroup001', 'name': 'secgroup001'}, 'primary': None, 'provisioning_state': 'Успешно завершено', 'tags': {}, 'type': 'Microsoft.Network/networkInterfaces'}] | ||
| networkinterfaces список / элементы=строка | всегда | Список словарей сетевых интерфейсов. Каждый словарь содержит параметры, которые можно передать модулю azure_rm_networkinterface. | ||
| create_with_security_group логическое | успех | Указывает, следует ли создавать группу безопасности по умолчанию вместе с сетевым интерфейсом. Применимо только при создании нового сетевого интерфейса. | ||
| dns_servers строка | успех | Какие DNS-серверы должен использовать сетевой интерфейс. Список IP-адресов. | ||
| dns_settings строка | успех | Настройки DNS в сетевом интерфейсе. | ||
| applied_dns_servers строка | успех | Если виртуальная машина, использующая этот сетевой интерфейс, является частью набора доступности, этот список будет содержать объединение всех DNS-серверов от всех сетевых интерфейсов, которые являются частью набора доступности. Это свойство настраивается на каждой из этих виртуальных машин. | ||
| dns_servers строка | успех | Список IP-адресов DNS-серверов. | ||
| internal_dns_name_label строка | успех | Относительное имя DNS для этого сетевого интерфейса, используемое для внутренней связи между виртуальными машинами в одной и той же виртуальной сети. | ||
| internal_fqdn строка | успех | Полное доменное имя (FQDN), поддерживающее внутреннюю связь между виртуальными машинами в одной и той же виртуальной сети. | ||
| enable_accelerated_networking строка | успех | Указывает, должен ли сетевой интерфейс быть создан с функцией ускоренной работы сети или нет. | ||
| enable_ip_forwarding строка | успех | Включить или нет IP-перенаправление. | ||
| id строка | успех | Идентификатор сетевого интерфейса. | ||
| ip_configurations строка | успех | Список IP-конфигураций, если их несколько. | ||
| application_security_groups строка | успех | Список групп безопасности приложений. Пример: /subscriptions/<subsid>/resourceGroups/<rg>/providers/Microsoft.Network/applicationSecurityGroups/myASG | ||
| load_balancer_backend_address_pools строка | успех | Список существующих пулов адресов обратного балансировщика, которые следует связать с сетевым интерфейсом. | ||
| name строка | успех | Имя IP-конфигурации. | ||
| primary строка | успех | Является ли IP-конфигурация основной в списке. | ||
| private_ip_address строка | успех | Приватный IP-адрес для IP-конфигурации. | ||
| private_ip_allocation_method строка | успех | Метод распределения приватного IP-адреса. | ||
| public_ip_address строка | успех | Имя общедоступного IP-адреса. None для отключения IP-адреса. | ||
| public_ip_allocation_method строка | успех | Метод распределения общедоступного IP-адреса. | ||
| location строка | успех | Расположение Azure. | ||
| mac_address строка | успех | MAC-адрес сетевого интерфейса. | ||
| name строка | успех | Имя сетевого интерфейса. | ||
| provisioning_state строка | успех | Состояние подготовки сетевого интерфейса. | ||
| resource_group строка | успех | Имя группы ресурсов, в которой находится сетевой интерфейс. | ||
| security_group строка | успех | Идентификатор ресурса группы безопасности, который следует связать с сетевым интерфейсом. | ||
| subnet строка | успех | Имя существующей подсети в указанной виртуальной сети. | ||
| tags строка | успех | Теги сетевого интерфейса. | ||
| virtual_network строка | успех | Существующая виртуальная сеть, с которой будет связан сетевой интерфейс. Это словарь, содержащий имя и группу ресурсов виртуальной сети. | ||
Авторы
- Chris Houseknecht (@chouseknecht)
- Matt Davis (@nitzmahone)
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/azure/azcollection/azure_rm_networkinterface_info_module.html
