|
| 1 | +# oci_core_cross_connect |
| 2 | + |
| 3 | +## CrossConnect Resource |
| 4 | + |
| 5 | +### CrossConnect Reference |
| 6 | + |
| 7 | +The following attributes are exported: |
| 8 | + |
| 9 | +* `compartment_id` - The OCID of the compartment containing the cross-connect group. |
| 10 | +* `cross_connect_group_id` - The OCID of the cross-connect group this cross-connect belongs to (if any). |
| 11 | +* `display_name` - A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. |
| 12 | +* `id` - The cross-connect's Oracle ID (OCID). |
| 13 | +* `location_name` - The name of the FastConnect location where this cross-connect is installed. |
| 14 | +* `port_name` - A string identifying the meet-me room port for this cross-connect. |
| 15 | +* `port_speed_shape_name` - The port speed for this cross-connect. Example: `10 Gbps` |
| 16 | +* `state` - The cross-connect's current state. |
| 17 | +* `time_created` - The date and time the cross-connect was created, in the format defined by RFC3339. Example: `2016-08-25T21:10:29.600Z` |
| 18 | + |
| 19 | + |
| 20 | + |
| 21 | +### Create Operation |
| 22 | +Creates a new cross-connect. Oracle recommends you create each cross-connect in a |
| 23 | +[CrossConnectGroup](https://docs.us-phoenix-1.oraclecloud.com/api/#/en/iaas/20160918/CrossConnectGroup) so you can use link aggregation |
| 24 | +with the connection. |
| 25 | + |
| 26 | +After creating the `CrossConnect` object, you need to go the FastConnect location |
| 27 | +and request to have the physical cable installed. For more information, see |
| 28 | +[FastConnect Overview](https://docs.us-phoenix-1.oraclecloud.com/Content/Network/Concepts/fastconnect.htm). |
| 29 | + |
| 30 | +For the purposes of access control, you must provide the OCID of the |
| 31 | +compartment where you want the cross-connect to reside. If you're |
| 32 | +not sure which compartment to use, put the cross-connect in the |
| 33 | +same compartment with your VCN. For more information about |
| 34 | +compartments and access control, see |
| 35 | +[Overview of the IAM Service](https://docs.us-phoenix-1.oraclecloud.com/Content/Identity/Concepts/overview.htm). |
| 36 | +For information about OCIDs, see |
| 37 | +[Resource Identifiers](https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/identifiers.htm). |
| 38 | + |
| 39 | +You may optionally specify a *display name* for the cross-connect. |
| 40 | +It does not have to be unique, and you can change it. Avoid entering confidential information. |
| 41 | + |
| 42 | + |
| 43 | +The following arguments are supported: |
| 44 | + |
| 45 | +* `compartment_id` - (Required) The OCID of the compartment to contain the cross-connect. |
| 46 | +* `cross_connect_group_id` - (Optional) The OCID of the cross-connect group to put this cross-connect in. |
| 47 | +* `display_name` - (Optional) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. |
| 48 | +* `far_cross_connect_or_cross_connect_group_id` - (Optional) 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. |
| 49 | +* `location_name` - (Required) The name of the FastConnect location where this cross-connect will be installed. To get a list of the available locations, see [ListCrossConnectLocations](https://docs.us-phoenix-1.oraclecloud.com/api/#/en/iaas/20160918/CrossConnectLocation/ListCrossConnectLocations). Example: `CyrusOne, Chandler, AZ` |
| 50 | +* `near_cross_connect_or_cross_connect_group_id` - (Optional) 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. |
| 51 | +* `port_speed_shape_name` - (Required) The port speed for this cross-connect. To get a list of the available port speeds, see [ListCrossConnectPortSpeedShapes](https://docs.us-phoenix-1.oraclecloud.com/api/#/en/iaas/20160918/CrossConnectPortSpeedShape/ListCrossconnectPortSpeedShapes). Example: `10 Gbps` |
| 52 | +* `is_active` - (Optional) Set to true to activate the cross-connect. You activate it after the physical cabling is complete, and you've confirmed the cross-connect's light levels are good and your side of the interface is up. Activation indicates to Oracle that the physical connection is ready. |
| 53 | + |
| 54 | + |
| 55 | +### Update Operation |
| 56 | +Updates the specified cross-connect. |
| 57 | + |
| 58 | +The following arguments support updates: |
| 59 | +* `display_name` - A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. |
| 60 | +* `is_active` - (Optional) Set to true to activate the cross-connect. You activate it after the physical cabling is complete, and you've confirmed the cross-connect's light levels are good and your side of the interface is up. Activation indicates to Oracle that the physical connection is ready. |
| 61 | + |
| 62 | + |
| 63 | +** IMPORTANT ** |
| 64 | +Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values |
| 65 | + |
| 66 | +### Example Usage |
| 67 | + |
| 68 | +```hcl |
| 69 | +resource "oci_core_cross_connect" "test_cross_connect" { |
| 70 | + #Required |
| 71 | + compartment_id = "${var.compartment_id}" |
| 72 | + location_name = "${var.cross_connect_location_name}" |
| 73 | + port_speed_shape_name = "${var.cross_connect_port_speed_shape_name}" |
| 74 | +
|
| 75 | + #Optional |
| 76 | + cross_connect_group_id = "${oci_core_cross_connect_group.test_cross_connect_group.id}" |
| 77 | + display_name = "${var.cross_connect_display_name}" |
| 78 | + far_cross_connect_or_cross_connect_group_id = "${oci_core_far_cross_connect_or_cross_connect_group.test_far_cross_connect_or_cross_connect_group.id}" |
| 79 | + near_cross_connect_or_cross_connect_group_id = "${oci_core_near_cross_connect_or_cross_connect_group.test_near_cross_connect_or_cross_connect_group.id}" |
| 80 | +} |
| 81 | +``` |
| 82 | + |
| 83 | + |
| 84 | +## CrossConnect Singular DataSource |
| 85 | + |
| 86 | + |
| 87 | +### Get Operation |
| 88 | +Gets the specified cross-connect's information. |
| 89 | + |
| 90 | +The following arguments are supported: |
| 91 | + |
| 92 | +* `cross_connect_id` - (Required) The OCID of the cross-connect. |
| 93 | + |
| 94 | + |
| 95 | +### Example Usage |
| 96 | + |
| 97 | +```hcl |
| 98 | +data "oci_core_cross_connect" "test_cross_connect" { |
| 99 | + #Required |
| 100 | + cross_connect_id = "${var.cross_connect_cross_connect_id}" |
| 101 | +} |
| 102 | +``` |
| 103 | +# oci_core_cross_connects |
| 104 | + |
| 105 | +## CrossConnect DataSource |
| 106 | + |
| 107 | +Gets a list of cross_connects. |
| 108 | + |
| 109 | +### List Operation |
| 110 | +Lists the cross-connects in the specified compartment. You can filter the list |
| 111 | +by specifying the OCID of a cross-connect group. |
| 112 | + |
| 113 | +The following arguments are supported: |
| 114 | + |
| 115 | +* `compartment_id` - (Required) The OCID of the compartment. |
| 116 | +* `cross_connect_group_id` - (Optional) The OCID of the cross-connect group. |
| 117 | +* `display_name` - (Optional) A filter to return only resources that match the given display name exactly. |
| 118 | +* `state` - (Optional) A filter to return only resources that match the specified lifecycle state. The value is case insensitive. |
| 119 | + |
| 120 | + |
| 121 | +The following attributes are exported: |
| 122 | + |
| 123 | +* `cross_connects` - The list of cross_connects. |
| 124 | + |
| 125 | +### Example Usage |
| 126 | + |
| 127 | +```hcl |
| 128 | +data "oci_core_cross_connects" "test_cross_connects" { |
| 129 | + #Required |
| 130 | + compartment_id = "${var.compartment_id}" |
| 131 | +
|
| 132 | + #Optional |
| 133 | + cross_connect_group_id = "${oci_core_cross_connect_group.test_cross_connect_group.id}" |
| 134 | + display_name = "${var.cross_connect_display_name}" |
| 135 | + state = "${var.cross_connect_state}" |
| 136 | +} |
| 137 | +``` |
0 commit comments