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

Примечание

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

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

Для использования в playbook, укажите: community.azure.azure_rm_virtualmachine_facts.

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

Обзор

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

Требования

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

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` могут использоваться для определения идентификатора подписки, если их несколько, в противном случае используется стандартная подписка az 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, или войти в систему перед запуском задач или 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
  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 строка		всегда	Имя пользователя администратора. Пример: admin
	boot_diagnostics complex		всегда	Информация о настройках диагностики загрузки.
		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 complex		всегда	Список подключенных дисков данных.
		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 complex		всегда	Спецификация образа.
		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 строка		всегда	Размер виртуальной машины. Пример: Standard_D4

Авторы

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.10/collections/community/azure/azure_rm_virtualmachine_facts_module.html