Skip to main content

cross_connects

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

Overview​

Namecross_connects
TypeResource
Idoci.network.cross_connects

Fields​

The following fields are returned by SELECT queries:

The cross-connect was retrieved.

NameDatatypeDescription
idstringThe cross-connect's Oracle ID (OCID).
compartmentIdstringThe [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment containing the cross-connect group.
crossConnectGroupIdstringThe [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the cross-connect group this cross-connect belongs to (if any).
customerReferenceNamestringA reference name or identifier for the physical fiber connection that this cross-connect uses.
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.
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"}
interfaceNamestringThe name of the FastConnect interface where this cross-connect is installed.
lifecycleStatestringThe cross-connect's current state. (PENDING_CUSTOMER, PROVISIONING, PROVISIONED, INACTIVE, TERMINATING, TERMINATED)
locationNamestringThe name of the FastConnect location where this cross-connect is installed.
macsecPropertiesobjectProperties used for MACsec (if capable).
ociLogicalDeviceNamestringThe FastConnect device that terminates the logical connection. This device might be different than the device that terminates the physical connection.
ociPhysicalDeviceNamestringThe FastConnect device that terminates the physical connection.
portNamestringA string identifying the meet-me room port for this cross-connect.
portSpeedShapeNamestringThe port speed for this cross-connect. Example: 10 Gbps
timeCreatedstring (date-time)The date and time the cross-connect 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
getselectcrossConnectId, regionGets the specified cross-connect's information.
listselectcompartmentId, regioncrossConnectGroupId, limit, page, displayName, sortBy, sortOrder, lifecycleStateLists the cross-connects in the specified compartment. You can filter the list<br />by specifying the [OCID](/iaas/Content/General/Concepts/identifiers.htm) of a cross-connect group.<br />
createinsertregion, locationName, portSpeedShapeName, compartmentIdopc-retry-tokenCreates a new cross-connect. Oracle recommends you create each cross-connect in a<br />[CrossConnectGroup](#/en/iaas/latest/CrossConnectGroup) so you can use link aggregation<br />with the connection.<br /><br />After creating the CrossConnect object, you need to go the FastConnect location<br />and request to have the physical cable installed. For more information, see<br />[FastConnect Overview](/iaas/Content/Network/Concepts/fastconnect.htm).<br /><br />For the purposes of access control, you must provide the [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the<br />compartment where you want the cross-connect to reside. If you're<br />not sure which compartment to use, put the cross-connect in the<br />same compartment with your VCN. For more information about<br />compartments and access control, see<br />[Overview of the IAM Service](/iaas/Content/Identity/Concepts/overview.htm).<br />For information about OCIDs, see<br />[Resource Identifiers](/iaas/Content/General/Concepts/identifiers.htm).<br /><br />You may optionally specify a display name for the cross-connect.<br />It does not have to be unique, and you can change it. Avoid entering confidential information.<br />
updateupdatecrossConnectId, regionif-matchUpdates the specified cross-connect.
deletedeletecrossConnectId, regionif-matchDeletes the specified cross-connect. It must not be mapped to a<br />[VirtualCircuit](#/en/iaas/latest/VirtualCircuit/).<br />
change_compartmentexeccrossConnectId, region, compartmentIdopc-request-id, opc-retry-tokenMoves a cross-connect 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 />

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.
crossConnectIdstringThe [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the cross-connect.
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)
crossConnectGroupIdstringThe [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the cross-connect group.
displayNamestringA filter to return only resources that match the given display name exactly.
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.
lifecycleStatestringA filter to return only resources that match the specified lifecycle state. The value is case insensitive.
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).
sortBystringThe field to sort by. You can provide one sort order (sortOrder). Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive. Note: In general, some "List" operations (for example, ListInstances) let you optionally filter by availability domain if the scope of the resource type is within a single availability domain. If you call one of these "List" operations without specifying an availability domain, the resources are grouped by availability domain, then sorted.
sortOrderstringThe sort order to use, either ascending (ASC) or descending (DESC). The DISPLAYNAME sort order is case sensitive.

SELECT examples​

Gets the specified cross-connect's information.

SELECT
id,
compartmentId,
crossConnectGroupId,
customerReferenceName,
definedTags,
displayName,
freeformTags,
interfaceName,
lifecycleState,
locationName,
macsecProperties,
ociLogicalDeviceName,
ociPhysicalDeviceName,
portName,
portSpeedShapeName,
timeCreated
FROM oci.network.cross_connects
WHERE crossConnectId = '{{ crossConnectId }}' -- required
AND region = '{{ region }}' -- required
;

INSERT examples​

Creates a new cross-connect. Oracle recommends you create each cross-connect in a<br />[CrossConnectGroup](#/en/iaas/latest/CrossConnectGroup) so you can use link aggregation<br />with the connection.<br /><br />After creating the CrossConnect object, you need to go the FastConnect location<br />and request to have the physical cable installed. For more information, see<br />[FastConnect Overview](/iaas/Content/Network/Concepts/fastconnect.htm).<br /><br />For the purposes of access control, you must provide the [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the<br />compartment where you want the cross-connect to reside. If you're<br />not sure which compartment to use, put the cross-connect in the<br />same compartment with your VCN. For more information about<br />compartments and access control, see<br />[Overview of the IAM Service](/iaas/Content/Identity/Concepts/overview.htm).<br />For information about OCIDs, see<br />[Resource Identifiers](/iaas/Content/General/Concepts/identifiers.htm).<br /><br />You may optionally specify a display name for the cross-connect.<br />It does not have to be unique, and you can change it. Avoid entering confidential information.<br />

INSERT INTO oci.network.cross_connects (
compartmentId,
crossConnectGroupId,
customerReferenceName,
definedTags,
displayName,
farCrossConnectOrCrossConnectGroupId,
freeformTags,
interfaceName,
locationName,
macsecProperties,
nearCrossConnectOrCrossConnectGroupId,
ociPhysicalDeviceName,
portSpeedShapeName,
region,
opc-retry-token
)
SELECT 
'{{ compartmentId }}' /* required */,
'{{ crossConnectGroupId }}',
'{{ customerReferenceName }}',
'{{ definedTags }}',
'{{ displayName }}',
'{{ farCrossConnectOrCrossConnectGroupId }}',
'{{ freeformTags }}',
'{{ interfaceName }}',
'{{ locationName }}' /* required */,
'{{ macsecProperties }}',
'{{ nearCrossConnectOrCrossConnectGroupId }}',
'{{ ociPhysicalDeviceName }}',
'{{ portSpeedShapeName }}' /* required */,
'{{ region }}',
'{{ opc-retry-token }}'
RETURNING
id,
compartmentId,
crossConnectGroupId,
customerReferenceName,
definedTags,
displayName,
freeformTags,
interfaceName,
lifecycleState,
locationName,
macsecProperties,
ociLogicalDeviceName,
ociPhysicalDeviceName,
portName,
portSpeedShapeName,
timeCreated
;

UPDATE examples​

Updates the specified cross-connect.

UPDATE oci.network.cross_connects
SET 
customerReferenceName = '{{ customerReferenceName }}',
definedTags = '{{ definedTags }}',
displayName = '{{ displayName }}',
freeformTags = '{{ freeformTags }}',
isActive = {{ isActive }},
macsecProperties = '{{ macsecProperties }}'
WHERE 
crossConnectId = '{{ crossConnectId }}' --required
AND region = '{{ region }}' --required
AND if-match = '{{ if-match}}'
RETURNING
id,
compartmentId,
crossConnectGroupId,
customerReferenceName,
definedTags,
displayName,
freeformTags,
interfaceName,
lifecycleState,
locationName,
macsecProperties,
ociLogicalDeviceName,
ociPhysicalDeviceName,
portName,
portSpeedShapeName,
timeCreated;

DELETE examples​

Deletes the specified cross-connect. It must not be mapped to a<br />[VirtualCircuit](#/en/iaas/latest/VirtualCircuit/).<br />

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

Lifecycle Methods​

Moves a cross-connect 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.cross_connects.change_compartment 
@crossConnectId='{{ crossConnectId }}' --required, 
@region='{{ region }}' --required, 
@opc-request-id='{{ opc-request-id }}', 
@opc-retry-token='{{ opc-retry-token }}' 
@@json=
'{
"compartmentId": "{{ compartmentId }}"
}'
;