aws_direct_connect_virtual_interface – Manage Direct Connect virtual interfaces¶
New in version 2.5.
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 
                    -
                                                                 | 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 
                    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. aliases: ec2_access_key, access_key | |
| 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. 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. | |
| debug_botocore_endpoint_logs 
                    boolean
                                                                 added in 2.8 | 
 | 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. | 
| 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. | |
| id_to_associate 
                    -
                                                                 | The ID of the link aggregation group or connection to associate with the virtual interface. aliases: link_aggregation_group_id, connection_id | |
| name 
                    -
                                                                 | The name of the virtual interface. | |
| profile 
                    string
                                                                 | Uses a boto profile. Only works with boto >= 2.24.0. | |
| public 
                    boolean
                                                                 | 
 | 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. aliases: access_token | |
| state 
                    -
                                                                 | 
 | The desired state of the Direct Connect virtual interface. | 
| validate_certs 
                    boolean
                                                                 | 
 | 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. | 
Notes¶
Note
- If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence AWS_URLorEC2_URL,AWS_ACCESS_KEY_IDorAWS_ACCESS_KEYorEC2_ACCESS_KEY,AWS_SECRET_ACCESS_KEYorAWS_SECRET_KEYorEC2_SECRET_KEY,AWS_SECURITY_TOKENorEC2_SECURITY_TOKEN,AWS_REGIONorEC2_REGION
- 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_REGIONor- EC2_REGIONcan 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
  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
Return Values¶
Common return values are documented here, the following are the fields unique to this module:
Status¶
- This module is not guaranteed to have a backwards compatible interface. [preview]
- This module is maintained by the Ansible Community. [community]
Authors¶
- Sloane Hertel (@s-hertel)
Hint
If you notice any issues in this documentation, you can edit this document to improve it.
