oracle.oci.oci_data_catalog_connection_facts – Fetches details about one or multiple Connection resources in Oracle Cloud Infrastructure¶
Note
This plugin is part of the oracle.oci collection (version 5.2.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_connection_facts
.
New in version 2.9.0: of oracle.oci
Synopsis¶
Fetches details about one or multiple Connection resources in Oracle Cloud Infrastructure
Returns a list of all Connections for a data asset.
If connection_key is specified, the details of a single Connection will be returned.
Requirements¶
The below requirements are needed on the host that executes this module.
python >= 3.6
Python SDK for Oracle Cloud Infrastructure https://oracle-cloud-infrastructure-python-sdk.readthedocs.io
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
|
|
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
|
|
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 . |
|
connection_key
string
|
Unique connection key.
Required to get a specific connection.
|
|
created_by_id
string
|
OCID of the user who created the resource.
|
|
data_asset_key
string
/ required
|
Unique data asset key.
|
|
display_name
string
|
A filter to return only resources that match the entire display name given. The match is not case sensitive.
aliases: name |
|
display_name_contains
string
|
A filter to return only resources that match display name pattern given. The match is not case sensitive. For Example : /folders?displayNameContains=Cu.* The above would match all folders with display name that starts with "Cu" or has the pattern "Cu" anywhere in between.
|
|
external_key
string
|
Unique external identifier of this resource in the external source system.
|
|
fields
list
/ elements=string
|
|
Specifies the fields to return in a connection response.
|
is_default
boolean
|
|
Indicates whether this connection is the default connection.
|
lifecycle_state
string
|
|
A filter to return only resources that match the specified lifecycle state. The value is case insensitive.
|
realm_specific_endpoint_template_enabled
boolean
|
|
Enable/Disable realm specific endpoint template for service client. By Default, realm specific endpoint template is disabled. If not set, then the value of the OCI_REALM_SPECIFIC_SERVICE_ENDPOINT_TEMPLATE_ENABLED variable, if any, is used.
|
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
|
|
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
|
|
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 |
|
time_created
string
|
Time that the resource was created. An RFC3339 formatted datetime string.
|
|
time_status_updated
string
|
Time that the resource's status was last updated. An RFC3339 formatted datetime string.
|
|
time_updated
string
|
Time that the resource was updated. An RFC3339 formatted datetime string.
|
|
updated_by_id
string
|
OCID of the user who updated the resource.
|
Notes¶
Note
For OCI python sdk configuration, please refer to https://oracle-cloud-infrastructure-python-sdk.readthedocs.io/en/latest/configuration.html
Examples¶
- name: Get a specific connection
oci_data_catalog_connection_facts:
# required
connection_key: connection_key_example
catalog_id: "ocid1.catalog.oc1..xxxxxxEXAMPLExxxxxx"
data_asset_key: data_asset_key_example
# optional
fields: [ "key" ]
- name: List connections
oci_data_catalog_connection_facts:
# required
catalog_id: "ocid1.catalog.oc1..xxxxxxEXAMPLExxxxxx"
data_asset_key: data_asset_key_example
# optional
display_name: display_name_example
display_name_contains: display_name_contains_example
lifecycle_state: CREATING
time_created: 2013-10-20T19:20:30+01:00
time_updated: 2013-10-20T19:20:30+01:00
created_by_id: "ocid1.createdby.oc1..xxxxxxEXAMPLExxxxxx"
updated_by_id: "ocid1.updatedby.oc1..xxxxxxEXAMPLExxxxxx"
external_key: external_key_example
time_status_updated: 2013-10-20T19:20:30+01:00
is_default: true
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 | ||
---|---|---|---|---|
connections
complex
|
on success |
List of Connection resources
Sample:
[{'created_by_id': 'ocid1.createdby.oc1..xxxxxxEXAMPLExxxxxx', 'custom_property_members': [{'allowed_values': [], 'data_type': 'TEXT', 'description': 'description_example', 'display_name': 'display_name_example', 'is_editable': True, 'is_event_enabled': True, 'is_hidden': True, 'is_list_type': True, 'is_multi_valued': True, 'is_shown_in_list': True, 'key': 'key_example', 'namespace_key': 'namespace_key_example', 'namespace_name': 'namespace_name_example', 'value': 'value_example'}], 'data_asset_key': 'data_asset_key_example', 'description': 'description_example', 'display_name': 'display_name_example', 'external_key': 'external_key_example', 'is_default': True, 'key': 'key_example', 'lifecycle_state': 'CREATING', 'properties': {}, 'time_created': '2013-10-20T19:20:30+01:00', 'time_status_updated': '2013-10-20T19:20:30+01:00', 'time_updated': '2013-10-20T19:20:30+01:00', 'type_key': 'type_key_example', 'updated_by_id': 'ocid1.updatedby.oc1..xxxxxxEXAMPLExxxxxx', 'uri': 'uri_example'}]
|
||
created_by_id
string
|
on success |
OCID of the user who created the connection.
Returned for get operation
Sample:
ocid1.createdby.oc1..xxxxxxEXAMPLExxxxxx
|
||
custom_property_members
complex
|
on success |
The list of customized properties along with the values for this object
Returned for get operation
|
||
allowed_values
list
/ elements=string
|
on success |
Allowed values for the custom property if any
|
||
data_type
string
|
on success |
The 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
|
||
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_hidden
boolean
|
on success |
If this field is a hidden field
Sample:
True
|
||
is_list_type
boolean
|
on success |
Is this property allowed to have list of values
Sample:
True
|
||
is_multi_valued
boolean
|
on success |
If this field allows multiple values to be set
Sample:
True
|
||
is_shown_in_list
boolean
|
on success |
If this field is displayed in a list view of applicable objects.
Sample:
True
|
||
key
string
|
on success |
Unique Identifier of the attribute which is ID
Sample:
key_example
|
||
namespace_key
string
|
on success |
Unique namespace key that is immutable
Sample:
namespace_key_example
|
||
namespace_name
string
|
on success |
Namespace name of the custom property
Sample:
namespace_name_example
|
||
value
string
|
on success |
The custom property value
Sample:
value_example
|
||
data_asset_key
string
|
on success |
Unique key of the parent data asset.
Sample:
data_asset_key_example
|
||
description
string
|
on success |
A description of the connection.
Sample:
description_example
|
||
display_name
string
|
on success |
A user-friendly display name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
Sample:
display_name_example
|
||
external_key
string
|
on success |
Unique external key of this object from the source system.
Sample:
external_key_example
|
||
is_default
boolean
|
on success |
Indicates whether this connection is the default connection.
Sample:
True
|
||
key
string
|
on success |
Unique connection key that is immutable.
Sample:
key_example
|
||
lifecycle_state
string
|
on success |
The current state of the connection.
Sample:
CREATING
|
||
properties
dictionary
|
on success |
A map of maps that contains the properties which are specific to the connection type. Each connection type definition defines it's set of required and optional properties. The map keys are category names and the values are maps of property name to property value. Every property is contained inside of a category. Most connections have required properties within the "default" category. Example: `{"properties": { "default": { "username": "user1"}}}`
Returned for get operation
|
||
time_created
string
|
on success |
The date and time the connection was created, in the format defined by RFC3339. Example: `2019-03-25T21:10:29.600Z`
Sample:
2013-10-20T19:20:30+01:00
|
||
time_status_updated
string
|
on success |
Time that the connections status was last updated. An RFC3339 formatted datetime string.
Returned for get operation
Sample:
2013-10-20T19:20:30+01:00
|
||
time_updated
string
|
on success |
The last time that any change was made to the connection. An RFC3339 formatted datetime string.
Returned for get operation
Sample:
2013-10-20T19:20:30+01:00
|
||
type_key
string
|
on success |
The key of the object type. Type key's can be found via the '/types' endpoint.
Sample:
type_key_example
|
||
updated_by_id
string
|
on success |
OCID of the user who modified the connection.
Returned for get operation
Sample:
ocid1.updatedby.oc1..xxxxxxEXAMPLExxxxxx
|
||
uri
string
|
on success |
URI to the connection instance in the API.
Sample:
uri_example
|
Authors¶
Oracle (@oracle)