Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace CrossConnect

For use with Oracle Cloud Infrastructure FastConnect. A cross-connect represents a physical connection between an existing network and Oracle. Customers who are colocated with Oracle in a FastConnect location create and use cross-connects. For more information, see FastConnect Overview.

Oracle recommends you create each cross-connect in a CrossConnectGroup so you can use link aggregation with the connection.

*Note:** If you're a provider who is setting up a physical connection to Oracle so customers can use FastConnect over the connection, be aware that your connection is modeled the same way as a colocated customer's (with {@code CrossConnect} and {@code CrossConnectGroup} objects, and so on).

To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to an administrator. If you're an administrator who needs to write policies to give users access, see [Getting Started with Policies](https://docs.cloud.oracle.com/iaas/Content/Identity/Concepts/policygetstarted.htm).

Properties

Optional compartmentId

compartmentId: undefined | string

The OCID of the compartment containing the cross-connect group.

Optional crossConnectGroupId

crossConnectGroupId: undefined | string

The OCID of the cross-connect group this cross-connect belongs to (if any).

Optional customerReferenceName

customerReferenceName: undefined | string

A reference name or identifier for the physical fiber connection that this cross-connect uses.

Optional definedTags

definedTags: undefined | object

Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

Example: {@code {\"Operations\": {\"CostCenter\": \"42\"}}}

Optional displayName

displayName: undefined | string

A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.

Optional freeformTags

freeformTags: undefined | object

Free-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.

Example: {@code {\"Department\": \"Finance\"}}

Optional id

id: undefined | string

The cross-connect's Oracle ID (OCID).

Optional lifecycleState

lifecycleState: LifecycleState

The cross-connect's current state.

Optional locationName

locationName: undefined | string

The name of the FastConnect location where this cross-connect is installed.

Optional macsecProperties

macsecProperties: model.MacsecProperties

Optional ociLogicalDeviceName

ociLogicalDeviceName: undefined | string

The FastConnect device that terminates the logical connection. This device might be different than the device that terminates the physical connection.

Optional ociPhysicalDeviceName

ociPhysicalDeviceName: undefined | string

The FastConnect device that terminates the physical connection.

Optional portName

portName: undefined | string

A string identifying the meet-me room port for this cross-connect.

Optional portSpeedShapeName

portSpeedShapeName: undefined | string

The port speed for this cross-connect.

Example: {@code 10 Gbps}

Optional timeCreated

timeCreated: Date

The date and time the cross-connect was created, in the format defined by RFC3339.

Example: {@code 2016-08-25T21:10:29.600Z}

Functions

getDeserializedJsonObj

getJsonObj