New in version 2.5.
The below requirements are needed on the host that executes this module.
| Parameter | Choices/Defaults | Comments |
|---|---|---|
| address_type |
The type of IP address for the BGP peer.
|
|
| amazon_address |
The amazon address CIDR with which to create the virtual interface.
|
|
| authentication_key |
The authentication key for BGP configuration.
|
|
| aws_access_key |
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.
aliases: ec2_access_key, access_key |
|
| aws_secret_key |
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.
aliases: ec2_secret_key, secret_key |
|
| bgp_asn |
Default: 65000
|
The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.
|
| cidr |
A list of route filter prefix CIDRs with which to create the public virtual interface.
|
|
| customer_address |
The customer address CIDR with which to create the virtual interface.
|
|
| ec2_url |
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.
|
|
| id_to_associate |
The ID of the link aggrecation group or connection to associate with the virtual interface.
aliases: link_aggregation_group_id, connection_id |
|
| name |
The name of the virtual interface.
|
|
|
profile
(added in 1.6) |
Uses a boto profile. Only works with boto >= 2.24.0.
|
|
|
public
bool |
|
The type of virtual interface.
|
| region |
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
(added in 1.6) |
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
aliases: access_token |
|
| state |
|
The desired state of the Direct Connect virtual interface.
|
|
validate_certs
bool (added in 1.5) |
|
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
|
| virtual_gateway_id |
The virtual gateway ID required for creating a private virtual interface.
|
|
| virtual_interface_id |
The virtual interface ID.
|
|
| vlan |
Default: 100
|
The VLAN ID.
|
Note
AWS_URL or EC2_URL, 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_REGIONAWS_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---
- name: create an association between a LAG and connection
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
aws_direct_connect_virtual_interface:
state: absent
connection_id: dxcon-XXXXXXXX
virtual_interface_id: dxv-XXXXXXXX
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
int
|
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.
|
|
|
customer_address
string
|
always |
IP address assigned to the customer interface.
Sample:
169.254.255.2/30
|
|
|
amazon_address
string
|
always |
IP address assigned to the Amazon interface.
Sample:
169.254.255.1/30
|
|
|
address_family
string
|
always |
The address family for the BGP peer.
Sample:
ipv4
|
|
|
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
|
|
|
asn
int
|
always |
The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.
Sample:
65000
|
|
|
bgp_status
string
|
always |
The up/down state of the BGP peer.
Sample:
up
|
|
|
changed
bool
|
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.
|
|
|
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
int
|
always |
The VLAN ID.
Sample:
100
|
|
This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.
This module is flagged as community which means that it is maintained by the Ansible Community. See Module Maintenance & Support for more info.
For a list of other modules that are also maintained by the Ansible Community, see here.
Hint
If you notice any issues in this documentation you can edit this document to improve it.