community.aws.ec2_transit_gateway_info – Gather information about ec2 transit gateways in AWS

Note

This plugin is part of the community.aws collection (version 1.5.0).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install community.aws.

To use it in a playbook, specify: community.aws.ec2_transit_gateway_info.

New in version 1.0.0: of community.aws

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

Comments

aws_access_key

aliases: ec2_access_key, 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.

If profile is set this parameter is ignored.

Passing the aws_access_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

aws_ca_bundle

path

The location of a CA Bundle to use when validating SSL certificates.

Only used for boto3 based modules.

Note: The CA Bundle is read ‘module’ side and may need to be explicitly copied from the controller if not run locally.

aws_config

dictionary

A dictionary to modify the botocore configuration.

Parameters can be found at 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 http://boto.cloudhackers.com/en/latest/boto_config_tut.html#boto for more boto configuration.

aws_secret_key

aliases: ec2_secret_key, 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.

If profile is set this parameter is ignored.

Passing the aws_secret_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

debug_botocore_endpoint_logs

boolean

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.

Choices:

  • no ← (default)

  • yes

ec2_url

aliases: aws_endpoint_url, endpoint_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

aliases: aws_profile

string

Uses a boto profile. Only works with boto >= 2.24.0.

Using profile will override aws_access_key, aws_secret_key and security_token and support for passing them at the same time as profile has been deprecated.

aws_access_key, aws_secret_key and security_token will be made mutually exclusive with profile after 2022-06-01.

region

aliases: aws_region, ec2_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

security_token

aliases: aws_security_token, access_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.

If profile is set this parameter is ignored.

Passing the security_token and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

transit_gateway_ids

aliases: transit_gateway_id

list / elements=string

A list of transit gateway IDs to gather information for.

validate_certs

boolean

When set to “no”, SSL certificates will not be validated for boto versions >= 2.6.0.

Choices:

  • no

  • yes ← (default)

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_PROFILE or AWS_DEFAULT_PROFILE, 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, AWS_CA_BUNDLE

  • 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.

- name: Gather info about all transit gateways
  community.aws.ec2_transit_gateway_info:

- name: Gather info about a particular transit gateway using filter transit gateway ID
  community.aws.ec2_transit_gateway_info:
    filters:
      transit-gateway-id: tgw-02c42332e6b7da829

- name: Gather info about a particular transit gateway using multiple option filters
  community.aws.ec2_transit_gateway_info:
    filters:
      options.dns-support: enable
      options.vpn-ecmp-support: enable

- name: Gather info about multiple transit gateways using module param
  community.aws.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

Description

transit_gateways

complex

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

creation_time

string

The creation time.

Returned: always

Sample: “2019-02-05T16:19:58+00:00”

description

string

The description of the transit gateway.

Returned: always

Sample: “A transit gateway”

options

complex

A dictionary of the transit gateway options.

Returned: always

amazon_side_asn

integer

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

association_default_route_table_id

string

The ID of the default association route table.

Returned: when present

Sample: “rtb-11223344”

auto_accept_shared_attachments

string

Indicates whether attachment requests are automatically accepted.

Returned: always

Sample: “enable”

default_route_table_association

string

Indicates whether resource attachments are automatically associated with the default association route table.

Returned: always

Sample: “disable”

default_route_table_propagation

string

Indicates whether resource attachments automatically propagate routes to the default propagation route table.

Returned: always

Sample: “disable”

dns_support

string

Indicates whether DNS support is enabled.

Returned: always

Sample: “enable”

propagation_default_route_table_id

string

The ID of the default propagation route table.

Returned: when present

Sample: “rtb-11223344”

vpn_ecmp_support

string

Indicates whether Equal Cost Multipath Protocol support is enabled.

Returned: always

Sample: “enable”

owner_id

string

The AWS account number ID which owns the transit gateway.

Returned: always

Sample: “1234567654323”

state

string

The state of the transit gateway.

Returned: always

Sample: “available”

tags

dictionary

A dict of tags associated with the transit gateway.

Returned: always

Sample: “{ \”Name\”: \”A sample TGW\” }”

transit_gateway_arn

string

The Amazon Resource Name (ARN) of the transit gateway.

Returned: always

Sample: “arn:aws:ec2:us-west-2:1234567654323:transit-gateway/tgw-02c42332e6b7da829”

transit_gateway_id

string

The ID of the transit gateway.

Returned: always

Sample: “tgw-02c42332e6b7da829”

Authors

  • Bob Boldin (@BobBoldin)