oci core cross connect
Overview
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.
Warning: Oracle recommends that you avoid using any confidential information when you supply string values using the API.
This documentation is generated from the Ruby OCI SDK.
Attributes
| Attribute Name | Short Description |
|---|---|
| absent_states | The OCI states, pupet will detect as the resource beeing absent. |
| compartment | The Puppet® name of the resource identified by compartment_id. |
| compartment_id | The OCID of the compartment that contains the object. |
| cross_connect_group | The Puppet® name of the resource identified by cross_connect_group_id. |
| cross_connect_group_id | The OCID of the cross-connect group to put this cross-connect in. |
| cross_connect_name | The name of the cross_connect. |
| customer_reference_name | uses. |
| defined_tags | Defined tags for this resource. |
| disable_corrective_change | Disable the modification of a resource when Puppet® decides it is a corrective change. |
| disable_corrective_ensure | Disable the creation or removal of a resource when Puppet® decides is a corrective change. |
| ensure | The basic property that the resource should be in. |
| far_cross_connect_or_cross_connect_group | The Puppet® name of the resource identified by far_cross_connect_or_cross_connect_group_id. |
| far_cross_connect_or_cross_connect_group_id | cross-connect group. |
| freeform_tags | Free-form tags for this resource. |
| id | The OCID of the resource. |
| lifecycle_state | The cross-connect’s current state. |
| location_name | The name of the FastConnect location where this cross-connect will be installed. |
| name | The full name of the object. |
| near_cross_connect_or_cross_connect_group | The Puppet® name of the resource identified by near_cross_connect_or_cross_connect_group_id. |
| near_cross_connect_or_cross_connect_group_id | OCID of that existing cross-connect or cross-connect group. |
| oci_timeout | The maximum time to wait for the OCI resource to be in the ready state. |
| oci_wait_interval | The interval beween calls to OCI to check if a resource is in the ready state. |
| port_name | A string identifying the meet-me room port for this cross-connect. |
| port_speed_shape_name | The port speed for this cross-connect. |
| present_states | The OCI states, pupet will detect as the resource beeing present. |
| provider | resource. |
| synchronized | Specifies if Puppet® waits for OCI actions to be ready before moving on to an other resource. |
| tenant | The tenant for this resource. |
| time_created | The date and time the cross-connect was created, in the format defined by RFC3339. |
absent_states
The OCI states, pupet will detect as the resource beeing absent.
Back to overview of oci_core_cross_connect
compartment
The Puppet® name of the resource identified by compartment_id.
See the documentation of compartment_id for all details.
This documentation is generated from the Ruby OCI SDK.
Back to overview of oci_core_cross_connect
compartment_id
The OCID of the compartment that contains the object.
Rather use the property compartment instead of a direct OCID reference.
This documentation is generated from the Ruby OCI SDK.
Back to overview of oci_core_cross_connect
cross_connect_group
The Puppet® name of the resource identified by cross_connect_group_id.
See the documentation of cross_connect_group_id for all details.
This documentation is generated from the Ruby OCI SDK.
Back to overview of oci_core_cross_connect
cross_connect_group_id
The OCID of the cross-connect group to put this cross-connect in. Rather use the property cross_connect_group instead of a direct OCID reference.
This documentation is generated from the Ruby OCI SDK.
Back to overview of oci_core_cross_connect
cross_connect_name
The name of the cross_connect.
Back to overview of oci_core_cross_connect
customer_reference_name
A reference name or identifier for the physical fiber connection that this cross-connect uses.
This documentation is generated from the Ruby OCI SDK.
Back to overview of oci_core_cross_connect
defined_tags
Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
Example: {"Operations": {"CostCenter": "42"}}
This documentation is generated from the Ruby OCI SDK.
Back to overview of oci_core_cross_connect
disable_corrective_change
Disable the modification of a resource when Puppet® decides it is a corrective change.
(requires easy_type V2.11.0 or higher)
When using a Puppet® Server, Puppet® knows about adaptive and corrective changes. A corrective change is when Puppet® notices that the resource has changed, but the catalog has not changed. This can occur for example, when a user, by accident or willingly, changed something on the system that Puppet® is managing. The normal Puppet® process then repairs this and puts the resource back in the state as defined in the catalog. This process is precisely what you want most of the time, but not always. This can sometimes also occur when a hardware or network error occurs. Then Puppet® cannot correctly determine the current state of the system and thinks the resource is changed, while in fact, it is not. Letting Puppet recreate remove or change the resource in these cases, is NOT wat you want.
Using the disable_corrective_change parameter, you can disable corrective changes on the current resource.
Here is an example of this:
crucial_resource {'be_carefull':
...
disable_corrective_change => true,
...
}
When a corrective ensure does happen on the resource Puppet® will not modify the resource and signal an error:
Error: Corrective change present requested by catalog, but disabled by parameter disable_corrective_change
Error: /Stage[main]/Main/Crucial_resource[be_carefull]/parameter: change from '10' to '20' failed: Corrective change present requested by catalog, but disabled by parameter disable_corrective_change. (corrective)
Back to overview of oci_core_cross_connect
disable_corrective_ensure
Disable the creation or removal of a resource when Puppet® decides is a corrective change.
(requires easy_type V2.11.0 or higher)
When using a Puppet® Server, Puppet® knows about adaptive and corrective changes. A corrective change is when Puppet® notices that the resource has changed, but the catalog has not changed. This can occur for example, when a user, by accident or willingly, changed something on the system that Puppet® is managing. The normal Puppet® process then repairs this and puts the resource back in the state as defined in the catalog. This process is precisely what you want most of the time, but not always. This can sometimes also occur when a hardware or network error occurs. Then Puppet® cannot correctly determine the current state of the system and thinks the resource is changed, while in fact, it is not. Letting Puppet recreate remove or change the resource in these cases, is NOT wat you want.
Using the disable_corrective_ensure parameter, you can disable corrective ensure present or ensure absent actions on the current resource.
Here is an example of this:
crucial_resource {'be_carefull':
ensure => 'present',
...
disable_corrective_ensure => true,
...
}
When a corrective ensure does happen on the resource Puppet® will not create or remove the resource and signal an error:
Error: Corrective ensure present requested by catalog, but disabled by parameter disable_corrective_ensure.
Error: /Stage[main]/Main/Crucial_resource[be_carefull]/ensure: change from 'absent' to 'present' failed: Corrective ensure present requested by catalog, but disabled by parameter disable_corrective_ensure. (corrective)
Back to overview of oci_core_cross_connect
ensure
The basic property that the resource should be in.
Valid values are present, absent.
Back to overview of oci_core_cross_connect
far_cross_connect_or_cross_connect_group
The Puppet® name of the resource identified by far_cross_connect_or_cross_connect_group_id.
See the documentation of far_cross_connect_or_cross_connect_group_id for all details.
This documentation is generated from the Ruby OCI SDK.
Back to overview of oci_core_cross_connect
far_cross_connect_or_cross_connect_group_id
If you already have an existing cross-connect or cross-connect group at this FastConnect location, and you want this new cross-connect to be on a different router (for the purposes of redundancy), provide the OCID of that existing cross-connect or cross-connect group. Rather use the property far_cross_connect_or_cross_connect_group instead of a direct OCID reference.
This documentation is generated from the Ruby OCI SDK.
Back to overview of oci_core_cross_connect
freeform_tags
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"}
This documentation is generated from the Ruby OCI SDK.
Back to overview of oci_core_cross_connect
id
The OCID of the resource. This is a read-only property.
This documentation is generated from the Ruby OCI SDK.
Back to overview of oci_core_cross_connect
lifecycle_state
The cross-connect’s current state.
This documentation is generated from the Ruby OCI SDK.
Back to overview of oci_core_cross_connect
location_name
The name of the FastConnect location where this cross-connect will be installed. To get a list of the available locations, see {#list_cross_connect_locations list_cross_connect_locations}.
Example: CyrusOne, Chandler, AZ
This documentation is generated from the Ruby OCI SDK.
Back to overview of oci_core_cross_connect
name
The full name of the object.
Back to overview of oci_core_cross_connect
near_cross_connect_or_cross_connect_group
The Puppet® name of the resource identified by near_cross_connect_or_cross_connect_group_id.
See the documentation of near_cross_connect_or_cross_connect_group_id for all details.
This documentation is generated from the Ruby OCI SDK.
Back to overview of oci_core_cross_connect
near_cross_connect_or_cross_connect_group_id
If you already have an existing cross-connect or cross-connect group at this FastConnect location, and you want this new cross-connect to be on the same router, provide the OCID of that existing cross-connect or cross-connect group. Rather use the property near_cross_connect_or_cross_connect_group instead of a direct OCID reference.
This documentation is generated from the Ruby OCI SDK.
Back to overview of oci_core_cross_connect
oci_timeout
The maximum time to wait for the OCI resource to be in the ready state.
Back to overview of oci_core_cross_connect
oci_wait_interval
The interval beween calls to OCI to check if a resource is in the ready state.
Back to overview of oci_core_cross_connect
port_name
A string identifying the meet-me room port for this cross-connect.
This documentation is generated from the Ruby OCI SDK.
Back to overview of oci_core_cross_connect
port_speed_shape_name
The port speed for this cross-connect. To get a list of the available port speeds, see {#list_crossconnect_port_speed_shapes list_crossconnect_port_speed_shapes}.
Example: 10 Gbps
This documentation is generated from the Ruby OCI SDK.
Back to overview of oci_core_cross_connect
present_states
The OCI states, pupet will detect as the resource beeing present.
Back to overview of oci_core_cross_connect
provider
The specific backend to use for this oci_core_cross_connect resource. You will seldom need to specify this — Puppet® will usually discover the appropriate provider for your platform.Available providers are:
- sdk
Back to overview of oci_core_cross_connect
synchronized
Specifies if Puppet® waits for OCI actions to be ready before moving on to an other resource.
Back to overview of oci_core_cross_connect
tenant
The tenant for this resource.
Back to overview of oci_core_cross_connect
time_created
The date and time the cross-connect was created, in the format defined by RFC3339.
Example: 2016-08-25T21:10:29.600Z
This documentation is generated from the Ruby OCI SDK.
