ansible / ansible.builtin / v2.9.17 / module / ec2_transit_gateway_info Gather information about ec2 transit gateways in AWS | "added in version" 2.8 of ansible.builtin" Authors: Bob Boldin (@BobBoldin) preview | supported by communityansible.builtin.ec2_transit_gateway_info (v2.9.17) — module
pip
Install with pip install ansible==2.9.17
Gather information about ec2 transit gateways in AWS
# Note: These examples do not set authentication details, see the AWS Guide for details. # Gather info about all transit gateways - ec2_transit_gateway_info:
# Gather info about a particular transit gateway using filter transit gateway ID - ec2_transit_gateway_info: filters: transit-gateway-id: tgw-02c42332e6b7da829
# Gather info about a particular transit gateway using multiple option filters - ec2_transit_gateway_info: filters: options.dns-support: enable options.vpn-ecmp-support: enable
# Gather info about multiple transit gateways using module param - ec2_transit_gateway_info: transit_gateway_ids: - tgw-02c42332e6b7da829 - tgw-03c53443d5a8cb716
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 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 filters: description: - A dict of filters to apply. Each dict item consists of a filter key and a filter value. See U(https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeTransitGateways.html) for filters. type: dict 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 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 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 transit_gateway_ids: aliases: - transit_gateway_id description: - A list of transit gateway IDs to gather information for. type: list version_added: '2.8' version_added_collection: ansible.builtin 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
transit_gateways: contains: creation_time: description: The creation time. returned: always sample: '2019-02-05T16:19:58+00:00' type: str description: description: The description of the transit gateway. returned: always sample: A transit gateway type: str options: contains: amazon_side_asn: description: - A private Autonomous System Number (ASN) for the Amazon side of a BGP session. The range is 64512 to 65534 for 16-bit ASNs and 4200000000 to 4294967294 for 32-bit ASNs. returned: always sample: 64512 type: int association_default_route_table_id: description: - The ID of the default association route table. returned: when present sample: rtb-11223344 type: str auto_accept_shared_attachments: description: - Indicates whether attachment requests are automatically accepted. returned: always sample: enable type: str default_route_table_association: description: - Indicates whether resource attachments are automatically associated with the default association route table. returned: always sample: disable type: str default_route_table_propagation: description: - Indicates whether resource attachments automatically propagate routes to the default propagation route table. returned: always sample: disable type: str dns_support: description: - Indicates whether DNS support is enabled. returned: always sample: enable type: str propagation_default_route_table_id: description: - The ID of the default propagation route table. returned: when present sample: rtb-11223344 type: str vpn_ecmp_support: description: - Indicates whether Equal Cost Multipath Protocol support is enabled. returned: always sample: enable type: str description: A dictionary of the transit gateway options. returned: always type: complex owner_id: description: The AWS account number ID which owns the transit gateway. returned: always sample: '1234567654323' type: str state: description: The state of the transit gateway. returned: always sample: available type: str tags: description: A dict of tags associated with the transit gateway. returned: always sample: '{ "Name": "A sample TGW" }' type: dict transit_gateway_arn: description: The Amazon Resource Name (ARN) of the transit gateway. returned: always sample: arn:aws:ec2:us-west-2:1234567654323:transit-gateway/tgw-02c42332e6b7da829 type: str transit_gateway_id: description: The ID of the transit gateway. returned: always sample: tgw-02c42332e6b7da829 type: str description: 'Transit gateways that match the provided filters. Each element consists of a dict with all the information related to that transit gateway. ' returned: on success type: complex