oci_fast_connect_provider_service_facts – Fetches details of one or more OCI Fast Connect Provider Services

New in version 2.5.

Synopsis

  • Fetches details of the OCI Fast Connect Provider Services

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 fast connect provider service 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.
provider_service_id
-
Identifier of the fast connect provider service whose details 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 All Fast Connect Provider Services under a specific compartment
- name: Fetch All Fast Connect Provider Services under a specific compartment
  oci_fast_connect_provider_service_facts:
      compartment_id: 'ocid1.compartment.oc1.iad.xxxxxEXAMPLExxxxx'

# Fetch a specific Fast Connect Provider Service
- name: Fetch a specific Fast Connect Provider Service
  oci_fast_connect_provider_service_facts:
      provider_service_id: 'ocid1.serviceprovider.oc1.iad.xxxxxEXAMPLExxxxx'

Return Values

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

Key Returned Description
oci_fast_connect_provider_services
complex
success
Attributes of the Fast Connect Provider Service.

Sample:
[{'private_peering_bgp_management': 'CUSTOMER_MANAGED', 'description': 'https://megaport.al/', 'provider_service_name': 'Service', 'public_peering_bgp_management': 'ORACLE_MANAGED', 'provider_name': 'Megaport', 'supported_virtual_circuit_types': None, 'type': 'LAYER2', 'id': 'ocid1.providerservice.oc1.iad.xxxxxEXAMPLExxxxx'}, {'private_peering_bgp_management': 'CUSTOMER_MANAGED', 'description': 'https://marketplaceportal.com/web/guest/login', 'provider_service_name': 'Service Exchange', 'public_peering_bgp_management': 'ORACLE_MANAGED', 'provider_name': 'Digital Realty', 'supported_virtual_circuit_types': ['PRIVATE', 'PUBLIC'], 'type': 'LAYER2', 'id': 'ocid1.providerservice.oc1.iad.xxxxxEXAMPLExxxxx'}]
  description
string
always
A description of the service offered by the provider.

Sample:
https://megaport.al/
  id
string
always
Identifier of the Fast Connect Provider Service

Sample:
ocid1.providerservice.oc1.iad.xxxxxEXAMPLExxxxx
  private_peering_bgp_management
string
always
Who is responsible for managing the private peering BGP information.

Sample:
CUSTOMER_MANAGED
  provider_name
string
always
The name of the provider.

Sample:
Megaport
  provider_service_name
string
always
The name of the service offered by the provider.

Sample:
Service
  public_peering_bgp_management
string
always
Who is responsible for managing the public peering BGP information.

Sample:
ORACLE_MANAGED
  supported_virtual_circuit_types
list
always
An array of virtual circuit types supported by this service.

Sample:
['PRIVATE', 'PUBLIC']
  type
list
always
Provider service type.

Sample:
LAYER2


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.