Try SpotterManage Direct Connect LAG bundles
| "added in version" 1.0.0 of community.aws"
Authors: Sloane Hertel (@s-hertel)
Install with ansible-galaxy collection install community.aws:==2.6.1
collections:
- name: community.aws
version: 2.6.1Create, delete, or modify a Direct Connect link aggregation group.
# create a Direct Connect connection - community.aws.aws_direct_connect_link_aggregation_group: state: present location: EqDC2 lag_id: dxlag-xxxxxxxx bandwidth: 1Gbps
name:
description:
- The name of the Direct Connect link aggregation group.
type: str
wait:
default: false
description:
- 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 I(wait_timeout).
type: bool
state:
choices:
- present
- absent
description:
- The state of the Direct Connect link aggregation group.
required: true
type: str
region:
aliases:
- aws_region
- ec2_region
description:
- The AWS region to use.
- For global services such as IAM, Route53 and CloudFront, I(region) is ignored.
- The C(AWS_REGION) or C(EC2_REGION) environment variables may also be used.
- See the Amazon AWS documentation for more information U(http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region).
- The C(ec2_region) alias has been deprecated and will be removed in a release after
2024-12-01
- Support for the C(EC2_REGION) environment variable has been deprecated and will
be removed in a release after 2024-12-01.
type: str
profile:
aliases:
- aws_profile
description:
- A named AWS profile to use for authentication.
- See the AWS documentation for more information about named profiles U(https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-profiles.html).
- The C(AWS_PROFILE) environment variable may also be used.
- The I(profile) option is mutually exclusive with the I(aws_access_key), I(aws_secret_key)
and I(security_token) options.
type: str
location:
description:
- The location of the link aggregation group.
type: str
bandwidth:
description:
- The bandwidth of the link aggregation group.
type: str
min_links:
description:
- The minimum number of physical connections that must be operational for the LAG
itself to be operational.
type: int
access_key:
aliases:
- aws_access_key_id
- aws_access_key
- ec2_access_key
description:
- AWS access key ID.
- See the AWS documentation for more information about access tokens U(https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys).
- The C(AWS_ACCESS_KEY_ID), C(AWS_ACCESS_KEY) or C(EC2_ACCESS_KEY) environment variables
may also be used in decreasing order of preference.
- The I(aws_access_key) and I(profile) options are mutually exclusive.
- The I(aws_access_key_id) alias was added in release 5.1.0 for consistency with the
AWS botocore SDK.
- The I(ec2_access_key) alias has been deprecated and will be removed in a release
after 2024-12-01.
- Support for the C(EC2_ACCESS_KEY) environment variable has been deprecated and will
be removed in a release after 2024-12-01.
type: str
aws_config:
description:
- A dictionary to modify the botocore configuration.
- Parameters can be found in the AWS documentation U(https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config).
type: dict
secret_key:
aliases:
- aws_secret_access_key
- aws_secret_key
- ec2_secret_key
description:
- AWS secret access key.
- See the AWS documentation for more information about access tokens U(https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys).
- The C(AWS_SECRET_ACCESS_KEY), C(AWS_SECRET_KEY), or C(EC2_SECRET_KEY) environment
variables may also be used in decreasing order of preference.
- The I(secret_key) and I(profile) options are mutually exclusive.
- The I(aws_secret_access_key) alias was added in release 5.1.0 for consistency with
the AWS botocore SDK.
- The I(ec2_secret_key) alias has been deprecated and will be removed in a release
after 2024-12-01.
- Support for the C(EC2_SECRET_KEY) environment variable has been deprecated and will
be removed in a release after 2024-12-01.
type: str
endpoint_url:
aliases:
- ec2_url
- aws_endpoint_url
- s3_url
description:
- URL to connect to instead of the default AWS endpoints. While this can be used
to connection to other AWS-compatible services the amazon.aws and community.aws
collections are only tested against AWS.
- The C(AWS_URL) or C(EC2_URL) environment variables may also be used, in decreasing
order of preference.
- The I(ec2_url) and I(s3_url) aliases have been deprecated and will be removed in
a release after 2024-12-01.
- Support for the C(EC2_URL) environment variable has been deprecated and will be
removed in a release after 2024-12-01.
type: str
force_delete:
default: false
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.
type: bool
wait_timeout:
default: 120
description:
- The duration in seconds to wait if I(wait=true).
type: int
aws_ca_bundle:
description:
- The location of a CA Bundle to use when validating SSL certificates.
- The C(AWS_CA_BUNDLE) environment variable may also be used.
type: path
connection_id:
description:
- A connection ID to link with the link aggregation group upon creation.
type: str
session_token:
aliases:
- aws_session_token
- security_token
- aws_security_token
- access_token
description:
- AWS STS session token for use with temporary credentials.
- See the AWS documentation for more information about access tokens U(https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys).
- The C(AWS_SESSION_TOKEN), C(AWS_SECURITY_TOKEN) or C(EC2_SECURITY_TOKEN) environment
variables may also be used in decreasing order of preference.
- The I(security_token) and I(profile) options are mutually exclusive.
- Aliases I(aws_session_token) and I(session_token) were added in release 3.2.0, with
the parameter being renamed from I(security_token) to I(session_token) in release
6.0.0.
- The I(security_token), I(aws_security_token), and I(access_token) aliases have been
deprecated and will be removed in a release after 2024-12-01.
- Support for the C(EC2_SECRET_KEY) and C(AWS_SECURITY_TOKEN) environment variables
has been deprecated and will be removed in a release after 2024-12-01.
type: str
validate_certs:
default: true
description:
- When set to C(false), SSL certificates will not be validated for communication with
the AWS APIs.
- Setting I(validate_certs=false) is strongly discouraged, as an alternative, consider
setting I(aws_ca_bundle) instead.
type: bool
num_connections:
description:
- The number of connections with which to initialize the link aggregation group.
type: int
link_aggregation_group_id:
description:
- The ID of the Direct Connect link aggregation group.
type: str
delete_with_disassociation:
default: false
description:
- To be used with I(state=absent) to delete connections after disassociating them
with the LAG.
type: bool
debug_botocore_endpoint_logs:
default: false
description:
- Use a C(botocore.endpoint) logger to parse the unique (rather than total) C("resource:action")
API calls made during a task, outputing the set to the resource_actions key in the
task results. Use the C(aws_resource_action) callback to output to total list made
during a playbook.
- The C(ANSIBLE_DEBUG_BOTOCORE_LOGS) environment variable may also be used.
type: bool
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