Spec-Zone.ru › Ansible 2.11

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

Примечание

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

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

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

Новое в версии 0.1.2: из azure.azcollection

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

Описание

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

Требования

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

  • python >= 2.7
  • azure >= 2.0.0

Параметры

...
Параметр Варианты/Значения по умолчанию Комментарии
ad_user
строка
Имя пользователя Active Directory. Используется при аутентификации с пользователем Active Directory вместо служебного принципала.
adfs_authority_url
строка
добавлено в 0.0.1 of azure.azcollection
URL-адрес полномочий Azure AD. Используется при аутентификации с помощью имени пользователя/пароля и собственных полномочий ADFS.
api_profile
строка
добавлено в 0.0.1 of azure.azcollection
По умолчанию:
"latest"
Выбирает профиль API для взаимодействия с Azure-сервисами. Значение по умолчанию latest подходит для общедоступных облаков; будущие значения позволят использовать Azure Stack.
auth_source
строка
добавлено в 0.0.1 of 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.

Примечания

Примечание

  • Для аутентификации с 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
  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
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
при создании из образа маркета
Предложение платформенного или маркетплейс-образа, используемого для создания виртуальной машины.

Пример:
RHEL
publisher
string
при создании из образа маркета
Имя издателя.

Пример:
RedHat
sku
string
при создании из образа маркета
Название SKU.

Пример:
7-RAW
version
string
при создании из образа маркета
Версия образа.

Пример:
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/azure/azcollection/azure_rm_virtualmachine_info_module.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API