Spec-Zone.ru › Ansible

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

Примечание

Этот модуль является частью коллекции azure.azcollection (версия 2.7.0).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.

Для установки используйте: ansible-galaxy collection install azure.azcollection. Для использования этого модуля необходимы дополнительные требования, см. Требования для получения подробностей.

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

Новая версия в azure.azcollection 0.1.2

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

Описание

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

Требования

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

  • python >= 2.7
  • На хосте, на котором выполняется модуль, должна быть установлена коллекция azure.azcollection через galaxy
  • Все пакеты python, перечисленные в файле requirements.txt коллекции, должны быть установлены с помощью pip на хосте, на котором выполняются модули из azure.azcollection
  • Полные инструкции по установке можно найти по адресу https://galaxy.ansible.com/azure/azcollection

Параметры

Параметр

Комментарии

ad_user

string

Имя пользователя Active Directory. Используйте при аутентификации с пользователем Active Directory, а не с субъектом безопасности.

adfs_authority_url

string

added in azure.azcollection 0.0.1

URL-адрес узла Azure AD. Используйте при аутентификации с помощью имени пользователя/пароля и имеете собственный узел ADFS.

api_profile

string

added in azure.azcollection 0.0.1

Выбирает профиль API для использования при взаимодействии с службами Azure. Значение по умолчанию latest подходит для общедоступных облаков; будущие значения позволят использовать с Azure Stack.

Default: "latest"

auth_source

string

added in azure.azcollection 0.0.1

Управляет источником учетных данных для аутентификации.

Также может быть установлен через переменную среды 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.

Варианты:

  • "auto" ← (по умолчанию)
  • "cli"
  • "credential_file"
  • "env"
  • "msi"

cert_validation_mode

string

added in azure.azcollection 0.0.1

Управляет поведением проверки сертификата для конечных точек Azure. По умолчанию все модули будут проверять серверный сертификат, но при использовании прокси-сервера HTTPS или для Azure Stack может потребоваться отключить это поведение, передав ignore. Также может быть установлен через профиль файла учетных данных или переменную среды AZURE_CERT_VALIDATION.

Варианты:

  • "ignore"
  • "validate"

client_id

string

Идентификатор клиента Azure. Используйте при аутентификации с помощью субъекта безопасности или управляемой идентификации (msi).

Также может быть установлен через переменную среды AZURE_CLIENT_ID.

cloud_environment

string

added in azure.azcollection 0.0.1

Для облачных сред, отличных от общедоступного облака США, имя среды (как определено в Azure Python SDK, например, AzureChinaCloud, AzureUSGovernment), или URL-адрес конечной точки обнаружения метаданных (требуется для Azure Stack). Также может быть установлен через профиль файла учетных данных или переменную среды AZURE_CLOUD_ENVIRONMENT.

Default: "AzureCloud"

disable_instance_discovery

boolean

added in azure.azcollection 2.3.0

Определяет, выполняется ли обнаружение экземпляров при попытке аутентификации. Установка этого значения в true полностью отключит как обнаружение экземпляров, так и проверку полномочий. Эта функция предназначена для использования в сценариях, когда конечная точка метаданных недоступна, например, в частных облаках или Azure Stack. Процесс обнаружения экземпляров включает в себя получение метаданных полномочий из https://login.microsoft.com/ для проверки полномочий. Установив это значение в **True**, проверка полномочий отключается. В результате необходимо убедиться, что настроенный узел полномочий действителен и заслуживает доверия.

Устанавливается через профиль файла учетных данных или переменную среды AZURE_DISABLE_INSTANCE_DISCOVERY.

Варианты:

  • false ← (по умолчанию)
  • true

log_mode

string

Родительский аргумент.

log_path

string

Родительский аргумент.

name

string

Имя виртуальной машины.

password

string

Пароль пользователя Active Directory. Используйте при аутентификации с пользователем Active Directory, а не с субъектом безопасности.

profile

string

Профиль безопасности, найденный в файле ~/.azure/credentials.

resource_group

string

Имя группы ресурсов, содержащей виртуальные машины (требуется при фильтрации по имени виртуальной машины).

secret

string

Секретный ключ клиента Azure. Используйте при аутентификации с помощью субъекта безопасности.

subscription_id

string

Ваш идентификатор подписки Azure.

Метки

список / элементы=строка

Ограничить результаты, указав список меток. Форматировать метки как ‘ключ’ или ‘ключ:значение’.

арендатор

строка

Идентификатор арендатора Azure. Используйте при аутентификации с помощью принципала службы.

отпечаток_ключа

строка

добавлен в azure.azcollection 1.14.0

Отпечаток частного ключа, указанного в x509_certificate_path.

Используйте при аутентификации с помощью принципала службы.

Требуется, если задано x509_certificate_path.

путь_к_сертификату_x509

путь

добавлен в azure.azcollection 1.14.0

Путь к сертификату X509, используемому для создания принципала службы в формате PEM.

Сертификат должен быть добавлен к частному ключу.

Используйте при аутентификации с помощью принципала службы.

Примечания

Примечание

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

Список виртуальных машин.

Возвращается: всегда

additional_capabilities

dictionary

Включает или отключает функциональность на виртуальной машине.

Возвращается: всегда

Пример: {"ultra_ssd_enabled": false}

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/"

CapacityReservation

dictionary

Имя или ID группы резервирования емкости, которая будет связана.

Возвращается: всегда

Пример: {}

data_disks

complex

Список подключенных дисков данных.

Возвращается: всегда

caching

string

Тип кэширования диска данных.

Возвращается: всегда

Пример: "ReadOnly"

disk_size_gb

integer

Начальный размер диска в ГБ для пустых дисков данных.

Возвращается: всегда

Пример: 64

lun

integer

Номер логического устройства для диска данных.

Возвращается: всегда

Пример: 0

managed_disk_id

string

ID управляемого диска данных.

Возвращается: всегда

Пример: "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/Microsoft.Compute/disks/diskName"

managed_disk_type

string

Тип управляемого диска данных.

Возвращается: всегда

Пример: "Standard_LRS"

display_status

string

Краткая локализуемая метка для состояния.

Возвращается: всегда

Пример: "VM running"

id

string

ID ресурса.

Возвращается: всегда

Пример: "/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

Имя SKU.

Возвращается: при создании из образа Marketplace

Пример: "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"

provisioning_state

string

Состояние подготовки, которое отображается только в ответе.

Возвращается: всегда

Пример: "running"

proximityPlacementGroup

dictionary

Имя или идентификатор группы размещения поблизости, с которой должна быть связана виртуальная машина.

Возвращается: всегда

Пример: {"id": "/subscriptions/xxx/resourceGroups/xxx/providers/Microsoft.Compute/proximityPlacementGroups/testid13"}

resource_group

string

Группа ресурсов.

Возвращается: всегда

Пример: "myResourceGroup"

security_profile

complex

Указывает параметры профиля, связанные с безопасностью, для виртуальной машины.

Возвращается: при использовании

encryption_at_host

boolean

Это свойство может использоваться пользователем в запросе для включения или отключения шифрования на узле для виртуальной машины.

Это включит шифрование для всех дисков, включая диск ресурса/временный диск, на самом узле.

Возвращается: при включении

Пример: true

security_type

string

Указывает тип безопасности виртуальной машины.

Он установлен как TrustedLaunch для включения UefiSettings.

Возвращается: при включении

Пример: "TrustedLaunch"

uefi_settings

complex

Указывает параметры безопасности, такие как безопасный запуск и vTPM, используемые при создании виртуальной машины.

Возвращается: при включении

secure_boot_enabled

boolean

Указывает, следует ли включить безопасный запуск на виртуальной машине.

Возвращается: при включении

Пример: true

v_tpm_enabled

boolean

Указывает, следует ли включить vTPM на виртуальной машине.

Возвращается: при включении

Пример: true

state

string

Состояние ресурса.

Возвращается: всегда

Пример: "present"

tags

dictionary

Теги ресурса.

Возвращается: всегда

Пример: {"key1": "value1"}

vm_agent_version

string

Версия агента Azure VM (waagent), работающего внутри виртуальной машины.

Возвращается: всегда

Пример: "2.9.1.1"

vm_size

string

Размер виртуальной машины.

Возвращается: всегда

Пример: "Standard_D4"

zones

list / elements=string

Список зон доступности для вашей виртуальной машины.

Возвращается: успех

Пример: [1]

Авторы

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

Ссылки на сборку

  • Система отслеживания задач
  • Главная страница
  • Репозиторий (источники)

© 2012–2018 Michael DeHaan
© 2018–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/azure/azcollection/azure_rm_virtualmachine_info_module.html

Spec-Zone.ru

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