oracle.oci.oci_opsi_data_objects_facts – Fetches details about one or multiple OpsiDataObjects resources in Oracle Cloud Infrastructure

Note

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

New in version 2.9.0: of oracle.oci

Synopsis

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

  • Gets a list of OPSI data objects based on the query parameters specified. CompartmentId id query parameter must be specified.

  • If opsi_data_object_identifier is specified, the details of a single OpsiDataObjects 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.
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_type
list / elements=string
    Choices:
  • DATABASE_INSIGHTS_DATA_OBJECT
  • HOST_INSIGHTS_DATA_OBJECT
  • EXADATA_INSIGHTS_DATA_OBJECT
OPSI data object types.
display_name
string
A filter to return only resources that match the entire display name.

aliases: name
opsi_data_object_identifier
string
Unique OPSI data object identifier.
Required to get a specific opsi_data_objects.
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:
  • displayName
  • dataObjectType
OPSI data object list sort options.
sort_order
string
    Choices:
  • ASC
  • DESC
The sort order to use, either ascending (`ASC`) or descending (`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

Examples

- name: Get a specific opsi_data_objects
  oci_opsi_data_objects_facts:
    # required
    opsi_data_object_identifier: opsi_data_object_identifier_example
    compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"

- name: List opsi_data_objects
  oci_opsi_data_objects_facts:
    # required
    compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"

    # optional
    data_object_type: [ "DATABASE_INSIGHTS_DATA_OBJECT" ]
    display_name: display_name_example
    sort_order: ASC
    sort_by: displayName

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
List of OpsiDataObjects resources

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.
Returned for get operation

   
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)