opentelekomcloud.cloud.ces_alarms – Modify or Create Alarms

Note

This plugin is part of the opentelekomcloud.cloud collection (version 0.9.0).

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	Choices/Defaults	Comments
alarm_action_enabled boolean	Choices: no yes ←	Specifies whether to enable the action to be triggered by an alarm
alarm_actions list / elements=string	Default: []	Specifies the action triggered by an alarm
alarm_description string	Default: ""	Description of the Alarm
alarm_enabled boolean	Choices: no yes ←	Specifies whether to enable the alarm
alarm_level integer	Default: 2	Specifies the alarm severity. The value can be 1, 2, 3 or 4, which indicates critical, major, minor, and informational, respectively
alarm_name string / required		Name of the Alarm. Can be an ID too if state == absent
api_timeout integer		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.
auth dictionary		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.
auth_type string		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.
ca_cert string		A path to a CA Cert bundle that can be used as part of verifying SSL API requests. aliases: cacert
client_cert string		A path to a client certificate to use as part of the SSL transaction. aliases: cert
client_key string		A path to a client key to use as part of the SSL transaction. aliases: key
cloud raw		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.
condition dictionary		Specifies the alarm triggering condition. Required if state == present
interface string	Choices: admin internal public ←	Endpoint URL type to fetch from the service catalog. aliases: endpoint_type
metric dictionary		Specifies the Alarm metrics. Required if state == present
ok_actions list / elements=string	Default: []	Specifies the action triggered by clearing an alarm
region_name string		Name of the region.
state string	Choices: present ← absent	Resource state
switch_alarm_state boolean	Choices: no ← yes	If true switches the alarm state from on to off or off to on. Requires state == present
timeout integer	Default: 180	How long should ansible wait for the requested resource.
validate_certs boolean	Choices: no ← yes	Whether or not SSL API requests should be verified. Before Ansible 2.3 this defaulted to yes. aliases: verify
wait boolean	Choices: no yes ←	Should ansible wait until the requested resource is complete.

Notes

Note

• The standard OpenStack environment variables, such as OS_USERNAME may 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	Returned	Description
alarms list / elements=string	changed	Dictionary of Event Data Sample: [{'alarm_action_enabled': True, 'alarm_actions': {'id': None, 'location': None, 'name': None, 'notificationList': None, 'type': None}, 'alarm_description': '', 'alarm_enabled': True, 'alarm_id': 'al1234506573003nnErvLjNy', 'alarm_level': 2, 'alarm_state': None, 'condition': {'comparison_operator': '>=', 'count': 1, 'filter': 'average', 'id': None, 'location': None, 'name': None, 'period': 300, 'unit': 'B/s', 'value': 6}, 'id': 'al1234506573003nnErvLjNy', 'location': {'cloud': 'otc', 'project': {'domain_id': None, 'domain_name': None, 'id': '12345a84a13b49529d2e2c3646691288', 'name': 'eu-de'}, 'region_name': 'eu-de', 'zone': None}, 'metric': {'dimensions': [{'id': None, 'location': None, 'name': 'instance_id', 'value': '123456789-6c9d-4594-9d6b-80da84491bec'}, {'id': None, 'location': None, 'name': 'instance_id', 'value': '123456789-0691-4896-8e19-1046b727d4e2'}], 'id': None, 'location': None, 'metric_name': 'network_outgoing_bytes_rate_inband', 'name': None, 'namespace': 'SYS.ECS'}, 'name': 'alarm-sgode', 'ok_actions': {'id': None, 'location': None, 'name': None, 'notificationList': None, 'type': None}, 'update_time': None}]

Authors

• Sebastian Gode (@SebastianGode)