Spec-Zone.ru › Ansible

Модуль azure.azcollection.azure_rm_hdinsightcluster_info – Получение фактов кластера Azure HDInsight

Примечание

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

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

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

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

Новое в azure.azcollection 0.1.2

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

Описание

  • Получение фактов кластера Azure HDInsight.

Требования

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

  • 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 могут использоваться для идентификации идентификатора подписки, если присутствует более одного, в противном случае используется подписка az cli по умолчанию.

При установке в msi, хост-машина должна быть ресурсом Azure с включенным расширением MSI. subscription_id или переменная среды AZURE_SUBSCRIPTION_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

log_mode

string

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

log_path

string

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

name

string

Имя кластера HDInsight.

password

string

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

profile

string

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

resource_group

string

Имя группы ресурсов Azure.

secret

string

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

subscription_id

string

Ваш идентификатор подписки Azure.

Теги

список / элементы=строка

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

Подписчик

строка

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

Отпечаток

строка

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

Отпечаток цифровой подписи приватного ключа, указанного в x509_certificate_path.

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

Необходим, если определен x509_certificate_path.

Путь к сертификату x509

путь

Добавлен в 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 и пароль или установите 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 instance of HDInsight Cluster
  azure_rm_hdinsightcluster_info:
    resource_group: myResourceGroup
    name: myCluster

- name: List instances of HDInsight Cluster
  azure_rm_hdinsightcluster_info:
    resource_group: myResourceGroup
    tags:
      - key:value

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

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

Ключ

Описание

clusters

сложный

Список словарей, содержащих сведения о кластере HDInsight.

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

cluster_definition

сложный

Определение кластера.

Возвращается: успешно

kind

строка

Тип кластера.

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

Пример: "spark"

cluster_version

строка

Версия кластера.

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

Пример: "3.6.1000.67"

compute_profile_roles

сложный

Список ролей в кластере.

Возвращается: успешно

linux_profile

словарь

Профиль операционной системы Linux.

Возвращается: успешно

username

строка

Имя пользователя.

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

Пример: "myuser"

name

строка

Имя роли.

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

Пример: "headnode"

target_instance_count

целое число

Количество экземпляров кластера.

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

Пример: 2

vm_size

строка

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

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

Пример: "Standard_D3"

connectivity_endpoints

сложный

Точки подключения к кластеру.

Возвращается: успешно

location

строка

Расположение точки подключения.

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

Пример: "myCluster-ssh.azurehdinsight.net"

name

строка

Имя точки подключения.

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

Пример: "SSH"

port

целое число

Порт точки подключения.

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

Пример: 22

protocol

строка

Протокол точки подключения.

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

Пример: "TCP"

id

строка

Уникальный идентификатор ресурса кластера HDInsight.

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

Пример: "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.HDInsight/clusters/myCluster"

location

строка

Расположение группы ресурсов, к которой принадлежит ресурс.

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

Пример: "westus"

name

строка

Имя кластера HDInsight.

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

Пример: "testaccount"

os_type

string

Тип операционной системы.

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

Пример: "linux"

resource_group

string

Имя группы Azure ресурсов.

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

Пример: "myResourceGroup"

tags

dictionary

Теги ресурса.

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

Пример: {}

tier

string

Уровень кластера.

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

Пример: "standard"

Авторы

  • Zim Kalinowski (@zikalino)

Ссылки на коллекцию

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

© 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_hdinsightcluster_info_module.html

Spec-Zone.ru

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