You are reading an unmaintained version of the Ansible documentation. Unmaintained Ansible versions can contain unfixed security vulnerabilities (CVE). Please upgrade to a maintained version. See the latest Ansible documentation.

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

Note

This module is part of the community.aws collection (version 3.6.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.aws_direct_connect_link_aggregation_group.

New in community.aws 1.0.0

Synopsis

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

Requirements

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

• python >= 3.6

• boto3 >= 1.16.0

• botocore >= 1.19.0

Parameters

Parameter	Comments
aws_access_key aliases: ec2_access_key, 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.
aws_ca_bundle path	The location of a CA Bundle to use when validating SSL certificates. Not used by boto 2 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. Parameters can be found at https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config. 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 aliases: ec2_secret_key, 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.
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
ec2_url aliases: aws_endpoint_url, endpoint_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.
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	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.
region aliases: aws_region, ec2_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
security_token aliases: aws_session_token, session_token, aws_security_token, access_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_session_token and session_token have been added in version 3.2.0.
state string / required	The state of the Direct Connect link aggregation group. Choices: "present" "absent"
validate_certs boolean	When set to “no”, SSL certificates will not be validated for communication with the AWS APIs. 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

• 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

• When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ~/.aws/credentials). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information.

• Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information.

• AWS_REGION or EC2_REGION can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files.

Examples

# create a Direct Connect connection
- community.aws.aws_direct_connect_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": "448830907657", "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