community.azure.azure_rm_hdinsightcluster_info – Get Azure HDInsight Cluster facts

From Get docs
Ansible/docs/2.10/collections/community/azure/azure rm hdinsightcluster info module


community.azure.azure_rm_hdinsightcluster_info – Get Azure HDInsight Cluster facts

Note

This plugin is part of the community.azure collection (version 1.0.0).

To install it use: ansible-galaxy collection install community.azure.

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


Synopsis

  • Get facts of Azure HDInsight Cluster.

Requirements

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

  • python >= 2.7
  • azure >= 2.0.0

Parameters

Parameter Choices/Defaults 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 0.0.1 of azure.azcollection

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

api_profile

string

added in 0.0.1 of azure.azcollection

Default:

"latest"

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.

auth_source

string

added in 0.0.1 of azure.azcollection

  • auto

  • cli
  • credential_file
  • env
  • msi

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.

cert_validation_mode

string

added in 0.0.1 of azure.azcollection

  • ignore
  • validate

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.

client_id

string

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

cloud_environment

string

added in 0.0.1 of azure.azcollection

Default:

"AzureCloud"

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.

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.



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 Returned Description

clusters

complex

always

A list of dictionaries containing facts for HDInsight Cluster.


cluster_definition

string

success

The cluster definition.


kind

string

always

The type of cluster.


Sample:

spark

cluster_version

string

always

The version of the cluster.


Sample:

3.6.1000.67

compute_profile_roles

list / elements=string

success

The list of roles in the cluster.


linux_profile

string

success

The Linux OS profile.


username

string

always

User name.


Sample:

myuser

name

string

always

The name of the role.


Sample:

headnode

target_instance_count

integer

always

The instance count of the cluster.


Sample:

2

vm_size

string

always

The size of the VM.


Sample:

Standard_D3

connectivity_endpoints

list / elements=string

success

Cluster's connectivity endpoints.


location

string

always

Endpoint location.


Sample:

myCluster-ssh.azurehdinsight.net

name

string

always

Endpoint name.


Sample:

SSH

port

integer

always

Endpoint port.


Sample:

22

protocol

string

always

Endpoint protocol.


Sample:

TCP

id

string

always

The unique resource identifier of the HDInsight Cluster.


Sample:

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

location

string

always

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


Sample:

westus

name

string

always

The name of the HDInsight Cluster.


Sample:

testaccount

os_type

string

always

The type of operating system.


Sample:

linux

resource_group

string

always

Name of an Azure resource group.


Sample:

myResourceGroup

tags

complex

always

The tags of the resource.


tier

string

always

The cluster tier.


Sample:

standard




Authors

  • Zim Kalinowski (@zikalino)

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