oracle.oci.oci_network_fast_connect_provider_service_facts – Fetches details about one or multiple FastConnectProviderService resources in Oracle Cloud Infrastructure

Note

This plugin is part of the oracle.oci collection (version 4.10.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_fast_connect_provider_service_facts.

New in version 2.9.0: of oracle.oci

Synopsis

  • Fetches details about one or multiple FastConnectProviderService resources in Oracle Cloud Infrastructure

  • Lists the service offerings from supported providers. You need this information so you can specify your desired provider and service offering when you create a virtual circuit.

  • For the compartment ID, provide the OCID of your tenancy (the root compartment).

  • For more information, see FastConnect Overview.

  • If provider_service_id is specified, the details of a single FastConnectProviderService will be returned.

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_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
The OCID of the compartment.
Required to list multiple fast_connect_provider_services.
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
string
The OCID of the provider service.
Required to get a specific fast_connect_provider_service.

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: Get a specific fast_connect_provider_service
  oci_network_fast_connect_provider_service_facts:
    # required
    provider_service_id: "ocid1.providerservice.oc1..xxxxxxEXAMPLExxxxxx"

- name: List fast_connect_provider_services
  oci_network_fast_connect_provider_service_facts:
    # required
    compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"

Return Values

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

Key Returned Description
fast_connect_provider_services
complex
on success
List of FastConnectProviderService resources

Sample:
[{'bandwith_shape_management': 'CUSTOMER_MANAGED', 'customer_asn_management': 'CUSTOMER_MANAGED', 'description': 'description_example', 'id': 'ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx', 'private_peering_bgp_management': 'CUSTOMER_MANAGED', 'provider_name': 'provider_name_example', 'provider_service_key_management': 'CUSTOMER_MANAGED', 'provider_service_name': 'provider_service_name_example', 'public_peering_bgp_management': 'CUSTOMER_MANAGED', 'required_total_cross_connects': 56, 'supported_virtual_circuit_types': [], 'type': 'LAYER2'}]
 
bandwith_shape_management
string
on success
Who is responsible for managing the virtual circuit bandwidth.

Sample:
CUSTOMER_MANAGED
 
customer_asn_management
string
on success
Who is responsible for managing the ASN information for the network at the other end of the connection from Oracle.

Sample:
CUSTOMER_MANAGED
 
description
string
on success
The location of the provider's website or portal. This portal is where you can get information about the provider service, create a virtual circuit connection from the provider to Oracle Cloud Infrastructure, and retrieve your provider service key for that virtual circuit connection.
Example: `https://example.com`

Sample:
description_example
 
id
string
on success
The OCID of the service offered by the provider.

Sample:
ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
 
private_peering_bgp_management
string
on success
Who is responsible for managing the private peering BGP information.

Sample:
CUSTOMER_MANAGED
 
provider_name
string
on success
The name of the provider.

Sample:
provider_name_example
 
provider_service_key_management
string
on success
Who is responsible for managing the provider service key.

Sample:
CUSTOMER_MANAGED
 
provider_service_name
string
on success
The name of the service offered by the provider.

Sample:
provider_service_name_example
 
public_peering_bgp_management
string
on success
Who is responsible for managing the public peering BGP information.

Sample:
CUSTOMER_MANAGED
 
required_total_cross_connects
integer
on success
Total number of cross-connect or cross-connect groups required for the virtual circuit.

Sample:
56
 
supported_virtual_circuit_types
list / elements=string
on success
An array of virtual circuit types supported by this service.

 
type
string
on success
Provider service type.

Sample:
LAYER2


Authors

  • Oracle (@oracle)