community.azure.azure_rm_hdinsightcluster_info module – Get Azure HDInsight Cluster facts

Note

This module is part of the community.azure collection (version 1.1.0).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install community.azure. You need further requirements to be able to use this module, see Requirements for details.

To use it in a playbook, specify: community.azure.azure_rm_hdinsightcluster_info.

DEPRECATED

Removed in:

version 2.0.0

Why:

The Ansible collection community.azure is deprecated. Use azure.azcollection instead.

Alternative:

Use azure.azcollection.azure_rm_hdinsightcluster_info instead.

Synopsis

  • Get facts of Azure HDInsight Cluster.

Requirements

The below requirements are needed on the host that executes this module.

  • python >= 2.7

  • The host that executes this module must have the azure.azcollection collection installed via galaxy

  • All python packages listed in collection’s requirements-azure.txt must be installed via pip on the host that executes modules from azure.azcollection

  • Full installation instructions may be found https://galaxy.ansible.com/azure/azcollection

Parameters

Parameter

Comments

ad_user

string

Active Directory username. Use when authenticating with an Active Directory user rather than service principal.

adfs_authority_url

string

added in azure.azcollection 0.0.1

Azure AD authority url. Use when authenticating with Username/password, and has your own ADFS authority.

api_profile

string

added in azure.azcollection 0.0.1

Selects an API profile to use when communicating with Azure services. Default value of latest is appropriate for public clouds; future values will allow use with Azure Stack.

Default: "latest"

auth_source

string

added in azure.azcollection 0.0.1

Controls the source of the credentials to use for authentication.

Can also be set via the ANSIBLE_AZURE_AUTH_SOURCE environment variable.

When set to auto (the default) the precedence is module parameters -> env -> credential_file -> cli.

When set to env, the credentials will be read from the environment variables

When set to credential_file, it will read the profile from ~/.azure/credentials.

When set to cli, the credentials will be sources from the Azure CLI profile. subscription_id or the environment variable AZURE_SUBSCRIPTION_ID can be used to identify the subscription ID if more than one is present otherwise the default az cli subscription is used.

When set to msi, the host machine must be an azure resource with an enabled MSI extension. subscription_id or the environment variable AZURE_SUBSCRIPTION_ID can be used to identify the subscription ID if the resource is granted access to more than one subscription, otherwise the first subscription is chosen.

The msi was added in Ansible 2.6.

Choices:

  • "auto" ← (default)

  • "cli"

  • "credential_file"

  • "env"

  • "msi"

cert_validation_mode

string

added in azure.azcollection 0.0.1

Controls the certificate validation behavior for Azure endpoints. By default, all modules will validate the server certificate, but when an HTTPS proxy is in use, or against Azure Stack, it may be necessary to disable this behavior by passing ignore. Can also be set via credential file profile or the AZURE_CERT_VALIDATION environment variable.

Choices:

  • "ignore"

  • "validate"

client_id

string

Azure client ID. Use when authenticating with a Service Principal.

cloud_environment

string

added in azure.azcollection 0.0.1

For cloud environments other than the US public cloud, the environment name (as defined by Azure Python SDK, eg, AzureChinaCloud, AzureUSGovernment), or a metadata discovery endpoint URL (required for Azure Stack). Can also be set via credential file profile or the AZURE_CLOUD_ENVIRONMENT environment variable.

Default: "AzureCloud"

log_mode

string

Parent argument.

log_path

string

Parent argument.

name

string

HDInsight cluster name.

password

string

Active Directory user password. Use when authenticating with an Active Directory user rather than service principal.

profile

string

Security profile found in ~/.azure/credentials file.

resource_group

string

Name of an Azure resource group.

secret

string

Azure client secret. Use when authenticating with a Service Principal.

subscription_id

string

Your Azure subscription Id.

tags

string

Limit results by providing a list of tags. Format tags as ‘key’ or ‘key:value’.

tenant

string

Azure tenant ID. Use when authenticating with a Service Principal.

thumbprint

string

added in azure.azcollection 1.14.0

The thumbprint of the private key specified in x509_certificate_path.

Use when authenticating with a Service Principal.

Required if x509_certificate_path is defined.

x509_certificate_path

path

added in azure.azcollection 1.14.0

Path to the X509 certificate used to create the service principal in PEM format.

The certificate must be appended to the private key.

Use when authenticating with a Service Principal.

Notes

Note

  • For authentication with Azure you can pass parameters, set environment variables, use a profile stored in ~/.azure/credentials, or log in before you run your tasks or playbook with az login.

  • Authentication is also possible using a service principal or Active Directory user.

  • To authenticate via service principal, pass subscription_id, client_id, secret and tenant or set environment variables AZURE_SUBSCRIPTION_ID, AZURE_CLIENT_ID, AZURE_SECRET and AZURE_TENANT.

  • To authenticate via Active Directory user, pass ad_user and password, or set AZURE_AD_USER and AZURE_PASSWORD in the environment.

  • Alternatively, credentials can be stored in ~/.azure/credentials. This is an ini file containing a [default] section and the following keys: subscription_id, client_id, secret and tenant or subscription_id, ad_user and password. It is also possible to add additional profiles. Specify the profile by passing profile or setting AZURE_PROFILE in the environment.

See Also

See also

Sign in with Azure CLI

How to authenticate using the az login command.

Examples

- name: Get instance of HDInsight Cluster
  community.azure.azure_rm_hdinsightcluster_info:
    resource_group: myResourceGroup
    name: myCluster

- name: List instances of HDInsight Cluster
  community.azure.azure_rm_hdinsightcluster_info:
    resource_group: myResourceGroup

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key

Description

clusters

complex

A list of dictionaries containing facts for HDInsight Cluster.

Returned: always

cluster_definition

string

The cluster definition.

Returned: success

kind

string

The type of cluster.

Returned: always

Sample: "spark"

cluster_version

string

The version of the cluster.

Returned: always

Sample: "3.6.1000.67"

compute_profile_roles

list / elements=string

The list of roles in the cluster.

Returned: success

linux_profile

string

The Linux OS profile.

Returned: success

username

string

User name.

Returned: always

Sample: "myuser"

name

string

The name of the role.

Returned: always

Sample: "headnode"

target_instance_count

integer

The instance count of the cluster.

Returned: always

Sample: 2

vm_size

string

The size of the VM.

Returned: always

Sample: "Standard_D3"

connectivity_endpoints

list / elements=string

Cluster’s connectivity endpoints.

Returned: success

location

string

Endpoint location.

Returned: always

Sample: "myCluster-ssh.azurehdinsight.net"

name

string

Endpoint name.

Returned: always

Sample: "SSH"

port

integer

Endpoint port.

Returned: always

Sample: 22

protocol

string

Endpoint protocol.

Returned: always

Sample: "TCP"

id

string

The unique resource identifier of the HDInsight Cluster.

Returned: always

Sample: "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.HDInsight/clusters/myCluster"

location

string

The location of the resource group to which the resource belongs.

Returned: always

Sample: "westus"

name

string

The name of the HDInsight Cluster.

Returned: always

Sample: "testaccount"

os_type

string

The type of operating system.

Returned: always

Sample: "linux"

resource_group

string

Name of an Azure resource group.

Returned: always

Sample: "myResourceGroup"

tags

complex

The tags of the resource.

Returned: always

Sample: {}

tier

string

The cluster tier.

Returned: always

Sample: "standard"

Status

  • This module will be removed in version 2.0.0. [deprecated]

  • For more information see DEPRECATED.

Authors

  • Zim Kalinowski (@zikalino)