oracle.oci.oci_monitoring_alarm_dimension_states_actions – Perform actions on an AlarmDimensionStates resource 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_dimension_states_actions.

New in version 2.9.0: of oracle.oci

Synopsis

  • Perform actions on an AlarmDimensionStates resource in Oracle Cloud Infrastructure

  • For action=retrieve_dimension_states, lists the current alarm status of each metric stream, where status is derived from the metric stream’s last associated transition. Optionally filter by status value and one or more dimension key-value pairs. For more information, see Listing Metric Stream Status in 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
action
string / required
    Choices:
  • retrieve_dimension_states
The action to perform on the AlarmDimensionStates.
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
  • 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.
dimension_filters
dictionary
A filter to return only alarm state entries that match the exact set of specified dimension key-value pairs. If you specify `"availabilityDomain": "phx-ad-1"` but the alarm state entry corresponds to the set `"availabilityDomain": "phx- ad-1"` and `"resourceId": "ocid1.instance.region1.phx.exampleuniqueID"`, then no results are returned.
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.
status
string
A filter to return only alarm state entries that match the status value. Example: `FIRING`
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: Perform action retrieve_dimension_states on alarm_dimension_states
  oci_monitoring_alarm_dimension_states_actions:
    # required
    alarm_id: "ocid1.alarm.oc1..xxxxxxEXAMPLExxxxxx"
    action: retrieve_dimension_states

    # optional
    dimension_filters: null
    status: status_example

Return Values

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

Key Returned Description
alarm_dimension_states_collection
complex
on success
Details of the AlarmDimensionStates resource acted upon by the current operation

Sample:
{'alarm_summary': 'alarm_summary_example', 'dimensions': {}, 'rule_name': 'rule_name_example', 'status': 'FIRING', 'timestamp': '2013-10-20T19:20:30+01:00'}
 
alarm_summary
string
on success
Customizable alarm summary (`alarmSummary` alarm message parameter). Optionally include dynamic variables. The alarm summary appears within the body of the alarm message and in responses to ListAlarmStatus GetAlarmHistory and RetrieveDimensionStates.

Sample:
alarm_summary_example
 
dimensions
dictionary
on success
Indicator of the metric stream associated with the alarm state entry. Includes one or more dimension key-value pairs.
 
rule_name
string
on success
Identifier of the alarm's base values for alarm evaluation, for use when the alarm contains overrides. Default value is `BASE`. For information about alarm overrides, see AlarmOverride.

Sample:
rule_name_example
 
status
string
on success
Transition state (status value) associated with the alarm state entry.
Example: `FIRING`

Sample:
FIRING
 
timestamp
string
on success
Transition time associated with the alarm state entry. Format defined by RFC3339.
Example: `2022-02-01T01:02:29.600Z`

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


Authors

  • Oracle (@oracle)