community.azure.azure_rm_virtualmachine_info – Получение фактов о виртуальных машинах

Примечание

Этот плагин входит в коллекцию community.azure (версия 1.0.0).

Для его установки используйте: ansible-galaxy collection install community.azure.

Для использования в плейбуке укажите: community.azure.azure_rm_virtualmachine_info.

Обзор
Требования
Параметры
Примечания
См. также
Примеры
Возвращаемые значения

Обзор

Получение фактов для одной или всех виртуальных машин в группе ресурсов.

Требования

Ниже перечислены требования, необходимые на хосте, на котором выполняется этот модуль.

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	Варианты: auto ← cli credential_file env msi	Управляет источником учетных данных для аутентификации. Также может быть задано через переменную среды `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	Варианты: ignore validate	Управляет поведением проверки сертификатов для 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 all virtual machines of a resource group
  community.azure.azure_rm_virtualmachine_info:
    resource_group: myResourceGroup

- name: Get facts by name
  community.azure.azure_rm_virtualmachine_info:
    resource_group: myResourceGroup
    name: myVm

- name: Get facts by tags
  community.azure.azure_rm_virtualmachine_info:
    resource_group: myResourceGroup
    tags:
      - testing
      - foo:bar

Возвращаемые значения

Общие возвращаемые значения описаны здесь, следующие поля уникальны для этого модуля:

Ключ			Возвращаемое значение	Описание
vms complex			всегда	Список виртуальных машин.
	admin_username string		всегда	Имя пользователя администратора. Пример: admin
	boot_diagnostics complex		всегда	Информация о настройках диагностики загрузки.
		console_screenshot_uri string	всегда	Содержит URI для получения скриншота консоли. Присутствует только при включении. Пример: https://mystorageaccountname.blob.core.windows.net/bootdiagnostics-myvm01-a4db09a6-ab7f-4d80-9da8-fbceaef9288a/ myVm.a4db09a6-ab7f-4d80-9da8-fbceaef9288a.screenshot.bmp
		enabled boolean	всегда	Указывает, включена ли диагностика загрузки. Пример: True
		serial_console_log_uri string	всегда	Содержит URI для получения журнала последовательной консоли. Присутствует только при включении. Пример: https://mystorageaccountname.blob.core.windows.net/bootdiagnostics-myvm01-a4db09a6-ab7f-4d80-9da8-fbceaef9288a/ myVm.a4db09a6-ab7f-4d80-9da8-fbceaef9288a.serialconsole.log
		storage_uri string	всегда	Указывает используемую учетную запись хранилища для диагностики загрузки. Пример: https://mystorageaccountname.blob.core.windows.net/
	data_disks complex		всегда	Список подключенных дополнительных дисков.
		caching string	всегда	Тип кэширования диска. Пример: ReadOnly
		disk_size_gb integer	всегда	Начальный размер диска в ГБ для пустых дополнительных дисков. Пример: 64
		lun integer	всегда	Логический номер устройства для диска.
		managed_disk_type string	всегда	Тип управляемого диска. Пример: Standard_LRS
	id string		всегда	Идентификатор ресурса. Пример: /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVm
	image complex		всегда	Спецификация образа.
		id string	при создании из пользовательского образа	Идентификатор ресурса пользовательского образа. Пример: /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.Compute/images/myImage
		offer string	при создании из образа из Marketplace	Предложение платформенного образа или образа из Marketplace, используемого для создания виртуальной машины. Пример: RHEL
		publisher string	при создании из образа из Marketplace	Название издателя. Пример: RedHat
		sku string	при создании из образа из Marketplace	Имя SKU. Пример: 7-RAW
		version string	при создании из образа из Marketplace	Версия образа. Пример: 7.5.2018050901
	location string		всегда	Местоположение ресурса. Пример: japaneast
	name string		всегда	Имя ресурса. Пример: myVm
	network_interface_names list / elements=string		всегда	Список подключенных сетевых адаптеров. Пример: ['myNetworkInterface']
	os_disk_caching string		всегда	Тип кэширования системного диска. Пример: ReadOnly
	os_type string		всегда	Базовый тип операционной системы. Пример: Linux
	power_state string		всегда	Состояние питания виртуальной машины. Пример: running
	resource_group string		всегда	Группа ресурсов. Пример: myResourceGroup
	state string		всегда	Состояние ресурса. Пример: present
	tags dictionary		всегда	Теги ресурса. Пример: {'key1': 'value1'}
	vm_size string		всегда	Размер виртуальной машины. Пример: Standard_D4

Авторы

Gustavo Muniz do Carmo (@gustavomcarmo)
Zim Kalinowski (@zikalino)

© 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/community/azure/azure_rm_virtualmachine_info_module.html