Модуль community.general.clc_alert_policy – Создание или удаление правил оповещения в CenturyLink Cloud

Примечание

Этот модуль входит в коллекцию community.general (версия 9.5.0).

Эта коллекция, возможно, уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.

Чтобы установить её, используйте: ansible-galaxy collection install community.general. Для использования этого модуля необходимы дополнительные требования, подробнее см. Требования.

Чтобы использовать его в книге задач, укажите: community.general.clc_alert_policy.

Обзор
Требования
Параметры
Атрибуты
Примечания
Примеры
Значения возврата

Обзор

Модуль Ansible для создания или удаления правил оповещения в облаке CenturyLink.

Требования

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

python = 2.7
requests >= 2.5.0
clc-sdk

Параметры

Параметр	Комментарии
alert_recipients список / элементы=строка	Список адресов электронной почты получателей оповещений. Требуется для состояния ‘present’
alias строка / обязательно	Псевдоним вашей учетной записи CLC
duration строка	Продолжительность превышения порога в минутах. Требуется для состояния ‘present’
id строка	Идентификатор правила оповещения. Взаимоисключающее с параметром name
metric строка	Метрика, по которой будет измеряться условие, вызывающее оповещение. Требуется для состояния ‘present’ Выбор: `"cpu"` `"memory"` `"disk"`
name строка	Название правила оповещения. Взаимоисключающее с параметром id
state строка	Действие: создание или удаление правила. Выбор: `"present"` ← (по умолчанию) `"absent"`
threshold целое число	Порог, при достижении которого метрика триггерит оповещение. Требуется для состояния ‘present’. Число представляет собой процент и должно быть значением от 5.0 до 95.0, кратным 5.0

Атрибуты

Атрибут	Поддержка	Описание
check_mode	Поддержка: полная	Может работать в режиме `check_mode` и возвращать прогноз статуса изменения без модификации целевого объекта.
diff_mode	Поддержка: отсутствует	Возвращает информацию о том, что изменилось (или, возможно, нуждается в изменении в `check_mode`), когда режим diff включен.

Примечания

Примечание

Для использования этого модуля необходимо установить переменные окружения, которые предоставляют доступ к облаку CenturyLink: CLC_V2_API_USERNAME (логин), CLC_V2_API_PASSWORD (пароль).
В качестве альтернативы модуль принимает 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.
Пользователи могут установить 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
      community.general.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
      ansible.builtin.debug: var=policy

- name: Delete Alert Policy Example
  hosts: localhost
  gather_facts: false
  connection: local
  tasks:
    - name: Delete an Alert Policy
      community.general.clc_alert_policy:
        alias: wfad
        name: 'alert for disk > 80%'
        state: absent
      register: policy

    - name: Debug
      ansible.builtin.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}]}`

Ключ

Описание

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}]}

Авторы

CLC Runner (@clc-runner)

Ссылки на коллекцию

© 2012–2018 Michael DeHaan
© 2018–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/community/general/clc_alert_policy_module.html