oracle / oracle.oci / 4.32.0 / module / oci_network_cross_connect_group Manage a CrossConnectGroup resource in Oracle Cloud Infrastructure | "added in version" 2.9.0 of oracle.oci" Authors: Oracle (@oracle) preview | supported by communityoracle.oci.oci_network_cross_connect_group (4.32.0) — module
Install with ansible-galaxy collection install oracle.oci:==4.32.0
collections: - name: oracle.oci version: 4.32.0
This module allows the user to create, update and delete a CrossConnectGroup resource in Oracle Cloud Infrastructure
For I(state=present), creates a new cross-connect group to use with Oracle Cloud Infrastructure FastConnect. For more information, see L(FastConnect Overview,https://docs.cloud.oracle.com/iaas/Content/Network/Concepts/fastconnect.htm).
For the purposes of access control, you must provide the L(OCID,https://docs.cloud.oracle.com/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 L(Overview of the IAM Service,https://docs.cloud.oracle.com/iaas/Content/Identity/Concepts/overview.htm). For information about OCIDs, see L(Resource Identifiers,https://docs.cloud.oracle.com/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.
This resource has the following action operations in the M(oracle.oci.oci_network_cross_connect_group_actions) module: change_compartment.
- name: Create cross_connect_group oci_network_cross_connect_group: # required compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx" # optional defined_tags: {'Operations': {'CostCenter': 'US'}} display_name: display_name_example customer_reference_name: customer_reference_name_example freeform_tags: {'Department': 'Finance'} macsec_properties: # required state: ENABLED # optional primary_key: # required connectivity_association_name_secret_id: "ocid1.connectivityassociationnamesecret.oc1..xxxxxxEXAMPLExxxxxx" connectivity_association_key_secret_id: "ocid1.connectivityassociationkeysecret.oc1..xxxxxxEXAMPLExxxxxx" # optional connectivity_association_name_secret_version: 56 connectivity_association_key_secret_version: 56 encryption_cipher: AES128_GCM
- name: Update cross_connect_group oci_network_cross_connect_group: # required cross_connect_group_id: "ocid1.crossconnectgroup.oc1..xxxxxxEXAMPLExxxxxx" # optional defined_tags: {'Operations': {'CostCenter': 'US'}} display_name: display_name_example customer_reference_name: customer_reference_name_example freeform_tags: {'Department': 'Finance'} macsec_properties: # required state: ENABLED # optional primary_key: # required connectivity_association_name_secret_id: "ocid1.connectivityassociationnamesecret.oc1..xxxxxxEXAMPLExxxxxx" connectivity_association_key_secret_id: "ocid1.connectivityassociationkeysecret.oc1..xxxxxxEXAMPLExxxxxx" # optional connectivity_association_name_secret_version: 56 connectivity_association_key_secret_version: 56 encryption_cipher: AES128_GCM
- name: Update cross_connect_group using name (when environment variable OCI_USE_NAME_AS_IDENTIFIER is set) oci_network_cross_connect_group: # required compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx" display_name: display_name_example # optional defined_tags: {'Operations': {'CostCenter': 'US'}} customer_reference_name: customer_reference_name_example freeform_tags: {'Department': 'Finance'} macsec_properties: # required state: ENABLED # optional primary_key: # required connectivity_association_name_secret_id: "ocid1.connectivityassociationnamesecret.oc1..xxxxxxEXAMPLExxxxxx" connectivity_association_key_secret_id: "ocid1.connectivityassociationkeysecret.oc1..xxxxxxEXAMPLExxxxxx" # optional connectivity_association_name_secret_version: 56 connectivity_association_key_secret_version: 56 encryption_cipher: AES128_GCM
- name: Delete cross_connect_group oci_network_cross_connect_group: # required cross_connect_group_id: "ocid1.crossconnectgroup.oc1..xxxxxxEXAMPLExxxxxx" state: absent
- name: Delete cross_connect_group using name (when environment variable OCI_USE_NAME_AS_IDENTIFIER is set) oci_network_cross_connect_group: # required compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx" display_name: display_name_example state: absent
wait: default: true description: Whether to wait for create or delete operation to complete. type: bool state: choices: - present - absent default: present description: - The state of the CrossConnectGroup. - Use I(state=present) to create or update a CrossConnectGroup. - Use I(state=absent) to delete a CrossConnectGroup. required: false type: str key_by: description: The list of attributes of this resource which should be used to uniquely identify an instance of the resource. By default, all the attributes of a resource are used to uniquely identify a resource. elements: str type: list region: description: - The Oracle Cloud Infrastructure region to use for all OCI API requests. If not set, then the value of the OCI_REGION variable, if any, is used. This option is required if the region is not specified through a configuration file (See C(config_file_location)). Please refer to U(https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/regions.htm) for more information on OCI regions. type: str tenancy: description: - OCID of your tenancy. If not set, then the value of the OCI_TENANCY variable, if any, is used. This option is required if the tenancy OCID is not specified through a configuration file (See C(config_file_location)). To get the tenancy OCID, please refer U(https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/apisigningkey.htm) type: str api_user: description: - The OCID of the user, on whose behalf, OCI APIs are invoked. If not set, then the value of the OCI_USER_ID environment variable, if any, is used. This option is required if the user is not specified through a configuration file (See C(config_file_location)). To get the user's OCID, please refer U(https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/apisigningkey.htm). type: str auth_type: choices: - api_key - instance_principal - instance_obo_user - resource_principal - security_token default: api_key description: - The type of authentication to use for making API requests. By default C(auth_type="api_key") based authentication is performed and the API key (see I(api_user_key_file)) in your config file will be used. If this 'auth_type' module option is not specified, the value of the OCI_ANSIBLE_AUTH_TYPE, if any, is used. Use C(auth_type="instance_principal") to use instance principal based authentication when running ansible playbooks within an OCI compute instance. type: str cert_bundle: description: - The full path to a CA certificate bundle to be used for SSL verification. This will override the default CA certificate bundle. If not set, then the value of the OCI_ANSIBLE_CERT_BUNDLE variable, if any, is used. type: str auth_purpose: choices: - service_principal description: - The auth purpose which can be used in conjunction with 'auth_type=instance_principal'. The default auth_purpose for instance_principal is None. type: str defined_tags: description: - Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see L(Resource Tags,https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). - 'Example: `{"Operations": {"CostCenter": "42"}}`' - This parameter is updatable. type: dict display_name: aliases: - name description: - A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. - Required for create, update, delete when environment variable C(OCI_USE_NAME_AS_IDENTIFIER) is set. - This parameter is updatable when C(OCI_USE_NAME_AS_IDENTIFIER) is not set. type: str force_create: default: false description: Whether to attempt non-idempotent creation of a resource. By default, create resource is an idempotent operation, and doesn't create the resource if it already exists. Setting this option to true, forcefully creates a copy of the resource, even if it already exists.This option is mutually exclusive with I(key_by). type: bool wait_timeout: description: Time, in seconds, to wait when I(wait=yes). Defaults to 1200 for most of the services but some services might have a longer wait timeout. type: int freeform_tags: 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 L(Resource Tags,https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). - 'Example: `{"Department": "Finance"}`' - This parameter is updatable. type: dict compartment_id: description: - The L(OCID,https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment to contain the cross-connect group. - Required for create using I(state=present). - Required for update when environment variable C(OCI_USE_NAME_AS_IDENTIFIER) is set. - Required for delete when environment variable C(OCI_USE_NAME_AS_IDENTIFIER) is set. type: str api_user_key_file: description: - Full path and filename of the private key (in PEM format). If not set, then the value of the OCI_USER_KEY_FILE variable, if any, is used. This option is required if the private key is not specified through a configuration file (See C(config_file_location)). If the key is encrypted with a pass-phrase, the C(api_user_key_pass_phrase) option must also be provided. type: str macsec_properties: description: - '' - This parameter is updatable. suboptions: encryption_cipher: choices: - AES128_GCM - AES128_GCM_XPN - AES256_GCM - AES256_GCM_XPN description: - Type of encryption cipher suite to use for the MACsec connection. - This parameter is updatable. type: str primary_key: description: - '' suboptions: connectivity_association_key_secret_id: description: - Secret L(OCID,https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) containing the Connectivity Association Key (CAK) of this MACsec key. - 'NOTE: Only the latest secret version will be used.' - This parameter is updatable. required: true type: str connectivity_association_key_secret_version: description: - The secret version of the connectivityAssociationKey secret in Vault. - This parameter is updatable. type: int connectivity_association_name_secret_id: description: - Secret L(OCID,https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) containing the Connectivity association Key Name (CKN) of this MACsec key. - 'NOTE: Only the latest secret version will be used.' - This parameter is updatable. required: true type: str connectivity_association_name_secret_version: description: - The secret version of the connectivity association name secret in Vault. - This parameter is updatable. type: int type: dict state: choices: - ENABLED - DISABLED description: - Indicates whether or not MACsec is enabled. - This parameter is updatable. required: true type: str type: dict config_profile_name: description: - The profile to load from the config file referenced by C(config_file_location). If not set, then the value of the OCI_CONFIG_PROFILE environment variable, if any, is used. Otherwise, defaults to the "DEFAULT" profile in C(config_file_location). type: str api_user_fingerprint: description: - Fingerprint for the key pair being used. If not set, then the value of the OCI_USER_FINGERPRINT environment variable, if any, is used. This option is required if the key fingerprint is not specified through a configuration file (See C(config_file_location)). To get the key pair's fingerprint value please refer U(https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/apisigningkey.htm). type: str config_file_location: description: - Path to configuration file. If not set then the value of the OCI_CONFIG_FILE environment variable, if any, is used. Otherwise, defaults to ~/.oci/config. type: str cross_connect_group_id: aliases: - id description: - The L(OCID,https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the cross-connect group. - Required for update using I(state=present) when environment variable C(OCI_USE_NAME_AS_IDENTIFIER) is not set. - Required for delete using I(state=absent) when environment variable C(OCI_USE_NAME_AS_IDENTIFIER) is not set. type: str customer_reference_name: description: - A reference name or identifier for the physical fiber connection that this cross-connect group uses. - This parameter is updatable. type: str api_user_key_pass_phrase: description: - Passphrase used by the key referenced in C(api_user_key_file), if it is encrypted. If not set, then the value of the OCI_USER_KEY_PASS_PHRASE variable, if any, is used. This option is required if the key passphrase is not specified through a configuration file (See C(config_file_location)). type: str realm_specific_endpoint_template_enabled: description: - Enable/Disable realm specific endpoint template for service client. By Default, realm specific endpoint template is disabled. If not set, then the value of the OCI_REALM_SPECIFIC_SERVICE_ENDPOINT_TEMPLATE_ENABLED variable, if any, is used. type: bool
cross_connect_group: contains: compartment_id: description: - The L(OCID,https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment containing the cross-connect group. returned: on success sample: ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx type: str customer_reference_name: description: - A reference name or identifier for the physical fiber connection that this cross-connect group uses. returned: on success sample: customer_reference_name_example type: str defined_tags: description: - Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see L(Resource Tags,https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). - 'Example: `{"Operations": {"CostCenter": "42"}}`' returned: on success sample: Operations: CostCenter: US type: dict display_name: description: - A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. returned: on success sample: display_name_example type: str freeform_tags: 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 L(Resource Tags,https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). - 'Example: `{"Department": "Finance"}`' returned: on success sample: Department: Finance type: dict id: description: - The cross-connect group's Oracle ID (OCID). returned: on success sample: ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx type: str lifecycle_state: description: - The cross-connect group's current state. returned: on success sample: PROVISIONING type: str macsec_properties: contains: encryption_cipher: description: - Type of encryption cipher suite to use for the MACsec connection. returned: on success sample: AES128_GCM type: str primary_key: contains: connectivity_association_key_secret_id: description: - Secret L(OCID,https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) containing the Connectivity Association Key (CAK) of this MACsec key. returned: on success sample: ocid1.connectivityassociationkeysecret.oc1..xxxxxxEXAMPLExxxxxx type: str connectivity_association_key_secret_version: description: - The secret version of the `connectivityAssociationKey` secret in Vault. returned: on success sample: 56 type: int connectivity_association_name_secret_id: description: - Secret L(OCID,https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) containing the Connectivity association Key Name (CKN) of this MACsec key. returned: on success sample: ocid1.connectivityassociationnamesecret.oc1..xxxxxxEXAMPLExxxxxx type: str connectivity_association_name_secret_version: description: - The secret version of the connectivity association name secret in Vault. returned: on success sample: 56 type: int description: - '' returned: on success type: complex state: description: - Indicates whether or not MACsec is enabled. returned: on success sample: ENABLED type: str description: - '' returned: on success type: complex oci_logical_device_name: description: - The FastConnect device that terminates the logical connection. This device might be different than the device that terminates the physical connection. returned: on success sample: oci_logical_device_name_example type: str oci_physical_device_name: description: - The FastConnect device that terminates the physical connection. returned: on success sample: oci_physical_device_name_example type: str time_created: description: - The date and time the cross-connect group was created, in the format defined by L(RFC3339,https://tools.ietf.org/html/rfc3339). - 'Example: `2016-08-25T21:10:29.600Z`' returned: on success sample: '2013-10-20T19:20:30+01:00' type: str description: - Details of the CrossConnectGroup resource acted upon by the current operation returned: on success sample: compartment_id: ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx customer_reference_name: customer_reference_name_example defined_tags: Operations: CostCenter: US display_name: display_name_example freeform_tags: Department: Finance id: ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx lifecycle_state: PROVISIONING macsec_properties: encryption_cipher: AES128_GCM primary_key: connectivity_association_key_secret_id: ocid1.connectivityassociationkeysecret.oc1..xxxxxxEXAMPLExxxxxx connectivity_association_key_secret_version: 56 connectivity_association_name_secret_id: ocid1.connectivityassociationnamesecret.oc1..xxxxxxEXAMPLExxxxxx connectivity_association_name_secret_version: 56 state: ENABLED oci_logical_device_name: oci_logical_device_name_example oci_physical_device_name: oci_physical_device_name_example time_created: '2013-10-20T19:20:30+01:00' type: complex