community.aws.directconnect_virtual_interface module – Manage Direct Connect virtual interfaces
Note
This module is part of the community.aws collection (version 7.2.0).
You might already have this collection installed if you are using the ansible package.
It is not included in ansible-core.
To check whether it is installed, run ansible-galaxy collection list.
To install it, use: ansible-galaxy collection install community.aws.
You need further requirements to be able to use this module,
see Requirements for details.
To use it in a playbook, specify: community.aws.directconnect_virtual_interface.
New in community.aws 1.0.0
Synopsis
Create, delete, or modify a Direct Connect public or private virtual interface.
Prior to release 5.0.0 this module was called
community.aws.aws_direct_connect_virtual_interface. The usage did not change.
Aliases: aws_direct_connect_virtual_interface
Requirements
The below requirements are needed on the host that executes this module.
python >= 3.6
boto3 >= 1.26.0
botocore >= 1.29.0
Parameters
Parameter |
Comments |
|---|---|
AWS access key ID. See the AWS documentation for more information about access tokens https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys. The The aws_access_key and profile options are mutually exclusive. The aws_access_key_id alias was added in release 5.1.0 for consistency with the AWS botocore SDK. The ec2_access_key alias has been deprecated and will be removed in a release after 2024-12-01. Support for the |
|
The type of IP address for the BGP peer. |
|
The amazon address CIDR with which to create the virtual interface. |
|
The authentication key for BGP configuration. |
|
The location of a CA Bundle to use when validating SSL certificates. The |
|
A dictionary to modify the botocore configuration. Parameters can be found in the AWS documentation https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config. |
|
The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration. Default: |
|
A list of route filter prefix CIDRs with which to create the public virtual interface. |
|
The customer address CIDR with which to create the virtual interface. |
|
Use a The Choices:
|
|
The direct connect gateway ID for creating a private virtual interface. To create a private virtual interface virtual_gateway_id or direct_connect_gateway_id is required. These options are mutually exclusive. |
|
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 The ec2_url and s3_url aliases have been deprecated and will be removed in a release after 2024-12-01. Support for the |
|
The ID of the link aggregation group or connection to associate with the virtual interface. |
|
The name of the virtual interface. |
|
A named AWS profile to use for authentication. See the AWS documentation for more information about named profiles https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-profiles.html. The The profile option is mutually exclusive with the aws_access_key, aws_secret_key and security_token options. |
|
The type of virtual interface. Choices:
|
|
The AWS region to use. For global services such as IAM, Route53 and CloudFront, region is ignored. The See the Amazon AWS documentation for more information http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region. The Support for the |
|
AWS secret access key. See the AWS documentation for more information about access tokens https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys. The The secret_key and profile options are mutually exclusive. The aws_secret_access_key alias was added in release 5.1.0 for consistency with the AWS botocore SDK. The ec2_secret_key alias has been deprecated and will be removed in a release after 2024-12-01. Support for the |
|
AWS STS session token for use with temporary credentials. See the AWS documentation for more information about access tokens https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys. The The security_token and profile options are mutually exclusive. Aliases aws_session_token and session_token were added in release 3.2.0, with the parameter being renamed from security_token to session_token in release 6.0.0. The security_token, aws_security_token, and access_token aliases have been deprecated and will be removed in a release after 2024-12-01. Support for the |
|
The desired state of the Direct Connect virtual interface. Choices:
|
|
When set to Setting validate_certs=false is strongly discouraged, as an alternative, consider setting aws_ca_bundle instead. Choices:
|
|
The virtual gateway ID required for creating a private virtual interface. To create a private virtual interface virtual_gateway_id or direct_connect_gateway_id is required. These options are mutually exclusive. |
|
The virtual interface ID. |
|
The VLAN ID. Default: |
Notes
Note
Caution: For modules, environment variables and configuration files are read from the Ansible ‘host’ context and not the ‘controller’ context. As such, files may need to be explicitly copied to the ‘host’. For lookup and connection plugins, environment variables and configuration files are read from the Ansible ‘controller’ context and not the ‘host’ context.
The AWS SDK (boto3) that Ansible uses may also read defaults for credentials and other settings, such as the region, from its configuration files in the Ansible ‘host’ context (typically
~/.aws/credentials). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information.
Examples
---
- name: create an association between a LAG and connection
community.aws.directconnect_virtual_interface:
state: present
name: "{{ name }}"
link_aggregation_group_id: LAG-XXXXXXXX
connection_id: dxcon-XXXXXXXX
- name: remove an association between a connection and virtual interface
community.aws.directconnect_virtual_interface:
state: absent
connection_id: dxcon-XXXXXXXX
virtual_interface_id: dxv-XXXXXXXX
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
|---|---|
The address family for the BGP peer. Returned: always Sample: |
|
IP address assigned to the Amazon interface. Returned: always Sample: |
|
The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration. Returned: always Sample: |
|
The authentication key for BGP configuration. Returned: always Sample: |
|
A list of the BGP peers configured on this virtual interface. Returned: always |
|
The address family for the BGP peer. Returned: always Sample: |
|
IP address assigned to the Amazon interface. Returned: always Sample: |
|
The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration. Returned: always Sample: |
|
The authentication key for BGP configuration. Returned: always Sample: |
|
The state of the BGP peer (verifying, pending, available) Returned: always Sample: |
|
The up/down state of the BGP peer. Returned: always Sample: |
|
IP address assigned to the customer interface. Returned: always Sample: |
|
Indicated if the virtual interface has been created/modified/deleted Returned: always Sample: |
|
The ID of the connection. This field is also used as the ID type for operations that use multiple connection types (LAG, interconnect, and/or connection). Returned: always Sample: |
|
IP address assigned to the customer interface. Returned: always Sample: |
|
Information for generating the customer router configuration. Returned: always |
|
The ID of the Direct Connect gateway. This only applies to private virtual interfaces. Returned: when public=False Sample: |
|
Where the connection is located. Returned: always Sample: |
|
The AWS account that will own the new virtual interface. Returned: always Sample: |
|
A list of routes to be advertised to the AWS network in this region (public virtual interface). Returned: always |
|
A routes to be advertised to the AWS network in this region. Returned: always Sample: |
|
The ID of the virtual private gateway to a VPC. This only applies to private virtual interfaces. Returned: when public=False Sample: |
|
The ID of the virtual interface. Returned: always Sample: |
|
The name of the virtual interface assigned by the customer. Returned: always Sample: |
|
State of the virtual interface (confirming, verifying, pending, available, down, rejected). Returned: always Sample: |
|
The type of virtual interface (private, public). Returned: always Sample: |
|
The VLAN ID. Returned: always Sample: |