azure.azcollection.azure_rm_hdinsightcluster – Manage Azure HDInsight Cluster instance
azure.azcollection.azure_rm_hdinsightcluster – Manage Azure HDInsight Cluster instance
Note
This plugin is part of the azure.azcollection collection (version 1.3.1).
To install it use: ansible-galaxy collection install azure.azcollection
.
To use it in a playbook, specify: azure.azcollection.azure_rm_hdinsightcluster
.
New in version 0.1.2: of azure.azcollection
Synopsis
- Create, update and delete instance 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 | ||
append_tags boolean |
|
Use to control if tags field is canonical or just appends to existing tags. When canonical, any tags not found in the tags parameter will be removed from the object's metadata. | ||
auth_source string added in 0.0.1 of azure.azcollection |
|
Controls the source of the credentials to use for authentication. Can also be set via the When set to When set to When set to When set to When set to The | ||
cert_validation_mode string added in 0.0.1 of azure.azcollection |
|
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 | ||
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, | ||
cluster_definition string |
The cluster definition. | |||
gateway_rest_password string |
Gateway REST password. | |||
gateway_rest_username string |
Gateway REST user name. | |||
kind string |
|
The type of cluster. | ||
cluster_version string |
The version of the cluster. For example | |||
compute_profile_roles list / elements=string |
The list of roles in the cluster. | |||
linux_profile string |
The Linux OS profile. | |||
password string |
SSH password. | |||
username string |
SSH user name. | |||
min_instance_count string |
The minimum instance count of the cluster. | |||
name string |
|
The name of the role. | ||
target_instance_count string |
The instance count of the cluster. | |||
vm_size string |
The size of the VM. | |||
location string |
Resource location. If not set, location from the resource group will be used as default. | |||
name string / required |
The name of the cluster. | |||
os_type string |
|
The type of operating system. | ||
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 / required |
The name of the resource group. | |||
secret string |
Azure client secret. Use when authenticating with a Service Principal. | |||
state string |
|
Assert the state of the cluster. Use | ||
storage_accounts list / elements=string |
The list of storage accounts in the cluster. | |||
container string |
The container in the storage account. | |||
is_default string |
Whether or not the storage account is the default storage account. | |||
key string |
The storage account access key. | |||
name string |
Blob storage endpoint. For example storage_account_name.blob.core.windows.net. | |||
subscription_id string |
Your Azure subscription Id. | |||
tags dictionary |
Dictionary of string:string pairs to assign as metadata to the object. Metadata tags on the object will be updated with any provided values. To remove tags set append_tags option to false. | |||
tenant string |
Azure tenant ID. Use when authenticating with a Service Principal. | |||
tier string |
|
The cluster tier. |
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
Examples
- name: Create instance of HDInsight Cluster
azure_rm_hdinsightcluster:
resource_group: myResourceGroup
name: myCluster
location: eastus2
cluster_version: 3.6
os_type: linux
tier: standard
cluster_definition:
kind: spark
gateway_rest_username: http-user
gateway_rest_password: MuABCPassword!!@123
storage_accounts:
- name: myStorageAccount.blob.core.windows.net
is_default: yes
container: myContainer
key: GExmaxH4lDNdHA9nwAsCt8t4AOQas2y9vXQP1kKALTram7Q3/5xLVIab3+nYG1x63Xyak9/VXxQyNBHA9pDWw==
compute_profile_roles:
- name: headnode
target_instance_count: 2
hardware_profile:
vm_size: Standard_D3
linux_profile:
username: sshuser
password: MuABCPassword!!@123
- name: workernode
target_instance_count: 2
vm_size: Standard_D3
linux_profile:
username: sshuser
password: MuABCPassword!!@123
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key | Returned | Description |
---|---|---|
id string |
always |
Fully qualified resource id of the cluster.
Sample: /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.HDInsight/clusters/myCluster |
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/azure/azcollection/azure_rm_hdinsightcluster_module.html