CrossConnectGroup¶
- class oci.core.models.CrossConnectGroup(**kwargs)¶
Bases:
objectFor 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:
A constant which can be used with the lifecycle_state property of a CrossConnectGroup.
A constant which can be used with the lifecycle_state property of a CrossConnectGroup.
A constant which can be used with the lifecycle_state property of a CrossConnectGroup.
A constant which can be used with the lifecycle_state property of a CrossConnectGroup.
A constant which can be used with the lifecycle_state property of a CrossConnectGroup.
Gets the compartment_id of this CrossConnectGroup.
Gets the customer_reference_name of this CrossConnectGroup.
Gets the defined_tags of this CrossConnectGroup.
Gets the display_name of this CrossConnectGroup.
Gets the freeform_tags of this CrossConnectGroup.
Gets the id of this CrossConnectGroup.
Gets the interface_down_timer_value_in_milliseconds of this CrossConnectGroup.
Gets the is_interface_hold_timer_enabled of this CrossConnectGroup.
Gets the is_qos_enabled of this CrossConnectGroup.
Gets the lifecycle_state of this CrossConnectGroup.
Gets the macsec_properties of this CrossConnectGroup.
Gets the minimum_links of this CrossConnectGroup.
Gets the oci_logical_device_name of this CrossConnectGroup.
Gets the oci_physical_device_name of this CrossConnectGroup.
Gets the system_tags of this CrossConnectGroup.
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.
system_tags (dict(str, dict(str, object))) – The value to assign to the system_tags 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.
minimum_links (int) – The value to assign to the minimum_links property of this CrossConnectGroup.
is_interface_hold_timer_enabled (bool) – The value to assign to the is_interface_hold_timer_enabled property of this CrossConnectGroup.
interface_down_timer_value_in_milliseconds (int) – The value to assign to the interface_down_timer_value_in_milliseconds property of this CrossConnectGroup.
is_qos_enabled (bool) – The value to assign to the is_qos_enabled property of this CrossConnectGroup.
- property 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
- property 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
- property 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))
- property 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
- property 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)
- property id¶
Gets the id of this CrossConnectGroup. The cross-connect group’s Oracle ID (OCID).
- Returns
The id of this CrossConnectGroup.
- Return type
str
- property interface_down_timer_value_in_milliseconds¶
Gets the interface_down_timer_value_in_milliseconds of this CrossConnectGroup. The duration of the interface down timer in milliseconds between 0 and 3000 in multiples of 500.
- Returns
The interface_down_timer_value_in_milliseconds of this CrossConnectGroup.
- Return type
int
- property is_interface_hold_timer_enabled¶
Gets the is_interface_hold_timer_enabled of this CrossConnectGroup. The flag to enable or disable the down timer for the interface.
- Returns
The is_interface_hold_timer_enabled of this CrossConnectGroup.
- Return type
bool
- property is_qos_enabled¶
Gets the is_qos_enabled of this CrossConnectGroup. The flag to enable or disable the Qos for the cross-connect-group.
- Returns
The is_qos_enabled of this CrossConnectGroup.
- Return type
bool
- property 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
- property macsec_properties¶
Gets the macsec_properties of this CrossConnectGroup.
- Returns
The macsec_properties of this CrossConnectGroup.
- Return type
- property minimum_links¶
Gets the minimum_links of this CrossConnectGroup. Minimum number of active cross-connects required for the cross-connect group to be considered operational. If the number of active cross-connects falls below this value, the group is not considered operational. If this value was not explicitly set when the group was created or updated, it defaults to 1.
- Returns
The minimum_links of this CrossConnectGroup.
- Return type
int
- property 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
- property 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
- property system_tags¶
Gets the system_tags of this CrossConnectGroup. Usage of system tag keys. These predefined keys are scoped to namespaces. Example: { “orcl-cloud”: { “free-tier-retained”: “true” } }
- Returns
The system_tags of this CrossConnectGroup.
- Return type
dict(str, dict(str, object))