ec2_transit_gateway_info – Gather information about ec2 transit gateways in AWS¶

New in version 2.8.

Synopsis
Requirements
Parameters
Notes
Examples
Return Values
Status

Synopsis ¶

Gather information about ec2 transit gateways in AWS

Requirements ¶

The below requirements are needed on the host that executes this module.

boto
boto3
botocore
python >= 2.6

Parameters ¶

Parameter	Choices/Defaults	Comments
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
debug_botocore_endpoint_logs boolean added in 2.8	Choices: no ← yes	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.
filters dictionary		A dict of filters to apply. Each dict item consists of a filter key and a filter value. See https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeTransitGateways.html for filters.
profile string		Uses a boto profile. Only works with boto >= 2.24.0.
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
transit_gateway_ids list added in 2.8		A list of transit gateway IDs to gather information for. aliases: transit_gateway_id
validate_certs boolean	Choices: no yes ←	When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.

Notes ¶

Note

If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence 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_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_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

Examples ¶

# 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

Return Values ¶

Common return values are documented here, the following are the fields unique to this module:

Key			Returned	Description
transit_gateways complex			on success	Transit gateways that match the provided filters. Each element consists of a dict with all the information related to that transit gateway.
	creation_time string		always	The creation time. Sample: 2019-02-05T16:19:58+00:00
	description string		always	The description of the transit gateway. Sample: A transit gateway
	options complex		always	A dictionary of the transit gateway options.
		amazon_side_asn integer	always	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. Sample: 64512
		association_default_route_table_id string	when present	The ID of the default association route table. Sample: rtb-11223344
		auto_accept_shared_attachments string	always	Indicates whether attachment requests are automatically accepted. Sample: enable
		default_route_table_association string	always	Indicates whether resource attachments are automatically associated with the default association route table. Sample: disable
		default_route_table_propagation string	always	Indicates whether resource attachments automatically propagate routes to the default propagation route table. Sample: disable
		dns_support string	always	Indicates whether DNS support is enabled. Sample: enable
		propagation_default_route_table_id string	when present	The ID of the default propagation route table. Sample: rtb-11223344
		vpn_ecmp_support string	always	Indicates whether Equal Cost Multipath Protocol support is enabled. Sample: enable
	owner_id string		always	The AWS account number ID which owns the transit gateway. Sample: 1234567654323
	state string		always	The state of the transit gateway. Sample: available
	tags dictionary		always	A dict of tags associated with the transit gateway. Sample: { "Name": "A sample TGW" }
	transit_gateway_arn string		always	The Amazon Resource Name (ARN) of the transit gateway. Sample: arn:aws:ec2:us-west-2:1234567654323:transit-gateway/tgw-02c42332e6b7da829
	transit_gateway_id string		always	The ID of the transit gateway. Sample: tgw-02c42332e6b7da829

Status ¶

This module is not guaranteed to have a backwards compatible interface. [preview]
This module is maintained by the Ansible Community. [community]

Authors¶

Bob Boldin (@BobBoldin)

Hint

If you notice any issues in this documentation, you can edit this document to improve it.

ec2_transit_gateway_info – Gather information about ec2 transit gateways in AWS¶

Synopsis¶

Requirements¶

Parameters¶

Notes¶

Examples¶

Return Values¶

Status¶