CrossConnectGroup¶

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

Bases: object

For use with Oracle Cloud Infrastructure FastConnect. A cross-connect group is a link aggregation group (LAG), which can contain one or more CrossConnect. Customers who are colocated with Oracle in a FastConnect location create and use cross-connect groups. For more information, see FastConnect Overview.

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 CrossConnectGroup.
`LIFECYCLE_STATE_PROVISIONED`	A constant which can be used with the lifecycle_state property of a CrossConnectGroup.
`LIFECYCLE_STATE_PROVISIONING`	A constant which can be used with the lifecycle_state property of a CrossConnectGroup.
`LIFECYCLE_STATE_TERMINATED`	A constant which can be used with the lifecycle_state property of a CrossConnectGroup.
`LIFECYCLE_STATE_TERMINATING`	A constant which can be used with the lifecycle_state property of a CrossConnectGroup.
`compartment_id`	Gets the compartment_id of this CrossConnectGroup.
`customer_reference_name`	Gets the customer_reference_name of this CrossConnectGroup.
`defined_tags`	Gets the defined_tags of this CrossConnectGroup.
`display_name`	Gets the display_name of this CrossConnectGroup.
`freeform_tags`	Gets the freeform_tags of this CrossConnectGroup.
`id`	Gets the id of this CrossConnectGroup.
`lifecycle_state`	Gets the lifecycle_state of this CrossConnectGroup.
`macsec_properties`	Gets the macsec_properties of this CrossConnectGroup.
`oci_logical_device_name`	Gets the oci_logical_device_name of this CrossConnectGroup.
`oci_physical_device_name`	Gets the oci_physical_device_name of this CrossConnectGroup.
`time_created`	Gets the time_created of this CrossConnectGroup.

Methods

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

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

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

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

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

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

__init__(**kwargs)¶

Initializes a new CrossConnectGroup 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 CrossConnectGroup.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this CrossConnectGroup.
display_name (str) – The value to assign to the display_name property of this CrossConnectGroup.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this CrossConnectGroup.
id (str) – The value to assign to the id property of this CrossConnectGroup.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this CrossConnectGroup. Allowed values for this property are: “PROVISIONING”, “PROVISIONED”, “INACTIVE”, “TERMINATING”, “TERMINATED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
customer_reference_name (str) – The value to assign to the customer_reference_name property of this CrossConnectGroup.
time_created (datetime) – The value to assign to the time_created property of this CrossConnectGroup.
macsec_properties (oci.core.models.MacsecProperties) – The value to assign to the macsec_properties property of this CrossConnectGroup.
oci_physical_device_name (str) – The value to assign to the oci_physical_device_name property of this CrossConnectGroup.
oci_logical_device_name (str) – The value to assign to the oci_logical_device_name property of this CrossConnectGroup.

compartment_id¶

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

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

customer_reference_name¶

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

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

defined_tags¶

Gets the defined_tags of this CrossConnectGroup. 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 CrossConnectGroup.
Return type:	dict(str, dict(str, object))

display_name¶

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

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

freeform_tags¶

Gets the freeform_tags of this CrossConnectGroup. 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 CrossConnectGroup.
Return type:	dict(str, str)

id¶

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

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

lifecycle_state¶

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

Allowed values for this property are: “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 CrossConnectGroup.
Return type:	str

macsec_properties¶

Gets the macsec_properties of this CrossConnectGroup.

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

oci_logical_device_name¶

Gets the oci_logical_device_name of this CrossConnectGroup. 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 CrossConnectGroup.
Return type:	str

oci_physical_device_name¶

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

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

time_created¶

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

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

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