oracle.oci.oci_monitoring_alarm_history_collection_facts – Fetches details about a AlarmHistoryCollection resource in Oracle Cloud Infrastructure

Note

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

New in version 2.9.0: of oracle.oci

Synopsis

  • Fetches details about a AlarmHistoryCollection resource in Oracle Cloud Infrastructure

  • Get the history of the specified alarm. For important limits information, see Limits on Monitoring.

  • This call is subject to a Monitoring limit that applies to the total number of requests across all alarm operations. Monitoring might throttle this call to reject an otherwise valid request when the total rate of alarm operations exceeds 10 requests, or transactions, per second (TPS) for a given tenancy.

Requirements

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

Parameters

Parameter Choices/Defaults Comments
alarm_historytype
string
    Choices:
  • STATE_HISTORY
  • STATE_TRANSITION_HISTORY
The type of history entries to retrieve. State history (STATE_HISTORY) or state transition history (STATE_TRANSITION_HISTORY). If not specified, entries of both types are retrieved.
Example: `STATE_HISTORY`
alarm_id
string / required
The OCID of an alarm.

aliases: id
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.
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.
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
timestamp_greater_than_or_equal_to
string
A filter to return only alarm history entries with timestamps occurring on or after the specified date and time. Format defined by RFC3339.
Example: `2019-01-01T01:00:00.789Z`
timestamp_less_than
string
A filter to return only alarm history entries with timestamps occurring before the specified date and time. Format defined by RFC3339.
Example: `2019-01-02T01:00:00.789Z`

Examples

- name: Get a specific alarm_history_collection
  oci_monitoring_alarm_history_collection_facts:
    # required
    alarm_id: "ocid1.alarm.oc1..xxxxxxEXAMPLExxxxxx"

    # optional
    alarm_historytype: STATE_HISTORY
    timestamp_greater_than_or_equal_to: 2013-10-20T19:20:30+01:00
    timestamp_less_than: 2013-10-20T19:20:30+01:00

Return Values

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

Key Returned Description
alarm_history_collection
complex
on success
AlarmHistoryCollection resource

Sample:
{'alarm_id': 'ocid1.alarm.oc1..xxxxxxEXAMPLExxxxxx', 'entries': [{'summary': 'summary_example', 'timestamp': '2013-10-20T19:20:30+01:00', 'timestamp_triggered': '2013-10-20T19:20:30+01:00'}], 'is_enabled': True}
 
alarm_id
string
on success
The OCID of the alarm for which to retrieve history.

Sample:
ocid1.alarm.oc1..xxxxxxEXAMPLExxxxxx
 
entries
complex
on success
The set of history entries retrieved for the alarm.
   
summary
string
on success
Description for this alarm history entry.
Example 1 - alarm state history entry: `The alarm state is FIRING`
Example 2 - alarm state transition history entry: `State transitioned from OK to Firing`

Sample:
summary_example
   
timestamp
string
on success
Timestamp for this alarm history entry. Format defined by RFC3339.
Example: `2019-02-01T01:02:29.600Z`

Sample:
2013-10-20T19:20:30+01:00
   
timestamp_triggered
string
on success
Timestamp for the transition of the alarm state. For example, the time when the alarm transitioned from OK to Firing. Available for state transition entries only. Note: A three-minute lag for this value accounts for any late-arriving metrics.
Example: `2019-02-01T0:59:00.789Z`

Sample:
2013-10-20T19:20:30+01:00
 
is_enabled
boolean
on success
Whether the alarm is enabled.
Example: `true`

Sample:
True


Authors

  • Oracle (@oracle)