ansible / ansible.builtin / v2.9.17 / module / aws_direct_connect_virtual_interface Manage Direct Connect virtual interfaces. | "added in version" 2.5 of ansible.builtin" Authors: Sloane Hertel (@s-hertel) preview | supported by communityansible.builtin.aws_direct_connect_virtual_interface (v2.9.17) — module
pip
Install with pip install ansible==2.9.17
Create, delete, or modify a Direct Connect public or private virtual interface.
--- - 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
cidr: description: - A list of route filter prefix CIDRs with which to create the public virtual interface. name: description: - The name of the virtual interface. vlan: default: 100 description: - The VLAN ID. state: choices: - present - absent description: - The desired state of the Direct Connect virtual interface. public: description: - The type of virtual interface. type: bool region: aliases: - aws_region - ec2_region description: - 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 U(http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region) type: str bgp_asn: default: 65000 description: - The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration. ec2_url: aliases: - aws_endpoint_url - endpoint_url description: - 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. type: str profile: aliases: - aws_profile description: - Using I(profile) will override I(aws_access_key), I(aws_secret_key) and I(security_token) and support for passing them at the same time as I(profile) has been deprecated. - I(aws_access_key), I(aws_secret_key) and I(security_token) will be made mutually exclusive with I(profile) after 2022-06-01. type: str aws_config: description: - A dictionary to modify the botocore configuration. - Parameters can be found at U(https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config). - Only the 'user_agent' key is used for boto modules. See U(http://boto.cloudhackers.com/en/latest/boto_config_tut.html#boto) for more boto configuration. type: dict address_type: description: - The type of IP address for the BGP peer. aws_ca_bundle: description: - The location of a CA Bundle to use when validating SSL certificates. - Not used by boto 2 based modules. - 'Note: The CA Bundle is read ''module'' side and may need to be explicitly copied from the controller if not run locally.' type: path amazon_address: description: - The amazon address CIDR with which to create the virtual interface. aws_access_key: aliases: - ec2_access_key - access_key description: - C(AWS access key). If not set then the value of the C(AWS_ACCESS_KEY_ID), C(AWS_ACCESS_KEY) or C(EC2_ACCESS_KEY) environment variable is used. - If I(profile) is set this parameter is ignored. - Passing the I(aws_access_key) and I(profile) options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01. type: str aws_secret_key: aliases: - ec2_secret_key - secret_key description: - C(AWS secret key). If not set then the value of the C(AWS_SECRET_ACCESS_KEY), C(AWS_SECRET_KEY), or C(EC2_SECRET_KEY) environment variable is used. - If I(profile) is set this parameter is ignored. - Passing the I(aws_secret_key) and I(profile) options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01. type: str security_token: aliases: - aws_security_token - access_token description: - C(AWS STS security token). If not set then the value of the C(AWS_SECURITY_TOKEN) or C(EC2_SECURITY_TOKEN) environment variable is used. - If I(profile) is set this parameter is ignored. - Passing the I(security_token) and I(profile) options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01. type: str validate_certs: default: true description: - When set to "no", SSL certificates will not be validated for communication with the AWS APIs. type: bool id_to_associate: aliases: - link_aggregation_group_id - connection_id description: - The ID of the link aggregation group or connection to associate with the virtual interface. customer_address: description: - The customer address CIDR with which to create the virtual interface. authentication_key: description: - The authentication key for BGP configuration. virtual_gateway_id: description: - The virtual gateway ID required for creating a private virtual interface. virtual_interface_id: description: - The virtual interface ID. debug_botocore_endpoint_logs: default: 'no' description: - 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. type: bool
address_family: description: The address family for the BGP peer. returned: always sample: ipv4 type: str amazon_address: description: IP address assigned to the Amazon interface. returned: always sample: 169.254.255.1/30 type: str asn: description: The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration. returned: always sample: 65000 type: int auth_key: description: The authentication key for BGP configuration. returned: always sample: 0xZ59Y1JZ2oDOSh6YriIlyRE type: str bgp_peers: contains: address_family: description: The address family for the BGP peer. returned: always sample: ipv4 type: str amazon_address: description: IP address assigned to the Amazon interface. returned: always sample: 169.254.255.1/30 type: str asn: description: The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration. returned: always sample: 65000 type: int auth_key: description: The authentication key for BGP configuration. returned: always sample: 0xZ59Y1JZ2oDOSh6YriIlyRE type: str bgp_peer_state: description: The state of the BGP peer (verifying, pending, available) returned: always sample: available type: str bgp_status: description: The up/down state of the BGP peer. returned: always sample: up type: str customer_address: description: IP address assigned to the customer interface. returned: always sample: 169.254.255.2/30 type: str description: A list of the BGP peers configured on this virtual interface. returned: always type: complex changed: description: Indicated if the virtual interface has been created/modified/deleted returned: always sample: false type: bool connection_id: description: - 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: dxcon-fgb175av type: str customer_address: description: IP address assigned to the customer interface. returned: always sample: 169.254.255.2/30 type: str customer_router_config: description: Information for generating the customer router configuration. returned: always type: str location: description: Where the connection is located. returned: always sample: EqDC2 type: str owner_account: description: The AWS account that will own the new virtual interface. returned: always sample: '123456789012' type: str route_filter_prefixes: contains: cidr: description: A routes to be advertised to the AWS network in this region. returned: always sample: 54.227.92.216/30 type: str description: A list of routes to be advertised to the AWS network in this region (public virtual interface). returned: always type: complex virtual_gateway_id: description: The ID of the virtual private gateway to a VPC. This only applies to private virtual interfaces. returned: when I(public=False) sample: vgw-f3ce259a type: str virtual_interface_id: description: The ID of the virtual interface. returned: always sample: dxvif-fh0w7cex type: str virtual_interface_name: description: The name of the virtual interface assigned by the customer. returned: always sample: test_virtual_interface type: str virtual_interface_state: description: State of the virtual interface (confirming, verifying, pending, available, down, rejected). returned: always sample: available type: str virtual_interface_type: description: The type of virtual interface (private, public). returned: always sample: private type: str vlan: description: The VLAN ID. returned: always sample: 100 type: int