Модуль azure.azcollection.azure_rm_networkinterface_info – Получение фактов о сетевом интерфейсе
Примечание
Этот модуль входит в коллекцию azure.azcollection (версия 2.7.0).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install azure.azcollection. Для использования этого модуля требуются дополнительные зависимости. Подробности см. в разделе Требования.
Чтобы использовать его в playbook, укажите: 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 added in azure.azcollection 0.0.1 | URL-адрес узла Azure AD. Используйте при аутентификации с помощью имени пользователя/пароля и имеете собственный узел ADFS. |
api_profile string added in azure.azcollection 0.0.1 | Выбирает профиль API для использования при взаимодействии с службами Azure. Значение по умолчанию Default: |
auth_source string added in azure.azcollection 0.0.1 | Управляет источником учетных данных для аутентификации. Также может быть установлен через переменную среды При установке в При установке в При установке в При установке в При установке в
Варианты:
|
cert_validation_mode string added in azure.azcollection 0.0.1 | Управляет поведением проверки сертификата для конечных точек Azure. По умолчанию все модули будут проверять серверный сертификат, но при использовании прокси-сервера HTTPS или в Azure Stack может потребоваться отключить это поведение, передав Варианты:
|
client_id string | Идентификатор клиента Azure. Используйте при аутентификации с помощью субъекта безопасности или управляемой идентификации (msi). Также может быть установлен через переменную среды |
cloud_environment string added in azure.azcollection 0.0.1 | Для облачных сред, отличных от общедоступного облака США, имя среды (как определено в Azure Python SDK, например, Default: |
disable_instance_discovery boolean added in azure.azcollection 2.3.0 | Определяет, выполняется ли обнаружение экземпляров при попытке аутентификации. Установка этого значения в true полностью отключит как обнаружение экземпляров, так и проверку подлинности. Эта функция предназначена для использования в сценариях, когда конечная точка метаданных недоступна, например, в частных облаках или Azure Stack. Процесс обнаружения экземпляров включает в себя получение метаданных узла из https://login.microsoft.com/ для проверки узла. Установив это значение в **True**, проверка узла отключается. В результате крайне важно убедиться, что настроенный узел является действительным и заслуживающим доверия. Устанавливается через профиль файла учетных данных или переменную среды Варианты:
|
log_mode string | Родительский аргумент. |
log_path string | Родительский аргумент. |
name string | Показывать результаты только для определенного сетевого интерфейса. |
password string | Пароль пользователя Active Directory. Используйте при аутентификации с пользователем Active Directory, а не с главным субъектом безопасности. |
profile string | Профиль безопасности, найденный в файле ~/.azure/credentials. |
resource_group string | Имя группы ресурсов, содержащей сетевой интерфейс (интерфейсы). Требуется при поиске по имени. |
secret string | Секретный ключ клиента Azure. Используйте при аутентификации с помощью субъекта безопасности. |
subscription_id string | Ваш идентификатор подписки Azure. |
метки список / элементы=строка | Ограничить результаты, предоставив список меток. Форматируйте метки как ‘ключ’ или ‘ключ:значение’. |
арендатор строка | Идентификатор аренды Azure. Используйте при аутентификации с помощью принципала службы. |
отпечаток строка добавлено в azure.azcollection 1.14.0 | Отпечаток частного ключа, указанного в x509_certificate_path. Используйте при аутентификации с помощью принципала службы. Требуется, если определен x509_certificate_path. |
путь_к_сертификату_x509 путь добавлено в 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. Также возможно добавить дополнительные профили. Укажите профиль, передав профиль или установив 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 сложный | Список словарей сетевых интерфейсов. Каждый словарь содержит параметры, которые можно передать модулю azure.azcollection.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 строка |
Полное доменное имя DNS, поддерживающее внутреннюю связь между виртуальными машинами в одной и той же виртуальной сети. Возвращаемое значение: всегда |
|
enable_accelerated_networking логическое |
Указывает, следует ли создавать сетевой интерфейс с функцией ускоренного сетевого взаимодействия. Возвращаемое значение: всегда Пример: |
|
enable_ip_forwarding логическое |
Включить или выключить IP-переадресацию. Возвращаемое значение: всегда Пример: |
|
id строка |
Идентификатор сетевого интерфейса. Возвращаемое значение: всегда Пример: |
|
ip_configurations сложный |
Список IP-конфигураций, если их несколько. Возвращаемое значение: всегда |
|
application_gateway_backend_address_pools список / элементы=строка добавлен в azure.azcollection 1.10.0 |
Список существующих пулов обратных адресов шлюза приложений, связанных с сетевым интерфейсом. Возвращаемое значение: всегда |
|
application_security_groups список / элементы=строка |
Список групп безопасности приложений. Возвращаемое значение: всегда Пример: |
|
load_balancer_backend_address_pools список / элементы=строка |
Список существующих пулов обратных адресов балансировщика нагрузки, связанных с сетевым интерфейсом. Возвращаемое значение: всегда |
|
name строка |
Имя IP-конфигурации. Возвращаемое значение: всегда Пример: |
|
primary boolean |
Является ли IP-конфигурация основной в списке. Возвращается: всегда Пример: |
|
private_ip_address string |
Приватный IP-адрес для IP-конфигурации. Возвращается: всегда Пример: |
|
private_ip_allocation_method string |
Метод выделения приватного IP-адреса. Возвращается: всегда Пример: |
|
public_ip_address string |
Имя публичного IP-адреса. None для отключенного IP-адреса. Возвращается: всегда |
|
public_ip_allocation_method string |
Метод выделения публичного IP-адреса. Возвращается: всегда |
|
location string |
Расположение Azure. Возвращается: всегда Пример: |
|
mac_address string |
MAC-адрес сетевого интерфейса. Возвращается: всегда |
|
name string |
Имя сетевого интерфейса. Возвращается: всегда Пример: |
|
provisioning_state string |
Состояние подготовки сетевого интерфейса. Возвращается: всегда Пример: |
|
resource_group string |
Имя группы ресурсов, где существует сетевой интерфейс. Возвращается: всегда Пример: |
|
security_group string |
Идентификатор ресурса группы безопасности, с которой необходимо связать сетевой интерфейс. Возвращается: всегда |
|
subnet string |
Имя существующей подсети в указанной виртуальной сети. Возвращается: всегда Пример: |
|
tags dictionary |
Теги сетевого интерфейса. Возвращается: всегда Пример: |
|
virtual_network complex |
Существующая виртуальная сеть, с которой будет связан сетевой интерфейс. Это словарь, содержащий name и resource_group виртуальной сети. Возвращается: всегда |
|
name string |
Имя виртуальной сети, связанной с сетевым интерфейсом. Возвращается: всегда Пример: |
|
resource_gorup string |
Имя группы ресурсов, существующей в виртуальной сети. Возвращается: всегда Пример: |
|
subnet_id string |
Идентификатор подсети. Возвращается: всегда Пример: |
|
subscription_id string |
Идентификатор подписки виртуальной сети. Возвращается: всегда Пример: |
Ссылки на коллекцию
© 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_networkinterface_info_module.html