Spec-Zone.ru › Ansible

Модуль azure.azcollection.azure_rm_manageddisk_info – Получение фактов о управляемых дисках

Примечание

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

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

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

Чтобы использовать его в книге задач, укажите: azure.azcollection.azure_rm_manageddisk_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

строка

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

adfs_authority_url

строка

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

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

api_profile

строка

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

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

По умолчанию: "latest"

auth_source

строка

добавлен в 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"
... ...

subscription_id

string

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

tags

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

Ограничить результаты, указав список тегов.

Формат тегов: 'ключ' или 'ключ:значение'.

tenant

строка

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

thumbprint

строка

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

Отпечаток цифровой подписи закрытого ключа, указанного в x509_certificate_path.

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

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

x509_certificate_path

путь

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

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

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

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

Примечания

Примечание

  • Этот модуль назывался azure.azcollection.azure_rm_managed_disk_facts до Ansible 2.8. Использование не изменилось.
  • Для аутентификации с 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 one managed disk
  azure_rm_manageddisk_info:
    name: Testing
    resource_group: myResourceGroup

- name: Get facts for all managed disks
  azure_rm_manageddisk_info:

- name: Get facts for all managed disks managed by a specific vm
  azure_rm_manageddisk_info:
    managed_by: '/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/rgName/Microsoft.Compute/virtualMachines/vmName'

- name: Get facts by tags
  azure_rm_manageddisk_info:
    tags:
      - testing

Значения возврата

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

Ключ

Описание

azure_managed_disk

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

Список словарей управляемого диска.

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

create_option

строка

Параметр создания диска.

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

Пример: "copy"

disk_size_gb

строка

Размер создаваемого управляемого диска в ГБ.

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

id

строка

Идентификатор ресурса.

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

location

строка

Действительное расположение Azure.

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

managed_by

строка

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

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

Пример: "/subscriptions/xxx-xxx/resourceGroups/myRG/providers/Microsoft.Compute/virtualMachines/testVM"

managed_by_extended

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

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

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

Пример: ["/subscriptions/xxx-xxx/resourceGroups/myRG/providers/Microsoft.Compute/virtualMachines/testVM"]

max_shares

целое число

Максимальное количество ВМ, которые могут быть подключены к диску одновременно.

Значение больше единицы указывает на диск, который может быть смонтирован на нескольких ВМ одновременно.

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

Пример: 3

name

строка

Имя управляемого диска.

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

os_type

строка

Тип операционной системы.

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

Может возвращать только:

  • "linux"
  • "windows"

source_uri

строка

URI файла VHD или идентификатор ресурса управляемого диска для копирования.

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

storage_account_type

строка

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

См. https://docs.microsoft.com/ru-ru/azure/virtual-machines/windows/disks-types для получения дополнительной информации об этом типе.

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

Пример: "Standard_LRS"

tags

словарь

Теги, которые нужно назначить управляемому диску.

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

Пример: {"tag": "value"}

time_created

строка

Время создания диска.

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

Пример: "2018-01-01T11:08:15.338648900:00"

Авторы

  • Bruno Medina (@brusMX)
  • Paul Aiton (@paultaiton)

Ссылки на коллекцию

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

© 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_manageddisk_info_module.html

Spec-Zone.ru

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