Skip to content
This repository has been archived by the owner on May 1, 2021. It is now read-only.

Latest commit

 

History

History
608 lines (557 loc) · 40.7 KB

oci_cross_connect_module.rst

File metadata and controls

608 lines (557 loc) · 40.7 KB
Raw
source:cloud/oracle/oci_cross_connect.py
orphan:

oci_cross_connect -- Create,update and delete OCI cross-connects

.. versionadded:: 2.5

Synopsis

  • Create an OCI cross-connect
  • Update an OCI cross-connect, if present, with a new display name
  • Activate an OCI cross-connect
  • Delete an OCI cross-connect, if present.

Requirements

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

Parameters

Parameter Choices/Defaults Comments
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_OCID 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_type
string
    Choices:
  • api_key ←
  • instance_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.
compartment_id
-
Identifier of the compartment under which this cross-connect would be created. Mandatory for create operation. Mutually exclusive with cross_connect_id.
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_group_id
-
The OCID of the cross-connect group to put this cross-connect in.
cross_connect_id
-
Identifier of the cross-connect. Mandatory for delete and update.

aliases: id
display_name
-
A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.

aliases: name
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.
force_create
boolean
    Choices:
  • no ←
  • yes
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 key_by.
is_active
-
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.
key_by
list
The list of comma-separated attributes of this resource which should be used to uniquely identify an instance of the resource. By default, all the attributes of a resource except freeform_tags are used to uniquely identify a resource.
location_name
-
The name of the FastConnect location where this cross-connect will be installed.
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.
port_speed_shape_name
-
The port speed for this cross-connect.
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.
state
-
    Choices:
  • present ←
  • absent
Create,update or delete cross-connect. For state=present, if it does not exists, it gets created. If exists, it gets updated.
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
wait
boolean
    Choices:
  • no
  • yes ←
Whether to wait for create or delete operation to complete.
wait_timeout
integer
Default:
1200
Time, in seconds, to wait when wait=yes.
wait_until
string
The lifecycle state to wait for the resource to transition into when wait=yes. By default, when wait=yes, we wait for the resource to get into ACTIVE/ATTACHED/AVAILABLE/PROVISIONED/ RUNNING applicable lifecycle state during create operation & to get into DELETED/DETACHED/ TERMINATED lifecycle state during delete operation.

Notes

Examples

# Note: These examples do not set authentication details.
# Create a new cross-connect
- name: Create a new cross-connect
  oci_cross_connect:
      compartment_id: 'ocid1.compartment..xxxxxEXAMPLExxxxx'
      display_name: 'ansible-cross-connect'
      cross_connect_group_id: 'ocid1.crossconnectgroup..xvdf'
      far_cross_connect_or_cross_connect_group_id: 'ocid1.crossconnect..xxxxxEXAMPLExxxxx'
      location_name: 'EXAMPLE LOCATION'
      port_speed_shape_name: '10 Gbps'
      state: 'present'

# Update an existing cross-connect's display Name
- name: Update an existing cross-connect's display Name
  oci_cross_connect:
      cross_connect_id: 'ocid1.crossconnect..xxxxxEXAMPLExxxxx'
      display_name: 'cross-connect-updated'
      state: 'present'

# Activate a cross-connect
- name: Update cross-connect Active state
  oci_cross_connect:
      cross_connect_id: 'ocid1.crossconnect..xxxxxEXAMPLExxxxx'
      is_active: True
      state: 'present'

# Delete a cross-connect
- name: Delete cross-connect
  oci_cross_connect:
      cross_connect_id: 'ocid1.crossconnect..xxxxxEXAMPLExxxxx'
      state: 'absent'

Return Values

Common return values are documented :ref:`here <common_return_values>`, the following are the fields unique to this module:

Key Returned Description
cross_connect
complex
 success
Attributes of the cross-connect.

Sample:
{'lifecycle_state': 'PROVISIONING', 'port_speed_shape_name': '10 Gbps', 'location_name': 'EXAMPLE LOCATION', 'compartment_id': 'ocid1.compartment.oc1.iad.xxxxxEXAMPLExxxxx', 'cross_connect_group_id': 'ocid1.crossconnectgroup.oc1.iad.xxxxxEXAMPLExxxxx', 'time_created': '2018-03-03T06:55:49.463000+00:00', 'port_name': 'EXAMPLE PORT', 'display_name': 'ansible-cross-connect', 'id': 'ocid1.crossconnect.oc1.iad.xxxxxEXAMPLExxxxx'}
  compartment_id
string
 always
The OCID of the compartment containing the cross-connect group.

Sample:
ocid1.compartment.oc1.iad.xxxxxEXAMPLExxxxx
  cross_connect_group_id
string
 always
The OCID of the cross-connect group this cross-connect belongs to (if any).

Sample:
ocid1.crossconnectgroup.oc1.iad.xxxxxEXAMPLExxxxx
  display_name
string
 always
A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.

Sample:
ansible-cross-connect
  id
string
 always
Identifier of the cross-connect.

Sample:
ocid1.crossconnect.oc1.iad.xxxxxEXAMPLExxxxx
  lifecycle_state
string
 always
The current state of the cross-connect.

Sample:
PROVISIONED
  location_name
string
 always
The name of the FastConnect location where this cross-connect is installed.

Sample:
EXAMPLE LOCATION
  port_name
string
 always
A string identifying the meet-me room port for this cross-connect.

Sample:
EXAMPLE
  port_speed_shape_name
string
 always
The port speed for this cross-connect.

Sample:
10 Gbps
  time_created
datetime
 always
Date and time when the cross-connect was created, in the format defined by RFC3339

Sample:
2016-08-25 21:10:29.600000


Status

Authors

  • Debayan Gupta(@debayan_gupta)

Hint

If you notice any issues in this documentation you can edit this document to improve it.