ansible.builtin.aws_direct_connect_link_aggregation_group (v2.4.0.0-1) — module

Manage Direct Connect LAG bundles.

| "added in version" 2.4 of ansible.builtin"

Authors: Sloane Hertel (@s-hertel)

preview | supported by community

Install Ansible via pip

Install with pip install ansible==2.4.0.0.post1

Description

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


Requirements

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.

# create a Direct Connect connection
- aws_direct_connect_link_aggregation_group:
  state: present
  location: EqDC2
  lag_id: dxlag-xxxxxxxx
  bandwidth: 1Gbps

Inputs

    
name:
    description:
    - The name of the Direct Connect link aggregation group.

wait:
    description:
    - 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 C(wait_timeout).
    type: bool

state:
    choices:
    - present
    - absent
    description:
    - The state of the Direct Connect link aggregation group.

location:
    description:
    - The location of the link aggregation group.

bandwidth:
    description:
    - The bandwidth of the link aggregation group.

min_links:
    description:
    - The minimum number of physical connections that must be operational for the LAG
      itself to be operational.

force_delete:
    description:
    - 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.

wait_timeout:
    default: 120
    description:
    - The duration in seconds to wait if I(wait) is True.

connection_id:
    description:
    - A connection ID to link with the link aggregation group upon creation.

num_connections:
    description:
    - The number of connections with which to intialize the link aggregation group.

link_aggregation_group_id:
    description:
    - The ID of the Direct Connect link aggregation group.

delete_with_disassociation:
    description:
    - To be used with I(state=absent) to delete connections after disassociating them
      with the LAG.

Outputs

aws_device:
  description: The AWS Direct Connection endpoint that hosts the LAG.
  returned: when I(state=present)
  sample: EqSe2-1bwfvazist2k0
  type: str
changed:
  description: Whether or not the LAG has changed.
  returned: always
  type: str
connections:
  description: A list of connections bundled by this LAG.
  returned: when I(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
  type: list
connections_bandwidth:
  description: The individual bandwidth of the physical connections bundled by the
    LAG.
  returned: when I(state=present)
  sample: 1Gbps
  type: str
lag_id:
  description: Unique identifier for the link aggregation group.
  returned: when I(state=present)
  sample: dxlag-fgnsp4rq
  type: str
lag_name:
  description: User-provided name for the link aggregation group.
  returned: when I(state=present)
  type: str
lag_state:
  description: State of the LAG.
  returned: when I(state=present)
  sample: pending
  type: str
location:
  description: Where the connection is located.
  returned: when I(state=present)
  sample: EqSe2
  type: str
minimum_links:
  description: The minimum number of physical connections that must be operational
    for the LAG itself to be operational.
  returned: when I(state=present)
  type: int
number_of_connections:
  description: The number of physical connections bundled by the LAG.
  returned: when I(state=present)
  type: int
owner_account:
  description: Owner account ID of the LAG.
  returned: when I(state=present)
  type: str
region:
  description: The region in which the LAG exists.
  returned: when I(state=present)
  type: str