oci_cross_connect_group_facts – Fetches details of one or more OCI cross-connect groups

New in version 2.5.

Synopsis

  • Fetches details of a specified OCI cross-connect group or all cross-connect groups in a specified compartment.

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 the specified cross-connect group exists
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
-
Identifier of the cross-connect whose details needs to be fetched.

aliases: id
display_name
string
Use display_name along with the other options to return only resources that match the given display name exactly.
lifecycle_state
-
    Choices:
  • PROVISIONING
  • PROVISIONED
  • INACTIVE
  • TERMINATING
  • TERMINATED
A filter to return only resources that match the given lifecycle state.
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

# Note: These examples do not set authentication details.
# Fetch All Cross Connects Groups under a specific compartment
- name: Fetch All Cross Connects Groups under a specific compartment
  oci_cross_connect_group_facts:
      compartment_id: 'ocid1.compartment.oc1.iad.xxxxxEXAMPLExxxxx'

# Fetch All cross-connect groups under a specific compartment, filtered by
# display name and lifecycle state
- name: Fetch All cross-connect groups under a specific compartment, filtered by display name and lifecycle state
  oci_cross_connect_group_facts:
      compartment_id: 'ocid1.compartment.oc1.iad.xxxxxEXAMPLExxxxx'
      display_name: 'ansible-cross-connect-group'
      lifecycle_state: 'PROVISIOING'

# Fetch a specific cross-connect group
- name: Fetch a specific cross-connect group
  oci_cross_connect_group_facts:
      cross_connect_group_id: 'ocid1.crossconnectgroup.oc1.iad.xxxxxEXAMPLExxxxx'

Return Values

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

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

Sample:
[{'lifecycle_state': 'PROVISIONING', 'display_name': 'ansible-cross-connect-group', 'id': 'ocid1.crossconnectgroup.oc1.iad.xxxxxEXAMPLExxxxx', 'compartment_id': 'ocid1.compartment.oc1.iad.xxxxxEXAMPLExxxxx', 'time_created': '2018-03-03T06:55:49.463000+00:00'}, {'lifecycle_state': 'PROVISIONING', 'display_name': 'test-cross-connect', 'id': 'ocid1.crossconnectgroup.oc1.iad.xxxxxEXAMPLExxxxx', 'compartment_id': 'ocid1.compartment.oc1.iad.xxxxxEXAMPLExxxxx', 'time_created': '2018-03-04T06:55:49.463000+00:00'}]
  compartment_id
string
 always
The OCID of the compartment containing the cross-connect group.

Sample:
ocid1.compartment.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-group
  id
string
 always
Identifier of the cross-connect group.

Sample:
ocid1.crossconnectgroup.oc1.iad.xxxxxEXAMPLExxxxx
  lifecycle_state
string
 always
The current state of the Cross Connect.

Sample:
PROVISIONED
  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

  • This module is not guaranteed to have a backwards compatible interface. [preview]
  • This module is maintained by the Ansible Community. [community]

Authors

  • Debayan Gupta(@debayan_gupta)

Hint

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