azure_rm_virtualmachine_facts – Получение фактов о виртуальных машинах.
Новое в версии 2.7.
Обзор
- Получение фактов обо всех виртуальных машинах группы ресурсов.
Требования
Ниже приведены требования к хосту, на котором выполняется этот модуль.
- python >= 2.7
- azure >= 2.0.0
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| ad_user - | Имя пользователя Active Directory. Используется при аутентификации с помощью пользователя Active Directory, а не с помощью сервисного принципала. | |
| adfs_authority_url - добавлено в 2.6 | По умолчанию: null | URL-адрес авторизации Azure AD. Используется при аутентификации с помощью имени пользователя/пароля и собственной авторизацией ADFS. |
| api_profile - добавлено в 2.5 | По умолчанию: "latest" | Выбирает профиль API для использования при общении с Azure-сервисами. Значение по умолчанию latest подходит для общедоступных облаков; будущие значения позволят использовать Azure Stack. |
| auth_source - добавлено в 2.5 |
| Управляет источником учетных данных для аутентификации. Если не указано, будет использована переменная среды ANSIBLE_AZURE_AUTH_SOURCE и по умолчанию установлено значение auto при отсутствии переменной.auto будет следовать умолчанию по приоритету параметров модуля -> переменных среды -> профилю по умолчанию в файле учетных данных ~/.azure/credentials.При установке значения cli, учетные данные будут взяты из профиля Azure CLI по умолчанию.Также можно установить через переменную среды ANSIBLE_AZURE_AUTH_SOURCE.При установке значения msi, хост-машина должна быть ресурсом Azure с включённым расширением MSI. subscription_id или переменная среды AZURE_SUBSCRIPTION_ID могут использоваться для определения идентификатора подписки, если ресурсу предоставлен доступ к нескольким подпискам, в противном случае выбирается первая подписка.msi было добавлено в Ansible 2.6. |
| cert_validation_mode - добавлено в 2.5 |
| Управляет поведением проверки сертификатов для Azure-узлов. По умолчанию все модули проверяют серверный сертификат, но при использовании прокси HTTPS или работе с Azure Stack может потребоваться отключить это поведение, передав ignore. Также можно установить через профиль файла учетных данных или переменную среды AZURE_CERT_VALIDATION. |
| client_id - | Идентификатор клиента Azure. Используется при аутентификации с помощью сервисного принципала. | |
| cloud_environment - добавлено в 2.4 | По умолчанию: "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. Аутентификация возможна с помощью сервисного принципала или пользователя 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 в среде.
Примеры
- name: Get facts for all virtual machines of a resource group
azure_rm_virtualmachine_facts:
resource_group: Testing
- name: Get facts by name
azure_rm_virtualmachine_facts:
resource_group: Testing
name: vm
- name: Get facts by tags
azure_rm_virtualmachine_facts:
resource_group: Testing
tags:
- testing
- foo:bar
Возвращаемые значения
Общие возвращаемые значения описаны здесь, следующие поля уникальны для данного модуля:
| Ключ | Возвращаемое значение | Описание | ||
|---|---|---|---|---|
| vms сложный | всегда | Список виртуальных машин. | ||
| admin_username строка | всегда | Имя пользователя администратора. Пример: admin | ||
| data_disks сложный | всегда | Список присоединённых дисковых томов данных. | ||
| caching строка | Тип кэширования диска данных. Пример: ReadOnly | |||
| disk_size_gb целое число | Начальный размер диска в ГБ для пустых дисков данных Пример: 64 | |||
| lun целое число | Логический номер устройства (LUN) для диска данных | |||
| managed_disk_type строка | Тип управляемого диска данных Пример: Standard_LRS | |||
| id строка | всегда | Идентификатор ресурса. Пример: /subscriptions/xxxx/resourceGroups/myclusterrg/providers/Microsoft.Compute/virtualMachines/mycluster-node-2 | ||
| image сложный | всегда | Настройка образа. | ||
| offer строка | Предложение. Пример: RHEL | |||
| publisher строка | Имя издателя. Пример: RedHat | |||
| sku строка | Имя SKU. Пример: 7-RAW | |||
| version строка | Версия образа. Пример: 7.5.2018050901 | |||
| location строка | всегда | Расположение ресурса. Пример: japaneast | ||
| name строка | всегда | Имя ресурса. Пример: mycluster-node-2 | ||
| network_interface_names список | Список присоединённых сетевых интерфейсов. Пример: ['mycluster-node-2-nic'] | |||
| os_disk_caching строка | Тип кэширования операционной системы диска. Пример: ReadOnly | |||
| os_type строка | Базовый тип операционной системы. Пример: Linux | |||
| resource_group строка | Группа ресурсов. | |||
| state строка | Состояние ресурса. Пример: present | |||
| tags словарь | Теги. | |||
| vm_size строка | Размер виртуальной машины. Пример: Standard_D4 | |||
Статус
- Этот модуль не гарантирует обратную совместимость. [превью]
- Этот модуль поддерживается сообществом Ansible. [сообщество]
Авторы
- Gustavo Muniz do Carmo (@gustavomcarmo)
- Zim Kalinowski (@zikalino)
Подсказка
Если вы заметите какие-либо проблемы в этом руководстве, вы можете отредактировать этот документ, чтобы улучшить его.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.7/modules/azure_rm_virtualmachine_facts_module.html
