azure_rm_virtualmachine_scaleset – Управление наборами виртуальных машин Azure.

Новая версия с 2.4.

Обзор
Требования
Параметры
Примечания
Примеры
Возвращаемые значения
Статус

Обзор

Создание и обновление набора виртуальных машин.

Требования

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

python >= 2.7
azure >= 2.0.0

Параметры

Параметр		Варианты/Значения по умолчанию	Комментарии
ad_user -			Имя пользователя Active Directory. Используется при аутентификации с пользователем Active Directory, а не с сервисным принципалом.
adfs_authority_url - добавлено в 2.6		По умолчанию: null	URL авторитета Azure AD. Используется при аутентификации с именем пользователя/паролем и собственным авторитетом ADFS.
admin_password -			Пароль для имени пользователя администратора. Не требуется, если os_type Linux и аутентификация по паролю SSH отключена путем установки ssh_password_enabled в false.
admin_username -			Имя пользователя администратора, используемое для доступа к хосту после его создания. Требуется при создании виртуальной машины.
api_profile - добавлено в 2.5		По умолчанию: "latest"	Выбирает профиль API для использования при общении с Azure-службами. Значение по умолчанию `latest` подходит для общедоступных облаков; будущие значения позволят использовать с Azure Stack.
append_tags boolean		Варианты: no yes ←	Используется для управления тем, является ли поле тегов стандартным или просто добавляется к существующим тегам. При использовании в качестве стандартного, любые теги, отсутствующие в параметре tags, будут удалены из метаданных объекта.
auth_source - добавлено в 2.5		Варианты: auto cli credential_file env msi	Управляет источником учетных данных для аутентификации. Если не указано, будет использована переменная среды ANSIBLE_AZURE_AUTH_SOURCE и по умолчанию `auto` если переменная не определена. `auto` будет следовать стандартному приоритету параметров модуля -> переменных среды -> профиля по умолчанию в файле учетных данных `~/.azure/credentials`. При установке в `cli`, учетные данные будут взяты из профиля Azure CLI по умолчанию. Также может быть задан через переменную среды `ANSIBLE_AZURE_AUTH_SOURCE`. При установке в `msi`, хост-машина должна быть Azure-ресурсом с включенным расширением MSI. `subscription_id` или переменная среды `AZURE_SUBSCRIPTION_ID` могут использоваться для определения идентификатора подписки, если ресурсу предоставлен доступ к нескольким подпискам, в противном случае выбирается первая подписка. `msi` было добавлено в Ansible 2.6.
capacity - / обязательно		По умолчанию: 1	Емкость VMSS.
cert_validation_mode - добавлено в 2.5		Варианты: validate ignore	Управляет поведением проверки сертификатов для Azure-точниц. По умолчанию все модули проверяют серверный сертификат, но при использовании прокси HTTPS или подключении к Azure Stack, может потребоваться отключить это поведение, передав `ignore`. Также можно задать через профиль файла учетных данных или переменную среды `AZURE_CERT_VALIDATION`.
client_id -			Идентификатор клиента Azure. Используется при аутентификации с сервисным принципалом.
cloud_environment - добавлено в 2.4		По умолчанию: "AzureCloud"	Для облачных сред, отличных от общедоступного облака США, имя среды (как определено в Azure Python SDK, например, `AzureChinaCloud`, `AzureUSGovernment`), или URL конечной точки обнаружения метаданных (требуется для Azure Stack). Также может быть задано через профиль файла учетных данных или переменную среды `AZURE_CLOUD_ENVIRONMENT`.
data_disks - добавлено в 2.4			Описывает список дисков данных.
	caching - добавлено в 2.4	Варианты: ReadOnly ← ReadWrite	Тип кеширования диска данных.
	disk_size_gb - добавлено в 2.4		Начальный размер диска в ГБ для пустых дисков данных.
	lun - добавлено в 2.4	По умолчанию: 0	Логический номер устройства для диска данных.
	managed_disk_type - добавлено в 2.4	Варианты: Standard_LRS Premium_LRS	Тип управляемого диска данных.
enable_accelerated_networking boolean добавлено в 2.7		Варианты: no yes	Указывает, хочет ли пользователь разрешить ускоренную сеть для виртуальных машин в масштабируемом наборе, который создается.
image - / обязательно			Указывает образ, используемый для создания виртуальной машины. Если строка, образ получен из пользовательского образа по имени. Если словарь с ключами `publisher`, `offer`, `sku`, и `version`, образ получен из образа Marketplace. ПРИМЕЧАНИЕ: установите image.version в `latest` для получения последней версии данного образа. Если словарь с ключами `name` и `resource_group`, образ получен из пользовательского образа на основе `name` и `resource_group`. ПРИМЕЧАНИЕ: ключ `resource_group` необязателен, и если его нет, все образы в подписке будут искаться по `name`. Поддержка пользовательских образов была добавлена в Ansible 2.5
load_balancer - добавлено в 2.5			Имя балансировщика нагрузки.
location -			Допустимое расположение Azure. По умолчанию используется расположение группы ресурсов.
managed_disk_type -		Варианты: Standard_LRS Premium_LRS	Тип управляемого диска.
name - / обязательно			Имя виртуальной машины.
os_disk_caching -		Варианты: ReadOnly ← ReadWrite	Тип кеширования диска ОС. псевдонимы: disk_caching
os_type -		Варианты: Windows Linux ←	Базовый тип операционной системы.
password -			Пароль пользователя Active Directory. Используется при аутентификации с пользователем Active Directory, а не с сервисным принципалом.
profile -			Профиль безопасности, найденный в файле ~/.azure/credentials.
remove_on_absent -		По умолчанию: ["all"]	При удалении виртуальной машины с помощью состояния 'absent', также удаляются связанные ресурсы. Может быть 'all' или список с любым из следующих: ['network_interfaces', 'virtual_storage', 'public_ips']. Любой другой ввод будет проигнорирован.
resource_group - / обязательно			Имя группы ресурсов, содержащей масштабируемый набор виртуальных машин.

secret -		Секретный ключ Azure. Используется при аутентификации с помощью Служебного принципа.
security_group - добавлен в 2.7		Существующая группа безопасности, с которой следует связать подсеть. Может быть именем группы безопасности в той же группе ресурсов. Может быть идентификатором ресурса. Может быть словарем, содержащим `name` и `resource_group` группы безопасности. псевдонимы: security_group_name
short_hostname -		Короткое имя хоста
ssh_password_enabled boolean	Выборы: нет да ←	Когда os_type Linux, установка ssh_password_enabled в false отключит аутентификацию по паролю SSH и потребует использования ключей SSH.
ssh_public_keys -		Для os_type Linux укажите список ключей SSH. Каждый элемент в списке должен быть словарем, в котором словарь содержит два ключа: путь и key_data. Установите путь к стандартному расположению файлов authorized_keys. Например, на хосте Enterprise Linux путь будет /home/<имя_пользователя_админа>/.ssh/authorized_keys. Установите key_data в фактическое значение открытого ключа.
state -	Выборы: absent present ←	Утверждение состояния масштабируемого набора виртуальных машин. Состояние 'present' проверит, существует ли машина с запрошенной конфигурацией. Если конфигурация существующей машины не соответствует, машина будет обновлена. Состояние 'absent' удалит масштабируемый набор виртуальных машин.
subnet_name -		Имя подсети. псевдонимы: subnet
subscription_id -		Ваш идентификатор подписки Azure.
tags -		Словарь пар «строка:строка» для назначения метаданных объекту. Метаданные теги объекта будут обновлены любыми предоставленными значениями. Для удаления тегов установите опцию append_tags в false.
tenant -		Идентификатор арендатора Azure. Используется при аутентификации с помощью Служебного принципа.
tier -	Выборы: Basic Standard	Уровень SKU.
upgrade_policy -	Выборы: Ручное Автоматическое	Политика обновления.
virtual_network_name -		Имя виртуальной сети. псевдонимы: virtual_network
virtual_network_resource_group - добавлен в 2.5		При создании виртуальной машины, если должна использоваться определенная виртуальная сеть из другой группы ресурсов, используйте этот параметр для указания группы ресурсов для использования.
vm_size - / обязательно		Допустимое значение размера виртуальной машины Azure. Например, 'Standard_D4'. Список вариантов зависит от подписки и расположения. Проверьте вашу подписку для доступных вариантов.

Примечания

Примечание

Для аутентификации с Azure вы можете передать параметры, установить переменные окружения или использовать профиль, сохраненный в ~/.azure/credentials. Аутентификация возможна с помощью служебного принципа или пользователя 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 в окружении.

Примеры

- name: Create VMSS
  azure_rm_virtualmachine_scaleset:
    resource_group: Testing
    name: testvmss
    vm_size: Standard_DS1_v2
    capacity: 2
    virtual_network_name: testvnet
    subnet_name: testsubnet
    admin_username: adminUser
    ssh_password_enabled: false
    ssh_public_keys:
      - path: /home/adminUser/.ssh/authorized_keys
        key_data: < insert yor ssh public key here... >
    managed_disk_type: Standard_LRS
    image:
      offer: CoreOS
      publisher: CoreOS
      sku: Stable
      version: latest
    data_disks:
      - lun: 0
        disk_size_gb: 64
        caching: ReadWrite
        managed_disk_type: Standard_LRS

- name: Create a VMSS with a custom image
  azure_rm_virtualmachine_scaleset:
    resource_group: Testing
    name: testvmss
    vm_size: Standard_DS1_v2
    capacity: 2
    virtual_network_name: testvnet
    subnet_name: testsubnet
    admin_username: adminUser
    admin_password: password01
    managed_disk_type: Standard_LRS
    image: customimage001

- name: Create a VMSS with a custom image from a particular resource group
  azure_rm_virtualmachine_scaleset:
    resource_group: Testing
    name: testvmss
    vm_size: Standard_DS1_v2
    capacity: 2
    virtual_network_name: testvnet
    subnet_name: testsubnet
    admin_username: adminUser
    admin_password: password01
    managed_disk_type: Standard_LRS
    image:
      name: customimage001
      resource_group: Testing

Возвращаемые значения

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

Ключ		Возвращено	Описание
azure_vmss complex		всегда	Факты о текущем состоянии объекта. Обратите внимание, что факты не являются частью зарегистрированного вывода, но доступны напрямую.
	properties -
	sku -
	tags -
	type -

Статус

Этот модуль не гарантирует обратной совместимости интерфейса. [превью]
Этот модуль поддерживается сообществом Ansible. [community]

Авторы

Sertac Ozercan (@sozercan)

Подсказка

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

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.7/modules/azure_rm_virtualmachine_scaleset_module.html