New in version 2.6.
The below requirements are needed on the host that executes this module.
Parameter | Choices/Defaults | Comments |
---|---|---|
aws_access_key | AWS access key. If not set then the value of the AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY or EC2_ACCESS_KEY environment variable is used. aliases: ec2_access_key, access_key | |
aws_secret_key | AWS secret key. If not set then the value of the AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY, or EC2_SECRET_KEY environment variable is used. aliases: ec2_secret_key, secret_key | |
cross_zone_load_balancing bool |
| Indicates whether cross-zone load balancing is enabled. |
deletion_protection bool |
| Indicates whether deletion protection for the ELB is enabled. |
ec2_url | Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used. | |
listeners | A list of dicts containing listeners to attach to the ELB. See examples for detail of the dict required. Note that listener keys are CamelCased. | |
name required | The name of the load balancer. This name must be unique within your AWS account, can have a maximum of 32 characters, must contain only alphanumeric characters or hyphens, and must not begin or end with a hyphen. | |
profile (added in 1.6) | Uses a boto profile. Only works with boto >= 2.24.0. | |
purge_listeners bool |
| If yes, existing listeners will be purged from the ELB to match exactly what is defined by listeners parameter. If the listeners parameter is not set then listeners will not be modified |
purge_tags bool |
| If yes, existing tags will be purged from the resource to match exactly what is defined by tags parameter. If the tags parameter is not set then tags will not be modified. |
region | The AWS region to use. If not specified then the value of the AWS_REGION or EC2_REGION environment variable, if any, is used. See http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region
aliases: aws_region, ec2_region | |
scheme |
| Internet-facing or internal load balancer. An ELB scheme can not be modified after creation. |
security_token (added in 1.6) | AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used. aliases: access_token | |
state required |
| Create or destroy the load balancer. |
subnet_mappings | A list of dicts containing the IDs of the subnets to attach to the load balancer. You can also specify the allocation ID of an Elastic IP to attach to the load balancer. You can specify one Elastic IP address per subnet. This parameter is mutually exclusive with subnets
| |
subnets | A list of the IDs of the subnets to attach to the load balancer. You can specify only one subnet per Availability Zone. You must specify subnets from at least two Availability Zones. Required if state=present. This parameter is mutually exclusive with subnet_mappings
| |
tags | A dictionary of one or more tags to assign to the load balancer. | |
validate_certs bool (added in 1.5) |
| When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0. |
wait bool |
| Whether or not to wait for the network load balancer to reach the desired state. |
wait_timeout | The duration in seconds to wait, used in conjunction with wait. |
Note
AWS_URL
or EC2_URL
, AWS_ACCESS_KEY_ID
or AWS_ACCESS_KEY
or EC2_ACCESS_KEY
, AWS_SECRET_ACCESS_KEY
or AWS_SECRET_KEY
or EC2_SECRET_KEY
, AWS_SECURITY_TOKEN
or EC2_SECURITY_TOKEN
, AWS_REGION
or EC2_REGION
AWS_REGION
or EC2_REGION
can be typically be used to specify the AWS region, when required, but this can also be configured in the boto config file# Note: These examples do not set authentication details, see the AWS Guide for details. # Create an ELB and attach a listener - elb_network_lb: name: myelb subnets: - subnet-012345678 - subnet-abcdef000 listeners: - Protocol: TCP # Required. The protocol for connections from clients to the load balancer (Only TCP is available) (case-sensitive). Port: 80 # Required. The port on which the load balancer is listening. DefaultActions: - Type: forward # Required. Only 'forward' is accepted at this time TargetGroupName: mytargetgroup # Required. The name of the target group state: present # Create an ELB with an attached Elastic IP address - elb_network_lb: name: myelb subnet_mappings: - SubnetId: subnet-012345678 AllocationId: eipalloc-aabbccdd listeners: - Protocol: TCP # Required. The protocol for connections from clients to the load balancer (Only TCP is available) (case-sensitive). Port: 80 # Required. The port on which the load balancer is listening. DefaultActions: - Type: forward # Required. Only 'forward' is accepted at this time TargetGroupName: mytargetgroup # Required. The name of the target group state: present # Remove an ELB - elb_network_lb: name: myelb state: absent
Common return values are documented here, the following are the fields unique to this module:
Key | Returned | Description | ||
---|---|---|---|---|
availability_zones list | when state is present | The Availability Zones for the load balancer. Sample: [{'subnet_id': 'subnet-aabbccddff', 'zone_name': 'ap-southeast-2a', 'load_balancer_addresses': []}] | ||
canonical_hosted_zone_id string | when state is present | The ID of the Amazon Route 53 hosted zone associated with the load balancer. Sample: ABCDEF12345678 | ||
created_time string | when state is present | The date and time the load balancer was created. Sample: 2015-02-12T02:14:02+00:00 | ||
deletion_protection_enabled string | when state is present | Indicates whether deletion protection is enabled. Sample: True | ||
dns_name string | when state is present | The public DNS name of the load balancer. Sample: internal-my-elb-123456789.ap-southeast-2.elb.amazonaws.com | ||
idle_timeout_timeout_seconds string | when state is present | The idle timeout value, in seconds. Sample: 60 | ||
ip_address_type string | when state is present | The type of IP addresses used by the subnets for the load balancer. Sample: ipv4 | ||
listeners complex | when state is present | Information about the listeners. | ||
default_actions string | when state is present | The default actions for the listener. | ||
target_group_arn string | when state is present | The Amazon Resource Name (ARN) of the target group. | ||
type string | when state is present | The type of action. | ||
listener_arn string | when state is present | The Amazon Resource Name (ARN) of the listener. | ||
protocol string | when state is present | The protocol for connections from clients to the load balancer. Sample: HTTPS | ||
ssl_policy string | when state is present | The security policy that defines which ciphers and protocols are supported. | ||
certificates complex | when state is present | The SSL server certificate. | ||
certificate_arn string | when state is present | The Amazon Resource Name (ARN) of the certificate. | ||
load_balancer_arn string | when state is present | The Amazon Resource Name (ARN) of the load balancer. | ||
port int | when state is present | The port on which the load balancer is listening. Sample: 80 | ||
load_balancer_arn string | when state is present | The Amazon Resource Name (ARN) of the load balancer. Sample: arn:aws:elasticloadbalancing:ap-southeast-2:0123456789:loadbalancer/app/my-elb/001122334455 | ||
load_balancer_name string | when state is present | The name of the load balancer. Sample: my-elb | ||
load_balancing_cross_zone_enabled string | when state is present | Indicates whether cross-zone load balancing is enabled. Sample: True | ||
scheme string | when state is present | Internet-facing or internal load balancer. Sample: internal | ||
state dict | when state is present | The state of the load balancer. Sample: {'code': 'active'} | ||
tags dict | when state is present | The tags attached to the load balancer. Sample: { 'Tag': 'Example' } | ||
type string | when state is present | The type of load balancer. Sample: network | ||
vpc_id string | when state is present | The ID of the VPC for the load balancer. Sample: vpc-0011223344 |
This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.
This module is flagged as community which means that it is maintained by the Ansible Community. See Module Maintenance & Support for more info.
For a list of other modules that are also maintained by the Ansible Community, see here.
Hint
If you notice any issues in this documentation you can edit this document to improve it.
© 2012–2018 Michael DeHaan
© 2018 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.7/modules/elb_network_lb_module.html