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 bool |
| Используется для управления тем, является ли поле тегов каноническим или просто добавляется к существующим тегам. При каноничности все теги, отсутствующие в параметре tags, будут удалены из метаданных объекта. | |
| auth_source (добавлен в 2.5) |
| Управляет источником учетных данных для аутентификации. Если не указано, будет использоваться переменная среды 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) |
| Управляет поведением проверки сертификатов для 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) | Описание списка дисков данных. | ||
| lun (добавлен в 2.4) | По умолчанию: 0 | Логический номер устройства для диска данных. | |
| disk_size_gb (добавлен в 2.4) | Начальный размер диска в ГБ для пустых дисков данных. | ||
| managed_disk_type (добавлен в 2.4) |
| Тип управляемого диска данных. | |
| caching (добавлен в 2.4) |
| Тип кэширования диска данных. | |
| 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 |
| Базовый тип операционной системы. | |
| password | Пароль пользователя Active Directory. Используйте при аутентификации с пользователем Active Directory вместо принципа службы. | ||
| profile | Профиль безопасности, найденный в файле ~/.azure/credentials. | ||
| remove_on_absent | По умолчанию: ["all"] | При удалении виртуальной машины с помощью состояния 'absent', также удалить связанные ресурсы. Может быть 'all' или список с любым из следующих: ['network_interfaces', 'virtual_storage', 'public_ips']. Любой другой ввод будет проигнорирован. | |
| resource_group обязательно | Имя группы ресурсов, содержащей набор виртуальных машин. | ||
| secret | Секрет Azure-клиента. Используйте при аутентификации с принципалом службы. | ||
| short_hostname (добавлен в 2.6) | Короткое имя хоста | ||
| ssh_password_enabled bool |
| При 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 |
| Утвердить состояние набора виртуальных машин. Состояние 'present' проверит, существует ли машина с запрошенной конфигурацией. Если конфигурация существующей машины не совпадает, машина будет обновлена. состояние. Состояние 'absent' удалит набор виртуальных машин. | |
| subnet_name | Имя подсети. псевдонимы: subnet | ||
| subscription_id | Ваш идентификатор подписки Azure. | ||
| tags | Словарь пар строка:строка для присвоения метаданных объекту. Метаданные теги объекта будут обновлены любыми предоставленными значениями. Для удаления тегов установите опцию append_tags в false. | ||
| tenant | Идентификатор Azure-аренды. Используйте при аутентификации с принципалом службы. | ||
| tier |
| Уровень 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. Также можно добавить дополнительные профили. Укажите профиль, передав параметр 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 сложное | всегда | Факты о текущем состоянии объекта. Обратите внимание, что факты не являются частью зарегистрированного вывода, но доступны непосредственно. | |
| properties | | ||
| sku | | ||
| tags | | ||
| type | | ||
Статус
Этот модуль помечен как превью, что означает, что его интерфейс не гарантируется обратной совместимостью.
Техническое обслуживание
Этот модуль помечен как сообщество, что означает, что его поддерживает сообщество Ansible. Подробнее см. Техническое обслуживание модулей и поддержка.
Список других модулей, также поддерживаемых сообществом Ansible, см. здесь.
Автор
- 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.6/modules/azure_rm_virtualmachine_scaleset_module.html
