New in version 2.4.
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 | |
bandwidth | The bandwidth of the link aggregation group. | |
connection_id | A connection ID to link with the link aggregation group upon creation. | |
delete_with_disassociation | To be used with state=absent to delete connections after disassociating them with the LAG. | |
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. | |
force_delete | 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 | The ID of the Direct Connect link aggregation group. | |
location | The location of the link aggregation group. | |
min_links | The minimum number of physical connections that must be operational for the LAG itself to be operational. | |
name | The name of the Direct Connect link aggregation group. | |
num_connections | The number of connections with which to intialize the link aggregation group. | |
profile (added in 1.6) | Uses a boto profile. Only works with boto >= 2.24.0. | |
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 | |
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 |
| The state of the Direct Connect link aggregation group. |
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 operation to complete. May be useful when waiting for virtual interfaces to be deleted. May modify the time of waiting with wait_timeout . |
wait_timeout | Default: 120 | The duration in seconds to wait if wait is True. |
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# create a Direct Connect connection - aws_direct_connect_link_aggregation_group: state: present location: EqDC2 lag_id: dxlag-xxxxxxxx bandwidth: 1Gbps
Common return values are documented here, the following are the fields unique to this module:
Key | Returned | Description |
---|---|---|
aws_device str | when state=present | The AWS Direct Connection endpoint that hosts the LAG. Sample: EqSe2-1bwfvazist2k0 |
changed str | always | Whether or not the LAG has changed. |
connections list | when state=present | A list of connections bundled by this LAG. Sample: {'connections': [{'aws_device': 'EqSe2-1bwfvazist2k0', 'region': 'us-west-2', 'connection_state': 'down', 'connection_name': 'Requested Connection 1 for Lag dxlag-fgtoh97h', 'owner_account': '448830907657', 'connection_id': 'dxcon-fgzjah5a', 'bandwidth': '1Gbps', 'location': 'EqSe2', 'lag_id': 'dxlag-fgnsp4rq'}]} |
connections_bandwidth str | when state=present | The individual bandwidth of the physical connections bundled by the LAG. Sample: 1Gbps |
lag_id str | when state=present | Unique identifier for the link aggregation group. Sample: dxlag-fgnsp4rq |
lag_name str | when state=present | User-provided name for the link aggregation group. |
lag_state str | when state=present | State of the LAG. Sample: pending |
location str | when state=present | Where the connection is located. Sample: EqSe2 |
minimum_links int | when state=present | The minimum number of physical connections that must be operational for the LAG itself to be operational. |
number_of_connections int | when state=present | The number of physical connections bundled by the LAG. |
owner_account str | when state=present | Owner account ID of the LAG. |
region str | when state=present | The region in which the LAG exists. |
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/aws_direct_connect_link_aggregation_group_module.html