oracle.oci.oci_network_cross_connect_actions – Perform actions on a CrossConnect resource in Oracle Cloud Infrastructure

Note

This plugin is part of the oracle.oci collection (version 4.11.0).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install oracle.oci.

To use it in a playbook, specify: oracle.oci.oci_network_cross_connect_actions.

New in version 2.9.0: of oracle.oci

Synopsis

  • Perform actions on a CrossConnect resource in Oracle Cloud Infrastructure

  • For action=change_compartment, moves a cross-connect into a different compartment within the same tenancy. For information about moving resources between compartments, see Moving Resources to a Different Compartment.

Requirements

The below requirements are needed on the host that executes this module.

Parameters

Parameter Choices/Defaults Comments
action
string / required
    Choices:
  • change_compartment
The action to perform on the CrossConnect.
api_user
string
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 config_file_location). To get the user's OCID, please refer https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/apisigningkey.htm.
api_user_fingerprint
string
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 config_file_location). To get the key pair's fingerprint value please refer https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/apisigningkey.htm.
api_user_key_file
string
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 config_file_location). If the key is encrypted with a pass-phrase, the api_user_key_pass_phrase option must also be provided.
api_user_key_pass_phrase
string
Passphrase used by the key referenced in 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 config_file_location).
auth_purpose
string
    Choices:
  • service_principal
The auth purpose which can be used in conjunction with 'auth_type=instance_principal'. The default auth_purpose for instance_principal is None.
auth_type
string
    Choices:
  • api_key ←
  • instance_principal
  • instance_obo_user
  • resource_principal
The type of authentication to use for making API requests. By default auth_type="api_key" based authentication is performed and the API key (see 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 auth_type="instance_principal" to use instance principal based authentication when running ansible playbooks within an OCI compute instance.
cert_bundle
string
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.
compartment_id
string / required
The OCID of the compartment to move the cross-connect to.
config_file_location
string
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.
config_profile_name
string
The profile to load from the config file referenced by 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 config_file_location.
cross_connect_id
string / required
The OCID of the cross-connect.

aliases: id
region
string
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 config_file_location). Please refer to https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/regions.htm for more information on OCI regions.
tenancy
string
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 config_file_location). To get the tenancy OCID, please refer https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/apisigningkey.htm

Examples

- name: Perform action change_compartment on cross_connect
  oci_network_cross_connect_actions:
    # required
    cross_connect_id: "ocid1.crossconnect.oc1..xxxxxxEXAMPLExxxxxx"
    compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
    action: change_compartment

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key Returned Description
cross_connect
complex
on success
Details of the CrossConnect resource acted upon by the current operation

Sample:
{'compartment_id': 'ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx', 'cross_connect_group_id': 'ocid1.crossconnectgroup.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': 'PENDING_CUSTOMER', 'location_name': 'location_name_example', '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', 'port_name': 'port_name_example', 'port_speed_shape_name': 'port_speed_shape_name_example', 'time_created': '2013-10-20T19:20:30+01:00'}
 
compartment_id
string
on success
The OCID of the compartment containing the cross-connect group.

Sample:
ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx
 
cross_connect_group_id
string
on success
The OCID of the cross-connect group this cross-connect belongs to (if any).

Sample:
ocid1.crossconnectgroup.oc1..xxxxxxEXAMPLExxxxxx
 
customer_reference_name
string
on success
A reference name or identifier for the physical fiber connection that this cross-connect uses.

Sample:
customer_reference_name_example
 
defined_tags
dictionary
on success
Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
Example: `{"Operations": {"CostCenter": "42"}}`

Sample:
{'Operations': {'CostCenter': 'US'}}
 
display_name
string
on success
A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.

Sample:
display_name_example
 
freeform_tags
dictionary
on success
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"}`

Sample:
{'Department': 'Finance'}
 
id
string
on success
The cross-connect's Oracle ID (OCID).

Sample:
ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
 
lifecycle_state
string
on success
The cross-connect's current state.

Sample:
PENDING_CUSTOMER
 
location_name
string
on success
The name of the FastConnect location where this cross-connect is installed.

Sample:
location_name_example
 
macsec_properties
complex
on success

   
encryption_cipher
string
on success
Type of encryption cipher suite to use for the MACsec connection.

Sample:
AES128_GCM
   
primary_key
complex
on success

     
connectivity_association_key_secret_id
string
on success
Secret OCID containing the Connectivity Association Key (CAK) of this MACsec key.

Sample:
ocid1.connectivityassociationkeysecret.oc1..xxxxxxEXAMPLExxxxxx
     
connectivity_association_key_secret_version
integer
on success
The secret version of the `connectivityAssociationKey` secret in Vault.

Sample:
56
     
connectivity_association_name_secret_id
string
on success
Secret OCID containing the Connectivity association Key Name (CKN) of this MACsec key.

Sample:
ocid1.connectivityassociationnamesecret.oc1..xxxxxxEXAMPLExxxxxx
     
connectivity_association_name_secret_version
integer
on success
The secret version of the connectivity association name secret in Vault.

Sample:
56
   
state
string
on success
Indicates whether or not MACsec is enabled.

Sample:
ENABLED
 
oci_logical_device_name
string
on success
The FastConnect device that terminates the logical connection. This device might be different than the device that terminates the physical connection.

Sample:
oci_logical_device_name_example
 
oci_physical_device_name
string
on success
The FastConnect device that terminates the physical connection.

Sample:
oci_physical_device_name_example
 
port_name
string
on success
A string identifying the meet-me room port for this cross-connect.

Sample:
port_name_example
 
port_speed_shape_name
string
on success
The port speed for this cross-connect.
Example: `10 Gbps`

Sample:
port_speed_shape_name_example
 
time_created
string
on success
The date and time the cross-connect was created, in the format defined by RFC3339.
Example: `2016-08-25T21:10:29.600Z`

Sample:
2013-10-20T19:20:30+01:00


Authors

  • Oracle (@oracle)