oracle.oci.oci_data_safe_alert_analytics_facts – Fetches details about one or multiple AlertAnalytics 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_data_safe_alert_analytics_facts.

New in version 2.9.0: of oracle.oci

Synopsis

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

  • Returns aggregation details of alerts.

Requirements

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

Parameters

Parameter Choices/Defaults Comments
access_level
string
    Choices:
  • RESTRICTED
  • ACCESSIBLE
Valid values are RESTRICTED and ACCESSIBLE. Default is RESTRICTED. Setting this to ACCESSIBLE returns only those compartments for which the user has INSPECT permissions directly or indirectly (permissions can be on a resource in a subcompartment). When set to RESTRICTED permissions are checked and no partial results are displayed.
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
A filter to return only resources that match the specified compartment OCID.
compartment_id_in_subtree
boolean
    Choices:
  • no
  • yes
Default is false. When set to true, the hierarchy of compartments is traversed and all compartments and subcompartments in the tenancy are returned. Depends on the 'accessLevel' setting.
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.
group_by
list / elements=string
    Choices:
  • alertType
  • targetIds
  • targetNames
  • alertSeverity
  • alertStatus
  • timeCreated
  • policyId
A groupBy can only be used in combination with summaryField parameter. A groupBy value has to be a subset of the values mentioned in summaryField parameter.
query_time_zone
string
Default time zone is UTC if no time zone provided. The date-time considerations of the resource will be in accordance with the specified time zone.
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.
scim_query
string
The scimQuery query parameter accepts filter expressions that use the syntax described in Section 3.2.2.2 of the System for Cross-Domain Identity Management (SCIM) specification, which is available at RFC3339. In SCIM filtering expressions, text, date, and time values must be enclosed in quotation marks, with date and time values using ISO-8601 format. (Numeric and boolean values should not be quoted.)
**Example:** query=(timeCreated ge '2021-06-04T01-00-26') and (targetNames eq 'target_1') Supported fields: severity status alertType targetIds targetNames operationTime lifecycleState displayName timeCreated timeUpdated
sort_by
string
    Choices:
  • displayName
  • timeCreated
The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. If no value is specified timeCreated is default.
sort_order
string
    Choices:
  • ASC
  • DESC
The sort order to use, either ascending (ASC) or descending (DESC).
summary_field
list / elements=string
    Choices:
  • alertType
  • targetIds
  • targetNames
  • alertSeverity
  • alertStatus
  • timeCreated
  • policyId
  • open
  • closed
  • critical
  • high
  • medium
  • low
  • alertcount
Specifies a subset of summarized fields to be returned in the response.
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_ended
string
An optional filter to return audit events whose creation time in the database is less than and equal to the date-time specified, in the format defined by RFC3339.
time_started
string
An optional filter to return audit events whose creation time in the database is greater than and equal to the date-time specified, in the format defined by RFC3339.

Examples

- name: List alert_analytics
  oci_data_safe_alert_analytics_facts:
    # required
    compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"

    # optional
    compartment_id_in_subtree: true
    time_started: 2013-10-20T19:20:30+01:00
    time_ended: 2013-10-20T19:20:30+01:00
    query_time_zone: query_time_zone_example
    sort_order: ASC
    sort_by: displayName
    access_level: RESTRICTED
    scim_query: scim_query_example
    summary_field: [ "alertType" ]
    group_by: [ "alertType" ]

Return Values

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

Key Returned Description
alert_analytics
complex
on success
List of AlertAnalytics resources

Sample:
[{'count': 56, 'dimensions': {'group_by': {}}, 'metric_name': 'metric_name_example', 'time_ended': '2013-10-20T19:20:30+01:00', 'time_started': '2013-10-20T19:20:30+01:00'}]
 
count
integer
on success
Total count of aggregated values.

Sample:
56
 
dimensions
complex
on success

   
group_by
dictionary
on success
GroupBy value used in aggregation.

 
metric_name
string
on success
The name of the aggregation.

Sample:
metric_name_example
 
time_ended
string
on success
The time at which the aggregation ended.

Sample:
2013-10-20T19:20:30+01:00
 
time_started
string
on success
The time at which the aggregation started.

Sample:
2013-10-20T19:20:30+01:00


Authors

  • Oracle (@oracle)