clc_alert_policy – Создание или удаление правил оповещения в CenturyLink Cloud
Обзор
- Модуль Ansible для создания или удаления правил оповещения в CenturyLink Cloud.
Требования
Ниже перечислены требования, необходимые на хосте, на котором выполняется этот модуль.
- python = 2.7
- requests >= 2.5.0
- clc-sdk
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| alert_recipients - | Список адресов электронной почты получателей уведомлений об оповещении. Требуется для состояния 'present'. | |
| alias - / обязательно | Псевдоним вашей учетной записи CLC. | |
| duration - | Продолжительность в минутах, в течение которой условие должно превышать порог. Требуется для состояния 'present'. | |
| id - | Идентификатор правила оповещения. Взаимоисключающий с параметром name. | |
| metric - |
| Метрика, по которой измеряется условие, вызывающее оповещение. Требуется для состояния 'present'. |
| name - | Название правила оповещения. Взаимоисключающий с параметром id. | |
| state - |
| Определяет, создавать или удалять правило. |
| threshold - | Порог, который инициирует оповещение, когда метрика равна или превышает его. Требуется для состояния 'present'. Это число представляет собой процент и должно быть значением от 5,0 до 95,0, кратным 5,0. |
Примечания
Примечание
- Для использования этого модуля необходимо установить следующие переменные среды, которые обеспечивают доступ к CenturyLink Cloud — CLC_V2_API_USERNAME (идентификатор входа в учетную запись CenturyLink Cloud), CLC_V2_API_PASSWORD (пароль учетной записи CenturyLink Cloud).
- В качестве альтернативы модуль принимает токен API и псевдоним учетной записи. Токен API можно получить, выполнив вход в учетную запись CLC с помощью имени пользователя и пароля через вызов HTTP API по адресу: https://api.ctl.io/v2/authentication/login - CLC_V2_API_TOKEN (токен API, полученный с https://api.ctl.io/v2/authentication/login), CLC_ACCT_ALIAS (псевдоним учетной записи CenturyLink Cloud).
- Пользователи могут установить CLC_V2_API_URL, чтобы указать конечную точку для подключения к другой среде CLC.
Примеры
# Note - You must set the CLC_V2_API_USERNAME And CLC_V2_API_PASSWD Environment variables before running these examples
---
- name: Create Alert Policy Example
hosts: localhost
gather_facts: False
connection: local
tasks:
- name: Create an Alert Policy for disk above 80% for 5 minutes
clc_alert_policy:
alias: wfad
name: 'alert for disk > 80%'
alert_recipients:
- test1@centurylink.com
- test2@centurylink.com
metric: 'disk'
duration: '00:05:00'
threshold: 80
state: present
register: policy
- name: debug
debug: var=policy
---
- name: Delete Alert Policy Example
hosts: localhost
gather_facts: False
connection: local
tasks:
- name: Delete an Alert Policy
clc_alert_policy:
alias: wfad
name: 'alert for disk > 80%'
state: absent
register: policy
- name: debug
debug: var=policy
Возвращаемые значения
Общие возвращаемые значения документированы здесь, следующие поля уникальны для этого модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| policy словарь | успех | Информация о правиле оповещения. Пример: {'actions': [{'action': 'email', 'settings': {'recipients': ['user1@domain.com', 'user1@domain.com']}}], 'id': 'ba54ac54a60d4a4f1ed6d48c1ce240a7', 'links': [{'href': '/v2/alertPolicies/alias/ba54ac54a60d4a4fb1d6d48c1ce240a7', 'rel': 'self', 'verbs': ['GET', 'DELETE', 'PUT']}], 'name': 'test_alert', 'triggers': [{'duration': '00:05:00', 'metric': 'disk', 'threshold': 80.0}]} |
Статус
- Этот модуль не гарантирует обратную совместимость интерфейса. [предварительная версия]
- Этот модуль поддерживается сообществом Ansible. [сообщество]
Авторы
- CLC Runner (@clc-runner)
Подсказка
Если вы обнаружите какие-либо проблемы в этом документе, вы можете изменить этот документ, чтобы улучшить его.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.9/modules/clc_alert_policy_module.html
