Docs4dev
Docs
ansible / latest / collections / community / aws / aws_direct_connect_virtual_interface_module.html

community.aws.aws_direct_connect_virtual_interface – Manage Direct Connect virtual interfaces

Note

This plugin is part of the community.aws collection (version 1.5.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.

To use it in a playbook, specify: community.aws.aws_direct_connect_virtual_interface.

New in version 1.0.0: of community.aws

Synopsis

  • Create, delete, or modify a Direct Connect public or private virtual interface.

Requirements

The below requirements are needed on the host that executes this module.

  • boto
  • boto3
  • botocore
  • python >= 2.6

Parameters

Parameter Choices/Defaults Comments
address_type
string
The type of IP address for the BGP peer.
amazon_address
string
The amazon address CIDR with which to create the virtual interface.
authentication_key
string
The authentication key for BGP configuration.
aws_access_key
string
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.
If profile is set this parameter is ignored.
Passing the aws_access_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

aliases: ec2_access_key, access_key
aws_ca_bundle
path
The location of a CA Bundle to use when validating SSL certificates.
Only used for boto3 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
aws_config
dictionary
A dictionary to modify the botocore configuration.
Only the 'user_agent' key is used for boto modules. See http://boto.cloudhackers.com/en/latest/boto_config_tut.html#boto for more boto configuration.
aws_secret_key
string
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.
If profile is set this parameter is ignored.
Passing the aws_secret_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

aliases: ec2_secret_key, secret_key
bgp_asn
integer
Default:
65000
The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.
cidr
list / elements=string
A list of route filter prefix CIDRs with which to create the public virtual interface.
customer_address
string
The customer address CIDR with which to create the virtual interface.
debug_botocore_endpoint_logs
boolean
    Choices:
  • no ←
  • yes
Use a botocore.endpoint logger to parse the unique (rather than total) "resource:action" API calls made during a task, outputing the set to the resource_actions key in the task results. Use the aws_resource_action callback to output to total list made during a playbook. The ANSIBLE_DEBUG_BOTOCORE_LOGS environment variable may also be used.
direct_connect_gateway_id
string
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.
ec2_url
string
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.

aliases: aws_endpoint_url, endpoint_url
id_to_associate
string / required
The ID of the link aggregation group or connection to associate with the virtual interface.

aliases: link_aggregation_group_id, connection_id
name
string
The name of the virtual interface.
profile
string
Uses a boto profile. Only works with boto >= 2.24.0.
Using profile will override aws_access_key, aws_secret_key and security_token and support for passing them at the same time as profile has been deprecated.
aws_access_key, aws_secret_key and security_token will be made mutually exclusive with profile after 2022-06-01.

aliases: aws_profile
public
boolean
    Choices:
  • no
  • yes
The type of virtual interface.
region
string
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
string
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
If profile is set this parameter is ignored.
Passing the security_token and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

aliases: aws_security_token, access_token
state
string / required
    Choices:
  • present
  • absent
The desired state of the Direct Connect virtual interface.
validate_certs
boolean
    Choices:
  • no
  • yes ←
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
virtual_gateway_id
string
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.
virtual_interface_id
string
The virtual interface ID.
vlan
integer
Default:
100
The VLAN ID.

Notes

Note

  • If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence AWS_URL or EC2_URL, AWS_PROFILE or AWS_DEFAULT_PROFILE, 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_CA_BUNDLE
  • Ansible uses the boto configuration file (typically ~/.boto) if no credentials are provided. See https://boto.readthedocs.io/en/latest/boto_config_tut.html
  • 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

Examples

---
- name: create an association between a LAG and connection
  community.aws.aws_direct_connect_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.aws_direct_connect_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 Returned Description
address_family
string
always
The address family for the BGP peer.

Sample:
ipv4
amazon_address
string
always
IP address assigned to the Amazon interface.

Sample:
169.254.255.1/30
asn
integer
always
The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.

Sample:
65000
auth_key
string
always
The authentication key for BGP configuration.

Sample:
0xZ59Y1JZ2oDOSh6YriIlyRE
bgp_peers
complex
always
A list of the BGP peers configured on this virtual interface.

address_family
string
always
The address family for the BGP peer.

Sample:
ipv4
amazon_address
string
always
IP address assigned to the Amazon interface.

Sample:
169.254.255.1/30
asn
integer
always
The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.

Sample:
65000
auth_key
string
always
The authentication key for BGP configuration.

Sample:
0xZ59Y1JZ2oDOSh6YriIlyRE
bgp_peer_state
string
always
The state of the BGP peer (verifying, pending, available)

Sample:
available
bgp_status
string
always
The up/down state of the BGP peer.

Sample:
up
customer_address
string
always
IP address assigned to the customer interface.

Sample:
169.254.255.2/30
changed
boolean
always
Indicated if the virtual interface has been created/modified/deleted

connection_id
string
always
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).

Sample:
dxcon-fgb175av
customer_address
string
always
IP address assigned to the customer interface.

Sample:
169.254.255.2/30
customer_router_config
string
always
Information for generating the customer router configuration.

direct_connect_gateway_id
string
when public=False
The ID of the Direct Connect gateway. This only applies to private virtual interfaces.

Sample:
f7593767-eded-44e8-926d-a2234175835d
location
string
always
Where the connection is located.

Sample:
EqDC2
owner_account
string
always
The AWS account that will own the new virtual interface.

Sample:
123456789012
route_filter_prefixes
complex
always
A list of routes to be advertised to the AWS network in this region (public virtual interface).

cidr
string
always
A routes to be advertised to the AWS network in this region.

Sample:
54.227.92.216/30
virtual_gateway_id
string
when public=False
The ID of the virtual private gateway to a VPC. This only applies to private virtual interfaces.

Sample:
vgw-f3ce259a
virtual_interface_id
string
always
The ID of the virtual interface.

Sample:
dxvif-fh0w7cex
virtual_interface_name
string
always
The name of the virtual interface assigned by the customer.

Sample:
test_virtual_interface
virtual_interface_state
string
always
State of the virtual interface (confirming, verifying, pending, available, down, rejected).

Sample:
available
virtual_interface_type
string
always
The type of virtual interface (private, public).

Sample:
private
vlan
integer
always
The VLAN ID.

Sample:
100


Authors

  • Sloane Hertel (@s-hertel)

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/community/aws/aws_direct_connect_virtual_interface_module.html