oracle.oci.oci_data_catalog_type_facts – Fetches details about one or multiple Type resources in Oracle Cloud Infrastructure

Note

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

New in version 2.9.0: of oracle.oci

Synopsis

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

  • Returns a list of all types within a data catalog.

  • If type_key is specified, the details of a single Type 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.
catalog_id
string / required
Unique catalog identifier.
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.
external_type_name
string
Data type as defined in an external system.
fields
list / elements=string
    Choices:
  • key
  • description
  • name
  • catalogId
  • properties
  • isInternal
  • isTag
  • isApproved
  • typeCategory
  • externalTypeName
  • lifecycleState
  • uri
Specifies the fields to return in a type response.
is_approved
string
Indicates whether the type is approved for use as a classifying object.
is_internal
string
Indicates whether the type is internal, making it unavailable for use by metadata elements.
is_tag
string
Indicates whether the type can be used for tagging metadata elements.
lifecycle_state
string
    Choices:
  • CREATING
  • ACTIVE
  • INACTIVE
  • UPDATING
  • DELETING
  • DELETED
  • FAILED
  • MOVING
A filter to return only resources that match the specified lifecycle state. The value is case insensitive.
name
string
Immutable resource name.
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.
sort_by
string
    Choices:
  • TIMECREATED
  • DISPLAYNAME
The field to sort by. Only one sort order may be provided. Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. If no value is specified TIMECREATED is default.
sort_order
string
    Choices:
  • ASC
  • DESC
The sort order to use, either 'asc' or 'desc'.
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
type_category
string
Indicates the category of this type . For example, data assets or connections.
type_key
string
Unique type key.
Required to get a specific type.

Examples

- name: Get a specific type
  oci_data_catalog_type_facts:
    # required
    type_key: type_key_example
    catalog_id: "ocid1.catalog.oc1..xxxxxxEXAMPLExxxxxx"

    # optional
    fields: [ "key" ]

- name: List types
  oci_data_catalog_type_facts:
    # required
    catalog_id: "ocid1.catalog.oc1..xxxxxxEXAMPLExxxxxx"

    # optional
    name: name_example
    lifecycle_state: CREATING
    is_internal: is_internal_example
    is_tag: is_tag_example
    is_approved: is_approved_example
    external_type_name: external_type_name_example
    type_category: type_category_example
    fields: [ "key" ]
    sort_by: TIMECREATED
    sort_order: ASC

Return Values

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

Key Returned Description
types
complex
on success
List of Type resources

Sample:
[{'catalog_id': 'ocid1.catalog.oc1..xxxxxxEXAMPLExxxxxx', 'custom_properties': [{'allowed_values': [], 'created_by_id': 'ocid1.createdby.oc1..xxxxxxEXAMPLExxxxxx', 'data_type': 'TEXT', 'description': 'description_example', 'display_name': 'display_name_example', 'events': [{'created_by_id': 'ocid1.createdby.oc1..xxxxxxEXAMPLExxxxxx', 'event_config_status': 'ENABLED', 'property_id': 'ocid1.property.oc1..xxxxxxEXAMPLExxxxxx', 'property_name': 'property_name_example', 'time_created': '2013-10-20T19:20:30+01:00', 'time_updated': '2013-10-20T19:20:30+01:00', 'type_id': 'ocid1.type.oc1..xxxxxxEXAMPLExxxxxx', 'type_name': 'type_name_example', 'updated_by_id': 'ocid1.updatedby.oc1..xxxxxxEXAMPLExxxxxx'}], 'is_editable': True, 'is_event_enabled': True, 'is_filterable': True, 'is_hidden': True, 'is_hidden_in_search': True, 'is_multi_valued': True, 'is_service_defined': True, 'is_shown_in_list': True, 'is_sortable': True, 'key': 'key_example', 'lifecycle_state': 'CREATING', 'namespace_name': 'namespace_name_example', 'scope': [{'count': 56, 'is_event_enabled': True, 'type_id': 'ocid1.type.oc1..xxxxxxEXAMPLExxxxxx', 'type_name': 'type_name_example'}], 'time_created': '2013-10-20T19:20:30+01:00', 'time_updated': '2013-10-20T19:20:30+01:00', 'updated_by_id': 'ocid1.updatedby.oc1..xxxxxxEXAMPLExxxxxx', 'usage_count': 56}], 'description': 'description_example', 'external_type_name': 'external_type_name_example', 'is_approved': True, 'is_internal': True, 'is_tag': True, 'key': 'key_example', 'lifecycle_state': 'CREATING', 'name': 'name_example', 'parent_type_key': 'parent_type_key_example', 'parent_type_name': 'parent_type_name_example', 'properties': {}, 'type_category': 'type_category_example', 'uri': 'uri_example'}]
 
catalog_id
string
on success
The data catalog's OCID.

Sample:
ocid1.catalog.oc1..xxxxxxEXAMPLExxxxxx
 
custom_properties
complex
on success
Custom properties associated with this Type.
Returned for get operation

   
allowed_values
list / elements=string
on success
Allowed values for the custom property if any

   
created_by_id
string
on success
OCID of the user who created the custom property.

Sample:
ocid1.createdby.oc1..xxxxxxEXAMPLExxxxxx
   
data_type
string
on success
Data type of the custom property

Sample:
TEXT
   
description
string
on success
Description of the custom property

Sample:
description_example
   
display_name
string
on success
Display name of the custom property

Sample:
display_name_example
   
events
complex
on success
Event configuration for this custom property, against the desired subset of object types to which the property applies.

     
created_by_id
string
on success
OCID of the user who created the configuration.

Sample:
ocid1.createdby.oc1..xxxxxxEXAMPLExxxxxx
     
event_config_status
string
on success
Status of the configuration.

Sample:
ENABLED
     
property_id
string
on success
Unique property key identifier.

Sample:
ocid1.property.oc1..xxxxxxEXAMPLExxxxxx
     
property_name
string
on success
Name of the property.

Sample:
property_name_example
     
time_created
string
on success
The date and time the event was configured, in the format defined by RFC3339. Example: `2019-03-25T21:10:29.600Z`

Sample:
2013-10-20T19:20:30+01:00
     
time_updated
string
on success
The last time that any change was made to the configuration. An RFC3339 formatted datetime string.

Sample:
2013-10-20T19:20:30+01:00
     
type_id
string
on success
Unique type key identifier.

Sample:
ocid1.type.oc1..xxxxxxEXAMPLExxxxxx
     
type_name
string
on success
Name of the type.

Sample:
type_name_example
     
updated_by_id
string
on success
OCID of the user who last modified the configuration.

Sample:
ocid1.updatedby.oc1..xxxxxxEXAMPLExxxxxx
   
is_editable
boolean
on success
If this field is a editable field

Sample:
True
   
is_event_enabled
boolean
on success
If an OCI Event will be emitted when the custom property is modified.

Sample:
True
   
is_filterable
boolean
on success
If this field allows to filter or create facets from UI

Sample:
True
   
is_hidden
boolean
on success
If this field is a hidden field

Sample:
True
    is_hidden_in_search
boolean
on success
If this field is allowed to pop in search results

Sample:
True
   
is_multi_valued
boolean
on success
If this field allows multiple values to be set

Sample:
True
   
is_service_defined
boolean
on success
If this field is defined by service or by a user

Sample:
True
   
is_shown_in_list
boolean
on success
If this field is displayed in a list view of applicable objects.

Sample:
True
   
is_sortable
boolean
on success
If this field allows to sort from UI

Sample:
True
   
key
string
on success
Unique custom property key that is immutable.

Sample:
key_example
   
lifecycle_state
string
on success
The current state of the custom property.

Sample:
CREATING
   
namespace_name
string
on success
Namespace name of the custom property

Sample:
namespace_name_example
   
scope
complex
on success
Type or scope of the custom property belongs to. This will be an array of type id it will be belongs to

     
count
integer
on success
Number of objects associated with this type

Sample:
56
     
is_event_enabled
boolean
on success
If an OCI Event will be emitted when the custom property is modified.

Sample:
True
     
type_id
string
on success
Unique type key identifier

Sample:
ocid1.type.oc1..xxxxxxEXAMPLExxxxxx
     
type_name
string
on success
Name of the type associated with

Sample:
type_name_example
   
time_created
string
on success
The date and time the custom property was created, in the format defined by RFC3339. Example: `2019-03-25T21:10:29.600Z`

Sample:
2013-10-20T19:20:30+01:00
   
time_updated
string
on success
The last time that any change was made to the custom property. An RFC3339 formatted datetime string.

Sample:
2013-10-20T19:20:30+01:00
   
updated_by_id
string
on success
OCID of the user who last modified the custom property.

Sample:
ocid1.updatedby.oc1..xxxxxxEXAMPLExxxxxx
   
usage_count
integer
on success
Total number of first class objects using this custom property

Sample:
56
 
description
string
on success
Detailed description of the type.

Sample:
description_example
 
external_type_name
string
on success
Mapping type equivalence in the external system.
Returned for get operation

Sample:
external_type_name_example
 
is_approved
boolean
on success
Indicates whether the type is approved for use as a classifying object.
Returned for get operation

Sample:
True
 
is_internal
boolean
on success
Indicates whether the type is internal, making it unavailable for use by metadata elements.
Returned for get operation

Sample:
True
 
is_tag
boolean
on success
Indicates whether the type can be used for tagging metadata elements.
Returned for get operation

Sample:
True
 
key
string
on success
Unique type key that is immutable.

Sample:
key_example
 
lifecycle_state
string
on success
The current state of the type.

Sample:
CREATING
 
name
string
on success
The immutable name of the type.

Sample:
name_example
 
parent_type_key
string
on success
Unique key of the parent type.

Sample:
parent_type_key_example
 
parent_type_name
string
on success
Name of the parent type.

Sample:
parent_type_name_example
 
properties
dictionary
on success
"A map of arrays which defines the type specific properties, both required and optional. The map keys are category names and the values are arrays contiaing all property details. Every property is contained inside of a category. Most types have required properties within the \"default\" category. Example: `{ \"properties\": { \"default\": { \"attributes:\": [ { \"name\": \"host\", \"type\": \"string\", \"isRequired\": true, \"isUpdatable\": false }, ... ] } } }`"
Returned for get operation

 
type_category
string
on success
Indicates the category this type belongs to. For instance, data assets, connections.

Sample:
type_category_example
 
uri
string
on success
URI to the type instance in the API.

Sample:
uri_example


Authors

  • Oracle (@oracle)