oci_resource_type_facts – Retrieves facts of types of resource that you can find with a search or query

New in version 2.5.

Synopsis

  • This module allows the user to retrieve facts of all resource types or a specific resource type that you can find with a search or query.

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.
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
-
The name of the resource type. Required if you want details of a specific resource type. If name is unspecified, details of all resource types that are supported is returned.
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 facts about all resource types that you can find with a search or query
  oci_resource_type_facts:

- name: Get details of the Vcn resource type
  oci_resource_type_facts:
    name: "Vcn"

Return Values

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

Key Returned Description
resource_types
complex
On successful operation
A type of resource that you can find with a search or query.

Sample:
[{'fields': [{'isArray': True, 'objectProperties': [{'isArray': False, 'objectProperties': None, 'fieldName': 'freeformTags.value', 'fieldType': 'STRING'}, {'isArray': False, 'objectProperties': None, 'fieldName': 'freeformTags.key', 'fieldType': 'STRING'}], 'fieldName': 'freeformTags', 'fieldType': 'OBJECT'}, {'isArray': False, 'objectProperties': None, 'fieldName': 'displayName', 'fieldType': 'STRING'}, {'isArray': True, 'objectProperties': [{'isArray': False, 'objectProperties': None, 'fieldName': 'definedTags.key', 'fieldType': 'STRING'}, {'isArray': False, 'objectProperties': None, 'fieldName': 'definedTags.namespace', 'fieldType': 'STRING'}, {'isArray': False, 'objectProperties': None, 'fieldName': 'definedTags.value', 'fieldType': 'STRING'}], 'fieldName': 'definedTags', 'fieldType': 'OBJECT'}, {'isArray': False, 'objectProperties': None, 'fieldName': 'lifecycleState', 'fieldType': 'STRING'}, {'isArray': False, 'objectProperties': None, 'fieldName': 'compartmentId', 'fieldType': 'IDENTIFIER'}, {'isArray': False, 'objectProperties': None, 'fieldName': 'availabilityDomain', 'fieldType': 'STRING'}, {'isArray': False, 'objectProperties': None, 'fieldName': 'timeLastIndexed', 'fieldType': 'DATETIME'}, {'isArray': False, 'objectProperties': None, 'fieldName': 'timeCreated', 'fieldType': 'DATETIME'}, {'isArray': False, 'objectProperties': None, 'fieldName': 'identifier', 'fieldType': 'IDENTIFIER'}, {'isArray': False, 'objectProperties': None, 'fieldName': 'cidrBlock', 'fieldType': 'STRING'}, {'isArray': False, 'objectProperties': None, 'fieldName': 'dnsLabel', 'fieldType': 'STRING'}, {'isArray': False, 'objectProperties': None, 'fieldName': 'vcnDomainName', 'fieldType': 'STRING'}], 'name': 'Vcn'}]
  fields
complex
always
List of all the fields and their value type that are indexed for querying.

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

    field_type
string
always
The type of the field, which dictates what semantics and query constraints you can use when searching or querying.

    is_array
boolean
always
Indicates this field is actually an array of the specified field type.

    object_properties
same as fields
if the field type is OBJECT
If the field type is OBJECT, then this property will provide all the individual properties on the object that can be queried.

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



Status

  • This module is not guaranteed to have a backwards compatible interface. [preview]
  • This module is maintained by the Ansible Community. [community]

Authors

  • Sivakumar Thyagarajan (@sivakumart)

Hint

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