Try SpotterModify or Create Alarms
| "added in version" 0.3.0 of opentelekomcloud.cloud"
Authors: Sebastian Gode (@SebastianGode)
Install with ansible-galaxy collection install opentelekomcloud.cloud:==0.14.2
collections:
- name: opentelekomcloud.cloud
version: 0.14.2Modify or Create Alarms
# 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"
auth:
description:
- Dictionary containing auth information as needed by the cloud's auth plugin strategy.
For the default I(password) plugin, this would contain I(auth_url), I(username),
I(password), I(project_name) and any information about domains (for example, I(os_user_domain_name)
or I(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.
type: dict
wait:
default: true
description:
- Should ansible wait until the requested resource is complete.
type: bool
cloud:
description:
- Named cloud or cloud config to operate against. If I(cloud) is a string, it references
a named cloud config as defined in an OpenStack clouds.yaml file. Provides default
values for I(auth) and I(auth_type). This parameter is not needed if I(auth) is
provided or if OpenStack OS_* environment variables are present. If I(cloud) is
a dict, it contains a complete cloud configuration like would be in a section of
clouds.yaml.
type: raw
state:
choices:
- present
- absent
default: present
description:
- Resource state
type: str
metric:
description:
- Specifies the Alarm metrics. Required if state == present
required: false
type: dict
ca_cert:
aliases:
- cacert
description:
- A path to a CA Cert bundle that can be used as part of verifying SSL API requests.
type: str
timeout:
default: 180
description:
- How long should ansible wait for the requested resource.
type: int
auth_type:
description:
- 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 I(auth) parameter should be updated accordingly.
type: str
condition:
description:
- Specifies the alarm triggering condition. Required if state == present
required: false
type: dict
interface:
aliases:
- endpoint_type
choices:
- admin
- internal
- public
default: public
description:
- Endpoint URL type to fetch from the service catalog.
type: str
alarm_name:
description:
- Name of the Alarm. Can be an ID too if state == absent
required: true
type: str
client_key:
aliases:
- key
description:
- A path to a client key to use as part of the SSL transaction.
type: str
ok_actions:
default: []
description:
- Specifies the action triggered by clearing an alarm
elements: str
required: false
type: list
alarm_level:
default: 2
description:
- Specifies the alarm severity. The value can be 1, 2, 3 or 4, which indicates critical,
major, minor, and informational, respectively
required: false
type: int
api_timeout:
description:
- 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.
type: int
client_cert:
aliases:
- cert
description:
- A path to a client certificate to use as part of the SSL transaction.
type: str
region_name:
description:
- Name of the region.
type: str
sdk_log_path:
description:
- Path to the logfile of the OpenStackSDK. If empty no log is written
type: str
alarm_actions:
default: []
description:
- Specifies the action triggered by an alarm
elements: str
required: false
type: list
alarm_enabled:
default: true
description:
- Specifies whether to enable the alarm
required: false
type: bool
sdk_log_level:
choices:
- ERROR
- WARN
- INFO
- DEBUG
default: WARN
description: Log level of the OpenStackSDK
type: str
validate_certs:
aliases:
- verify
description:
- Whether or not SSL API requests should be verified.
- Before Ansible 2.3 this defaulted to C(yes).
type: bool
alarm_description:
default: ''
description:
- Description of the Alarm
required: false
type: str
switch_alarm_state:
default: false
description:
- If true switches the alarm state from on to off or off to on. Requires state ==
present
required: false
type: bool
alarm_action_enabled:
default: true
description:
- Specifies whether to enable the action to be triggered by an alarm
required: false
type: bool
alarms:
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: '>='
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
type: list