Spec-Zone.ru › Ansible 2.10

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
complex
всегда
Список наборов виртуальных машин.
admin_username
string
всегда
Имя пользователя администратора, используемое для доступа к хосту после его создания.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Пример:
Standard_D4


Авторы

  • 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.10/collections/community/azure/azure_rm_virtualmachinescaleset_info_module.html

Spec-Zone.ru

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