CrossConnect¶

class oci.core.models.CrossConnect(**kwargs)¶

Bases: object

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 CrossConnect and 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.

Attributes

`LIFECYCLE_STATE_INACTIVE`	A constant which can be used with the lifecycle_state property of a CrossConnect.
`LIFECYCLE_STATE_PENDING_CUSTOMER`	A constant which can be used with the lifecycle_state property of a CrossConnect.
`LIFECYCLE_STATE_PROVISIONED`	A constant which can be used with the lifecycle_state property of a CrossConnect.
`LIFECYCLE_STATE_PROVISIONING`	A constant which can be used with the lifecycle_state property of a CrossConnect.
`LIFECYCLE_STATE_TERMINATED`	A constant which can be used with the lifecycle_state property of a CrossConnect.
`LIFECYCLE_STATE_TERMINATING`	A constant which can be used with the lifecycle_state property of a CrossConnect.
`compartment_id`	Gets the compartment_id of this CrossConnect.
`cross_connect_group_id`	Gets the cross_connect_group_id of this CrossConnect.
`customer_reference_name`	Gets the customer_reference_name of this CrossConnect.
`defined_tags`	Gets the defined_tags of this CrossConnect.
`display_name`	Gets the display_name of this CrossConnect.
`freeform_tags`	Gets the freeform_tags of this CrossConnect.
`id`	Gets the id of this CrossConnect.
`lifecycle_state`	Gets the lifecycle_state of this CrossConnect.
`location_name`	Gets the location_name of this CrossConnect.
`macsec_properties`	Gets the macsec_properties of this CrossConnect.
`oci_logical_device_name`	Gets the oci_logical_device_name of this CrossConnect.
`oci_physical_device_name`	Gets the oci_physical_device_name of this CrossConnect.
`port_name`	Gets the port_name of this CrossConnect.
`port_speed_shape_name`	Gets the port_speed_shape_name of this CrossConnect.
`time_created`	Gets the time_created of this CrossConnect.

Methods

__init__(**kwargs) Initializes a new CrossConnect object with values from keyword arguments.

LIFECYCLE_STATE_INACTIVE = 'INACTIVE'¶: A constant which can be used with the lifecycle_state property of a CrossConnect. This constant has a value of “INACTIVE”

LIFECYCLE_STATE_PENDING_CUSTOMER = 'PENDING_CUSTOMER'¶: A constant which can be used with the lifecycle_state property of a CrossConnect. This constant has a value of “PENDING_CUSTOMER”

LIFECYCLE_STATE_PROVISIONED = 'PROVISIONED'¶: A constant which can be used with the lifecycle_state property of a CrossConnect. This constant has a value of “PROVISIONED”

LIFECYCLE_STATE_PROVISIONING = 'PROVISIONING'¶: A constant which can be used with the lifecycle_state property of a CrossConnect. This constant has a value of “PROVISIONING”

LIFECYCLE_STATE_TERMINATED = 'TERMINATED'¶: A constant which can be used with the lifecycle_state property of a CrossConnect. This constant has a value of “TERMINATED”

LIFECYCLE_STATE_TERMINATING = 'TERMINATING'¶: A constant which can be used with the lifecycle_state property of a CrossConnect. This constant has a value of “TERMINATING”

__init__(**kwargs)¶

Initializes a new CrossConnect object with values from keyword arguments. The following keyword arguments are supported (corresponding to the getters/setters of this class):

Parameters:

compartment_id (str) – The value to assign to the compartment_id property of this CrossConnect.
cross_connect_group_id (str) – The value to assign to the cross_connect_group_id property of this CrossConnect.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this CrossConnect.
display_name (str) – The value to assign to the display_name property of this CrossConnect.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this CrossConnect.
id (str) – The value to assign to the id property of this CrossConnect.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this CrossConnect. Allowed values for this property are: “PENDING_CUSTOMER”, “PROVISIONING”, “PROVISIONED”, “INACTIVE”, “TERMINATING”, “TERMINATED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
location_name (str) – The value to assign to the location_name property of this CrossConnect.
port_name (str) – The value to assign to the port_name property of this CrossConnect.
port_speed_shape_name (str) – The value to assign to the port_speed_shape_name property of this CrossConnect.
customer_reference_name (str) – The value to assign to the customer_reference_name property of this CrossConnect.
time_created (datetime) – The value to assign to the time_created property of this CrossConnect.
macsec_properties (oci.core.models.MacsecProperties) – The value to assign to the macsec_properties property of this CrossConnect.
oci_physical_device_name (str) – The value to assign to the oci_physical_device_name property of this CrossConnect.
oci_logical_device_name (str) – The value to assign to the oci_logical_device_name property of this CrossConnect.

compartment_id¶

Gets the compartment_id of this CrossConnect. The OCID of the compartment containing the cross-connect group.

Returns:	The compartment_id of this CrossConnect.
Return type:	str

cross_connect_group_id¶

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

Returns:	The cross_connect_group_id of this CrossConnect.
Return type:	str

customer_reference_name¶

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

Returns:	The customer_reference_name of this CrossConnect.
Return type:	str

defined_tags¶

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

Example: {“Operations”: {“CostCenter”: “42”}}

Returns:	The defined_tags of this CrossConnect.
Return type:	dict(str, dict(str, object))

display_name¶

Gets the display_name of this CrossConnect. A user-friendly name. Does not have to be unique, and it’s changeable. Avoid entering confidential information.

Returns:	The display_name of this CrossConnect.
Return type:	str

freeform_tags¶

Gets the freeform_tags of this CrossConnect. 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: {“Department”: “Finance”}

Returns:	The freeform_tags of this CrossConnect.
Return type:	dict(str, str)

id¶

Gets the id of this CrossConnect. The cross-connect’s Oracle ID (OCID).

Returns:	The id of this CrossConnect.
Return type:	str

lifecycle_state¶

Gets the lifecycle_state of this CrossConnect. The cross-connect’s current state.

Allowed values for this property are: “PENDING_CUSTOMER”, “PROVISIONING”, “PROVISIONED”, “INACTIVE”, “TERMINATING”, “TERMINATED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:	The lifecycle_state of this CrossConnect.
Return type:	str

location_name¶

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

Returns:	The location_name of this CrossConnect.
Return type:	str

macsec_properties¶

Gets the macsec_properties of this CrossConnect.

Returns:	The macsec_properties of this CrossConnect.
Return type:	oci.core.models.MacsecProperties

oci_logical_device_name¶

Gets the oci_logical_device_name of this CrossConnect. The FastConnect device that terminates the logical connection. This device might be different than the device that terminates the physical connection.

Returns:	The oci_logical_device_name of this CrossConnect.
Return type:	str

oci_physical_device_name¶

Gets the oci_physical_device_name of this CrossConnect. The FastConnect device that terminates the physical connection.

Returns:	The oci_physical_device_name of this CrossConnect.
Return type:	str

port_name¶

Gets the port_name of this CrossConnect. A string identifying the meet-me room port for this cross-connect.

Returns:	The port_name of this CrossConnect.
Return type:	str

port_speed_shape_name¶

Gets the port_speed_shape_name of this CrossConnect. The port speed for this cross-connect.

Example: 10 Gbps

Returns:	The port_speed_shape_name of this CrossConnect.
Return type:	str

time_created¶

Gets the time_created of this CrossConnect. The date and time the cross-connect was created, in the format defined by RFC3339.

Example: 2016-08-25T21:10:29.600Z

Returns:	The time_created of this CrossConnect.
Return type:	datetime