opentelekomcloud.cloud.ces_alarms module – Modify or Create Alarms¶
Note
This module is part of the opentelekomcloud.cloud collection (version 0.11.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 opentelekomcloud.cloud.
To use it in a playbook, specify: opentelekomcloud.cloud.ces_alarms.
New in version 0.3.0: of opentelekomcloud.cloud
Synopsis¶
Modify or Create Alarms
Requirements¶
The below requirements are needed on the host that executes this module.
openstacksdk
openstacksdk >= 0.36.0
otcextensions
python >= 3.6
Parameters¶
Parameter |
Comments |
|---|---|
Specifies whether to enable the action to be triggered by an alarm Choices:
|
|
Specifies the action triggered by an alarm Default: [] |
|
Description of the Alarm Default: “” |
|
Specifies whether to enable the alarm Choices:
|
|
Specifies the alarm severity. The value can be 1, 2, 3 or 4, which indicates critical, major, minor, and informational, respectively Default: 2 |
|
Name of the Alarm. Can be an ID too if state == absent |
|
How long should the socket layer wait before timing out for API calls. If this is omitted, nothing will be passed to the requests library. |
|
Dictionary containing auth information as needed by the cloud’s auth plugin strategy. For the default password plugin, this would contain auth_url, username, password, project_name and any information about domains (for example, os_user_domain_name or os_project_domain_name) if the cloud supports them. For other plugins, this param will need to contain whatever parameters that auth plugin requires. This parameter is not needed if a named cloud is provided or OpenStack OS_* environment variables are present. |
|
Name of the auth plugin to use. If the cloud uses something other than password authentication, the name of the plugin should be indicated here and the contents of the auth parameter should be updated accordingly. |
|
A path to a CA Cert bundle that can be used as part of verifying SSL API requests. |
|
A path to a client certificate to use as part of the SSL transaction. |
|
A path to a client key to use as part of the SSL transaction. |
|
Named cloud or cloud config to operate against. If cloud is a string, it references a named cloud config as defined in an OpenStack clouds.yaml file. Provides default values for auth and auth_type. This parameter is not needed if auth is provided or if OpenStack OS_* environment variables are present. If cloud is a dict, it contains a complete cloud configuration like would be in a section of clouds.yaml. |
|
Specifies the alarm triggering condition. Required if state == present |
|
Endpoint URL type to fetch from the service catalog. Choices:
|
|
Specifies the Alarm metrics. Required if state == present |
|
Specifies the action triggered by clearing an alarm Default: [] |
|
Name of the region. |
|
Resource state Choices:
|
|
If true switches the alarm state from on to off or off to on. Requires state == present Choices:
|
|
How long should ansible wait for the requested resource. Default: 180 |
|
Whether or not SSL API requests should be verified. Before Ansible 2.3 this defaulted to Choices:
|
|
Should ansible wait until the requested resource is complete. Choices:
|
Notes¶
Note
The standard OpenStack environment variables, such as
OS_USERNAMEmay be used instead of providing explicit values.Auth information is driven by openstacksdk, which means that values can come from a yaml config file in /etc/ansible/openstack.yaml, /etc/openstack/clouds.yaml or ~/.config/openstack/clouds.yaml, then from standard environment variables, then finally by explicit parameters in plays. More information can be found at https://docs.openstack.org/openstacksdk/
Examples¶
# Creating an Alarm with two instances in it:
- name: Creating a alarm
opentelekomcloud.cloud.ces_alarms:
alarm_name: alarm-test
state: present
metric:
namespace: "SYS.ECS"
dimensions:
- name: "instance_id"
value: "123456789-6c9d-4594-9d6b-80da84491bec"
- name: "instance_id"
value: "123456789-0691-4896-8e19-1046b727d4e2"
metric_name: "network_outgoing_bytes_rate_inband"
condition:
period: 300
filter: average
comparison_operator: ">="
value: 6
unit: "B/s"
count: 1
alarm_enabled: True
ok_actions:
- type: notification
notificationList:
- "urn:smn:region:12345a86d98e427e907e0097b7e35d48:sd"
alarm_actions:
- type: notification
notificationList:
- "urn:smn:region:12345a86d98e427e907e0097b7e35d48:sd"
Return Values¶
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
|---|---|
Dictionary of Event Data Returned: changed Sample: [{“alarm_action_enabled”: true, “alarm_actions”: {“id”: null, “location”: null, “name”: null, “notificationList”: null, “type”: null}, “alarm_description”: “”, “alarm_enabled”: true, “alarm_id”: “al1234506573003nnErvLjNy”, “alarm_level”: 2, “alarm_state”: null, “condition”: {“comparison_operator”: “\u003e=”, “count”: 1, “filter”: “average”, “id”: null, “location”: null, “name”: null, “period”: 300, “unit”: “B/s”, “value”: 6}, “id”: “al1234506573003nnErvLjNy”, “location”: {“cloud”: “otc”, “project”: {“domain_id”: null, “domain_name”: null, “id”: “12345a84a13b49529d2e2c3646691288”, “name”: “eu-de”}, “region_name”: “eu-de”, “zone”: null}, “metric”: {“dimensions”: [{“id”: null, “location”: null, “name”: “instance_id”, “value”: “123456789-6c9d-4594-9d6b-80da84491bec”}, {“id”: null, “location”: null, “name”: “instance_id”, “value”: “123456789-0691-4896-8e19-1046b727d4e2”}], “id”: null, “location”: null, “metric_name”: “network_outgoing_bytes_rate_inband”, “name”: null, “namespace”: “SYS.ECS”}, “name”: “alarm-sgode”, “ok_actions”: {“id”: null, “location”: null, “name”: null, “notificationList”: null, “type”: null}, “update_time”: null}] |