W3cubDocs

/Ansible 2.11

community.aws.aws_direct_connect_link_aggregation_group – Manage Direct Connect LAG bundles

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.aws_direct_connect_link_aggregation_group.

New in version 1.0.0: of community.aws

Synopsis

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

Requirements

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

  • boto
  • boto3
  • botocore
  • 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
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
    Choices:
  • 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.
delete_with_disassociation
boolean
    Choices:
  • no ←
  • yes
To be used with state=absent to delete connections after disassociating them with the LAG.
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
force_delete
boolean
    Choices:
  • no ←
  • yes
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.
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
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
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
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 / required
    Choices:
  • present
  • absent
The state of the Direct Connect link aggregation group.
validate_certs
boolean
    Choices:
  • no
  • yes ←
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
wait
boolean
    Choices:
  • no ←
  • yes
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.
wait_timeout
integer
Default:
120
The duration in seconds to wait if wait=true.

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
  • 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

# 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 Returned Description
aws_device
string
when state=present
The AWS Direct Connection endpoint that hosts the LAG.

Sample:
EqSe2-1bwfvazist2k0
changed
string
always
Whether or not the LAG has changed.
connections
list / elements=string
when state=present
A list of connections bundled by this LAG.

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
when state=present
The individual bandwidth of the physical connections bundled by the LAG.

Sample:
1Gbps
lag_id
string
when state=present
Unique identifier for the link aggregation group.

Sample:
dxlag-fgnsp4rq
lag_name
string
when state=present
User-provided name for the link aggregation group.
lag_state
string
when state=present
State of the LAG.

Sample:
pending
location
string
when state=present
Where the connection is located.

Sample:
EqSe2
minimum_links
integer
when state=present
The minimum number of physical connections that must be operational for the LAG itself to be operational.
number_of_connections
integer
when state=present
The number of physical connections bundled by the LAG.
owner_account
string
when state=present
Owner account ID of the LAG.
region
string
when state=present
The region in which the LAG exists.


Authors

  • Sloane Hertel (@s-hertel)

© 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/aws_direct_connect_link_aggregation_group_module.html