azure_rm_virtualmachine_info – Получение фактов о виртуальной машине
Новая версия с 2.9.
Обзор
- Получение фактов для одной или всех виртуальных машин в группе ресурсов.
Псевдонимы: azure_rm_virtualmachine_facts
Требования
Ниже перечислены требования к хосту, на котором выполняется этот модуль.
- python >= 2.7
- azure >= 2.0.0
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| ad_user строка | Имя пользователя Active Directory. Используйте при аутентификации с пользователем Active Directory, а не с принципалом службы. | |
| adfs_authority_url строка добавлено в 2.6 | 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, или выполнить вход перед запуском задач или 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. Также возможно добавление дополнительных профилей. Укажите профиль, передав profile или установив AZURE_PROFILE в среде.
См. также
См. также
- Авторизация с помощью Azure CLI
- Как авторизоваться, используя команду
az login.
Примеры
- name: Get facts for all virtual machines of a resource group
azure_rm_virtualmachine_info:
resource_group: myResourceGroup
- name: Get facts by name
azure_rm_virtualmachine_info:
resource_group: myResourceGroup
name: myVm
- name: Get facts by tags
azure_rm_virtualmachine_info:
resource_group: myResourceGroup
tags:
- testing
- foo:bar
Возвращаемые значения
Общие возвращаемые значения описаны здесь, следующие поля уникальны для данного модуля:
| Ключ | Возвращаемое значение | Описание | ||
|---|---|---|---|---|
| vms сложный | всегда | Список виртуальных машин. | ||
| admin_username строка | всегда | Имя пользователя администратора. Пример: admin | ||
| boot_diagnostics сложный | всегда | Информация о настройках диагностики загрузки. | ||
| console_screenshot_uri строка | всегда | Содержит URI для получения скриншота консоли. Присутствует только при включении. Пример: https://mystorageaccountname.blob.core.windows.net/bootdiagnostics-myvm01-a4db09a6-ab7f-4d80-9da8-fbceaef9288a/ myVm.a4db09a6-ab7f-4d80-9da8-fbceaef9288a.screenshot.bmp | ||
| enabled булево | всегда | Указывает, включена ли диагностика загрузки. Пример: True | ||
| serial_console_log_uri строка | всегда | Содержит URI для получения журнала последовательной консоли. Присутствует только при включении. Пример: https://mystorageaccountname.blob.core.windows.net/bootdiagnostics-myvm01-a4db09a6-ab7f-4d80-9da8-fbceaef9288a/ myVm.a4db09a6-ab7f-4d80-9da8-fbceaef9288a.serialconsole.log | ||
| storage_uri строка | всегда | Указывает учетную запись хранилища, используемую диагностикой загрузки. Пример: https://mystorageaccountname.blob.core.windows.net/ | ||
| data_disks сложный | всегда | Список подключенных дисков данных. | ||
| caching строка | всегда | Тип кэширования диска данных. Пример: ReadOnly | ||
| disk_size_gb целое число | всегда | Начальный размер диска в ГБ для пустых дисков данных. Пример: 64 | ||
| lun целое число | всегда | Логический номер устройства для диска данных. | ||
| managed_disk_type строка | всегда | Тип управляемого диска данных. Пример: Standard_LRS | ||
| id строка | всегда | Идентификатор ресурса. Пример: /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVm | ||
| image сложный | всегда | Спецификация образа. | ||
| id строка | при создании из пользовательского образа | Идентификатор ресурса пользовательского образа. Пример: /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.Compute/images/myImage | ||
| offer строка | при создании из образа маркета | Предложение платформенного образа или образа маркета, используемого для создания виртуальной машины. Пример: RHEL | ||
| publisher строка | при создании из образа маркета | Имя издателя. Пример: RedHat | ||
| sku строка | при создании из образа маркета | Имя SKU. Пример: 7-RAW | ||
| version строка | при создании из образа маркета | Версия образа. Пример: 7.5.2018050901 | ||
| location строка | всегда | Расположение ресурса. Пример: japaneast | ||
| name строка | всегда | Имя ресурса. Пример: myVm | ||
| network_interface_names список | всегда | Список подключенных сетевых интерфейсов. Пример: ['myNetworkInterface'] | ||
| os_disk_caching строка | всегда | Тип кэширования диска ОС. Пример: ReadOnly | ||
| os_type строка | всегда | Базовый тип операционной системы. Пример: Linux | ||
| power_state строка | всегда | Состояние питания виртуальной машины. Пример: running | ||
| resource_group строка | всегда | Группа ресурсов. Пример: myResourceGroup | ||
| state строка | всегда | Состояние ресурса. Пример: present | ||
| tags словарь | всегда | Теги ресурса. Пример: {'key1': 'value1'} | ||
| vm_size string | always | Размер виртуальной машины. Пример: 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.9/modules/azure_rm_virtualmachine_info_module.html
