List AWS TGW

Query Parameters

acct_name

string

Account name.

region

string

Region.

tgw_name

string

TGW name.

attachment_acct

string

Attachment account.

attachment_name

string

Attachment, e.g. VPC ID.

route_domain_name

string

A route domain name.

avx_gw_name

string

The AVX transit gw name.

subnet_list

string

A list of subnets.

edge_vpn

boolean

Native_edge_vpn attachment.

edge_dx

boolean

Native_edge_dx attachment.

tgw_peering

boolean

Native_tgw_peering attachment.

tgw_connect

boolean

Native_tgw_connect attachment.

conn_name

string

Vpn, DX, TGW Connect or TGW peering connection name.

public_ip

string

Public IP for CGW.

dx_gateway_id

string

Direct Connect Gateway ID.

aws_side_asn

string

AWS side ASN number.

firewall_domain

boolean

Add attachment to firewall domain.

cloud_type

enum<integer>

Cloud type.

Available options:

1,

256

allowed_prefix

string

Allowed prefix CIDRs for DX.

remote_cidrs

string

Static remote CIDR list.

customized_routes

string

Customized routes.

inside_ip_cidr_tun_1

string

Inside IP CIDR for Tunnel 1.

pre_shared_key_tun_1

string

Pre-Shared Key for Tunnel 1.

inside_ip_cidr_tun_2

string

Inside IP CIDR for Tunnel 2.

pre_shared_key_tun_2

string

Pre-Shared Key for Tunnel 2.

route_table_list

string

Route table list.

disable_local_propagation

boolean

Disable local route propagation to its own domain.

customized_routes_advertise

string

Customized routes advertise list.

log_file

string

Full path of the progress log file.

peer_tgw_name

string

Peer AWS TGW name.

peer_route_domain_name

string

Peer TGW route domain name.

enable_acceleration

boolean

Enable VPN Acceleration.

learned_cidrs_approval

enum<string>

Learned cidrs approval. A boolean choice expressed as a string

Available options:

yes,

no

summarize_rfc1918

enum<string>

Enable/disable summarize RFC1918 routes in VPC route table. A boolean choice expressed as a string

Available options:

yes,

no

multicast_enable

boolean

Enable multicast on the transit gateway.

protocol

string

TGW Connect protocol.

tgw_cidr_list

string

TGW CIDR list.

not_create_default_domains

boolean

Do not create default domains.

action

string

The API action to perform. Required for 7.2 controllers only.

CID

string

The opaque session ID token. Required for 7.2 controllers only.

Response

General v2 API response schema.

A generic API response container for v2 style APIs.

errortype

string

Error type if the API failed.

reason

string

Failure reason if the API failed.

results

API response data

return

boolean

Whether the API returned successfully

Concepts & Architecture

Guides

Reference

List AWS TGW

Query Parameters

Response