community.aws.directconnect_link_aggregation_group module – Manage Direct Connect LAG bundles

Note

This module is part of the community.aws collection (version 8.0.0).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install community.aws. You need further requirements to be able to use this module, see Requirements for details.

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

New in community.aws 1.0.0

Synopsis

• Create, delete, or modify a Direct Connect link aggregation group.

• Prior to release 5.0.0 this module was called community.aws.aws_direct_connect_link_aggregation_group. The usage did not change.

Aliases: aws_direct_connect_link_aggregation_group

Requirements

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

• python >= 3.6

• boto3 >= 1.26.0

• botocore >= 1.29.0

Parameters

Parameter	Comments
access_key aliases: aws_access_key_id, aws_access_key, ec2_access_key string	AWS access key ID. See the AWS documentation for more information about access tokens https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys. The AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY or EC2_ACCESS_KEY environment variables may also be used in decreasing order of preference. The aws_access_key and profile options are mutually exclusive. The aws_access_key_id alias was added in release 5.1.0 for consistency with the AWS botocore SDK. The ec2_access_key alias has been deprecated and will be removed in a release after 2024-12-01. Support for the EC2_ACCESS_KEY environment variable has been deprecated and will be removed in a release after 2024-12-01.
aws_ca_bundle path	The location of a CA Bundle to use when validating SSL certificates. The AWS_CA_BUNDLE environment variable may also be used.
aws_config dictionary	A dictionary to modify the botocore configuration. Parameters can be found in the AWS documentation https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config.
bandwidth string	The bandwidth of the link aggregation group.
connection_id string	A connection ID to link with the link aggregation group upon creation.
debug_botocore_endpoint_logs boolean	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. Choices: false ← (default) true
delete_with_disassociation boolean	To be used with state=absent to delete connections after disassociating them with the LAG. Choices: false ← (default) true
endpoint_url aliases: ec2_url, aws_endpoint_url, s3_url string	URL to connect to instead of the default AWS endpoints. While this can be used to connection to other AWS-compatible services the amazon.aws and community.aws collections are only tested against AWS. The AWS_URL or EC2_URL environment variables may also be used, in decreasing order of preference. The ec2_url and s3_url aliases have been deprecated and will be removed in a release after 2024-12-01. Support for the EC2_URL environment variable has been deprecated and will be removed in a release after 2024-12-01.
force_delete boolean	This allows the minimum number of links to be set to 0, any hosted connections disassociated, and any virtual interfaces associated to the LAG deleted. Choices: false ← (default) true
link_aggregation_group_id string	The ID of the Direct Connect link aggregation group.
location string	The location of the link aggregation group.
min_links integer	The minimum number of physical connections that must be operational for the LAG itself to be operational.
name string	The name of the Direct Connect link aggregation group.
num_connections integer	The number of connections with which to initialize the link aggregation group.
profile aliases: aws_profile string	A named AWS profile to use for authentication. See the AWS documentation for more information about named profiles https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-profiles.html. The AWS_PROFILE environment variable may also be used. The profile option is mutually exclusive with the aws_access_key, aws_secret_key and security_token options.
region aliases: aws_region, ec2_region string	The AWS region to use. For global services such as IAM, Route53 and CloudFront, region is ignored. The AWS_REGION or EC2_REGION environment variables may also be used. See the Amazon AWS documentation for more information http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region. The ec2_region alias has been deprecated and will be removed in a release after 2024-12-01 Support for the EC2_REGION environment variable has been deprecated and will be removed in a release after 2024-12-01.
secret_key aliases: aws_secret_access_key, aws_secret_key, ec2_secret_key string	AWS secret access key. See the AWS documentation for more information about access tokens https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys. The AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY, or EC2_SECRET_KEY environment variables may also be used in decreasing order of preference. The secret_key and profile options are mutually exclusive. The aws_secret_access_key alias was added in release 5.1.0 for consistency with the AWS botocore SDK. The ec2_secret_key alias has been deprecated and will be removed in a release after 2024-12-01. Support for the EC2_SECRET_KEY environment variable has been deprecated and will be removed in a release after 2024-12-01.
session_token aliases: aws_session_token, security_token, aws_security_token, access_token string	AWS STS session token for use with temporary credentials. See the AWS documentation for more information about access tokens https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys. The AWS_SESSION_TOKEN, AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variables may also be used in decreasing order of preference. The security_token and profile options are mutually exclusive. Aliases aws_session_token and session_token were added in release 3.2.0, with the parameter being renamed from security_token to session_token in release 6.0.0. The security_token, aws_security_token, and access_token aliases have been deprecated and will be removed in a release after 2024-12-01. Support for the EC2_SECRET_KEY and AWS_SECURITY_TOKEN environment variables has been deprecated and will be removed in a release after 2024-12-01.
state string / required	The state of the Direct Connect link aggregation group. Choices: "present" "absent"
validate_certs boolean	When set to false, SSL certificates will not be validated for communication with the AWS APIs. Setting validate_certs=false is strongly discouraged, as an alternative, consider setting aws_ca_bundle instead. Choices: false true ← (default)
wait boolean	Whether or not to wait for the operation to complete. May be useful when waiting for virtual interfaces to be deleted. The time to wait can be controlled by setting wait_timeout. Choices: false ← (default) true
wait_timeout integer	The duration in seconds to wait if wait=true. Default: 120

Notes

Note

• Caution: For modules, environment variables and configuration files are read from the Ansible ‘host’ context and not the ‘controller’ context. As such, files may need to be explicitly copied to the ‘host’. For lookup and connection plugins, environment variables and configuration files are read from the Ansible ‘controller’ context and not the ‘host’ context.

• The AWS SDK (boto3) that Ansible uses may also read defaults for credentials and other settings, such as the region, from its configuration files in the Ansible ‘host’ context (typically ~/.aws/credentials). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information.

Examples

# create a Direct Connect connection
- community.aws.directconnect_link_aggregation_group:
  state: present
  location: EqDC2
  lag_id: dxlag-xxxxxxxx
  bandwidth: 1Gbps

Return Values

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

Key	Description
aws_device string	The AWS Direct Connection endpoint that hosts the LAG. Returned: when state=present Sample: "EqSe2-1bwfvazist2k0"
changed string	Whether or not the LAG has changed. Returned: always
connections list / elements=string	A list of connections bundled by this LAG. Returned: when state=present Sample: {"connections": [{"aws_device": "EqSe2-1bwfvazist2k0", "bandwidth": "1Gbps", "connection_id": "dxcon-fgzjah5a", "connection_name": "Requested Connection 1 for Lag dxlag-fgtoh97h", "connection_state": "down", "lag_id": "dxlag-fgnsp4rq", "location": "EqSe2", "owner_account": "123456789012", "region": "us-west-2"}]}
connections_bandwidth string	The individual bandwidth of the physical connections bundled by the LAG. Returned: when state=present Sample: "1Gbps"
lag_id string	Unique identifier for the link aggregation group. Returned: when state=present Sample: "dxlag-fgnsp4rq"
lag_name string	User-provided name for the link aggregation group. Returned: when state=present
lag_state string	State of the LAG. Returned: when state=present Sample: "pending"
location string	Where the connection is located. Returned: when state=present Sample: "EqSe2"
minimum_links integer	The minimum number of physical connections that must be operational for the LAG itself to be operational. Returned: when state=present
number_of_connections integer	The number of physical connections bundled by the LAG. Returned: when state=present
owner_account string	Owner account ID of the LAG. Returned: when state=present
region string	The region in which the LAG exists. Returned: when state=present

Authors

• Sloane Hertel (@s-hertel)

Collection links

• Issue Tracker
• Repository (Sources)
• Communication