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

Примечание

Этот плагин является частью коллекции community.general (версия 2.0.1).

Для его установки используйте: ansible-galaxy collection install community.general.

Для использования в книге задач укажите: community.general.clc_alert_policy.

Описание
Требования
Параметры
Примечания
Примеры
Возвращаемые значения

Описание

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

Требования

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

python = 2.7
requests >= 2.5.0
clc-sdk

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
alert_recipients список / элементы=строка		Список адресов электронной почты получателей уведомлений об оповещении. Требуется для состояния 'present'.
alias строка / обязательно		Псевдоним вашей учетной записи CLC.
duration строка		Продолжительность в минутах, в течение которой условие должно превышать порог. Требуется для состояния 'present'.
id строка		Идентификатор правила оповещения. Взаимоисключающее с параметром name.
metric строка	Варианты: cpu memory disk	Метрика, по которой измеряется условие, вызывающее оповещение. Требуется для состояния 'present'.
name строка		Название правила оповещения. Взаимоисключающее с параметром id.
state строка	Варианты: present ← absent	Определяет, нужно ли создать или удалить правило.
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
      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}]}

Авторы

CLC Runner (@clc-runner)

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