azure_rm_loadbalancer - Manage Azure load balancers.
New in version 2.4.
Synopsis
- Create, update and delete Azure load balancers
Requirements (on host that executes module)
- python >= 2.7
- azure >= 2.0.0
Options
| parameter | required | default | choices | comments |
|---|---|---|---|---|
| ad_user | no | Active Directory username. Use when authenticating with an Active Directory user rather than service principal. | ||
| append_tags | no | True | 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. | |
| backend_port | no | Backend port that will be exposed for the load balancer. | ||
| client_id | no | Azure client ID. Use when authenticating with a Service Principal. | ||
| cloud_environment | no | 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. | |
| frontend_port | no | Frontend port that will be exposed for the load balancer. | ||
| idle_timeout | no | 4 | Timeout for TCP idle connection in minutes. | |
| load_distribution | no |
| The type of load distribution that the load balancer will employ. | |
| location | no | resource_group location | Valid azure location. Defaults to location of the resource group. | |
| name | yes | Name of the load balancer. | ||
| natpool_backend_port | no | Backend port used by the NAT pool. | ||
| natpool_frontend_port_end | no | End of the port range for a NAT pool. | ||
| natpool_frontend_port_start | no | Start of the port range for a NAT pool. | ||
| natpool_protocol | no | The protocol for the NAT pool. | ||
| password | no | Active Directory user password. Use when authenticating with an Active Directory user rather than service principal. | ||
| probe_fail_count | no | 3 | The amount of probe failures for the load balancer to make a health determination. | |
| probe_interval | no | 15 | How much time (in seconds) to probe the endpoint for health. | |
| probe_port | no | The port that the health probe will use. | ||
| probe_protocol | no |
| The protocol to use for the health probe. | |
| probe_request_path | no | The URL that an HTTP probe will use (only relevant if probe_protocol is set to Http). | ||
| profile | no | Security profile found in ~/.azure/credentials file. | ||
| protocol | no |
| The protocol (TCP or UDP) that the load balancer will use. | |
| public_ip_address_name | no | Name of an existing public IP address object to associate with the security group. aliases: public_ip_address, public_ip_name, public_ip | ||
| resource_group | yes | Name of a resource group where the load balancer exists or will be created. | ||
| secret | no | Azure client secret. Use when authenticating with a Service Principal. | ||
| state | no | present |
| Assert the state of the load balancer. Use 'present' to create or update a load balancer and 'absent' to delete a load balancer. |
| subscription_id | no | Your Azure subscription Id. | ||
| tags | no | 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 | no | Azure tenant ID. Use when authenticating with a Service Principal. |
Examples
- name: Create a load balancer
azure_rm_loadbalancer:
name: myloadbalancer
location: eastus
resource_group: my-rg
public_ip: mypublicip
probe_protocol: Tcp
probe_port: 80
probe_interval: 10
probe_fail_count: 3
protocol: Tcp
load_distribution: Default
frontend_port: 80
backend_port: 8080
idle_timeout: 4
natpool_frontend_port_start: 1030
natpool_frontend_port_end: 1040
natpool_backend_port: 80
natpool_protocol: Tcp
Return Values
Common return values are documented here Return Values, the following are the fields unique to this module:
| name | description | returned | type | sample |
|---|---|---|---|---|
| changed | Whether or not the resource has changed | always | bool | |
| state | Current state of the load balancer | always | dict |
Notes
Note
- For authentication with Azure you can pass parameters, set environment variables or use a profile stored in ~/.azure/credentials. Authentication is 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.
Status
This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.
For help in developing on modules, should you be so inclined, please read Community Information & Contributing, Testing Ansible and Developing Modules.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.4/azure_rm_loadbalancer_module.html