rax_mon_alarm – Создание или удаление оповещения Rackspace Cloud Monitoring.

Новая версия с 2.0.

Описание
Требования
Параметры
Примечания
Примеры
Статус

Описание

Создаёт или удаляет оповещение Rackspace Cloud Monitoring, которое связывает существующее rax_mon_entity, rax_mon_check и rax_mon_notification_plan с критериями, определяющими условия срабатывания и уровни оповещений. Поток модуля мониторинга Rackspace | rax_mon_entity -> rax_mon_check -> rax_mon_notification -> rax_mon_notification_plan -> rax_mon_alarm

Требования

Ниже приведены требования к хосту, на котором выполняется этот модуль.

python >= 2.6
pyrax

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
api_key -		Ключ API Rackspace, переопределяет credentials. псевдонимы: password
auth_endpoint - добавлен в 1.5	Значение по умолчанию: "https://identity.api.rackspacecloud.com/v2.0/"	URI службы аутентификации.
check_id - / обязательно		Идентификатор проверки, на которую должно быть отправлено оповещение. Может быть получен при регистрации задания rax_mon_check.
credentials -		Файл, в котором содержатся учетные данные Rackspace. Игнорируется, если заданы api_key и username. псевдонимы: creds_file
criteria -		DSL-описание оповещения, которое описывает условия срабатывания и их выходные состояния. Длина должна быть от 1 до 16384 символов. См. http://docs.rackspace.com/cm/api/v1.0/cm-devguide/content/alerts-language.html для справки по языку оповещений.
disabled boolean	Варианты: нет да	Если да, создаёт оповещение, но оставляет его в неактивном состоянии. По умолчанию нет.
entity_id - / обязательно		Идентификатор сущности, к которой прикреплено данное оповещение. Может быть получен при регистрации задания rax_mon_entity.
env - добавлен в 1.5		Окружение, как настроено в ~/.pyrax.cfg, см. https://github.com/rackspace/pyrax/blob/master/docs/getting_started.md#pyrax-configuration.
identity_type - добавлен в 1.5	Значение по умолчанию: "rackspace"	Механизм аутентификации, например, rackspace или keystone.
label - / обязательно		Наименование оповещения для обеспечения идемпотентности. Должно быть строкой длиной от 1 до 255 символов.
metadata -		Произвольные пары ключ-значение для оповещения. Должно быть словарем со строковыми ключами и значениями длиной от 1 до 255 символов.
notification_plan_id - / обязательно		Идентификатор плана оповещений для срабатывания при возникновении этого оповещения. Может быть получен при регистрации задания rax_mon_notification_plan.
region -	Значение по умолчанию: "DFW"	Регион для создания экземпляра.
state -	Варианты: present ← absent	Обеспечение того, что оповещение с данным `label` существует или не существует.
tenant_id - добавлен в 1.5		Идентификатор клиента для аутентификации.
tenant_name - добавлен в 1.5		Имя клиента для аутентификации.
username -		Имя пользователя Rackspace, переопределяет credentials.
verify_ssl - добавлен в 1.5		Требуется ли проверка SSL для конечных точек API.

Примечания

Примечание

Можно использовать следующие переменные среды: RAX_USERNAME, RAX_API_KEY, RAX_CREDS_FILE, RAX_CREDENTIALS, RAX_REGION.
RAX_CREDENTIALS и RAX_CREDS_FILE указывают на файл учетных данных, подходящий для pyrax. См. https://github.com/rackspace/pyrax/blob/master/docs/getting_started.md#authenticating
RAX_USERNAME и RAX_API_KEY исключают использование файла учетных данных
RAX_REGION определяет регион Rackspace Public Cloud (DFW, ORD, LON, …)

Примеры

- name: Alarm example
  gather_facts: False
  hosts: local
  connection: local
  tasks:
  - name: Ensure that a specific alarm exists.
    rax_mon_alarm:
      credentials: ~/.rax_pub
      state: present
      label: uhoh
      entity_id: "{{ the_entity['entity']['id'] }}"
      check_id: "{{ the_check['check']['id'] }}"
      notification_plan_id: "{{ defcon1['notification_plan']['id'] }}"
      criteria: >
        if (rate(metric['average']) > 10) {
          return new AlarmStatus(WARNING);
        }
        return new AlarmStatus(OK);
    register: the_alarm

Статус

Этот модуль не гарантирует обратную совместимость интерфейса. [превью]
Этот модуль поддерживается сообществом Ansible. [сообщество]

Авторы

Ash Wilson (@smashwilson)

Подсказка

Если вы заметили какие-либо проблемы в этой документации, вы можете отредактировать этот документ, чтобы улучшить его.

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.7/modules/rax_mon_alarm_module.html