oracle.oci.oci_loggingsearch_search_facts – Fetches details about a Search resource 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_loggingsearch_search_facts.

New in version 2.9.0: of oracle.oci

Synopsis

  • Fetches details about a Search resource in Oracle Cloud Infrastructure

  • Submit a query to search logs.

  • See Using the API for SDK examples.

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.
is_return_field_info
boolean
    Choices:
  • no
  • yes
Whether to return field schema information for the log stream specified in searchQuery.
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.
search_query
string / required
Query corresponding to the search operation. This query is parsed and validated before execution and should follow the specification. For more information on the query language specification, see Logging Query Language Specification.
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_end
string / required
End filter log's date and time, in the format defined by RFC3339.
time_start
string / required
Start filter log's date and time, in the format defined by RFC3339.

Examples

- name: Get a specific search
  oci_loggingsearch_search_facts:
    # required
    time_start: time_start_example
    time_end: time_end_example
    search_query: search_query_example

    # optional
    is_return_field_info: true

Return Values

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

Key Returned Description
search
complex
on success
Search resource

Sample:
{'fields': [{'field_name': 'field_name_example', 'field_type': 'STRING'}], 'results': [{'data': {}}], 'summary': {'field_count': 56, 'result_count': 56}}
 
fields
complex
on success
List of log field schema information.

   
field_name
string
on success
Field name

Sample:
field_name_example
   
field_type
string
on success
Field type - * `STRING`: A sequence of characters. * `NUMBER`: Numeric type which can be an integer or floating point. * `BOOLEAN`: Either true or false. * `ARRAY`: An ordered collection of values.

Sample:
STRING
 
results
complex
on success
List of search results

   
data
dictionary
on success
JSON blob containing the search entry with the projected fields.

 
summary
complex
on success

   
field_count
integer
on success
Total number of field schema information.

Sample:
56
   
result_count
integer
on success
Total number of search results.

Sample:
56


Authors

  • Oracle (@oracle)