Spec-Zone.ru › Ansible

Модуль azure.azcollection.azure_rm_manageddisk — Управление дисками Azure

Примечание

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

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

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

Чтобы использовать его в книге задач, укажите: azure.azcollection.azure_rm_manageddisk.

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

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

Обзор

  • Создание, обновление и удаление управляемого диска Azure.

Требования

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

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

append_tags

boolean

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

В каноническом режиме любые теги, не найденные в параметре тегов, будут удалены из метаданных объекта.

Choices:

  • false
  • true ← (default)

attach_caching

string

Политика кэширования дисков, управляемая виртуальной машиной. Будет использоваться при подключении к виртуальной машине, определенной managed_by.

Если этот параметр отличается от текущей политики кэширования, управляемый диск будет отключен и снова подключен с текущим параметром кэширования.

Choices:

  • ""
  • "read_only"
  • "read_write"

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.

Choices:

  • "auto" ← (default)
  • "cli"
  • "credential_file"
  • "env"
  • "msi"

cert_validation_mode

string

added in azure.azcollection 0.0.1

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

Choices:

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

create_option

string

import из файла VHD в source_uri и copy из предыдущего управляемого диска source_uri.

Choices:

  • "empty"
  • "import"
  • "copy"

disable_instance_discovery

boolean

added in azure.azcollection 2.3.0

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

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

Choices:

  • false ← (default)
  • true

disk_size_gb

integer

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

Если create_option=copy, то значение должно быть больше или равно размеру источника.

location

string

Допустимое расположение Azure. По умолчанию используется расположение группы ресурсов.

log_mode

string

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

log_path

string

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

lun

integer

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

Это значение используется для идентификации дисков данных в ВМ и, следовательно, должно быть уникальным для каждого диска данных, подключенного к ВМ.

managed_by

string

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

Чтобы отсоединить диск от ВМ, явно задайте значение «».

Если этот параметр не задан, его значение не будет изменено.

managed_by_extended

list / elements=dictionary

Список имен и групп ресурсов ВМ, к которым прикреплен диск.

max_shares следует установить на значение больше единицы для дисков, чтобы разрешить их подключение к нескольким ВМ.

name

string

Имя подключенной ВМ.

resource_group

string

Группа ресурсов подключенной ВМ.

max_shares

integer

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

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

name

string / обязательно

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

os_type

string

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

Используется при create_option=copy или create_option=import, если исходный диск - системный.

Если опущено при создании, значение не устанавливается.

Если опущено при обновлении, никаких изменений не происходит.

После установки это значение нельзя очистить.

Варианты:

  • "linux"
  • "windows"

password

string

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

profile

string

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

resource_group

string / обязательно

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

secret

string

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

source_uri

псевдонимы: source_resource_uri

string

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

state

string

Утверждение состояния управляемого диска. Используйте present для создания или обновления управляемого диска и absent для удаления управляемого диска.

Варианты:

  • "absent"
  • "present" ← (по умолчанию)

storage_account_id

string

Полный путь к учетной записи хранения, из которой будет импортирован образ.

Требуется при create_option=import.

storage_account_type

string

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

Если не указано, диск создается как Standard_LRS.

Standard_LRS — для жестких дисков Standard HDD.

StandardSSD_LRS (добавлено в 2.8) — для твердотельных дисков Standard SSD.

StandardSSD_ZRS — для твердотельных дисков Standard SSD с зональной избыточностью.

Premium_LRS — для твердотельных дисков Premium SSD.

Premium_ZRS — для твердотельных дисков Premium SSD с зональной избыточностью.

UltraSSD_LRS (добавлено в 2.8) — для твердотельных дисков Ultra SSD, доступных только на определенных типах экземпляров.

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

Варианты:

  • "Standard_LRS"
  • "StandardSSD_LRS"
  • "StandardSSD_ZRS"
  • "Premium_LRS"
  • "Premium_ZRS"
  • "UltraSSD_LRS"

subscription_id

string

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

tags

dictionary

Словарь пар «строка:строка» для назначения метаданных объекту.

Метаданные теги объекта будут обновлены любыми предоставленными значениями.

Чтобы удалить теги, установите параметр append_tags в значение false.

В настоящее время зоны Azure DNS и службы Traffic Manager также не допускают использование пробелов в теге.

Azure Front Door не поддерживает использование

Azure Automation и Azure CDN поддерживают только 15 тегов на ресурсах.

tenant

string

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

Отпечаток

строка

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

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

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

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

Путь к сертификату x509

путь

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

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

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

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

Зона

строка

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

Допустимые значения 1, 2, 3 и ''.

Варианты:

  • "1"
  • "2"
  • "3"
  • ""

Примечания

Примечание

  • Этот модуль назывался azure.azcollection.azure_rm_managed_disk до 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: Create managed disk
  azure_rm_manageddisk:
    name: mymanageddisk
    location: eastus
    resource_group: myResourceGroup
    disk_size_gb: 4

- name: Create managed operating system disk from page blob
  azure_rm_manageddisk:
    name: mymanageddisk
    location: eastus2
    resource_group: myResourceGroup
    create_option: import
    source_uri: https://storageaccountname.blob.core.windows.net/containername/blob-name.vhd
    storage_account_id: /subscriptions/<uuid>/resourceGroups/myResourceGroup/providers/Microsoft.Storage/storageAccounts/storageaccountname
    os_type: windows
    storage_account_type: Premium_LRS

- name: Mount the managed disk to VM
  azure_rm_manageddisk:
    name: mymanageddisk
    location: eastus
    resource_group: myResourceGroup
    disk_size_gb: 4
    managed_by: testvm001
    attach_caching: read_only

- name: Mount the managed disk to multiple VMs
  azure_rm_manageddisk:
    resource_group: myResourceGroup
    name: freddisk04
    max_shares: 4
    disk_size_gb: 1024
    storage_account_type: Premium_LRS
    managed_by_extended:
      - resource_group: myResourceGroup01
        name: testVM01
      - resource_group: myResourceGroup02
        name: testVM02
    zone: 1

- name: Unmount the managed disk to VM
  azure_rm_manageddisk:
    name: mymanageddisk
    location: eastus
    resource_group: myResourceGroup
    managed_by: ''
    disk_size_gb: 4

- name: Delete managed disk
  azure_rm_manageddisk:
    name: mymanageddisk
    location: eastus
    resource_group: myResourceGroup
    state: absent

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

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

Ключ

Описание

изменён

boolean

Изменился ли ресурс.

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

состояние

сложное

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

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

create_option

строка

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

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

Пример: "copy"

disk_size_gb

строка

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

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

id

строка

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

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

местоположение

строка

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

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

управляемый_кем

строка

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

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

управляемый_кем_расширенно

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

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

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

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

max_shares

целое число

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

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

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

Пример: 3

имя

строка

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

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

тип_ОС

строка

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

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

Пример: "linux"

source_uri

строка

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

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

id_учета_хранилища

строка

Полный путь к учетной записи хранения, из которой должна быть импортирована образ

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

Пример: "/subscriptions/<uuid>/resourceGroups/<resource group name>/providers/Microsoft.Storage/storageAccounts/<storage account name>"

тип_учета_хранилища

строка

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

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

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

Пример: "Standard_LRS"

метки

словарь

Метки для присвоения управляемому диску.

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

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

Авторы

  • Bruno Medina (@brusMX)

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

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

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

Spec-Zone.ru

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