Spec-Zone.ru › Ansible 2.11

community.azure.azure_rm_virtualmachinescaleset_info – Получение фактов о группе виртуальных машин

Примечание

Этот плагин входит в коллекцию community.azure (версия 1.0.0).

Для его установки используйте: ansible-galaxy collection install community.azure.

Для использования в книге задач укажите: community.azure.azure_rm_virtualmachinescaleset_info.

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

Описание

  • Получение фактов о группе виртуальных машин.
  • Обратите внимание, что этот модуль раньше назывался community.azure.azure_rm_virtualmachine_scaleset_facts до Ansible 2.8. Использование не изменилось.

Требования

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

  • python >= 2.7
  • azure >= 2.0.0

Параметры

Параметр Варианты/Значения по умолчанию Комментарии
ad_user
строка
Имя пользователя Active Directory. Используйте при аутентификации с пользователем Active Directory, а не с принципалом службы.
adfs_authority_url
строка
добавлен в 0.0.1 azure.azcollection
URL-адрес службы авторизации Azure AD. Используйте при аутентификации с именем пользователя/паролем и собственной службой авторизации ADFS.
api_profile
строка
добавлен в 0.0.1 azure.azcollection
По умолчанию:
"latest"
Выбор профиля API для взаимодействия с Azure-службами. Значение по умолчанию latest подходит для общедоступных облаков; будущие значения позволят использовать Azure Stack.
auth_source
строка
добавлен в 0.0.1 azure.azcollection
    Варианты:
  • auto ←
  • cli
  • credential_file
  • env
  • msi
Управление источником учетных данных для аутентификации.
Также может быть задан через переменную среды 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.
cert_validation_mode
строка
добавлен в 0.0.1 azure.azcollection
    Варианты:
  • ignore
  • validate
Управление поведением проверки сертификатов для Azure-точек входа. По умолчанию все модули проверяют сертификат сервера, но при использовании HTTPS-прокси или работе с Azure Stack может потребоваться отключить это поведение, передав ignore. Также может быть задан через профиль файла учетных данных или переменную среды AZURE_CERT_VALIDATION.
client_id
строка
Идентификатор клиента Azure. Используйте при аутентификации с принципалом службы.
cloud_environment
строка
добавлен в 0.0.1 azure.azcollection
По умолчанию:
"AzureCloud"
Для облачных сред, отличных от общедоступного облака США, используется имя среды (как определено в Azure Python SDK, например, AzureChinaCloud, AzureUSGovernment) или URL-адрес точки входа обнаружения метаданных (требуется для Azure Stack). Также может быть задан через профиль файла учетных данных или переменную среды AZURE_CLOUD_ENVIRONMENT.
format
строка
    Варианты:
  • curated
  • raw ←
Формат возвращаемых данных.
Если выбран raw, информация будет возвращена в формате raw из Azure Python SDK.
Если выбран curated, структура будет идентична параметрам входных данных модуля community.azure.azure_rm_virtualmachinescaleset.
В Ansible 2.5 и ниже факты всегда возвращаются в формате raw.
Обратите внимание, что этот параметр будет устаревшим в 2.10, когда curated формат станет единственным поддерживаемым форматом.
name
строка
Ограничение результатов конкретной группой виртуальных машин.
password
строка
Пароль пользователя Active Directory. Используйте при аутентификации с пользователем Active Directory, а не с принципалом службы.
profile
строка
Профиль безопасности, найденный в файле ~/.azure/credentials.
resource_group
строка
Группа ресурсов для поиска необходимой группы виртуальных машин.
secret
строка
Секрет клиента Azure. Используйте при аутентификации с принципалом службы.
subscription_id
строка
Идентификатор вашей Azure-подписки.
tags
строка
Список меток для сопоставления.
tenant
строка
Идентификатор Azure-аренды. Используйте при аутентификации с принципалом службы.

Примечания

Примечание

  • Для аутентификации в 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: Get facts for a virtual machine scale set
  community.azure.azure_rm_virtualmachinescaleset_info:
    resource_group: myResourceGroup
    name: testvmss001
    format: curated

- name: Get facts for all virtual networks
  community.azure.azure_rm_virtualmachinescaleset_info:
    resource_group: myResourceGroup

- name: Get facts by tags
  community.azure.azure_rm_virtualmachinescaleset_info:
    resource_group: myResourceGroup
    tags:
      - testing

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

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

Ключ Возвращаемое значение Описание
vmss
сложный тип
всегда
Список наборов виртуальных машин.
admin_username
строка
всегда
Имя пользователя администратора для доступа к хосту после его создания.

Пример:
adminuser
capacity
целое число
всегда
Ёмкость набора виртуальных машин.

Пример:
2
data_disks
сложный тип
всегда
Список подключенных дисков данных.
caching
строка
всегда
Тип кэширования диска данных.

Пример:
ReadOnly
disk_size_gb
целое число
всегда
Начальный размер диска в ГБ для пустых дисков данных.

Пример:
64
lun
целое число
всегда
Логический номер устройства для диска данных.
managed_disk_type
строка
всегда
Тип управляемого диска данных.

Пример:
Standard_LRS
id
строка
всегда
Идентификатор ресурса.

Пример:
/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.Compute/scalesets/myscaleset
image
сложный тип
всегда
Спецификация образа.
offer
строка
всегда
Предложение образа платформы или образа из маркетплейса, используемого для создания виртуальной машины.

Пример:
RHEL
publisher
строка
всегда
Имя издателя.

Пример:
RedHat
sku
строка
всегда
Имя SKU.

Пример:
7-RAW
version
строка
всегда
Версия образа.

Пример:
7.5.2018050901
load_balancer
строка
всегда
Имя балансировщика нагрузки.

Пример:
testlb
location
строка
всегда
Расположение ресурса.

Пример:
japaneast
managed_disk_type
строка
всегда
Тип управляемого диска данных.

Пример:
Standard_LRS
name
строка
всегда
Имя ресурса.

Пример:
myvmss
os_disk_caching
строка
всегда
Тип кэширования диска ОС.

Пример:
ReadOnly
os_type
строка
всегда
Основной тип операционной системы.

Пример:
Linux
overprovision
логическое значение
успех
Указывает, следует ли переоснастить набор виртуальных машин.

Пример:
True
resource_group
строка
всегда
Группа ресурсов.

Пример:
myResourceGroup
ssh_password_enabled
логическое значение
всегда
Включена ли аутентификация по паролю SSH. Действительно только для Linux.

Пример:
True
subnet_name
строка
всегда
Имя подсети.

Пример:
testsubnet
tags
словарь
всегда
Теги, назначенные ресурсу. Словарь пар строка:строка.

Пример:
{'tag1': 'abc'}
tier
строка
всегда
Уровень SKU.

Пример:
Basic
upgrade_policy
строка
всегда
Политика обновления.

Пример:
Manual
virtual_network_name
строка
всегда
Имя связанной виртуальной сети.

Пример:
testvn
vm_size
строка
всегда
Размер виртуальной машины.

Пример:
Standard_D4


Авторы

  • Sertac Ozercan (@sozercan)

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/community/azure/azure_rm_virtualmachinescaleset_info_module.html

Spec-Zone.ru

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