List VGW connections

Query Parameters

vpc_id

string

VPC id.

name

string

Connection name.

from_transit_spoke

boolean

Command from transit network page.

gw_name

string

Gateway name.

peer_ip

string

Public IP address of the Peer gateway.

peer_geo_info

string

Geo location of the Peer gateway.

peer_type

string

Peer gateway type.

remote_cidr

string

Remote site CIDR.

dpd_config

enum<string>

DPD config.

Available options:

disable,

enable

dpd_delay

string

DPD delay.

dpd_retry

string

DPD retry.

dpd_maxfail

string

DPD maxfail.

private_route_encr

boolean

Enable private route encryption.

cloud_subnet_cidr

string

Cloud subnet cidr.

netmap

boolean

Overlapping customer and cloud networks.

remote_virt_subnet

string

Remote site virtual subnet.

cloud_virt_subnet

string

Cloud virtual subnet.

psk

string

Pre-shared key.

psk_backup

string

Backup Pre-shared key.

same_backup_psk

boolean

Same backup pre-shared key.

auth_type

string

Auth type: pubkey or psk.

cert_based_s2c_remote_id

string

Remote identifier for IKE config in primary gateway.

cert_based_s2c_ha_remote_id

string

Remote identifier for IKE config in HA gateway.

s2c_cacert_tag_name

string

Remote CA cert name for cert based S2C.

enable_ha

boolean

Enable HA.

single_ip_ha

boolean

Enable single public IP HA.

enable_ikev2

boolean

Enable IKEv2.

rtbs_list

string

Route Tables List.

ph1_encr

string

Phase 1 encryption algorithm.

ph1_auth

string

Phase 1 authentication algorithm.

ph1_dh

string

Phase 1 DH group.

ph2_encr

string

Phase 2 encryption algorithm.

ph2_auth

string

Phase 2 authentication algorithm.

ph2_dh

string

Phase 2 DH group.

route_based

boolean

Select route based tunnel type.

bgp_local_ip

string

BGP local ip address.

bgp_remote_ip

string

BGP remote ip address.

bgp_backup_local_ip

string

BGP backup local ip addr.

bgp_backup_remote_ip

string

BGP backup remote ip addr.

proto

enum<string>

Select UDP.

Available options:

udp

ovpn

string

Opvn_file for client.

ssl_server_pool

string

Server pool for SSL, e.g. 192.168.0.0/16.

save_template

boolean

Saves the template.

local_ip

string

Source IP of tunnel.

local_ip_backup

string

Source IP of tunnel.

tunnel_address_local

string

tunnel_address_remote

string

tunnel_address_local_backup

string

tunnel_address_remote_backup

string

remote_peer_backup_private_ip

string

enable_lb_primary

boolean

enable_global_accelerator

string

active_active

enum<string>

Available options:

disable,

enable

event_triggered_ha

enum<string>

Available options:

disable,

enable

natt

enum<string>

Available options:

disable,

enable

phase1_identifier

enum<string>

Available options:

private_ip,

public_ip

phase1_remote_id

string

Phase 1 remote identification.

vti_policy

boolean

Running vti policy.

forward_to_transit

enum<string>

Available options:

disable,

enable

proxy_id

enum<string>

Available options:

disable,

enable

custom_map

boolean

remote_src_real_cidrs

string

Remote source real cidrs.

remote_src_virt_cidrs

string

Remote source virtual cidrs.

remote_dst_real_cidrs

string

Remote destination real cidrs.

remote_dst_virt_cidrs

string

Remote destination virtual cidrs.

local_src_real_cidrs

string

Local source real cidrs.

local_src_virt_cidrs

string

Local source virtual cidrs.

local_dst_real_cidrs

string

Local destination real cidrs.

local_dst_virt_cidrs

string

Local destination virtual cidrs.

clear_conntrack

boolean

Clear connection tracking table entries.

jumbo_frame

enum<string>

Enable/Disable jumbo frame support.

Available options:

disable,

enable

tunnel_detail

boolean

Show detailed info.

show_connections

boolean

Show connections in this VPC.

show_gateways

boolean

Show gateways in this connection.

details

boolean

Show detailed connection info.

algorithms

boolean

Show supported algorithms.

cloudwan_only

boolean

Show Cloud WAN connections only.

key_only

boolean

Show PSK only.

bgp_only

boolean

Show transit BGP VPC connections only.

cfg_file

string

Connection configuration.

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 VGW connections

Query Parameters

Response