oracle.oci.oci_data_flow_sql_endpoint_facts – Fetches details about one or multiple SqlEndpoint resources in Oracle Cloud Infrastructure

Note

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

New in version 2.9.0: of oracle.oci

Synopsis

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

  • Lists all Sql Endpoints in the specified compartment. The query must include compartmentId or sqlEndpointId. If the query does not include either compartmentId or sqlEndpointId, an error is returned.

  • If sql_endpoint_id is specified, the details of a single SqlEndpoint 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
  • security_token
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.
compartment_id
string
The OCID of the compartment in which to query resources.
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.
display_name
string
The query parameter for the Spark application name.

aliases: name
lifecycle_state
string
    Choices:
  • CREATING
  • ACTIVE
  • DELETING
  • DELETED
  • FAILED
A filter to return only those resources whose sqlEndpointLifecycleState matches the given sqlEndpointLifecycleState.
realm_specific_endpoint_template_enabled
boolean
    Choices:
  • no
  • yes
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
    Choices:
  • id
  • timeCreated
  • displayName
The field to sort by. Only one sort order may be provided. The default order for timeCreated is descending. The default order for displayName is ascending. If no value is specified timeCreated is used by default.
sort_order
string
    Choices:
  • ASC
  • DESC
The ordering of results in ascending or descending order.
sql_endpoint_id
string
The unique id of the SQL Endpoint.
Required to get a specific sql_endpoint.

aliases: id
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 sql_endpoint
  oci_data_flow_sql_endpoint_facts:
    # required
    sql_endpoint_id: "ocid1.sqlendpoint.oc1..xxxxxxEXAMPLExxxxxx"

- name: List sql_endpoints
  oci_data_flow_sql_endpoint_facts:

    # optional
    compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
    sql_endpoint_id: "ocid1.sqlendpoint.oc1..xxxxxxEXAMPLExxxxxx"
    lifecycle_state: CREATING
    display_name: display_name_example
    sort_order: ASC
    sort_by: id

Return Values

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

Key Returned Description
sql_endpoints
complex
on success
List of SqlEndpoint resources

Sample:
[{'compartment_id': 'ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx', 'defined_tags': {'Operations': {'CostCenter': 'US'}}, 'description': 'description_example', 'display_name': 'display_name_example', 'driver_shape': 'driver_shape_example', 'driver_shape_config': {'memory_in_gbs': 10, 'ocpus': 10}, 'executor_shape': 'executor_shape_example', 'executor_shape_config': {'memory_in_gbs': 10, 'ocpus': 10}, 'freeform_tags': {'Department': 'Finance'}, 'id': 'ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx', 'jdbc_endpoint_url': 'jdbc_endpoint_url_example', 'lake_id': 'ocid1.lake.oc1..xxxxxxEXAMPLExxxxxx', 'last_accepted_request_token': 'last_accepted_request_token_example', 'lifecycle_state': 'CREATING', 'max_executor_count': 56, 'metastore_id': 'ocid1.metastore.oc1..xxxxxxEXAMPLExxxxxx', 'min_executor_count': 56, 'network_configuration': {'access_control_rules': [{'ip_notation': 'IP_ADDRESS', 'value': 'value_example', 'vcn_ips': 'vcn_ips_example'}], 'host_name_prefix': 'host_name_prefix_example', 'network_type': 'VCN', 'nsg_ids': [], 'private_endpoint_ip': 'private_endpoint_ip_example', 'public_endpoint_ip': 'public_endpoint_ip_example', 'subnet_id': 'ocid1.subnet.oc1..xxxxxxEXAMPLExxxxxx', 'vcn_id': 'ocid1.vcn.oc1..xxxxxxEXAMPLExxxxxx'}, 'owner_principal_id': 'ocid1.ownerprincipal.oc1..xxxxxxEXAMPLExxxxxx', 'spark_advanced_configurations': {}, 'sql_endpoint_version': 'sql_endpoint_version_example', 'state_message': 'state_message_example', 'system_tags': {}, 'time_created': '2013-10-20T19:20:30+01:00', 'time_updated': '2013-10-20T19:20:30+01:00', 'warehouse_bucket_uri': 'warehouse_bucket_uri_example'}]
 
compartment_id
string
on success
The OCID of a compartment.

Sample:
ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx
 
defined_tags
dictionary
on success
Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: `{"Operations": {"CostCenter": "42"}}`

Sample:
{'Operations': {'CostCenter': 'US'}}
 
description
string
on success
The description of the SQL Endpoint.

Sample:
description_example
 
display_name
string
on success
The SQL Endpoint name, which can be changed.

Sample:
display_name_example
 
driver_shape
string
on success
The shape of the SQL Endpoint driver instance.

Sample:
driver_shape_example
 
driver_shape_config
complex
on success

   
memory_in_gbs
float
on success
The amount of memory used for the driver or executors.

Sample:
10
   
ocpus
float
on success
The total number of OCPUs used for the driver or executors. See here for details.

Sample:
10
 
executor_shape
string
on success
The shape of the SQL Endpoint executor instance.

Sample:
executor_shape_example
 
executor_shape_config
complex
on success

   
memory_in_gbs
float
on success
The amount of memory used for the driver or executors.

Sample:
10
   
ocpus
float
on success
The total number of OCPUs used for the driver or executors. See here for details.

Sample:
10
 
freeform_tags
dictionary
on success
Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: `{"Department": "Finance"}`

Sample:
{'Department': 'Finance'}
 
id
string
on success
The provision identifier that is immutable on creation.

Sample:
ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
 
jdbc_endpoint_url
string
on success
The JDBC URL field. For example, jdbc:spark://{serviceFQDN}:443/default;SparkServerType=DFI

Sample:
jdbc_endpoint_url_example
 
lake_id
string
on success
The OCID of OCI Lake.

Sample:
ocid1.lake.oc1..xxxxxxEXAMPLExxxxxx
 
last_accepted_request_token
string
on success
This token is used by Splat, and indicates that the service accepts the request, and that the request is currently being processed.

Sample:
last_accepted_request_token_example
 
lifecycle_state
string
on success
The current state of the Sql Endpoint.

Sample:
CREATING
 
max_executor_count
integer
on success
The maximum number of executors.

Sample:
56
 
metastore_id
string
on success
The OCID of OCI Hive Metastore.

Sample:
ocid1.metastore.oc1..xxxxxxEXAMPLExxxxxx
 
min_executor_count
integer
on success
The minimum number of executors.

Sample:
56
 
network_configuration
complex
on success

   
access_control_rules
complex
on success
A list of SecureAccessControlRule's to which access is limited to
     
ip_notation
string
on success
The type of IP notation.

Sample:
IP_ADDRESS
     
value
string
on success
The associated value of the selected IP notation.

Sample:
value_example
     
vcn_ips
string
on success
A comma-separated IP or CIDR address for VCN OCID IP notation selection.

Sample:
vcn_ips_example
   
host_name_prefix
string
on success
The host name prefix.

Sample:
host_name_prefix_example
   
network_type
string
on success
The type of network configuration.

Sample:
VCN
   
nsg_ids
list / elements=string
on success
The OCIDs of Network Security Groups (NSGs).
   
private_endpoint_ip
string
on success
Ip Address of private endpoint

Sample:
private_endpoint_ip_example
   
public_endpoint_ip
string
on success
Ip Address of public endpoint

Sample:
public_endpoint_ip_example
   
subnet_id
string
on success
The VCN Subnet OCID.

Sample:
ocid1.subnet.oc1..xxxxxxEXAMPLExxxxxx
   
vcn_id
string
on success
The VCN OCID.

Sample:
ocid1.vcn.oc1..xxxxxxEXAMPLExxxxxx
 
owner_principal_id
string
on success
The OCID of the user who created the resource.
Returned for list operation

Sample:
ocid1.ownerprincipal.oc1..xxxxxxEXAMPLExxxxxx
 
spark_advanced_configurations
dictionary
on success
The Spark configuration passed to the running process. See https://spark.apache.org/docs/latest/configuration.html#available-properties. Example: { "spark.app.name" : "My App Name", "spark.shuffle.io.maxRetries" : "4" } Note: Not all Spark properties are permitted to be set. Attempting to set a property that is not allowed to be overwritten will cause a 400 status to be returned.
 
sql_endpoint_version
string
on success
The version of SQL Endpoint.

Sample:
sql_endpoint_version_example
 
state_message
string
on success
A message describing the reason why the resource is in it's current state. Helps bubble up errors in state changes. For example, it can be used to provide actionable information for a resource in the Failed state.

Sample:
state_message_example
 
system_tags
dictionary
on success
The system tags associated with this resource, if any. The system tags are set by Oracle cloud infrastructure services. Each key is predefined and scoped to namespaces. For more information, see Resource Tags. Example: `{orcl-cloud: {free-tier-retain: true}}`
 
time_created
string
on success
The time the Sql Endpoint was created. An RFC3339 formatted datetime string.

Sample:
2013-10-20T19:20:30+01:00
 
time_updated
string
on success
The time the Sql Endpoint was updated. An RFC3339 formatted datetime string.

Sample:
2013-10-20T19:20:30+01:00
 
warehouse_bucket_uri
string
on success
The warehouse bucket URI. It is a Oracle Cloud Infrastructure Object Storage bucket URI as defined here https://docs.oracle.com/en/cloud/paas/atp-cloud/atpud/object-storage-uris.html

Sample:
warehouse_bucket_uri_example


Authors

  • Oracle (@oracle)