oci_letter_of_authority_facts – Fetches details of OCI cross-connect Letter of Authority

New in version 2.5.

Synopsis

  • Fetches details of OCI Letter of Authority

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_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_type
string
    Choices:
  • api_key ←
  • instance_principal
  • instance_obo_user
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.
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
- / required
Identifier of the cross-connect whose letter of authority needs to be fetched.

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

# Note: These examples do not set authentication details.
# Fetch Letter of Authority
- name: Fetch Letter of Authority
  oci_letter_of_authority_facts:
      cross_connect_id: 'ocid1.crossconnect.oc1.iad.xxxxxEXAMPLExxxxx'

Return Values

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

Key Returned Description
oci_letter_of_authorities
complex
 success
Attributes of the Letter of Authority.

Sample:
[{'cross_connect_id': 'ocid1.crossconnect.oc1.iad.xxxxxEXAMPLExxxxx', 'time_issued': '2018-02-03T06:55:49.463000+00:00', 'circuit_type': 'Single_mode_LC', 'authorized_entity_name': 'Example Authorized Entity Name', 'facility_location': 'Equinox', 'port_name': 'Example Port Name', 'time_expires': '2018-03-03T06:55:49.463000+00:00'}]
  authorized_entity_name
string
 always
The name of the entity authorized by this Letter of Authority.

Sample:
Example Authorized Entity
  circuit_type
string
 always
The type of cross-connect fiber, termination, and optical specification.

Sample:
Single_mode_LC
  cross_connect_id
string
 always
The OCID of the cross-connect.

Sample:
ocid1.crossconnect.oc1.iad.xxxxxEXAMPLExxxxx
  facility_location
string
 always
The address of the FastConnect location.

Sample:
Equinox
  port_name
string
 always
The meet-me room port for this cross-connect.

Sample:
Example Port Name
  time_expires
string
 always
The date and time when the Letter of Authority expires, in the format defined by RFC3339.

Sample:
2018-03-03 06:55:49.463000+00:00
  time_issued
string
 always
The date and time the Letter of Authority was created, in the format defined by RFC3339..

Sample:
2018-03-03 06:55:49.463000+00:00


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.