Skip to main content

remote_peering_connections

Creates, updates, deletes, gets or lists a remote_peering_connections resource.

Overview​

Nameremote_peering_connections
TypeResource
Idoci.network.remote_peering_connections

Fields​

The following fields are returned by SELECT queries:

The RPC was retrieved.

NameDatatypeDescription
idstringThe [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the RPC.
compartmentIdstringThe [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment that contains the RPC.
definedTagsobjectDefined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: {"Operations": {"CostCenter": "42"}}
displayNamestringA user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
drgIdstringThe [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the DRG that this RPC belongs to.
freeformTagsobjectFree-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: {"Department": "Finance"}
isCrossTenancyPeeringbooleanWhether the VCN at the other end of the peering is in a different tenancy. Example: false
lifecycleStatestringThe RPC's current lifecycle state. (AVAILABLE, PROVISIONING, TERMINATING, TERMINATED)
peerIdstringIf this RPC is peered, this value is the [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the other RPC.
peerRegionNamestringIf this RPC is peered, this value is the region that contains the other RPC. Example: us-ashburn-1
peerTenancyIdstringIf this RPC is peered, this value is the [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the other RPC's tenancy.
peeringStatusstringWhether the RPC is peered with another RPC. NEW means the RPC has not yet been peered. PENDING means the peering is being established. REVOKED means the RPC at the other end of the peering has been deleted. (INVALID, NEW, PENDING, PEERED, REVOKED)
timeCreatedstring (date-time)The date and time the RPC was created, in the format defined by [RFC3339](https:​//tools.ietf.org/html/rfc3339). Example: 2016-08-25T21:10:29.600Z

Methods​

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
getselectremotePeeringConnectionId, regionGet the specified remote peering connection's information.<br />
listselectcompartmentId, regiondrgId, limit, pageLists the remote peering connections (RPCs) for the specified DRG and compartment<br />(the RPC's compartment).<br />
createinsertregion, compartmentId, drgIdopc-retry-tokenCreates a new remote peering connection (RPC) for the specified DRG.<br />
updateupdateremotePeeringConnectionId, regionif-matchUpdates the specified remote peering connection (RPC).<br />
deletedeleteremotePeeringConnectionId, regionif-matchDeletes the remote peering connection (RPC).<br /><br />This is an asynchronous operation; the RPC's lifecycleState changes to TERMINATING temporarily<br />until the RPC is completely removed.<br />
change_compartmentexecremotePeeringConnectionId, region, compartmentIdopc-request-id, opc-retry-tokenMoves a remote peering connection (RPC) into a different compartment within the same tenancy. For information<br />about moving resources between compartments, see<br />[Moving Resources to a Different Compartment](/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes).<br />
connect_remote_peering_connectionsexecremotePeeringConnectionId, region, peerId, peerRegionNameConnects this RPC to another one in a different region.<br /><br />This operation must be called by the VCN administrator who is designated as<br />the requestor in the peering relationship. The acceptor must implement<br />an Identity and Access Management (IAM) policy that gives the requestor permission<br />to connect to RPCs in the acceptor's compartment. Without that permission, this<br />operation will fail. For more information, see<br />[VCN Peering](/iaas/Content/Network/Tasks/VCNpeering.htm).<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
compartmentIdstringThe [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment.
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)
remotePeeringConnectionIdstringThe [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the remote peering connection (RPC).
drgIdstringThe [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the DRG.
if-matchstringFor optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
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
opc-request-idstringUnique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
opc-retry-tokenstringA token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (for example, if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected).
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​

Get the specified remote peering connection's information.<br />

SELECT
id,
compartmentId,
definedTags,
displayName,
drgId,
freeformTags,
isCrossTenancyPeering,
lifecycleState,
peerId,
peerRegionName,
peerTenancyId,
peeringStatus,
timeCreated
FROM oci.network.remote_peering_connections
WHERE remotePeeringConnectionId = '{{ remotePeeringConnectionId }}' -- required
AND region = '{{ region }}' -- required
;

INSERT examples​

Creates a new remote peering connection (RPC) for the specified DRG.<br />

INSERT INTO oci.network.remote_peering_connections (
compartmentId,
definedTags,
displayName,
drgId,
freeformTags,
region,
opc-retry-token
)
SELECT 
'{{ compartmentId }}' /* required */,
'{{ definedTags }}',
'{{ displayName }}',
'{{ drgId }}' /* required */,
'{{ freeformTags }}',
'{{ region }}',
'{{ opc-retry-token }}'
RETURNING
id,
compartmentId,
definedTags,
displayName,
drgId,
freeformTags,
isCrossTenancyPeering,
lifecycleState,
peerId,
peerRegionName,
peerTenancyId,
peeringStatus,
timeCreated
;

UPDATE examples​

Updates the specified remote peering connection (RPC).<br />

UPDATE oci.network.remote_peering_connections
SET 
definedTags = '{{ definedTags }}',
displayName = '{{ displayName }}',
freeformTags = '{{ freeformTags }}'
WHERE 
remotePeeringConnectionId = '{{ remotePeeringConnectionId }}' --required
AND region = '{{ region }}' --required
AND if-match = '{{ if-match}}'
RETURNING
id,
compartmentId,
definedTags,
displayName,
drgId,
freeformTags,
isCrossTenancyPeering,
lifecycleState,
peerId,
peerRegionName,
peerTenancyId,
peeringStatus,
timeCreated;

DELETE examples​

Deletes the remote peering connection (RPC).<br /><br />This is an asynchronous operation; the RPC's lifecycleState changes to TERMINATING temporarily<br />until the RPC is completely removed.<br />

DELETE FROM oci.network.remote_peering_connections
WHERE remotePeeringConnectionId = '{{ remotePeeringConnectionId }}' --required
AND region = '{{ region }}' --required
AND if-match = '{{ if-match }}'
;

Lifecycle Methods​

Moves a remote peering connection (RPC) into a different compartment within the same tenancy. For information<br />about moving resources between compartments, see<br />[Moving Resources to a Different Compartment](/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes).<br />

EXEC oci.network.remote_peering_connections.change_compartment 
@remotePeeringConnectionId='{{ remotePeeringConnectionId }}' --required, 
@region='{{ region }}' --required, 
@opc-request-id='{{ opc-request-id }}', 
@opc-retry-token='{{ opc-retry-token }}' 
@@json=
'{
"compartmentId": "{{ compartmentId }}"
}'
;