Spec-Zone.ru › Ansible 2.4

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

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

  • Обзор
  • Требования (к хосту, на котором выполняется модуль)
  • Параметры
  • Примеры
  • Возвращаемые значения
  • Примечания
    • Статус

Обзор

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

Требования (к хосту, на котором выполняется модуль)

  • python >= 2.7
  • azure >= 2.0.0

Параметры

параметр обязательно по умолчанию возможные значения комментарии
ad_user
нет
Имя пользователя Active Directory. Используется при аутентификации с пользователем Active Directory, а не с принципалом службы.
admin_password
нет
Пароль для имени пользователя администратора. Не требуется, если тип операционной системы — Linux, и аутентификация по паролю SSH отключена, установив ssh_password_enabled в false.
admin_username
нет
Имя пользователя администратора, используемое для доступа к хосту после его создания. Требуется при создании ВМ.
append_tags
нет True
Контролирует, является ли поле тегов каноническим или оно просто добавляется к существующим тегам. При каноническом значении теги, отсутствующие в параметре tags, будут удалены из метаданных объекта.
capacity
да
Ёмкость набора виртуальных машин
client_id
нет
Идентификатор клиента Azure. Используется при аутентификации с принципалом службы.
cloud_environment
нет AzureCloud
Для облачных сред, отличных от общедоступного облака США, имя среды (как определено в Azure Python SDK, например, AzureChinaCloud, AzureUSGovernment) или URL-адрес конечной точки обнаружения метаданных (требуется для Azure Stack). Также может быть задан через профиль файла учетных данных или переменную среды AZURE_CLOUD_ENVIRONMENT.
data_disks
(добавлен в 2.4)
нет
Описание списка дисков данных.
Объект словаря data_disks
параметр обязательно по умолчанию возможные значения комментарии
caching
(добавлен в 2.4)
нет ReadOnly
  • ReadOnly
  • ReadWrite
Тип кэширования диска данных.
managed_disk_type
(добавлен в 2.4)
нет
  • Standard_LRS
  • Premium_LRS
Тип управляемого диска данных
disk_size_gb
(добавлен в 2.4)
нет
Начальный размер диска в ГБ для пустых дисков данных
lun
(добавлен в 2.4)
нет
Логический номер устройства для диска данных
image
да
Словарь, описывающий образ Marketplace, используемый для создания ВМ. Будет содержать ключи: publisher, offer, sku и version. ПРИМЕЧАНИЕ: установите image.version в 'latest', чтобы получить последнюю версию данного образа.
location
нет
Действительное расположение Azure. По умолчанию — расположение группы ресурсов.
managed_disk_type
нет
  • Standard_LRS
  • Premium_LRS
Тип управляемого диска
name
да
Имя виртуальной машины.
os_disk_caching
нет ReadOnly
  • ReadOnly
  • ReadWrite
Тип кэширования диска ОС.
псевдонимы: disk_caching
os_type
нет [u'Linux']
  • Windows
  • 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
нет True
При os_type Linux, установка ssh_password_enabled в false отключит аутентификацию по паролю SSH и потребует использования SSH-ключей.
ssh_public_keys
нет
Для os_type Linux укажите список SSH-ключей. Каждый элемент списка должен быть словарем, содержащим два ключа: path и key_data. Установите путь к стандартному расположению файлов authorized_keys. Например, на Enterprise Linux хосте путь будет /home/<имя пользователя администратора>/.ssh/authorized_keys. Установите key_data в фактическое значение открытого ключа.
state
нет present
  • absent
  • present
Утвердить состояние набора виртуальных машин.
Состояние 'present' проверит, существует ли машина с запрошенной конфигурацией. Если конфигурация существующей машины не соответствует, машина будет обновлена.
Состояние 'absent' удалит набор виртуальных машин.
subnet_name
нет
Имя подсети
псевдонимы: subnet
subscription_id
нет
Ваш идентификатор подписки Azure.
tags
нет
Словарь пар «строка:строка», присваиваемый в качестве метаданных объекту. Метаданные теги объекта будут обновлены любыми предоставленными значениями. Чтобы удалить теги, установите параметр append_tags в false.
tenant
нет
Идентификатор клиента Azure. Используется при аутентификации с принципалом службы.
tier
нет
  • Basic
  • Standard
Уровень SKU
upgrade_policy
нет
  • Manual
  • Automatic
Политика обновления
virtual_network_name
нет
Имя виртуальной сети
псевдонимы: virtual_network
vm_size
да
Действительное значение размера ВМ Azure. Например, 'Standard_D4'. Список возможных значений зависит от подписки и расположения. Проверьте свою подписку на предмет доступных вариантов.

Примеры

- 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

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

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

название описание возвращается тип пример
azure_vmss
Факты о текущем состоянии объекта. Обратите внимание, что факты не являются частью зарегистрированного вывода, но доступны непосредственно.
всегда сложный
содержит:
название описание возвращается тип пример
sku
тип
свойства
теги

Примечания

Примечание

  • Для аутентификации с 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 в среде.

Статус

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

Для помощи в разработке модулей, если у вас есть такое желание, пожалуйста, прочтите Информация о сообществе и участие в разработке, Тестирование Ansible и Разработка модулей.

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

Spec-Zone.ru

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