oracle / oracle.oci / 4.21.0 / module / oci_network_fast_connect_provider_service_facts Fetches details about one or multiple FastConnectProviderService resources in Oracle Cloud Infrastructure | "added in version" 2.9.0 of oracle.oci" Authors: Oracle (@oracle) preview | supported by communityoracle.oci.oci_network_fast_connect_provider_service_facts (4.21.0) — module
Install with ansible-galaxy collection install oracle.oci:==4.21.0
collections: - name: oracle.oci version: 4.21.0
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 L(OCID,https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of your tenancy (the root compartment).
For more information, see L(FastConnect Overview,https://docs.cloud.oracle.com/iaas/Content/Network/Concepts/fastconnect.htm).
If I(provider_service_id) is specified, the details of a single FastConnectProviderService will be returned.
- 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"
region: description: - 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 C(config_file_location)). Please refer to U(https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/regions.htm) for more information on OCI regions. type: str tenancy: description: - 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 C(config_file_location)). To get the tenancy OCID, please refer U(https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/apisigningkey.htm) type: str api_user: description: - 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 C(config_file_location)). To get the user's OCID, please refer U(https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/apisigningkey.htm). type: str auth_type: choices: - api_key - instance_principal - instance_obo_user - resource_principal default: api_key description: - The type of authentication to use for making API requests. By default C(auth_type="api_key") based authentication is performed and the API key (see I(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 C(auth_type="instance_principal") to use instance principal based authentication when running ansible playbooks within an OCI compute instance. type: str cert_bundle: description: - 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. type: str auth_purpose: choices: - service_principal description: - The auth purpose which can be used in conjunction with 'auth_type=instance_principal'. The default auth_purpose for instance_principal is None. type: str compartment_id: description: - The L(OCID,https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment. - Required to list multiple fast_connect_provider_services. type: str api_user_key_file: description: - 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 C(config_file_location)). If the key is encrypted with a pass-phrase, the C(api_user_key_pass_phrase) option must also be provided. type: str config_profile_name: description: - The profile to load from the config file referenced by C(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 C(config_file_location). type: str provider_service_id: aliases: - id description: - The L(OCID,https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the provider service. - Required to get a specific fast_connect_provider_service. type: str api_user_fingerprint: description: - 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 C(config_file_location)). To get the key pair's fingerprint value please refer U(https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/apisigningkey.htm). type: str config_file_location: description: - 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. type: str api_user_key_pass_phrase: description: - Passphrase used by the key referenced in C(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 C(config_file_location)). type: str realm_specific_endpoint_template_enabled: description: - Enable/Disable realm specific endpoint template for service client. By Default, realm specific endpoint template is disabled. If not set, then the value of the OCI_REALM_SPECIFIC_SERVICE_ENDPOINT_TEMPLATE_ENABLED variable, if any, is used. type: bool
fast_connect_provider_services: contains: bandwith_shape_management: description: - Who is responsible for managing the virtual circuit bandwidth. returned: on success sample: CUSTOMER_MANAGED type: str customer_asn_management: description: - Who is responsible for managing the ASN information for the network at the other end of the connection from Oracle. returned: on success sample: CUSTOMER_MANAGED type: str description: description: - 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`' returned: on success sample: description_example type: str id: description: - The L(OCID,https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the service offered by the provider. returned: on success sample: ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx type: str private_peering_bgp_management: description: - Who is responsible for managing the private peering BGP information. returned: on success sample: CUSTOMER_MANAGED type: str provider_name: description: - The name of the provider. returned: on success sample: provider_name_example type: str provider_service_key_management: description: - Who is responsible for managing the provider service key. returned: on success sample: CUSTOMER_MANAGED type: str provider_service_name: description: - The name of the service offered by the provider. returned: on success sample: provider_service_name_example type: str public_peering_bgp_management: description: - Who is responsible for managing the public peering BGP information. returned: on success sample: CUSTOMER_MANAGED type: str required_total_cross_connects: description: - Total number of cross-connect or cross-connect groups required for the virtual circuit. returned: on success sample: 56 type: int supported_virtual_circuit_types: description: - An array of virtual circuit types supported by this service. returned: on success sample: [] type: list type: description: - Provider service type. returned: on success sample: LAYER2 type: str description: - List of FastConnectProviderService resources returned: on success 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 type: complex