Try SpotterGet Azure HDInsight Cluster facts
| "added in version" 2.9 of ansible.builtin"
Authors: Zim Kalinowski (@zikalino)
preview | supported by community
pipInstall with pip install ansible==2.9.17
Get facts of Azure HDInsight Cluster.
- 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
name:
description:
- HDInsight cluster name.
tags:
description:
- Limit results by providing a list of tags. Format tags as 'key' or 'key:value'.
secret:
description:
- Azure client secret. Use when authenticating with a Service Principal.
type: str
tenant:
description:
- Azure tenant ID. Use when authenticating with a Service Principal.
type: str
ad_user:
description:
- Active Directory username. Use when authenticating with an Active Directory user
rather than service principal.
type: str
profile:
description:
- Security profile found in ~/.azure/credentials file.
type: str
password:
description:
- Active Directory user password. Use when authenticating with an Active Directory
user rather than service principal.
type: str
client_id:
description:
- Azure client ID. Use when authenticating with a Service Principal.
type: str
api_profile:
default: latest
description:
- Selects an API profile to use when communicating with Azure services. Default value
of C(latest) is appropriate for public clouds; future values will allow use with
Azure Stack.
type: str
version_added: 0.0.1
version_added_collection: azure.azcollection
auth_source:
choices:
- auto
- cli
- credential_file
- env
- msi
default: auto
description:
- Controls the source of the credentials to use for authentication.
- Can also be set via the C(ANSIBLE_AZURE_AUTH_SOURCE) environment variable.
- When set to C(auto) (the default) the precedence is module parameters -> C(env)
-> C(credential_file) -> C(cli).
- When set to C(env), the credentials will be read from the environment variables
- When set to C(credential_file), it will read the profile from C(~/.azure/credentials).
- When set to C(cli), the credentials will be sources from the Azure CLI profile.
C(subscription_id) or the environment variable C(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 C(msi), the host machine must be an azure resource with an enabled MSI
extension. C(subscription_id) or the environment variable C(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 C(msi) was added in Ansible 2.6.
type: str
version_added: 0.0.1
version_added_collection: azure.azcollection
resource_group:
description:
- Name of an Azure resource group.
subscription_id:
description:
- Your Azure subscription Id.
type: str
cloud_environment:
default: AzureCloud
description:
- For cloud environments other than the US public cloud, the environment name (as
defined by Azure Python SDK, eg, C(AzureChinaCloud), C(AzureUSGovernment)), or a
metadata discovery endpoint URL (required for Azure Stack). Can also be set via
credential file profile or the C(AZURE_CLOUD_ENVIRONMENT) environment variable.
type: str
version_added: 0.0.1
version_added_collection: azure.azcollection
adfs_authority_url:
description:
- Azure AD authority url. Use when authenticating with Username/password, and has
your own ADFS authority.
type: str
version_added: 0.0.1
version_added_collection: azure.azcollection
cert_validation_mode:
choices:
- ignore
- validate
description:
- 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
C(ignore). Can also be set via credential file profile or the C(AZURE_CERT_VALIDATION)
environment variable.
type: str
version_added: 0.0.1
version_added_collection: azure.azcollection
clusters:
contains:
cluster_definition:
contains:
kind:
description:
- The type of cluster.
returned: always
sample: spark
type: str
description:
- The cluster definition.
cluster_version:
description:
- The version of the cluster.
returned: always
sample: 3.6.1000.67
type: str
compute_profile_roles:
contains:
linux_profile:
contains:
username:
description:
- User name.
returned: always
sample: myuser
type: str
description:
- The Linux OS profile.
name:
description:
- The name of the role.
returned: always
sample: headnode
type: str
target_instance_count:
description:
- The instance count of the cluster.
returned: always
sample: 2
type: int
vm_size:
description:
- The size of the VM.
returned: always
sample: Standard_D3
type: str
description:
- The list of roles in the cluster.
type: list
connectivity_endpoints:
contains:
location:
description:
- Endpoint location.
returned: always
sample: myCluster-ssh.azurehdinsight.net
type: str
name:
description:
- Endpoint name.
returned: always
sample: SSH
type: str
port:
description:
- Endpoint port.
returned: always
sample: 22
type: int
protocol:
description:
- Endpoint protocol.
returned: always
sample: TCP
type: str
description:
- Cluster's connectivity endpoints.
type: list
id:
description:
- The unique resource identifier of the HDInsight Cluster.
returned: always
sample: /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.HDInsight/clusters/myCluster
type: str
location:
description:
- The location of the resource group to which the resource belongs.
returned: always
sample: westus
type: str
name:
description:
- The name of the HDInsight Cluster.
returned: always
sample: testaccount
type: str
os_type:
description:
- The type of operating system.
returned: always
sample: linux
type: str
resource_group:
description:
- Name of an Azure resource group.
returned: always
sample: myResourceGroup
type: str
tags:
description:
- The tags of the resource.
returned: always
sample: {}
type: complex
tier:
description:
- The cluster tier.
returned: always
sample: standard
type: str
description:
- A list of dictionaries containing facts for HDInsight Cluster.
returned: always
type: complex