Spec-Zone.ru › Ansible

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

Примечание

Этот модуль является частью коллекции azure.azcollection (версия 2.7.0).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.

Для установки используйте: ansible-galaxy collection install azure.azcollection. Для использования этого модуля необходимы дополнительные требования, см. Требования для получения подробностей.

Чтобы использовать его в плейбуке, укажите: azure.azcollection.azure_rm_virtualmachinescaleset_info.

Новая функция в azure.azcollection 0.1.2

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

Описание

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

Требования

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

  • python >= 2.7
  • На хосте, который выполняет модуль, должна быть установлена коллекция azure.azcollection через galaxy
  • Все пакеты Python, перечисленные в файле requirements.txt коллекции, должны быть установлены с помощью pip на хосте, на котором выполняются модули из azure.azcollection
  • Полные инструкции по установке можно найти по адресу https://galaxy.ansible.com/azure/azcollection

Параметры

Параметр

Комментарии

ad_user

string

Имя пользователя Active Directory. Используйте при аутентификации с пользователем Active Directory, а не с субъектом безопасности.

adfs_authority_url

string

added in azure.azcollection 0.0.1

URL-адрес узла Azure AD. Используйте при аутентификации с помощью имени пользователя/пароля и имеете собственный узел ADFS.

api_profile

string

added in azure.azcollection 0.0.1

Выбирает профиль API для использования при взаимодействии с службами Azure. Значение по умолчанию latest подходит для общедоступных облаков; будущие значения позволят использовать с Azure Stack.

Default: "latest"

auth_source

string

added in azure.azcollection 0.0.1

Управляет источником учетных данных, используемых для аутентификации.

Также может быть установлен через переменную среды ANSIBLE_AZURE_AUTH_SOURCE.

При установке в auto (по умолчанию) приоритет имеет параметры модуля -> env -> credential_file -> cli.

При установке в env, учетные данные будут считываться из переменных среды

При установке в credential_file, профиль будет считываться из ~/.azure/credentials.

При установке в cli, учетные данные будут получены из профиля Azure CLI. subscription_id или переменная среды AZURE_SUBSCRIPTION_ID могут использоваться для идентификации ID подписки, если присутствует более одной, в противном случае используется подписка az cli по умолчанию.

При установке в msi, хост-машина должна быть ресурсом Azure с включенным расширением MSI. subscription_id или переменная среды AZURE_SUBSCRIPTION_ID могут использоваться для идентификации ID подписки, если ресурсу предоставлен доступ к более чем одной подписке, в противном случае выбирается первая подписка.

msi был добавлен в Ansible 2.6.

Варианты:

  • "auto" ← (по умолчанию)
  • "cli"
  • "credential_file"
  • "env"
  • "msi"

cert_validation_mode

string

added in azure.azcollection 0.0.1

Управляет поведением проверки сертификата для конечных точек Azure. По умолчанию все модули будут проверять серверный сертификат, но при использовании прокси HTTPS или в Azure Stack может потребоваться отключить это поведение, передав ignore. Также может быть установлен через профиль файла учетных данных или переменную среды AZURE_CERT_VALIDATION.

Варианты:

  • "ignore"
  • "validate"

client_id

string

Идентификатор клиента Azure. Используйте при аутентификации с помощью субъекта безопасности или управляемой идентификации (msi).

Также может быть установлен через переменную среды AZURE_CLIENT_ID.

cloud_environment

string

added in azure.azcollection 0.0.1

Для облачных сред, отличных от общедоступного облака США, имя среды (как определено в Azure Python SDK, например, AzureChinaCloud, AzureUSGovernment), или URL-адрес конечной точки обнаружения метаданных (требуется для Azure Stack). Также может быть установлен через профиль файла учетных данных или переменную среды AZURE_CLOUD_ENVIRONMENT.

Default: "AzureCloud"

disable_instance_discovery

boolean

added in azure.azcollection 2.3.0

Определяет, выполняется ли обнаружение экземпляров при попытке аутентификации. Установка этого значения в true полностью отключит как обнаружение экземпляров, так и проверку полномочий. Эта функция предназначена для использования в сценариях, когда конечная точка метаданных недоступна, например, в частных облаках или Azure Stack. Процесс обнаружения экземпляров включает в себя получение метаданных полномочий из https://login.microsoft.com/ для проверки полномочий. Установив это значение в **True**, проверка полномочий отключается. В результате важно убедиться, что настроенный узел полномочий является действительным и заслуживающим доверия.

Устанавливается через профиль файла учетных данных или переменную среды AZURE_DISABLE_INSTANCE_DISCOVERY.

Варианты:

  • false ← (по умолчанию)
  • true

format

string

Формат возвращаемых данных.

Если выбран raw, информация будет возвращена в необработанном формате из Azure Python SDK.

Если выбран curated, структура будет идентична входным параметрам модуля azure.azcollection.azure_rm_virtualmachinescaleset.

В Ansible 2.5 и более ранних версиях факты всегда возвращаются в необработанном формате.

Обратите внимание, что этот параметр будет устаревшим в версии 2.10, когда отформатированный формат станет единственным поддерживаемым форматом.

Варианты:

  • "curated"
  • "raw" ← (по умолчанию)

log_mode

string

Родительский аргумент.

log_path

string

Родительский аргумент.

name

string

Ограничивает результаты для определенного масштабируемого набора виртуальных машин.

password

string

Пароль пользователя Active Directory. Используйте при аутентификации с пользователем Active Directory, а не с субъектом безопасности.

profile

string

Профиль безопасности, найденный в файле ~/.azure/credentials.

resource_group

string

Группа ресурсов, в которой необходимо найти виртуальную машину масштабирования.

secret

string

Секретный ключ клиента Azure. Используется при аутентификации с помощью принципала службы.

subscription_id

string

Идентификатор вашей подписки Azure.

tags

list / elements=string

Ограничьте результаты, предоставив список тегов. Формат тегов: ‘ключ’ или ‘ключ:значение’.

tenant

string

Идентификатор Azure-тенанта. Используется при аутентификации с помощью принципала службы.

thumbprint

string

добавлено в azure.azcollection 1.14.0

Отпечаток закрытого ключа, указанного в x509_certificate_path.

Используется при аутентификации с помощью принципала службы.

Требуется, если определён x509_certificate_path.

x509_certificate_path

path

добавлено в azure.azcollection 1.14.0

Путь к X509-сертификату, используемому для создания принципала службы в формате PEM.

Сертификат должен быть присоединён к закрытому ключу.

Используется при аутентификации с помощью принципала службы.

Примечания

Примечание

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

Вместимость VMSS.

Возвращается: всегда

Пример: 2

data_disks

complex

Список подключенных дисков данных.

Возвращается: всегда

caching

string

Тип кэширования дисков данных.

Возвращается: всегда

Пример: "ReadOnly"

disk_size_gb

integer

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

Возвращается: всегда

Пример: 64

lun

integer

Номер логического устройства для диска данных.

Возвращается: всегда

Пример: 0

managed_disk_type

string

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

Возвращается: всегда

Пример: "Standard_LRS"

id

string

Идентификатор ресурса.

Возвращается: всегда

Пример: "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.Compute/scalesets/myscaleset"

identity

complex

Идентификатор для сервера.

Возвращается: если доступно

type

string

Тип управляемого идентификатора

Возвращается: всегда

Пример: "UserAssigned"

user_assigned_identities

complex

Управляемые идентификаторы, назначенные пользователем, и их параметры

Возвращается: всегда

id

dictionary

Словарь идентификаторов назначенных пользователем идентификаторов, связанных с ресурсом

Возвращается: всегда

image

complex

Спецификация образа.

Возвращается: всегда

offer

string

Предложение платформенного или образа Marketplace, используемого для создания виртуальной машины.

Возвращается: всегда

Пример: "RHEL"

publisher

string

Имя издателя.

Возвращается: всегда

Пример: "RedHat"

sku

string

Имя SKU.

Возвращается: всегда

Пример: "7-RAW"

version

string

Версия образа.

Возвращается: всегда

Пример: "7.5.2018050901"

load_balancer

string

Имя балансировщика нагрузки.

Returned: always

Sample: "testlb"

location

string

Расположение ресурса.

Returned: always

Sample: "japaneast"

managed_disk_type

string

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

Returned: always

Sample: "Standard_LRS"

name

string

Имя ресурса.

Returned: always

Sample: "myvmss"

orchestrationMode

string

Режим оркестровки для масштабируемого набора виртуальных машин.

Returned: always

Sample: "Flexible"

os_disk_caching

string

Тип кэширования диска ОС.

Returned: always

Sample: "ReadOnly"

os_type

string

Базовый тип операционной системы.

Returned: always

Sample: "Linux"

overprovision

boolean

Указывает, следует ли перераспределять масштабируемый набор виртуальных машин.

Returned: success

Sample: true

platformFaultDomainCount

integer

Количество доменов сбоев для каждой группы размещения.

Returned: always

Sample: 1

resource_group

string

Группа ресурсов.

Returned: always

Sample: "myResourceGroup"

ssh_password_enabled

boolean

Включена ли аутентификация по паролю SSH. Действительно только для Linux.

Returned: always

Sample: true

subnet_name

string

Имя подсети.

Returned: always

Sample: "testsubnet"

tags

dictionary

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

Returned: always

Sample: {"tag1": "abc"}

tier

string

Уровень SKU.

Returned: always

Sample: "Basic"

upgrade_policy

string

Политика обновления.

Returned: always

Sample: "Manual"

virtual_network_name

string

Имя связанной виртуальной сети.

Returned: always

Sample: "testvn"

vm_size

string

Размер виртуальной машины.

Returned: always

Sample: "Standard_D4"

Авторы

  • Sertac Ozercan (@sozercan)

Справочные ссылки

  • Отслеживание проблем
  • Главная страница
  • Репозиторий (источники)

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

Spec-Zone.ru

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