community.general.clc_alert_policy 模块 – 在 CenturyLink Cloud 创建或删除警报策略

注意

此模块是 community.general 集合（版本 10.1.0）的一部分。

如果您正在使用 ansible 包，您可能已经安装了此集合。它不包含在 ansible-core 中。要检查它是否已安装，请运行 ansible-galaxy collection list。

要安装它，请使用：ansible-galaxy collection install community.general。您需要进一步的要求才能使用此模块，请参阅要求了解详情。

要在 playbook 中使用它，请指定：community.general.clc_alert_policy。

概要 

一个 Ansible 模块，用于在 CenturyLink Cloud 创建或删除警报策略。

要求 

以下要求需要在执行此模块的主机上满足。

python = 2.7
requests >= 2.5.0
clc-sdk

参数 

参数	注释
alert_recipients list / elements=string	用于通知警报的收件人电子邮件 ID 列表。这是状态“present”所必需的
alias string / required	您的 CLC 帐户的别名
duration string	条件必须超过阈值的时长（以分钟为单位）。这是状态“present”所必需的
id string	警报策略 ID。它与 name 互斥
metric string	用于衡量将触发警报的条件的指标。这是状态“present”所必需的选项 `"cpu"` `"memory"` `"disk"`
name string	警报策略的名称。它与 id 互斥
state string	是否创建或删除策略。选项 `"present"` ← (默认) `"absent"`
threshold integer	当指标等于或超过此值时将触发警报的阈值。这是状态“present”所必需的。此数字表示一个百分比，必须是 5.0 到 95.0 之间的值，并且是 5.0 的倍数

属性 

属性	支持	描述
check_mode	支持：完全	可以在 `check_mode` 中运行并返回更改状态预测，而无需修改目标。
diff_mode	支持：无	在 diff 模式下，将返回已更改内容（或可能需要在 `check_mode` 中更改的内容）的详细信息。

说明 

注意

要使用此模块，需要设置以下环境变量，这些变量允许访问 Centurylink Cloud - CLC_V2_API_USERNAME，centurylink cloud 的帐户登录 ID - CLC_V2_API_PASSWORD，centurylink cloud 的帐户密码
或者，该模块接受 API 令牌和帐户别名。API 令牌可以使用 CLC 帐户登录名和密码通过 HTTP API 调用生成，地址为 https://api.ctl.io/v2/authentication/login - CLC_V2_API_TOKEN，从 https://api.ctl.io/v2/authentication/login 生成的 API 令牌 - 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:
            - [email protected]
            - [email protected]
        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": ["[email protected]", "[email protected]"]}}], "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)