azure.azcollection.azure_rm_virtualmachinescaleset – Manage Azure virtual machine scale sets¶
Note
This plugin is part of the azure.azcollection collection (version 1.5.0).
To install it use: ansible-galaxy collection install azure.azcollection
.
To use it in a playbook, specify: azure.azcollection.azure_rm_virtualmachinescaleset
.
New in version 0.1.2: of azure.azcollection
Synopsis¶
Create and update a virtual machine scale set.
Note that this module was called azure_rm_virtualmachine_scaleset before Ansible 2.8. The usage did not change.
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.
|
||
admin_password
string
|
Password for the admin username.
Not required if the os_type is Linux and SSH password authentication is disabled by setting ssh_password_enabled=false.
|
||
admin_username
string
|
Admin username used to access the host after it is created. Required when creating a VM.
|
||
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. |
|
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.
|
|
application_gateway
string
|
Application gateway name.
|
||
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
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 variablesWhen 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. |
|
capacity
string
|
Default: 1
|
Capacity of VMSS.
|
|
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
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. |
|
custom_data
string
|
Data which is made available to the virtual machine and used by e.g.,
cloud-init .Many images in the marketplace are not cloud-init ready. Thus, data sent to custom_data would be ignored.
If the image you are attempting to use is not listed in https://docs.microsoft.com/en-us/azure/virtual-machines/linux/using-cloud-init#cloud-init-overview, follow these steps https://docs.microsoft.com/en-us/azure/virtual-machines/linux/cloudinit-prepare-custom-image.
|
||
data_disks
string
|
Describes list of data disks.
|
||
caching
string
|
|
Type of data disk caching.
|
|
disk_size_gb
string
|
The initial disk size in GB for blank data disks.
|
||
lun
string
|
Default: 0
|
The logical unit number for data disk.
|
|
managed_disk_type
string
|
|
Managed data disk type.
|
|
enable_accelerated_networking
boolean
|
|
Indicates whether user wants to allow accelerated networking for virtual machines in scaleset being created.
|
|
ephemeral_os_disk
boolean
|
|
Parameters of ephemeral disk settings that can be specified for operating system disk.
Ephemeral OS disk is only supported for VMS Instances using Managed Disk.
|
|
image
string
/ required
|
Specifies the image used to build the VM.
If a string, the image is sourced from a custom image based on the name.
If a dict with the keys publisher, offer, sku, and version, the image is sourced from a Marketplace image. Note that set version=latest to get the most recent version of a given image.
If a dict with the keys name and resource_group, the image is sourced from a custom image based on the name and resource_group set. Note that the key resource_group is optional and if omitted, all images in the subscription will be searched for by name.
Custom image support was added in Ansible 2.5.
|
||
load_balancer
string
|
Load balancer name.
|
||
location
string
|
Valid Azure location. Defaults to location of the resource group.
|
||
managed_disk_type
string
|
|
Managed disk type.
|
|
name
string
/ required
|
Name of the virtual machine.
|
||
os_disk_caching
string
|
|
Type of OS disk caching.
aliases: disk_caching |
|
os_type
string
|
|
Base type of operating system.
|
|
overprovision
boolean
|
|
Specifies whether the Virtual Machine Scale Set should be overprovisioned.
|
|
password
string
|
Active Directory user password. Use when authenticating with an Active Directory user rather than service principal.
|
||
plan
dictionary
|
Third-party billing plan for the VM.
|
||
name
string
/ required
|
Billing plan name.
|
||
product
string
/ required
|
Product name.
|
||
promotion_code
string
|
Optional promotion code.
|
||
publisher
string
/ required
|
Publisher offering the plan.
|
||
profile
string
|
Security profile found in ~/.azure/credentials file.
|
||
public_ip_per_vm
boolean
|
|
Assign a public IP to each virtual machine of the scale set
|
|
remove_on_absent
string
|
Default: ["all"]
|
When removing a VM using state=absent, also remove associated resources.
It can be
all or a list with any of the following ['network_interfaces', 'virtual_storage', 'public_ips'].Any other input will be ignored.
|
|
resource_group
string
/ required
|
Name of the resource group containing the virtual machine scale set.
|
||
scale_in_policy
string
|
|
define the order in which vmss instances are scaled-in
|
|
secret
string
|
Azure client secret. Use when authenticating with a Service Principal.
|
||
security_group
string
|
Existing security group with which to associate the subnet.
It can be the security group name which is in the same resource group.
It can be the resource ID.
It can be a dict which contains name and resource_group of the security group.
aliases: security_group_name |
||
short_hostname
string
|
Short host name.
|
||
single_placement_group
boolean
|
|
When true this limits the scale set to a single placement group, of max size 100 virtual machines.
|
|
ssh_password_enabled
boolean
|
|
When the os_type is Linux, setting ssh_password_enabled=false will disable SSH password authentication and require use of SSH keys.
|
|
ssh_public_keys
string
|
For os_type=Linux provide a list of SSH keys.
Each item in the list should be a dictionary where the dictionary contains two keys,
path and key_data .Set the
path to the default location of the authorized_keys files.On an Enterprise Linux host, for example, the path=/home/<admin username>/.ssh/authorized_keys. Set
key_data to the actual value of the public key. |
||
state
string
|
|
Assert the state of the virtual machine scale set.
State
present will check that the machine exists with the requested configuration. If the configuration of the existing machine does not match, the machine will be updated.State
absent will remove the virtual machine scale set. |
|
subnet_name
string
|
Subnet name.
aliases: subnet |
||
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.
Currently, Azure DNS zones and Traffic Manager services also don't allow the use of spaces in the tag.
Azure Front Door doesn't support the use of
Azure Automation and Azure CDN only support 15 tags on resources.
|
||
tenant
string
|
Azure tenant ID. Use when authenticating with a Service Principal.
|
||
terminate_event_timeout_minutes
string
|
timeout time for termination notification event
in range between 5 and 15
|
||
tier
string
|
|
SKU Tier.
|
|
upgrade_policy
string
|
|
Upgrade policy.
Required when creating the Azure virtual machine scale sets.
|
|
virtual_network_name
string
|
Virtual Network name.
aliases: virtual_network |
||
virtual_network_resource_group
string
|
When creating a virtual machine, if a specific virtual network from another resource group should be used.
Use this parameter to specify the resource group to use.
|
||
vm_size
string
|
A valid Azure VM size value. For example,
Standard_D4 .The list of choices varies depending on the subscription and location. Check your subscription for available choices.
|
||
zones
list
/ elements=string
|
A list of Availability Zones for your virtual machine scale set.
|
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: Create VMSS
azure_rm_virtualmachinescaleset:
resource_group: myResourceGroup
name: testvmss
vm_size: Standard_DS1_v2
capacity: 2
virtual_network_name: testvnet
upgrade_policy: Manual
subnet_name: testsubnet
terminate_event_timeout_minutes: 10
scale_in_policy: NewestVM
admin_username: adminUser
ssh_password_enabled: false
ssh_public_keys:
- path: /home/adminUser/.ssh/authorized_keys
key_data: < insert yor ssh public key here... >
managed_disk_type: Standard_LRS
image:
offer: CoreOS
publisher: CoreOS
sku: Stable
version: latest
data_disks:
- lun: 0
disk_size_gb: 64
caching: ReadWrite
managed_disk_type: Standard_LRS
- name: Create VMSS with an image that requires plan information
azure_rm_virtualmachinescaleset:
resource_group: myResourceGroup
name: testvmss
vm_size: Standard_DS1_v2
capacity: 3
virtual_network_name: testvnet
upgrade_policy: Manual
subnet_name: testsubnet
admin_username: adminUser
ssh_password_enabled: false
ssh_public_keys:
- path: /home/adminUser/.ssh/authorized_keys
key_data: < insert yor ssh public key here... >
managed_disk_type: Standard_LRS
image:
offer: cis-ubuntu-linux-1804-l1
publisher: center-for-internet-security-inc
sku: Stable
version: latest
plan:
name: cis-ubuntu-linux-1804-l1
product: cis-ubuntu-linux-1804-l1
publisher: center-for-internet-security-inc
data_disks:
- lun: 0
disk_size_gb: 64
caching: ReadWrite
managed_disk_type: Standard_LRS
- name: Create a VMSS with a custom image
azure_rm_virtualmachinescaleset:
resource_group: myResourceGroup
name: testvmss
vm_size: Standard_DS1_v2
capacity: 2
virtual_network_name: testvnet
upgrade_policy: Manual
subnet_name: testsubnet
admin_username: adminUser
admin_password: password01
managed_disk_type: Standard_LRS
image: customimage001
- name: Create a VMSS with over 100 instances
azure_rm_virtualmachinescaleset:
resource_group: myResourceGroup
name: testvmss
vm_size: Standard_DS1_v2
capacity: 120
single_placement_group: False
virtual_network_name: testvnet
upgrade_policy: Manual
subnet_name: testsubnet
admin_username: adminUser
admin_password: password01
managed_disk_type: Standard_LRS
image: customimage001
- name: Create a VMSS with a custom image from a particular resource group
azure_rm_virtualmachinescaleset:
resource_group: myResourceGroup
name: testvmss
vm_size: Standard_DS1_v2
capacity: 2
virtual_network_name: testvnet
upgrade_policy: Manual
subnet_name: testsubnet
admin_username: adminUser
admin_password: password01
managed_disk_type: Standard_LRS
image:
name: customimage001
resource_group: myResourceGroup
Return Values¶
Common return values are documented here, the following are the fields unique to this module:
Authors¶
Sertac Ozercan (@sozercan)