cross_connect_groups

Creates, updates, deletes, gets or lists a cross_connect_groups resource.

Overview

Name	`cross_connect_groups`
Type	Resource
Id	`oci.network.cross_connect_groups`

Fields

The following fields are returned by SELECT queries:

get
list

The cross-connect group was retrieved.

Name	Datatype	Description
`id`	`string`	The cross-connect group's Oracle ID (OCID).
`compartmentId`	`string`	The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment containing the cross-connect group.
`customerReferenceName`	`string`	A reference name or identifier for the physical fiber connection that this cross-connect group uses.
`definedTags`	`object`	Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}`
`displayName`	`string`	A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
`freeformTags`	`object`	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](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}`
`lifecycleState`	`string`	The cross-connect group's current state. (PROVISIONING, PROVISIONED, INACTIVE, TERMINATING, TERMINATED)
`macsecProperties`	`object`	Properties used for MACsec (if capable).
`ociLogicalDeviceName`	`string`	The FastConnect device that terminates the logical connection. This device might be different than the device that terminates the physical connection.
`ociPhysicalDeviceName`	`string`	The FastConnect device that terminates the physical connection.
`systemTags`	`object`	Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{ "orcl-cloud": { "free-tier-retained": "true" } }`
`timeCreated`	`string (date-time)`	The date and time the cross-connect group was created, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z`

For use with Oracle Cloud Infrastructure FastConnect. A cross-connect group is a link aggregation group (LAG), which can contain one or more [CrossConnects](#/en/iaas/latest/CrossConnect). Customers who are colocated with Oracle in a FastConnect location create and use cross-connect groups. For more information, see [FastConnect Overview](/iaas/Content/Network/Concepts/fastconnect.htm). 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](/iaas/Content/Identity/Concepts/policygetstarted.htm).

Name	Datatype	Description
`id`	`string`	The cross-connect group's Oracle ID (OCID).
`compartmentId`	`string`	The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment containing the cross-connect group.
`customerReferenceName`	`string`	A reference name or identifier for the physical fiber connection that this cross-connect group uses.
`definedTags`	`object`	Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}`
`displayName`	`string`	A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
`freeformTags`	`object`	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](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}`
`lifecycleState`	`string`	The cross-connect group's current state. (PROVISIONING, PROVISIONED, INACTIVE, TERMINATING, TERMINATED)
`macsecProperties`	`object`	Properties used for MACsec (if capable).
`ociLogicalDeviceName`	`string`	The FastConnect device that terminates the logical connection. This device might be different than the device that terminates the physical connection.
`ociPhysicalDeviceName`	`string`	The FastConnect device that terminates the physical connection.
`systemTags`	`object`	Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{ "orcl-cloud": { "free-tier-retained": "true" } }`
`timeCreated`	`string (date-time)`	The date and time the cross-connect group was created, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z`

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
`get`	`select`	`crossConnectGroupId`, `region`		Gets the specified cross-connect group's information.
`list`	`select`	`compartmentId`, `region`	`limit`, `page`, `displayName`, `sortBy`, `sortOrder`, `lifecycleState`	Lists the cross-connect groups in the specified compartment.<br />
`create`	`insert`	`region`, `compartmentId`	`opc-retry-token`	Creates a new cross-connect group to use with Oracle Cloud Infrastructure<br />FastConnect. For more information, see<br />[FastConnect Overview](/iaas/Content/Network/Concepts/fastconnect.htm).<br /><br />For the purposes of access control, you must provide the [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the<br />compartment where you want the cross-connect group to reside. If you're<br />not sure which compartment to use, put the cross-connect group in the<br />same compartment with your VCN. For more information about<br />compartments and access control, see<br />[Overview of the IAM Service](/iaas/Content/Identity/Concepts/overview.htm).<br />For information about OCIDs, see<br />[Resource Identifiers](/iaas/Content/General/Concepts/identifiers.htm).<br /><br />You may optionally specify a display name for the cross-connect group.<br />It does not have to be unique, and you can change it. Avoid entering confidential information.<br />
`update`	`update`	`crossConnectGroupId`, `region`	`if-match`	Updates the specified cross-connect group's display name.<br />Avoid entering confidential information.<br />
`delete`	`delete`	`crossConnectGroupId`, `region`	`if-match`	Deletes the specified cross-connect group. It must not contain any<br />cross-connects, and it cannot be mapped to a<br />[VirtualCircuit](#/en/iaas/latest/VirtualCircuit/).<br />
`change_compartment`	`exec`	`crossConnectGroupId`, `region`, `compartmentId`	`opc-request-id`, `opc-retry-token`	Moves a cross-connect group into a different compartment within the same tenancy. For information<br />about moving resources between compartments, see<br />[Moving Resources to a Different Compartment](/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes).<br />

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
`compartmentId`	`string`	The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment.
`crossConnectGroupId`	`string`	The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the cross-connect group.
`region`	`string`	OCI region identifier (e.g. us-ashburn-1, ap-sydney-1); resolves from OCI_REGION when not supplied in the query. (default: us-ashburn-1, x-stackQL-envVar: OCI_REGION)
`displayName`	`string`	A filter to return only resources that match the given display name exactly.
`if-match`	`string`	For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`lifecycleState`	`string`	A filter to return only resources that match the specified lifecycle state. The value is case insensitive.
`limit`	`integer`	For list pagination. The maximum number of results per page, or items to return in a paginated "List" call. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). Example: `50`
`opc-request-id`	`string`	Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`opc-retry-token`	`string`	A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (for example, if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected).
`page`	`string`	For list pagination. The value of the `opc-next-page` response header from the previous "List" call. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).
`sortBy`	`string`	The field to sort by. You can provide one sort order (`sortOrder`). Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive. Note: In general, some "List" operations (for example, `ListInstances`) let you optionally filter by availability domain if the scope of the resource type is within a single availability domain. If you call one of these "List" operations without specifying an availability domain, the resources are grouped by availability domain, then sorted.
`sortOrder`	`string`	The sort order to use, either ascending (`ASC`) or descending (`DESC`). The DISPLAYNAME sort order is case sensitive.

`SELECT` examples

get
list

Gets the specified cross-connect group's information.

SELECT
id,
compartmentId,
customerReferenceName,
definedTags,
displayName,
freeformTags,
lifecycleState,
macsecProperties,
ociLogicalDeviceName,
ociPhysicalDeviceName,
systemTags,
timeCreated
FROM oci.network.cross_connect_groups
WHERE crossConnectGroupId = '{{ crossConnectGroupId }}' -- required
AND region = '{{ region }}' -- required
;

Lists the cross-connect groups in the specified compartment.

SELECT
id,
compartmentId,
customerReferenceName,
definedTags,
displayName,
freeformTags,
lifecycleState,
macsecProperties,
ociLogicalDeviceName,
ociPhysicalDeviceName,
systemTags,
timeCreated
FROM oci.network.cross_connect_groups
WHERE compartmentId = '{{ compartmentId }}' -- required
AND region = '{{ region }}' -- required
AND limit = '{{ limit }}'
AND page = '{{ page }}'
AND displayName = '{{ displayName }}'
AND sortBy = '{{ sortBy }}'
AND sortOrder = '{{ sortOrder }}'
AND lifecycleState = '{{ lifecycleState }}'
;

`INSERT` examples

create
Manifest

Creates a new cross-connect group to use with Oracle Cloud Infrastructure FastConnect. For more information, see [FastConnect Overview](/iaas/Content/Network/Concepts/fastconnect.htm). For the purposes of access control, you must provide the [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment where you want the cross-connect group to reside. If you're not sure which compartment to use, put the cross-connect group in the same compartment with your VCN. For more information about compartments and access control, see [Overview of the IAM Service](/iaas/Content/Identity/Concepts/overview.htm). For information about OCIDs, see [Resource Identifiers](/iaas/Content/General/Concepts/identifiers.htm). You may optionally specify a display name for the cross-connect group. It does not have to be unique, and you can change it. Avoid entering confidential information.

INSERT INTO oci.network.cross_connect_groups (
compartmentId,
customerReferenceName,
definedTags,
displayName,
freeformTags,
macsecProperties,
region,
opc-retry-token
)
SELECT 
'{{ compartmentId }}' /* required */,
'{{ customerReferenceName }}',
'{{ definedTags }}',
'{{ displayName }}',
'{{ freeformTags }}',
'{{ macsecProperties }}',
'{{ region }}',
'{{ opc-retry-token }}'
RETURNING
id,
compartmentId,
customerReferenceName,
definedTags,
displayName,
freeformTags,
lifecycleState,
macsecProperties,
ociLogicalDeviceName,
ociPhysicalDeviceName,
systemTags,
timeCreated
;

# Description fields are for documentation purposes
- name: cross_connect_groups
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the cross_connect_groups resource.
  - name: compartmentId
    value: "{{ compartmentId }}"
    description: |
      The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment to contain the cross-connect group.
  - name: customerReferenceName
    value: "{{ customerReferenceName }}"
    description: |
      A reference name or identifier for the physical fiber connection that this cross-connect
      group uses.
  - name: definedTags
    value: "{{ definedTags }}"
    description: |
      Defined tags for this resource. Each key is predefined and scoped to a
      namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm).
      Example: `{"Operations": {"CostCenter": "42"}}`
  - name: displayName
    value: "{{ displayName }}"
    description: |
      A user-friendly name. Does not have to be unique, and it's changeable.
      Avoid entering confidential information.
  - name: freeformTags
    value: "{{ freeformTags }}"
    description: |
      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](/iaas/Content/General/Concepts/resourcetags.htm).
      Example: `{"Department": "Finance"}`
  - name: macsecProperties
    description: |
      Properties used to configure MACsec (if capable).
    value:
      encryptionCipher: "{{ encryptionCipher }}"
      isUnprotectedTrafficAllowed: {{ isUnprotectedTrafficAllowed }}
      primaryKey:
        connectivityAssociationKeySecretId: "{{ connectivityAssociationKeySecretId }}"
        connectivityAssociationNameSecretId: "{{ connectivityAssociationNameSecretId }}"
      state: "{{ state }}"
  - name: opc-retry-token
    value: "{{ opc-retry-token }}"
    description: A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (for example, if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected). 
    description: A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (for example, if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected). 

`UPDATE` examples

update

Updates the specified cross-connect group's display name. Avoid entering confidential information.

UPDATE oci.network.cross_connect_groups
SET 
customerReferenceName = '{{ customerReferenceName }}',
definedTags = '{{ definedTags }}',
displayName = '{{ displayName }}',
freeformTags = '{{ freeformTags }}',
macsecProperties = '{{ macsecProperties }}'
WHERE 
crossConnectGroupId = '{{ crossConnectGroupId }}' --required
AND region = '{{ region }}' --required
AND if-match = '{{ if-match}}'
RETURNING
id,
compartmentId,
customerReferenceName,
definedTags,
displayName,
freeformTags,
lifecycleState,
macsecProperties,
ociLogicalDeviceName,
ociPhysicalDeviceName,
systemTags,
timeCreated;

`DELETE` examples

delete

Deletes the specified cross-connect group. It must not contain any cross-connects, and it cannot be mapped to a [VirtualCircuit](#/en/iaas/latest/VirtualCircuit/).

DELETE FROM oci.network.cross_connect_groups
WHERE crossConnectGroupId = '{{ crossConnectGroupId }}' --required
AND region = '{{ region }}' --required
AND if-match = '{{ if-match }}'
;

Lifecycle Methods

change_compartment

Moves a cross-connect group into a different compartment within the same tenancy. For information about moving resources between compartments, see [Moving Resources to a Different Compartment](/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes).

EXEC oci.network.cross_connect_groups.change_compartment 
@crossConnectGroupId='{{ crossConnectGroupId }}' --required, 
@region='{{ region }}' --required, 
@opc-request-id='{{ opc-request-id }}', 
@opc-retry-token='{{ opc-retry-token }}' 
@@json=
'{
"compartmentId": "{{ compartmentId }}"
}'
;

Overview​

Fields​

Methods​

Parameters​

SELECT examples​

INSERT examples​

UPDATE examples​

DELETE examples​

Lifecycle Methods​