virtual_circuit_associated_tunnels
Creates, updates, deletes, gets or lists a virtual_circuit_associated_tunnels resource.
Overview​
| Name | virtual_circuit_associated_tunnels |
| Type | Resource |
| Id | oci.network.virtual_circuit_associated_tunnels |
Fields​
The following fields are returned by SELECT queries:
- list
Detailed private tunnel info associated with the virtual circuit.
| Name | Datatype | Description |
|---|---|---|
ipsecConnectionId | string | The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of IPSec connection associated with the virtual circuit. |
tunnelId | string | The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the IPSec tunnel associated with the virtual circuit. |
tunnelType | string | The type of the tunnel associated with the virtual circuit. (IPSEC) |
Methods​
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
list | select | virtualCircuitId, region | limit, page | Gets the specified virtual circuit's associatedTunnelsInfo. |
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 |
|---|---|---|
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) |
virtualCircuitId | string | The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the virtual circuit. |
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
Gets the specified virtual circuit's associatedTunnelsInfo.
SELECT
ipsecConnectionId,
tunnelId,
tunnelType
FROM oci.network.virtual_circuit_associated_tunnels
WHERE virtualCircuitId = '{{ virtualCircuitId }}' -- required
AND region = '{{ region }}' -- required
AND limit = '{{ limit }}'
AND page = '{{ page }}'
;