Skip to main content

ip_sec_connection_tunnel_security_associations

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

Overview​

Nameip_sec_connection_tunnel_security_associations
TypeResource
Idoci.network.ip_sec_connection_tunnel_security_associations

Fields​

The following fields are returned by SELECT queries:

A summary of the IPSec tunnel security association details.<br />

NameDatatypeDescription
cpeSubnetstringThe IP address and mask of the partner subnet used in policy based VPNs or static routes.
oracleSubnetstringThe IP address and mask of the local subnet used in policy based VPNs or static routes.
timestringTime in the current state, in seconds.
tunnelSaErrorInfostringCurrent state if the IPSec tunnel status is not UP, including phase one and phase two details and a possible reason the tunnel is not UP.
tunnelSaStatusstringThe IPSec tunnel's phase one status. (INITIATING, LISTENING, UP, DOWN, ERROR, UNKNOWN)

Methods​

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
listselectipscId, tunnelId, regionlimit, pageLists the tunnel security associations information for the specified IPSec tunnel ID.<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.

NameDatatypeDescription
ipscIdstringThe [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the IPSec connection.
regionstringOCI 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)
tunnelIdstringThe [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the tunnel.
limitintegerFor 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
pagestringFor 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​

Lists the tunnel security associations information for the specified IPSec tunnel ID.<br />

SELECT
cpeSubnet,
oracleSubnet,
time,
tunnelSaErrorInfo,
tunnelSaStatus
FROM oci.network.ip_sec_connection_tunnel_security_associations
WHERE ipscId = '{{ ipscId }}' -- required
AND tunnelId = '{{ tunnelId }}' -- required
AND region = '{{ region }}' -- required
AND limit = '{{ limit }}'
AND page = '{{ page }}'
;