oracle.oci.oci_resource_search_resource_type_facts – Fetches details about one or multiple ResourceType 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_resource_search_resource_type_facts.

New in version 2.9.0: of oracle.oci

Synopsis

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

  • Lists all resource types that you can search or query for.

  • If name is specified, the details of a single ResourceType 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.
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.
name
string
The name of the resource type.
Required to get a specific resource_type.
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 resource_type
  oci_resource_search_resource_type_facts:
    # required
    name: name_example

- name: List resource_types
  oci_resource_search_resource_type_facts:

Return Values

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

Key Returned Description
resource_types
complex
on success
List of ResourceType resources

Sample:
[{'fields': [{'field_name': 'field_name_example', 'field_type': 'IDENTIFIER', 'is_array': True, 'object_properties': [{'field_name': 'field_name_example', 'field_type': 'IDENTIFIER', 'is_array': True, 'object_properties': []}]}], 'name': 'name_example'}]
 
fields
complex
on success
List of all the fields and their value type that are indexed for querying.

   
field_name
string
on success
The name of the field to use when constructing the query. Field names are present for all types except `OBJECT`.

Sample:
field_name_example
   
field_type
string
on success
The type of the field, which dictates what semantics and query constraints you can use when searching or querying.

Sample:
IDENTIFIER
   
is_array
boolean
on success
Indicates that this field is actually an array of the specified field type.

Sample:
True
   
object_properties
complex
on success
If the field type is `OBJECT`, then this property will provide all the individual properties of the object that can be queried.

     
field_name
string
on success
The name of the field to use when constructing the query. Field names are present for all types except `OBJECT`.

Sample:
field_name_example
     
field_type
string
on success
The type of the field, which dictates what semantics and query constraints you can use when searching or querying.

Sample:
IDENTIFIER
     
is_array
boolean
on success
Indicates that this field is actually an array of the specified field type.

Sample:
True
     
object_properties
list / elements=string
on success
If the field type is `OBJECT`, then this property will provide all the individual properties of the object that can be queried.

 
name
string
on success
The unique name of the resource type, which matches the value returned as part of the ResourceSummary object.

Sample:
name_example


Authors

  • Oracle (@oracle)