ip_sec_connection_tunnel_routes

Creates, updates, deletes, gets or lists an ip_sec_connection_tunnel_routes resource.

Overview

Name	ip_sec_connection_tunnel_routes
Type	Resource
Id	oci.network.ip_sec_connection_tunnel_routes

Fields

The following fields are returned by SELECT queries:

list

A summary of the routes advertised to and received from the on-premises network.<br />

Name	Datatype	Description
advertiser	string	The source of the route advertisement. (CUSTOMER, ORACLE)
age	integer (int64)	The age of the route.
asPath	array	A list of ASNs in AS_Path.
isBestPath	boolean	Indicates this is the best route.
prefix	string	The BGP network layer reachability information.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list	select	ipscId, tunnelId, region	limit, page, advertiser	The routes advertised to the on-premises network and the routes received from the on-premises network.<br />

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
ipscId	string	The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the IPSec connection.
region	string	OCI region identifier (e.g. us-ashburn-1, ap-sydney-1); resolves from OCI_REGION when not supplied in the query. (default: us-ashburn-1, x-stackQL-envVar: OCI_REGION)
tunnelId	string	The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the tunnel.
advertiser	string	Specifies the advertiser of the routes. If set to ORACLE, this returns only the routes advertised by Oracle. When set to CUSTOMER, this returns only the routes advertised by the CPE.
limit	integer	For list pagination. The maximum number of results per page, or items to return in a paginated "List" call. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). Example: 50
page	string	For list pagination. The value of the opc-next-page response header from the previous "List" call. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).

SELECT examples

list

The routes advertised to the on-premises network and the routes received from the on-premises network.<br />

SELECT
advertiser,
age,
asPath,
isBestPath,
prefix
FROM oci.network.ip_sec_connection_tunnel_routes
WHERE ipscId = '{{ ipscId }}' -- required
AND tunnelId = '{{ tunnelId }}' -- required
AND region = '{{ region }}' -- required
AND limit = '{{ limit }}'
AND page = '{{ page }}'
AND advertiser = '{{ advertiser }}'
;