oracle.oci.oci_monitoring_alarm_suppression_history_item_facts – Fetches details about one or multiple AlarmSuppressionHistoryItem resources in Oracle Cloud Infrastructure¶

Note

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

New in version 2.9.0: of oracle.oci

Synopsis
Requirements
Parameters
Notes
Examples
Return Values

Synopsis ¶

Fetches details about one or multiple AlarmSuppressionHistoryItem resources in Oracle Cloud Infrastructure
Returns history of suppressions for the specified alarm, including both dimension-specific and and alarm-wide suppressions.
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.

python >= 3.6
Python SDK for Oracle Cloud Infrastructure https://oracle-cloud-infrastructure-python-sdk.readthedocs.io

Parameters ¶

Parameter	Choices/Defaults	Comments
alarm_id string / required		The OCID of an alarm.
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`.
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. Example: `{"resourceId": "ocid1.instance.region1.phx.exampleuniqueID"}`
display_name string		Use display_name along with the other options to return only resources that match the given display name exactly.
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.
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_greater_than_or_equal_to string		A filter to return only entries with "timeSuppressFrom" time occurring on or after the specified time. The value cannot be a future time. Format defined by RFC3339. Example: `2023-02-01T01:02:29.600Z`
time_suppress_from_less_than string		A filter to return only entries with "timeSuppressFrom" time occurring before the specified time. The value cannot be a future time. Format defined by RFC3339. Example: `2023-02-01T01:02:29.600Z`

Notes ¶

Note

For OCI python sdk configuration, please refer to https://oracle-cloud-infrastructure-python-sdk.readthedocs.io/en/latest/configuration.html

Examples ¶

- name: List alarm_suppression_history_items
  oci_monitoring_alarm_suppression_history_item_facts:
    # required
    alarm_id: "ocid1.alarm.oc1..xxxxxxEXAMPLExxxxxx"

    # optional
    dimensions: null
    time_suppress_from_greater_than_or_equal_to: time_suppress_from_greater_than_or_equal_to_example
    time_suppress_from_less_than: time_suppress_from_less_than_example

Return Values ¶

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

Key			Returned	Description
alarm_suppression_history_items complex			on success	List of AlarmSuppressionHistoryItem resources Sample: [{'alarm_suppression_target': {'alarm_id': 'ocid1.alarm.oc1..xxxxxxEXAMPLExxxxxx', 'target_type': 'ALARM'}, 'description': 'description_example', 'dimensions': {}, 'display_name': 'display_name_example', 'level': 'ALARM', 'suppression_id': 'ocid1.suppression.oc1..xxxxxxEXAMPLExxxxxx', 'time_effective_from': '2013-10-20T19:20:30+01:00', 'time_effective_until': '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
	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
	level string		on success	The level of this alarm suppression. `ALARM` indicates a suppression of the entire alarm, regardless of dimension. `DIMENSION` indicates a suppression configured for specified dimensions. Sample: ALARM
	suppression_id string		on success	The OCID of the alarm suppression. Sample: ocid1.suppression.oc1..xxxxxxEXAMPLExxxxxx
	time_effective_from string		on success	The start date and time for the suppression actually starts, inclusive. Format defined by RFC3339. Example: `2023-02-01T01:02:29.600Z` Sample: 2013-10-20T19:20:30+01:00
	time_effective_until string		on success	The end date and time for the suppression actually ends, inclusive. Format defined by RFC3339. Example: `2023-02-01T02:02:29.600Z` Sample: 2013-10-20T19:20:30+01:00

Authors¶

Oracle (@oracle)

oracle.oci.oci_monitoring_alarm_suppression_history_item_facts – Fetches details about one or multiple AlarmSuppressionHistoryItem resources in Oracle Cloud Infrastructure¶

Synopsis¶

Requirements¶

Parameters¶

Notes¶

Examples¶

Return Values¶