clc_alert_policy - Создание или удаление политик оповещений в CenturyLink Cloud.
Новое в версии 2.0.
Обзор
- Модуль Ansible для создания или удаления политик оповещений в CenturyLink Cloud.
Требования
Ниже приведены требования к хосту, на котором выполняется этот модуль.
- python = 2.7
- requests >= 2.5.0
- clc-sdk
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| alert_recipients | Значение по умолчанию: None | Список адресов электронной почты получателей оповещений. Требуется для состояния 'present' |
| alias обязательно | Псевдоним вашей учетной записи CLC | |
| duration | Значение по умолчанию: None | Продолжительность в минутах, в течение которой условие должно превышать порог. Требуется для состояния 'present' |
| id | Значение по умолчанию: None | Идентификатор политики оповещения. Взаимоисключительно с параметром name |
| metric |
None | Метрика, по которой будет измеряться условие, вызывающее оповещение. Требуется для состояния 'present' |
| name | Значение по умолчанию: None | Имя политики оповещения. Взаимоисключительно с параметром id |
| state |
| Определяет, нужно ли создать или удалить политику. |
| threshold | Значение по умолчанию: None | Порог, который вызовет оповещение, когда метрика достигнет или превзойдет его значение. Требуется для состояния '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-вызов по адресу @ 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 dict | success | Информация о политике оповещения Пример: {'name': 'test_alert', 'actions': [{'action': 'email', 'settings': {'recipients': ['user1@domain.com', 'user1@domain.com']}}], 'id': 'ba54ac54a60d4a4f1ed6d48c1ce240a7', 'links': [{'href': '/v2/alertPolicies/alias/ba54ac54a60d4a4fb1d6d48c1ce240a7', 'verbs': ['GET', 'DELETE', 'PUT'], 'rel': 'self'}], 'triggers': [{'duration': '00:05:00', 'threshold': 80.0, 'metric': 'disk'}]} |
Статус
Этот модуль помечен как предварительный, что означает, что он не гарантирует обратную совместимость интерфейса.
Автор
- 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.5/modules/clc_alert_policy_module.html
