oracle.oci.oci_opsi_data_objects_actions – Perform actions on an OpsiDataObjects resource in Oracle Cloud Infrastructure

Note

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

New in version 2.9.0: of oracle.oci

Synopsis

  • Perform actions on an OpsiDataObjects resource in Oracle Cloud Infrastructure

  • For action=query, queries an OPSI data object with the inputs provided and sends the result set back. Either analysisTimeInterval or timeIntervalStart and timeIntervalEnd parameters need to be passed as well.

Requirements

The below requirements are needed on the host that executes this module.

Parameters

Parameter Choices/Defaults Comments
action
string / required
    Choices:
  • query
The action to perform on the OpsiDataObjects.
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.
compartment_id
string / required
The OCID of the compartment.
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.
data_object_identifier
string
Unique OPSI data object identifier.
query
dictionary / required
group_by_list
list / elements=string
List of items to be added into the GROUP BY clause of the query; items will be added with comma separation.
having_conditions_list
list / elements=string
List of items to be added into the HAVING clause of the query; items will be added with AND separation.
order_by_list
list / elements=string
List of items to be added into the ORDER BY clause of the query; items will be added with comma separation.
query_type
string / required
    Choices:
  • TEMPLATIZED_QUERY
Type of Query
select_list
list / elements=string
List of items to be added into the SELECT clause of the query; items will be added with comma separation.
time_filters
dictionary
time_end
string
End time in UTC in RFC3339 formatted datetime string. Example: 2021-10-30T00:00:00.000Z. timeStart and timeEnd are used together. If timePeriod is specified, this parameter is ignored. If timeEnd is not specified, current time is used as timeEnd.
time_period
string
Specify time period in ISO 8601 format with respect to current time. Default is last 30 days represented by P30D. If timePeriod is specified, then timeStart and timeEnd will be ignored. Examples: P90D (last 90 days), P4W (last 4 weeks), P2M (last 2 months), P1Y (last 12 months).
time_start
string
Start time in UTC in RFC3339 formatted datetime string. Example: 2021-10-30T00:00:00.000Z. timeStart and timeEnd are used together. If timePeriod is specified, this parameter is ignored.
where_conditions_list
list / elements=string
List of items to be added into the WHERE clause of the query; items will be added with AND separation. Item can contain a single condition or multiple conditions. Single condition e.g: "optimizer_mode='mode1'" Multiple conditions e.g: (module='module1' OR module='module2')
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.
resource_filters
dictionary
compartment_id_in_subtree
boolean
    Choices:
  • no
  • yes
A flag to consider all resources within a given compartment and all sub-compartments.
defined_tag_equals
list / elements=string
A list of tag filters to apply. Only resources with a defined tag matching the value will be considered. Each item in the list has the format "{namespace}.{tagName}.{value}". All inputs are case-insensitive. Multiple values for the same key (i.e. same namespace and tag name) are interpreted as "OR". Values for different keys (i.e. different namespaces, different tag names, or both) are interpreted as "AND".
defined_tag_exists
list / elements=string
A list of tag existence filters to apply. Only resources for which the specified defined tags exist will be considered. Each item in the list has the format "{namespace}.{tagName}.true" (for checking existence of a defined tag) or "{namespace}.true". All inputs are case-insensitive. Currently, only existence ("true" at the end) is supported. Absence ("false" at the end) is not supported. Multiple values for the same key (i.e. same namespace and tag name) are interpreted as "OR". Values for different keys (i.e. different namespaces, different tag names, or both) are interpreted as "AND".
freeform_tag_equals
list / elements=string
A list of tag filters to apply. Only resources with a freeform tag matching the value will be considered. The key for each tag is "{tagName}.{value}". All inputs are case-insensitive. Multiple values for the same tag name are interpreted as "OR". Values for different tag names are interpreted as "AND".
freeform_tag_exists
list / elements=string
A list of tag existence filters to apply. Only resources for which the specified freeform tags exist will be considered. The key for each tag is "{tagName}.true". All inputs are case-insensitive. Currently, only existence ("true" at the end) is supported. Absence ("false" at the end) is not supported. Multiple values for different tag names are interpreted as "AND".
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: Perform action query on opsi_data_objects
  oci_opsi_data_objects_actions:
    # required
    compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
    query:
      # required
      query_type: TEMPLATIZED_QUERY

      # optional
      select_list: [ "select_list_example" ]
      where_conditions_list: [ "where_conditions_list_example" ]
      group_by_list: [ "group_by_list_example" ]
      having_conditions_list: [ "having_conditions_list_example" ]
      order_by_list: [ "order_by_list_example" ]
      time_filters:
        # optional
        time_period: time_period_example
        time_start: time_start_example
        time_end: time_end_example
    action: query

    # optional
    data_object_identifier: data_object_identifier_example
    resource_filters:
      # optional
      defined_tag_equals: [ "defined_tag_equals_example" ]
      freeform_tag_equals: [ "freeform_tag_equals_example" ]
      defined_tag_exists: [ "defined_tag_exists_example" ]
      freeform_tag_exists: [ "freeform_tag_exists_example" ]
      compartment_id_in_subtree: true

Return Values

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

Key Returned Description
opsi_data_objects
complex
on success
Details of the OpsiDataObjects resource acted upon by the current operation

Sample:
{'columns_metadata': [{'category': 'DIMENSION', 'data_type_name': 'NUMBER', 'description': 'description_example', 'display_name': 'display_name_example', 'group_name': 'group_name_example', 'name': 'name_example', 'unit_details': {'denominator': {'display_name': 'display_name_example', 'unit_category': 'DATA_SIZE'}, 'display_name': 'display_name_example', 'numerator': {'display_name': 'display_name_example', 'unit_category': 'DATA_SIZE'}, 'unit': 'CORE', 'unit_category': 'DATA_SIZE'}}], 'data_object_type': 'DATABASE_INSIGHTS_DATA_OBJECT', 'description': 'description_example', 'display_name': 'display_name_example', 'identifier': 'identifier_example'}
 
columns_metadata
complex
on success
Metadata of columns in a data object.

   
category
string
on success
Category of the column.

Sample:
DIMENSION
   
data_type_name
string
on success
Type of a data object column.

Sample:
NUMBER
   
description
string
on success
Description of the column.

Sample:
description_example
   
display_name
string
on success
Display name of the column.

Sample:
display_name_example
   
group_name
string
on success
Group name of the column.

Sample:
group_name_example
   
name
string
on success
Name of the column.

Sample:
name_example
   
unit_details
complex
on success

     
denominator
complex
on success

       
display_name
string
on success
Display name of the column's unit.

Sample:
display_name_example
       
unit_category
string
on success
Category of the column's unit.

Sample:
DATA_SIZE
     
display_name
string
on success
Display name of the column's unit.

Sample:
display_name_example
     
numerator
complex
on success

       
display_name
string
on success
Display name of the column's unit.

Sample:
display_name_example
       
unit_category
string
on success
Category of the column's unit.

Sample:
DATA_SIZE
     
unit
string
on success
Core unit.

Sample:
CORE
     
unit_category
string
on success
Category of the column's unit.

Sample:
DATA_SIZE
 
data_object_type
string
on success
Type of OPSI data object.

Sample:
DATABASE_INSIGHTS_DATA_OBJECT
 
description
string
on success
Description of OPSI data object.

Sample:
description_example
 
display_name
string
on success
User-friendly name of OPSI data object.

Sample:
display_name_example
 
identifier
string
on success
Unique identifier of OPSI data object.

Sample:
identifier_example


Authors

  • Oracle (@oracle)