New in version 2.4.
- boto3
- botocore
| parameter | required | default | choices | comments |
|---|---|---|---|---|
| bandwidth |
no |
The bandwidth of the link aggregation group.
|
||
| connection_id |
no |
A connection ID to link with the link aggregation group upon creation.
|
||
| delete_with_disassociation |
no |
To be used with state=absent to delete connections after disassociating them with the LAG.
|
||
| force_delete |
no |
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 |
no |
The ID of the Direct Connect link aggregation group.
|
||
| location |
no |
The location of the link aggregation group.
|
||
| min_links |
no |
The minimum number of physical connections that must be operational for the LAG itself to be operational.
|
||
| name |
no |
The name of the Direct Connect link aggregation group.
|
||
| num_connections |
no |
The number of connections with which to intialize the link aggregation group.
|
||
| state |
no |
|
The state of the Direct Connect link aggregation group.
|
|
| wait |
no |
|
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 |
no | 120 |
The duration in seconds to wait if wait is True.
|
# 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 Return Values, the following are the fields unique to this module:
| name | description | returned | type | sample |
|---|---|---|---|---|
| connections |
A list of connections bundled by this LAG.
|
when I(state=present) | list | {'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'}]} |
| aws_device |
The AWS Direct Connection endpoint that hosts the LAG.
|
when I(state=present) | str | EqSe2-1bwfvazist2k0 |
| changed |
Whether or not the LAG has changed.
|
always | str | |
| region |
The region in which the LAG exists.
|
when I(state=present) | str | |
| lag_state |
State of the LAG.
|
when I(state=present) | str | pending |
| connections_bandwidth |
The individual bandwidth of the physical connections bundled by the LAG.
|
when I(state=present) | str | 1Gbps |
| owner_account |
Owner account ID of the LAG.
|
when I(state=present) | str | |
| minimum_links |
The minimum number of physical connections that must be operational for the LAG itself to be operational.
|
when I(state=present) | int | |
| location |
Where the connection is located.
|
when I(state=present) | str | EqSe2 |
| lag_id |
Unique identifier for the link aggregation group.
|
when I(state=present) | str | dxlag-fgnsp4rq |
| lag_name |
User-provided name for the link aggregation group.
|
when I(state=present) | str | |
| number_of_connections |
The number of physical connections bundled by the LAG.
|
when I(state=present) | int |
This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.
For help in developing on modules, should you be so inclined, please read Community Information & Contributing, Testing Ansible and Developing Modules.