oracle.oci.oci_monitoring_alarm_suppression_facts – Fetches details about one or multiple AlarmSuppression resources in Oracle Cloud Infrastructure

Note

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

New in version 2.9.0: of oracle.oci

Synopsis

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

  • Lists alarm suppressions for the specified alarm. Only dimension-level suppressions are listed. Alarm-level suppressions are not listed.

  • 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.

  • If alarm_suppression_id is specified, the details of a single AlarmSuppression will be returned.

Requirements

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

Parameters

Parameter Choices/Defaults Comments
alarm_id
string
The OCID of the alarm that is the target of the alarm suppression.
Required to list multiple alarm_suppressions.
alarm_suppression_id
string
The OCID of the alarm suppression.
Required to get a specific alarm_suppression.

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
  • security_token
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.
display_name
string
A filter to return only resources that match the given display name exactly. Use this filter to list a alarm suppression by name. Alternatively, when you know the alarm suppression OCID, use the GetAlarmSuppression operation.

aliases: name
lifecycle_state
string
    Choices:
  • ACTIVE
  • DELETED
A filter to return only resources that match the given lifecycle state exactly. When not specified, only resources in the ACTIVE lifecycle state are listed.
realm_specific_endpoint_template_enabled
boolean
    Choices:
  • no
  • yes
Enable/Disable realm specific endpoint template for service client. By Default, realm specific endpoint template is disabled. If not set, then the value of the OCI_REALM_SPECIFIC_SERVICE_ENDPOINT_TEMPLATE_ENABLED variable, if any, is used.
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
  • timeCreated
  • timeSuppressFrom
The field to use when sorting returned alarm suppressions. Only one sorting level is provided.
Example: `timeCreated`
sort_order
string
    Choices:
  • ASC
  • DESC
The sort order to use when sorting returned alarm suppressions. 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: Get a specific alarm_suppression
  oci_monitoring_alarm_suppression_facts:
    # required
    alarm_suppression_id: "ocid1.alarmsuppression.oc1..xxxxxxEXAMPLExxxxxx"

- name: List alarm_suppressions
  oci_monitoring_alarm_suppression_facts:
    # required
    alarm_id: "ocid1.alarm.oc1..xxxxxxEXAMPLExxxxxx"

    # optional
    display_name: display_name_example
    lifecycle_state: ACTIVE
    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_suppressions
complex
on success
List of AlarmSuppression resources

Sample:
[{'alarm_suppression_target': {'alarm_id': 'ocid1.alarm.oc1..xxxxxxEXAMPLExxxxxx', 'target_type': 'ALARM'}, 'compartment_id': 'ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx', 'defined_tags': {'Operations': {'CostCenter': 'US'}}, 'description': 'description_example', 'dimensions': {}, 'display_name': 'display_name_example', 'freeform_tags': {'Department': 'Finance'}, 'id': 'ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx', 'lifecycle_state': 'ACTIVE', 'time_created': '2013-10-20T19:20:30+01:00', 'time_suppress_from': '2013-10-20T19:20:30+01:00', 'time_suppress_until': '2013-10-20T19:20:30+01:00', 'time_updated': '2013-10-20T19:20:30+01:00'}]
 
alarm_suppression_target
complex
on success

   
alarm_id
string
on success
The OCID of the alarm that is the target of the alarm suppression.

Sample:
ocid1.alarm.oc1..xxxxxxEXAMPLExxxxxx
   
target_type
string
on success
The type of the alarm suppression target.

Sample:
ALARM
 
compartment_id
string
on success
The OCID of the compartment containing the alarm suppression.

Sample:
ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx
 
defined_tags
dictionary
on success
Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: `{"Operations": {"CostCenter": "42"}}`

Sample:
{'Operations': {'CostCenter': 'US'}}
 
description
string
on success
Human-readable reason for this alarm suppression. 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
 
dimensions
dictionary
on success
Configured dimension filter for suppressing alarm state entries that include the set of specified dimension key-value pairs.
Example: `{"resourceId": "ocid1.instance.region1.phx.exampleuniqueID"}`
 
display_name
string
on success
A user-friendly name for the alarm suppression. It does not have to be unique, and it's changeable. Avoid entering confidential information.

Sample:
display_name_example
 
freeform_tags
dictionary
on success
Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"Department": "Finance"}`

Sample:
{'Department': 'Finance'}
 
id
string
on success
The OCID of the alarm suppression.

Sample:
ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
 
lifecycle_state
string
on success
The current lifecycle state of the alarm suppression.
Example: `DELETED`

Sample:
ACTIVE
 
time_created
string
on success
The date and time the alarm suppression was created. Format defined by RFC3339.
Example: `2018-02-01T01:02:29.600Z`

Sample:
2013-10-20T19:20:30+01:00
 
time_suppress_from
string
on success
The start date and time for the suppression to take place, inclusive. Format defined by RFC3339.
Example: `2018-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: `2018-02-01T02:02:29.600Z`

Sample:
2013-10-20T19:20:30+01:00
 
time_updated
string
on success
The date and time the alarm suppression was last updated (deleted). Format defined by RFC3339.
Example: `2018-02-03T01:02:29.600Z`

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


Authors

  • Oracle (@oracle)