community / community.aws / 5.1.0 / module / directconnect_virtual_interface Manage Direct Connect virtual interfaces | "added in version" 1.0.0 of community.aws" Authors: Sloane Hertel (@s-hertel)community.aws.directconnect_virtual_interface (5.1.0) — module
Install with ansible-galaxy collection install community.aws:==5.1.0
collections: - name: community.aws version: 5.1.0
Create, delete, or modify a Direct Connect public or private virtual interface.
Prior to release 5.0.0 this module was called C(community.aws.aws_direct_connect_virtual_interface). The usage did not change.
--- - 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
cidr: description: - A list of route filter prefix CIDRs with which to create the public virtual interface. elements: str type: list name: description: - The name of the virtual interface. type: str vlan: default: 100 description: - The VLAN ID. type: int state: choices: - present - absent description: - The desired state of the Direct Connect virtual interface. required: true type: str public: description: - The type of virtual interface. type: bool region: aliases: - aws_region - ec2_region description: - The AWS region to use. - For global services such as IAM, Route53 and CloudFront, I(region) is ignored. - The C(AWS_REGION) or C(EC2_REGION) environment variables may also be used. - See the Amazon AWS documentation for more information U(http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region). - The C(ec2_region) alias has been deprecated and will be removed in a release after 2024-12-01 - Support for the C(EC2_REGION) environment variable has been deprecated and will be removed in a release after 2024-12-01. type: str bgp_asn: default: 65000 description: - The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration. type: int profile: aliases: - aws_profile description: - A named AWS profile to use for authentication. - See the AWS documentation for more information about named profiles U(https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-profiles.html). - The C(AWS_PROFILE) environment variable may also be used. - The I(profile) option is mutually exclusive with the I(aws_access_key), I(aws_secret_key) and I(security_token) options. type: str access_key: aliases: - aws_access_key_id - aws_access_key - ec2_access_key description: - AWS access key ID. - See the AWS documentation for more information about access tokens U(https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys). - The C(AWS_ACCESS_KEY_ID), C(AWS_ACCESS_KEY) or C(EC2_ACCESS_KEY) environment variables may also be used in decreasing order of preference. - The I(aws_access_key) and I(profile) options are mutually exclusive. - The I(aws_access_key_id) alias was added in release 5.1.0 for consistency with the AWS botocore SDK. - The I(ec2_access_key) alias has been deprecated and will be removed in a release after 2024-12-01. - Support for the C(EC2_ACCESS_KEY) environment variable has been deprecated and will be removed in a release after 2024-12-01. type: str aws_config: description: - A dictionary to modify the botocore configuration. - Parameters can be found in the AWS documentation U(https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config). type: dict secret_key: aliases: - aws_secret_access_key - aws_secret_key - ec2_secret_key description: - AWS secret access key. - See the AWS documentation for more information about access tokens U(https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys). - The C(AWS_SECRET_ACCESS_KEY), C(AWS_SECRET_KEY), or C(EC2_SECRET_KEY) environment variables may also be used in decreasing order of preference. - The I(secret_key) and I(profile) options are mutually exclusive. - The I(aws_secret_access_key) alias was added in release 5.1.0 for consistency with the AWS botocore SDK. - The I(ec2_secret_key) alias has been deprecated and will be removed in a release after 2024-12-01. - Support for the C(EC2_SECRET_KEY) environment variable has been deprecated and will be removed in a release after 2024-12-01. type: str address_type: description: - The type of IP address for the BGP peer. type: str endpoint_url: aliases: - ec2_url - aws_endpoint_url - s3_url description: - 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 C(AWS_URL) or C(EC2_URL) environment variables may also be used, in decreasing order of preference. - The I(ec2_url) and I(s3_url) aliases have been deprecated and will be removed in a release after 2024-12-01. - Support for the C(EC2_URL) environment variable has been deprecated and will be removed in a release after 2024-12-01. type: str aws_ca_bundle: description: - The location of a CA Bundle to use when validating SSL certificates. - The C(AWS_CA_BUNDLE) environment variable may also be used. type: path session_token: aliases: - aws_session_token - security_token - aws_security_token - access_token description: - AWS STS session token for use with temporary credentials. - See the AWS documentation for more information about access tokens U(https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys). - The C(AWS_SESSION_TOKEN), C(AWS_SECURITY_TOKEN) or C(EC2_SECURITY_TOKEN) environment variables may also be used in decreasing order of preference. - The I(security_token) and I(profile) options are mutually exclusive. - Aliases I(aws_session_token) and I(session_token) were added in release 3.2.0, with the parameter being renamed from I(security_token) to I(session_token) in release 6.0.0. - The I(security_token), I(aws_security_token), and I(access_token) aliases have been deprecated and will be removed in a release after 2024-12-01. - Support for the C(EC2_SECRET_KEY) and C(AWS_SECURITY_TOKEN) environment variables has been deprecated and will be removed in a release after 2024-12-01. type: str amazon_address: description: - The amazon address CIDR with which to create the virtual interface. type: str validate_certs: default: true description: - When set to C(false), SSL certificates will not be validated for communication with the AWS APIs. - Setting I(validate_certs=false) is strongly discouraged, as an alternative, consider setting I(aws_ca_bundle) instead. 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. required: true type: str customer_address: description: - The customer address CIDR with which to create the virtual interface. type: str authentication_key: description: - The authentication key for BGP configuration. type: str virtual_gateway_id: description: - The virtual gateway ID required for creating a private virtual interface. - To create a private virtual interface I(virtual_gateway_id) or I(direct_connect_gateway_id) is required. These options are mutually exclusive. type: str virtual_interface_id: description: - The virtual interface ID. type: str direct_connect_gateway_id: description: - The direct connect gateway ID for creating a private virtual interface. - To create a private virtual interface I(virtual_gateway_id) or I(direct_connect_gateway_id) is required. These options are mutually exclusive. type: str debug_botocore_endpoint_logs: default: false description: - Use a C(botocore.endpoint) logger to parse the unique (rather than total) C("resource:action") API calls made during a task, outputing the set to the resource_actions key in the task results. Use the C(aws_resource_action) callback to output to total list made during a playbook. - The C(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 direct_connect_gateway_id: description: The ID of the Direct Connect gateway. This only applies to private virtual interfaces. returned: when I(public=False) sample: f7593767-eded-44e8-926d-a2234175835d 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