azure_rm_virtualmachine_scaleset — Управление наборами виртуальных машин Azure.
Новая версия с 2.4.
Обзор
- Создание и обновление набора виртуальных машин.
Требования
Ниже перечислены требования к хосту, на котором выполняется этот модуль.
- python >= 2.7
- azure >= 2.0.0
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| ad_user | По умолчанию: Нет | Имя пользователя Active Directory. Используйте при аутентификации с пользователем Active Directory, а не с учетной записью службы. | |
| admin_password | Пароль для имени пользователя администратора. Не требуется, если os_type — Linux и аутентификация по паролю SSH отключена, установив ssh_password_enabled в значение false. | ||
| admin_username | Имя пользователя администратора, используемого для доступа к хосту после его создания. Требуется при создании виртуальной машины. | ||
| api_profile (добавлено в 2.5) |
| Выбирает профиль API для использования при взаимодействии с Azure-сервисами. Значение по умолчанию latest подходит для общедоступных облаков; будущие значения позволят использовать с Azure Stack. | |
| append_tags | По умолчанию: да | Управление тем, является ли поле тегов каноническим или оно просто добавляется к существующим тегам. При каноническом поле любые теги, отсутствующие в параметре tags, будут удалены из метаданных объекта. | |
| auth_source (добавлено в 2.5) |
| Управление источником учетных данных для аутентификации. auto будет следовать по умолчанию приоритету параметров модуля -> переменных среды -> профиля по умолчанию в файле учетных данных ~/.azure/credentials. При установке в значение cli, учетные данные будут взяты из профиля Azure CLI по умолчанию.Также можно установить через переменную среды ANSIBLE_AZURE_AUTH_SOURCE. | |
| capacity обязательно | Ёмкость VMSS. | ||
| cert_validation_mode (добавлено в 2.5) |
Нет | Управление поведением проверки сертификатов для 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) |
| Тип кэширования диска данных. | |
| managed_disk_type (добавлено в 2.4) |
| Тип управляемого диска данных. | |
| disk_size_gb (добавлено в 2.4) | Начальный размер диска в ГБ для пустых дисков данных. | ||
| lun (добавлено в 2.4) | По умолчанию: 0 | Логический номер устройства для диска данных. | |
| 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 |
| Тип управляемого диска. | |
| name обязательно | Имя виртуальной машины. | ||
| os_disk_caching |
| Тип кэширования диска ОС. псевдонимы: disk_caching | |
| os_type |
[u'Linux'] | Основной тип операционной системы. | |
| password | По умолчанию: Нет | Пароль пользователя Active Directory. Используйте при аутентификации с пользователем Active Directory, а не с учетной записью службы. | |
| profile | По умолчанию: Нет | Профиль безопасности, найденный в файле ~/.azure/credentials. | |
| remove_on_absent | По умолчанию: [u'all'] | При удалении виртуальной машины с состоянием 'absent', также удаляются связанные ресурсы. Может быть 'all' или список с одним из следующих: ['network_interfaces', 'virtual_storage', 'public_ips']. Любые другие входные данные будут проигнорированы. | |
| resource_group обязательно | Имя группы ресурсов, содержащей набор виртуальных машин. | ||
| secret | По умолчанию: Нет | Секрет клиента Azure. Используйте при аутентификации с помощью службы-принципала. | |
| ssh_password_enabled | По умолчанию: да | При os_type Linux, установка ssh_password_enabled в значение false отключит аутентификацию по паролю SSH и потребует использования ключей SSH. | |
| ssh_public_keys | Для os_type Linux укажите список ключей SSH. Каждый элемент списка должен быть словарем, содержащим два ключа: path и key_data. Установите path в стандартное расположение файла authorized_keys. Например, на Enterprise Linux-хосте path будет /home/<имя пользователя администратора>/.ssh/authorized_keys. Установите key_data в фактическое значение открытого ключа. | ||
| state |
| Утверждение состояния набора виртуальных машин. Состояние 'present' проверит, существует ли машина с запрошенной конфигурацией. Если конфигурация существующей машины не совпадает, машина будет обновлена. Состояние 'absent' удалит набор виртуальных машин. | |
| subnet_name | Имя подсети. псевдонимы: subnet | ||
| subscription_id | По умолчанию: Нет | Ваш идентификатор подписки Azure. | |
| tags | По умолчанию: Нет | Словарь пар «строка:строка» для назначения метаданных объекту. Метаданные теги объекта будут обновлены с любыми предоставленными значениями. Для удаления тегов установите параметр append_tags в значение false. | |
| tenant | По умолчанию: Нет | Идентификатор клиента Azure. Используйте при аутентификации с помощью службы-принципала. | |
| tier |
| Уровень SKU. | |
| upgrade_policy |
| Политика обновления. | |
| virtual_network_name | Имя виртуальной сети. псевдонимы: virtual_network | ||
| 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. Также можно добавить дополнительные профили. Укажите профиль, передав profile или установив 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 сложное | всегда | Данные о текущем состоянии объекта. Обратите внимание, что данные не являются частью зарегистрированного вывода, но доступны напрямую. | |
| sku | | ||
| type | | ||
| properties | | ||
| tags | | ||
Статус
Этот модуль помечен как превью, что означает, что его интерфейс не гарантирует обратную совместимость.
Автор
- 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.5/modules/azure_rm_virtualmachine_scaleset_module.html
