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 | нет | present |
| Создать или удалить правило. |
| threshold | нет | None | Порог, который сработает при оповещении, когда метрика равна или превышает его значение. Требуется для состояния 'present'. Это число представляет процент и должно быть значением от 5.0 до 95.0, кратным 5.0. |
Примеры
# 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 | {'name': 'test_alert', 'actions': [{'action': 'email', 'settings': {'recipients': ['user1@domain.com', 'user1@domain.com']}}], 'id': 'ba54ac54a60d4a4f1ed6d48c1ce240a7', 'links': [{'href': '/v2/alertPolicies/alias/ba54ac54a60d4a4f1ed6d48c1ce240a7', 'verbs': ['GET', 'DELETE', 'PUT'], 'rel': 'self'}], 'triggers': [{'duration': '00:05:00', 'threshold': 80.0, 'metric': 'disk'}]} |
Примечания
Примечание
- Для использования этого модуля необходимо установить следующие переменные окружения, которые обеспечивают доступ к 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.
Статус
Этот модуль помечен как предварительный, что означает, что его интерфейс не гарантируется как обратная совместимость.
Для получения помощи в разработке модулей, если вы так пожелаете, пожалуйста, прочитайте Информацию сообщества и участие в разработке, Тестирование Ansible и Разработка модулей.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.4/clc_alert_policy_module.html