Show BGP learned routes

Body

application/json

conn_name

string

required

Connection name.

vpc_id

string

required

VPC id.

CID

string

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

action

string

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

active_active

enum<string>

Available options:

disable,

enable

algorithms

boolean

Show supported algorithms.

auth_type

string

Auth type: pubkey or psk.

bgp_backup_local_ip

string

BGP backup local ip addr.

bgp_backup_remote_ip

string

BGP backup remote ip addr.

bgp_local_ip

string

BGP local ip address.

bgp_only

boolean

Show transit BGP VPC connections only.

bgp_remote_ip

string

BGP remote ip address.

cert_based_s2c_ha_remote_id

string

Remote identifier for IKE config in HA gateway.

cert_based_s2c_remote_id

string

Remote identifier for IKE config in primary gateway.

cfg_file

string

Connection configuration.

clear_conntrack

boolean

Clear connection tracking table entries.

cloud_subnet_cidr

string

Cloud subnet cidr.

cloud_virt_subnet

string

Cloud virtual subnet.

cloudwan_only

boolean

Show Cloud WAN connections only.

custom_map

boolean

dpd_config

enum<string>

DPD config.

Available options:

disable,

enable

dpd_delay

string

DPD delay.

dpd_maxfail

string

DPD maxfail.

dpd_retry

string

DPD retry.

enable_global_accelerator

string

enable_ha

boolean

Enable HA.

enable_ikev2

boolean

Enable IKEv2.

enable_lb_primary

boolean

event_triggered_ha

enum<string>

Available options:

disable,

enable

forward_to_transit

enum<string>

Available options:

disable,

enable

from_transit_spoke

boolean

Command from transit network page.

gw_name

string

Gateway name.

jumbo_frame

enum<string>

Enable/Disable jumbo frame support.

Available options:

disable,

enable

key_only

boolean

Show PSK only.

local_dst_real_cidrs

string

Local destination real cidrs.

local_dst_virt_cidrs

string

Local destination virtual cidrs.

local_ip

string

Source IP of tunnel.

local_ip_backup

string

Source IP of tunnel.

local_src_real_cidrs

string

Local source real cidrs.

local_src_virt_cidrs

string

Local source virtual cidrs.

natt

enum<string>

Available options:

disable,

enable

netmap

boolean

Overlapping customer and cloud networks.

ovpn

string

Opvn_file for client.

peer_geo_info

string

Geo location of the Peer gateway.

peer_ip

string

Public IP address of the Peer gateway.

peer_type

string

Peer gateway type.

ph1_auth

string

Phase 1 authentication algorithm.

ph1_dh

string

Phase 1 DH group.

ph1_encr

string

Phase 1 encryption algorithm.

ph2_auth

string

Phase 2 authentication algorithm.

ph2_dh

string

Phase 2 DH group.

ph2_encr

string

Phase 2 encryption algorithm.

phase1_identifier

enum<string>

Available options:

private_ip,

public_ip

phase1_remote_id

string

Phase 1 remote identification.

private_route_encr

boolean

Enable private route encryption.

proto

enum<string>

Select UDP.

Available options:

udp

proxy_id

enum<string>

Available options:

disable,

enable

psk

string

Pre-shared key.

psk_backup

string

Backup Pre-shared key.

remote_cidr

string

Remote site CIDR.

remote_dst_real_cidrs

string

Remote destination real cidrs.

remote_dst_virt_cidrs

string

Remote destination virtual cidrs.

remote_peer_backup_private_ip

string

remote_src_real_cidrs

string

Remote source real cidrs.

remote_src_virt_cidrs

string

Remote source virtual cidrs.

remote_virt_subnet

string

Remote site virtual subnet.

route_based

boolean

Select route based tunnel type.

rtbs_list

string

Route Tables List.

s2c_cacert_tag_name

string

Remote CA cert name for cert based S2C.

same_backup_psk

boolean

Same backup pre-shared key.

save_template

boolean

Saves the template.

show_connections

boolean

Show connections in this VPC.

show_gateways

boolean

Show gateways in this connection.

single_ip_ha

boolean

Enable single public IP HA.

ssl_server_pool

string

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

transit_only

boolean

Show transit VPC connections only.

tunnel_address_local

string

tunnel_address_local_backup

string

tunnel_address_remote

string

tunnel_address_remote_backup

string

tunnel_detail

boolean

Show detailed info.

vti_policy

boolean

Running vti policy.

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

Show BGP learned routes

Body

Response