oracle.oci.oci_data_connectivity_schema_facts – Fetches details about one or multiple Schema 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_connectivity_schema_facts.

New in version 2.9.0: of oracle.oci

Synopsis

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

  • Retrieves a list of all the schemas that can be accessed using the specified connection.

  • If schema_resource_name is specified, the details of a single Schema 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.
connection_key
string / required
The connection key.
endpoint_id
string
Endpoint ID used for getDataAssetFullDetails.
fields
list / elements=string
Specifies the fields to get for an object.
include_types
list / elements=string
Artifact type which needs to be listed while listing Artifacts.
name
string
Used to filter by the name of the object.
name_list
list / elements=string
Used to filter by the name of the object.
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.
registry_id
string / required
The registry OCID.
schema_resource_key
string
Schema resource name used for retrieving schemas.
schema_resource_name
string
The schema resource name used for retrieving schemas.
Required to get a specific schema.
sort_by
string
    Choices:
  • id
  • timeCreated
  • displayName
Specifies the field to sort by. Accepts only one field. By default, when you sort by time fields, results are shown in descending order. All other fields default to ascending order. Sorting related parameters are ignored when parameter `query` is present (search operation and sorting order are by relevance score in descending order).
sort_order
string
    Choices:
  • ASC
  • DESC
Specifies sort order to use, either `ASC` (ascending) or `DESC` (descending).
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 schema
  oci_data_connectivity_schema_facts:
    # required
    schema_resource_name: schema_resource_name_example
    registry_id: "ocid1.registry.oc1..xxxxxxEXAMPLExxxxxx"
    connection_key: connection_key_example

    # optional
    endpoint_id: "ocid1.endpoint.oc1..xxxxxxEXAMPLExxxxxx"

- name: List schemas
  oci_data_connectivity_schema_facts:
    # required
    registry_id: "ocid1.registry.oc1..xxxxxxEXAMPLExxxxxx"
    connection_key: connection_key_example

    # optional
    fields: [ "fields_example" ]
    sort_by: id
    sort_order: ASC
    schema_resource_key: schema_resource_key_example
    name: name_example
    name_list: [ "name_list_example" ]
    endpoint_id: "ocid1.endpoint.oc1..xxxxxxEXAMPLExxxxxx"
    include_types: [ "include_types_example" ]

Return Values

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

Key Returned Description
schemas
complex
on success
List of Schema resources

Sample:
[{'default_connection': 'default_connection_example', 'description': 'description_example', 'external_key': 'external_key_example', 'identifier': 'identifier_example', 'is_has_containers': True, 'key': 'key_example', 'metadata': {'aggregator': {'description': 'description_example', 'identifier': 'identifier_example', 'key': 'key_example', 'name': 'name_example', 'type': 'type_example'}, 'aggregator_key': 'aggregator_key_example', 'created_by': 'created_by_example', 'created_by_name': 'created_by_name_example', 'identifier_path': 'identifier_path_example', 'info_fields': {}, 'is_favorite': True, 'labels': [], 'registry_version': 56, 'time_created': '2013-10-20T19:20:30+01:00', 'time_updated': '2013-10-20T19:20:30+01:00', 'updated_by': 'updated_by_example', 'updated_by_name': 'updated_by_name_example'}, 'model_type': 'model_type_example', 'model_version': 'model_version_example', 'name': 'name_example', 'object_status': 56, 'object_version': 56, 'parent_ref': {'parent': 'parent_example'}, 'resource_name': 'resource_name_example'}]
 
default_connection
string
on success
The default connection key.

Sample:
default_connection_example
 
description
string
on success
User-defined description for the schema.

Sample:
description_example
 
external_key
string
on success
The external key of the object.

Sample:
external_key_example
 
identifier
string
on success
Value can only contain upper case letters, underscore, and numbers. It should begin with an upper case letter or underscore. The value can be modified.

Sample:
identifier_example
 
is_has_containers
boolean
on success
Specifies whether the schema has containers.

Sample:
True
 
key
string
on success
The object key.

Sample:
key_example
 
metadata
complex
on success

   
aggregator
complex
on success

     
description
string
on success
The description of the aggregator.

Sample:
description_example
     
identifier
string
on success
The identifier of the aggregator.

Sample:
identifier_example
     
key
string
on success
The key of the aggregator object.

Sample:
key_example
     
name
string
on success
The name of the aggregator.

Sample:
name_example
     
type
string
on success
The type of the aggregator.

Sample:
type_example
   
aggregator_key
string
on success
The owning object key for this object.

Sample:
aggregator_key_example
   
created_by
string
on success
The user that created the object.

Sample:
created_by_example
   
created_by_name
string
on success
The user that created the object.

Sample:
created_by_name_example
   
identifier_path
string
on success
The full path to identify the object.

Sample:
identifier_path_example
   
info_fields
dictionary
on success
Information property fields.

   
is_favorite
boolean
on success
Specifies whether this object is a favorite.

Sample:
True
   
labels
list / elements=string
on success
Labels are keywords or tags that you can add to data assets, dataflows, and so on. You can define your own labels and use them to categorize content.

   
registry_version
integer
on success
The registry version of the object.

Sample:
56
   
time_created
string
on success
The date and time that the object was created.

Sample:
2013-10-20T19:20:30+01:00
   
time_updated
string
on success
The date and time that the object was updated.

Sample:
2013-10-20T19:20:30+01:00
   
updated_by
string
on success
The user that updated the object.

Sample:
updated_by_example
   
updated_by_name
string
on success
The user that updated the object.

Sample:
updated_by_name_example
 
model_type
string
on success
The object type.

Sample:
model_type_example
 
model_version
string
on success
The model version of the object.

Sample:
model_version_example
 
name
string
on success
Free form text without any restriction on the permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters.

Sample:
name_example
 
object_status
integer
on success
The status of an object that can be set to value 1 for shallow references across objects, other values reserved.

Sample:
56
 
object_version
integer
on success
The version of the object that is used to track changes in the object instance.

Sample:
56
 
parent_ref
complex
on success

   
parent
string
on success
Key of the parent object.

Sample:
parent_example
 
resource_name
string
on success
A resource name can have letters, numbers, and special characters. The value is editable and is restricted to 4000 characters.

Sample:
resource_name_example


Authors

  • Oracle (@oracle)