azure_rm_networkinterface_facts - Получение фактов о сетевом интерфейсе.
Новое в версии 2.1.
- Краткое описание
- Требования (к хосту, на котором выполняется модуль)
- Параметры
- Примеры
- Возвращаемые значения
- Примечания
Краткое описание
- Получение фактов о конкретном сетевом интерфейсе или всех сетевых интерфейсах в группе ресурсов.
Требования (к хосту, на котором выполняется модуль)
- python >= 2.7
- azure >= 2.0.0
Параметры
| параметр | обязательный | значение по умолчанию | варианты | комментарии |
|---|---|---|---|---|
| ad_user | нет | Имя пользователя Active Directory. Используется при аутентификации с помощью пользователя Active Directory, а не с помощью службы. | ||
| client_id | нет | Идентификатор клиента Azure. Используется при аутентификации с помощью службы. | ||
| cloud_environment | нет | 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. Используется при аутентификации с помощью службы. |
Примеры
- name: Get facts for one network interface
azure_rm_networkinterface_facts:
resource_group: Testing
name: nic001
- name: Get network interfaces within a resource group
azure_rm_networkinterface_facts:
resource_group: Testing
- name: Get network interfaces by tag
azure_rm_networkinterface_facts:
resource_group: Testing
tags:
- testing
- foo:bar
Возвращаемые значения
Общие возвращаемые значения документированы здесь Возвращаемые значения, следующие поля уникальны для этого модуля:
| имя | описание | возвращается | тип | пример |
|---|---|---|---|---|
| azure_networkinterfaces | Список словарей сетевых интерфейсов. | всегда | список |
Примечания
Примечание
- Для аутентификации с Azure вы можете передать параметры, установить переменные среды или использовать профиль, хранящийся в ~/.azure/credentials. Аутентификация возможна с помощью службы или пользователя 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 в среде.
Статус
Этот модуль помечен как превью, что означает, что его интерфейс не гарантируется как обратная совместимость.
Для получения помощи в разработке модулей, если вы так решили, пожалуйста, прочитайте Справочную информацию по сообществу и сотрудничеству, Тестирование Ansible и Разработка модулей.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.4/azure_rm_networkinterface_facts_module.html