community.aws.elb_network_lb – Manage a Network Load Balancer

From Get docs
Ansible/docs/2.11/collections/community/aws/elb network lb module


community.aws.elb_network_lb – Manage a Network Load Balancer

Note

This plugin is part of the community.aws collection (version 1.3.0).

To install it use: ansible-galaxy collection install community.aws.

To use it in a playbook, specify: community.aws.elb_network_lb.


New in version 1.0.0: of community.aws


Synopsis

Requirements

The below requirements are needed on the host that executes this module.

  • boto
  • boto3
  • python >= 2.6

Parameters

Parameter Choices/Defaults Comments

aws_access_key

string

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.

If profile is set this parameter is ignored.

Passing the aws_access_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.


aliases: ec2_access_key, access_key

aws_ca_bundle

path

The location of a CA Bundle to use when validating SSL certificates.

Only used for boto3 based modules.

Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.

aws_config

dictionary

A dictionary to modify the botocore configuration.

Only the 'user_agent' key is used for boto modules. See http://boto.cloudhackers.com/en/latest/boto_config_tut.html#boto for more boto configuration.

aws_secret_key

string

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.

If profile is set this parameter is ignored.

Passing the aws_secret_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.


aliases: ec2_secret_key, secret_key

cross_zone_load_balancing

boolean

  • no
  • yes

Indicates whether cross-zone load balancing is enabled.

Defaults to false.

debug_botocore_endpoint_logs

boolean

  • no

  • yes

Use a botocore.endpoint logger to parse the unique (rather than total) "resource:action" API calls made during a task, outputing the set to the resource_actions key in the task results. Use the aws_resource_action callback to output to total list made during a playbook. The ANSIBLE_DEBUG_BOTOCORE_LOGS environment variable may also be used.

deletion_protection

boolean

  • no
  • yes

Indicates whether deletion protection for the ELB is enabled.

Defaults to false.

ec2_url

string

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.


aliases: aws_endpoint_url, endpoint_url

listeners

list / elements=dictionary

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.

Certificates

list / elements=dictionary

The SSL server certificate.

CertificateArn

string

The Amazon Resource Name (ARN) of the certificate.

DefaultActions

list / elements=dictionary / required

The default actions for the listener.

TargetGroupArn

string

The Amazon Resource Name (ARN) of the target group.

Type

string

The type of action.

Port

integer / required

The port on which the load balancer is listening.

Protocol

string / required

The protocol for connections from clients to the load balancer.

SslPolicy

string

The security policy that defines which ciphers and protocols are supported.

name

string / 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

string

Uses a boto profile. Only works with boto >= 2.24.0.

Using profile will override aws_access_key, aws_secret_key and security_token and support for passing them at the same time as profile has been deprecated.

aws_access_key, aws_secret_key and security_token will be made mutually exclusive with profile after 2022-06-01.


aliases: aws_profile

purge_listeners

boolean

  • no
  • yes

If purge_listeners=true, 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

boolean

  • no
  • yes

If purge_tags=true, 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

string

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

string

  • internet-facing

  • internal

Internet-facing or internal load balancer. An ELB scheme can not be modified after creation.

security_token

string

AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.

If profile is set this parameter is ignored.

Passing the security_token and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.


aliases: aws_security_token, access_token

state

string

  • present
  • absent

Create or destroy the load balancer.

The current default is absent. However, this behavior is inconsistent with other modules and as such the default will change to present in 2.14. To maintain the existing behavior explicitly set state=absent.

subnet_mappings

list / elements=dictionary

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

list / elements=string

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 when state=present.

This parameter is mutually exclusive with subnet_mappings.

tags

dictionary

A dictionary of one or more tags to assign to the load balancer.

validate_certs

boolean

  • no
  • yes

When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.

wait

boolean

  • no
  • yes

Whether or not to wait for the network load balancer to reach the desired state.

wait_timeout

integer

The duration in seconds to wait, used in conjunction with wait.



Notes

Note

  • Listeners are matched based on port. If a listener’s port is changed then a new listener will be created.
  • Listener rules are matched based on priority. If a rule’s priority is changed then a new rule will be created.
  • If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence AWS_URL or EC2_URL, AWS_PROFILE or AWS_DEFAULT_PROFILE, 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_CA_BUNDLE
  • Ansible uses the boto configuration file (typically ~/.boto) if no credentials are provided. See https://boto.readthedocs.io/en/latest/boto_config_tut.html
  • 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


Examples

# Note: These examples do not set authentication details, see the AWS Guide for details.

- name: Create an ELB and attach a listener
  community.aws.elb_network_lb:
    name: myelb
    subnets:
      - subnet-012345678
      - subnet-abcdef000
    listeners:
      - Protocol: TCP # Required. The protocol for connections from clients to the load balancer (TCP, TLS, UDP or TCP_UDP) (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

- name: Create an ELB with an attached Elastic IP address
  community.aws.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 (TCP, TLS, UDP or TCP_UDP) (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

- name: Remove an ELB
  community.aws.elb_network_lb:
    name: myelb
    state: absent

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key Returned Description

availability_zones

list / elements=string

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.


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.


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.


load_balancer_arn

string

when state is present

The Amazon Resource Name (ARN) of the load balancer.


port

integer

when state is present

The port on which the load balancer is listening.


Sample:

80

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.


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

dictionary

when state is present

The state of the load balancer.


Sample:

{'code': 'active'}

tags

dictionary

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




Authors

  • Rob White (@wimnat)

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/community/aws/elb_network_lb_module.html