cross_connect_mappings
Creates, updates, deletes, gets or lists a cross_connect_mappings resource.
Overview​
| Name | cross_connect_mappings |
| Type | Resource |
| Id | oci.network.cross_connect_mappings |
Fields​
The following fields are returned by SELECT queries:
- list
The list is being retrieved.
| Name | Datatype | Description |
|---|---|---|
bgpMd5AuthKey | string | The key for BGP MD5 authentication. Only applicable if your system requires MD5 authentication. If empty or not set (null), that means you don't use BGP MD5 authentication. |
crossConnectOrCrossConnectGroupId | string | The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the cross-connect or cross-connect group for this mapping. Specified by the owner of the cross-connect or cross-connect group (the customer if the customer is colocated with Oracle, or the provider if the customer is connecting via provider). |
customerBgpPeeringIp | string | The BGP IPv4 address for the router on the other end of the BGP session from Oracle. Specified by the owner of that router. If the session goes from Oracle to a customer, this is the BGP IPv4 address of the customer's edge router. If the session goes from Oracle to a provider, this is the BGP IPv4 address of the provider's edge router. Must use a subnet mask from /28 to /31. There's one exception: for a public virtual circuit, Oracle specifies the BGP IPv4 addresses. Example: 10.0.0.18/31 |
customerBgpPeeringIpv6 | string | The BGP IPv6 address for the router on the other end of the BGP session from Oracle. Specified by the owner of that router. If the session goes from Oracle to a customer, this is the BGP IPv6 address of the customer's edge router. If the session goes from Oracle to a provider, this is the BGP IPv6 address of the provider's edge router. Only subnet masks from /64 up to /127 are allowed. There's one exception: for a public virtual circuit, Oracle specifies the BGP IPv6 addresses. Example: 2001:db8::1/64 |
ipv4BgpStatus | string | The state of the Ipv4 BGP session. (UP, DOWN) |
ipv6BgpStatus | string | The state of the Ipv6 BGP session. (UP, DOWN) |
ociLogicalDeviceName | string | The FastConnect device that terminates the logical connection. |
oracleBgpPeeringIp | string | The IPv4 address for Oracle's end of the BGP session. Must use a subnet mask from /28 to /31. If the session goes from Oracle to a customer's edge router, the customer specifies this information. If the session goes from Oracle to a provider's edge router, the provider specifies this. There's one exception: for a public virtual circuit, Oracle specifies the BGP IPv4 addresses. Example: 10.0.0.19/31 |
oracleBgpPeeringIpv6 | string | The IPv6 address for Oracle's end of the BGP session. Only subnet masks from /64 up to /127 are allowed. If the session goes from Oracle to a customer's edge router, the customer specifies this information. If the session goes from Oracle to a provider's edge router, the provider specifies this. There's one exception: for a public virtual circuit, Oracle specifies the BGP IPv6 addresses. Example: 2001:db8::2/64 |
vlan | integer | The number of the specific VLAN (on the cross-connect or cross-connect group) that is assigned to this virtual circuit. Specified by the owner of the cross-connect or cross-connect group (the customer if the customer is colocated with Oracle, or the provider if the customer is connecting via provider). Example: 200 |
Methods​
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
list | select | virtualCircuitId, region | opc-request-id | Lists the Cross Connect mapping Details for the specified<br />virtual circuit.<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 |
|---|---|---|
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. |
opc-request-id | string | Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. |
SELECT examples​
- list
Lists the Cross Connect mapping Details for the specified<br />virtual circuit.<br />
SELECT
bgpMd5AuthKey,
crossConnectOrCrossConnectGroupId,
customerBgpPeeringIp,
customerBgpPeeringIpv6,
ipv4BgpStatus,
ipv6BgpStatus,
ociLogicalDeviceName,
oracleBgpPeeringIp,
oracleBgpPeeringIpv6,
vlan
FROM oci.network.cross_connect_mappings
WHERE virtualCircuitId = '{{ virtualCircuitId }}' -- required
AND region = '{{ region }}' -- required
AND opc-request-id = '{{ opc-request-id }}'
;