oracle.oci.oci_monitoring_alarm_status_facts – Fetches details about one or multiple AlarmStatus 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_monitoring_alarm_status_facts.

New in version 2.9.0: of oracle.oci

Synopsis

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

  • List the status of each alarm in the specified compartment. Status is collective, across all metric streams in the alarm. To list alarm status for each metric stream, use RetrieveDimensionStates. The alarm attribute isNotificationsPerMetricDimensionEnabled must be set to true. 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
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 containing the resources monitored by the metric that you are searching for. Use tenancyId to search in the root compartment.
Example: `ocid1.compartment.oc1..exampleuniqueID`
compartment_id_in_subtree
boolean
    Choices:
  • no
  • yes
When true, returns resources from all compartments and subcompartments. The parameter can only be set to true when compartmentId is the tenancy OCID (the tenancy is the root compartment). A true value requires the user to have tenancy-level permissions. If this requirement is not met, then the call is rejected. When false, returns resources from only the compartment specified in compartmentId. Default is false.
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.
display_name
string
A filter to return only resources that match the given display name exactly. Use this filter to list an alarm by name. Alternatively, when you know the alarm OCID, use the GetAlarm operation.

aliases: name
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
  • severity
The field to use when sorting returned alarm definitions. Only one sorting level is provided.
Example: `severity`
sort_order
string
    Choices:
  • ASC
  • DESC
The sort order to use when sorting returned alarm definitions. Ascending (ASC) or descending (DESC).
Example: `ASC`
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: List alarm_statuses
  oci_monitoring_alarm_status_facts:
    # required
    compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"

    # optional
    compartment_id_in_subtree: true
    display_name: display_name_example
    sort_by: displayName
    sort_order: ASC

Return Values

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

Key Returned Description
alarm_statuses
complex
on success
List of AlarmStatus resources

Sample:
[{'display_name': 'display_name_example', 'id': 'ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx', 'severity': 'CRITICAL', 'status': 'FIRING', 'suppression': {'description': 'description_example', 'time_suppress_from': '2013-10-20T19:20:30+01:00', 'time_suppress_until': '2013-10-20T19:20:30+01:00'}, 'timestamp_triggered': '2013-10-20T19:20:30+01:00'}]
 
display_name
string
on success
The configured name of the alarm.
Example: `High CPU Utilization`

Sample:
display_name_example
 
id
string
on success
The OCID of the alarm.

Sample:
ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
 
severity
string
on success
The configured severity of the alarm.
Example: `CRITICAL`

Sample:
CRITICAL
 
status
string
on success
The status of this alarm. Status is collective, across all metric streams in the alarm. To list alarm status for each metric stream, use RetrieveDimensionStates. The alarm attribute `isNotificationsPerMetricDimensionEnabled` must be set to `true`.
Example: `FIRING`

Sample:
FIRING
 
suppression
complex
on success
The configuration details for suppressing an alarm.

   
description
string
on success
Human-readable reason for suppressing alarm notifications. It does not have to be unique, and it's changeable. Avoid entering confidential information.
Oracle recommends including tracking information for the event or associated work, such as a ticket number.
Example: `Planned outage due to change IT-1234.`

Sample:
description_example
   
time_suppress_from
string
on success
The start date and time for the suppression to take place, inclusive. Format defined by RFC3339.
Example: `2019-02-01T01:02:29.600Z`

Sample:
2013-10-20T19:20:30+01:00
   
time_suppress_until
string
on success
The end date and time for the suppression to take place, inclusive. Format defined by RFC3339.
Example: `2019-02-01T02: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. Note: A three-minute lag for this value accounts for any late-arriving metrics.
Example: `2019-02-01T01:02:29.600Z`

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


Authors

  • Oracle (@oracle)