oci_service_facts - Retrieve the available services that you can access through a service gateway in this region

New in version 2.5.

Synopsis

  • This module retrieves information of a specific service or information of all the available services that you can access through a service gateway in this region.

Requirements

The below requirements are needed on the host that executes this module.

Parameters

Parameter Choices/Defaults Comments
api_user
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
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
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
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
    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.
config_file_location
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
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.
name
Use name along with the other options to return only resources that match the given name exactly.
region
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.
service_id
The OCID of the service. service_id is required to get a specific service's information.

aliases: id
tenancy
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 details of all the available services
  oci_service_facts:

- name: Get details of a specific service using its OCID
  oci_service_facts:
    id: "ocid1.service.oc1.phx.xxxxxEXAMPLExxxxx"

- name: Get details of a service using its name
  oci_service_facts:
    name: 'OCI IAD Object Storage'

Return Values

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

Key Returned Description
services
complex
always
Details of service

Sample:
[{'id': 'ocid1.service.oc1.phx.xxxxxEXAMPLExxxxx', 'cidr_block': 'oci-iad-objectstorage', 'description': 'OCI IAD Object Storage', 'name': 'OCI IAD Object Storage'}]
  cidr_block
string
always
A string that represents the public endpoints for the service. When you set up a route rule to route traffic to the service gateway, use this value as the destination CIDR block for the rule.

Sample:
oci-iad-objectstorage
  description
string
always
Description of the service.

Sample:
OCI IAD Object Storage
  id
string
always
The service's OCID.

Sample:
ocid1.service.oc1.phx.xxxxxEXAMPLExxxxx
  name
string
always
Name of the service.

Sample:
OCI IAD Object Storage


Status

This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.

This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.

Author

  • Rohit Chaware (@rohitChaware)

Hint

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