oracle.oci.oci_monitoring_alarm_suppression – Manage an AlarmSuppression resource 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.

New in version 2.9.0: of oracle.oci

Synopsis

  • This module allows the user to create and delete an AlarmSuppression resource in Oracle Cloud Infrastructure

  • For state=present, creates a dimension-specific suppression for an 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_id
string
The OCID of the alarm that is the target of the alarm suppression.
Required for create using state=present.
Required for delete when environment variable OCI_USE_NAME_AS_IDENTIFIER is set.
alarm_suppression_id
string
The OCID of the alarm suppression.
Required for delete using state=absent when environment variable OCI_USE_NAME_AS_IDENTIFIER is not set.

aliases: id
alarm_suppression_target
dictionary
Required for create using state=present.
alarm_id
string / required
The OCID of the alarm that is the target of the alarm suppression.
target_type
string / required
    Choices:
  • ALARM
The type of the alarm suppression target.
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.
defined_tags
dictionary
Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: `{"Operations": {"CostCenter": "42"}}`
description
string
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.`
dimensions
dictionary
A filter to suppress only alarm state entries that include the set of specified dimension key-value pairs. If you specify {"availabilityDomain": "phx-ad-1"} and the alarm state entry corresponds to the set {"availabilityDomain": "phx-ad-1" and "resourceId": "ocid1.instance.region1.phx.exampleuniqueID"}, then this alarm will be included for suppression.
The value cannot be an empty object. Only a single value is allowed per key. No grouping of multiple values is allowed under the same key. Maximum characters (after serialization): 4000. This maximum satisfies typical use cases. The response for an exceeded maximum is `HTTP 400` with an "dimensions values are too long" message.
Required for create using state=present.
display_name
string
A user-friendly name for the alarm suppression. It does not have to be unique, and it's changeable. Avoid entering confidential information.
Required for create using state=present.
Required for delete when environment variable OCI_USE_NAME_AS_IDENTIFIER is set.

aliases: name
force_create
boolean
    Choices:
  • no ←
  • yes
Whether to attempt non-idempotent creation of a resource. By default, create resource is an idempotent operation, and doesn't create the resource if it already exists. Setting this option to true, forcefully creates a copy of the resource, even if it already exists.This option is mutually exclusive with key_by.
freeform_tags
dictionary
Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"Department": "Finance"}`
key_by
list / elements=string
The list of attributes of this resource which should be used to uniquely identify an instance of the resource. By default, all the attributes of a resource are used to uniquely identify a resource.
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.
state
string
    Choices:
  • present ←
  • absent
The state of the AlarmSuppression.
Use state=present to create an AlarmSuppression.
Use state=absent to delete an AlarmSuppression.
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_suppress_from
string
The start date and time for the suppression to take place, inclusive. Format defined by RFC3339.
Example: `2023-02-01T01:02:29.600Z`
Required for create using state=present.
time_suppress_until
string
The end date and time for the suppression to take place, inclusive. Format defined by RFC3339.
Example: `2023-02-01T02:02:29.600Z`
Required for create using state=present.
wait
boolean
    Choices:
  • no
  • yes ←
Whether to wait for create or delete operation to complete.
wait_timeout
integer
Time, in seconds, to wait when wait=yes. Defaults to 1200 for most of the services but some services might have a longer wait timeout.

Examples

- name: Create alarm_suppression
  oci_monitoring_alarm_suppression:
    # required
    alarm_suppression_target:
      # required
      target_type: ALARM
      alarm_id: "ocid1.alarm.oc1..xxxxxxEXAMPLExxxxxx"
    display_name: display_name_example
    dimensions: null
    time_suppress_from: time_suppress_from_example
    time_suppress_until: time_suppress_until_example

    # optional
    description: description_example
    freeform_tags: {'Department': 'Finance'}
    defined_tags: {'Operations': {'CostCenter': 'US'}}

- name: Delete alarm_suppression
  oci_monitoring_alarm_suppression:
    # required
    alarm_suppression_id: "ocid1.alarmsuppression.oc1..xxxxxxEXAMPLExxxxxx"
    state: absent

- name: Delete alarm_suppression using name (when environment variable OCI_USE_NAME_AS_IDENTIFIER is set)
  oci_monitoring_alarm_suppression:
    # required
    display_name: display_name_example
    alarm_id: "ocid1.alarm.oc1..xxxxxxEXAMPLExxxxxx"
    state: absent

Return Values

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

Key Returned Description
alarm_suppression
complex
on success
Details of the AlarmSuppression resource acted upon by the current operation

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)