Spec-Zone.ru › Ansible 2.9

azure_rm_virtualmachinescaleset_info – Получение фактов о масштабируемом наборе виртуальных машин

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

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

Синопсис

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

Псевдонимы: azure_rm_virtualmachine_scaleset_facts,azure_rm_virtualmachinescaleset_facts

Требования

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

  • python >= 2.7
  • azure >= 2.0.0

Параметры

Параметр Варианты/Значения по умолчанию Комментарии
ad_user
строка
Имя пользователя Active Directory. Используется при аутентификации с пользователем Active Directory вместо служебного принципала.
adfs_authority_url
строка
добавлено в 2.6
URL-адрес авторизации Azure AD. Используется при аутентификации с именем пользователя/паролем и собственной авторизацией ADFS.
api_profile
строка
добавлено в 2.5
 По умолчанию:
"latest"
Выбирает профиль API для использования при общении с Azure-сервисами. Значение по умолчанию latest подходит для общедоступных облаков; будущие значения позволят использовать с Azure Stack.
auth_source
строка
добавлено в 2.5
    Варианты:
  • auto
  • cli
  • credential_file
  • env
  • msi
Управляет источником учетных данных для аутентификации.
Если не указано, будет использована переменная среды 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.
cert_validation_mode
строка
добавлено в 2.5
    Варианты:
  • ignore
  • validate
Управляет поведением проверки сертификата для 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.
format
-
добавлено в 2.6
    Варианты:
  • curated
  • raw ←
Формат возвращаемых данных.
Если выбрано raw, информация будет возвращена в формате raw из Azure Python SDK.
Если выбрано curated, структура будет идентична входным параметрам модуля 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, или выполнить вход перед запуском задач или playbook с 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
  azure_rm_virtualmachinescaleset_info:
    resource_group: myResourceGroup
    name: testvmss001
    format: curated

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

- name: Get facts by tags
  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


Статус

  • Этот модуль не гарантирует обратную совместимость интерфейса. [бета]
  • Этот модуль поддерживается сообществом Ansible. [community]

Авторы

  • 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.9/modules/azure_rm_virtualmachinescaleset_info_module.html

Spec-Zone.ru

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