community.grafana.grafana_organization 模块 – 管理 Grafana 组织

注意

此模块是 community.grafana 集合 (版本 2.1.0) 的一部分。

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

要安装它，请使用： ansible-galaxy collection install community.grafana。

要在 playbook 中使用它，请指定： community.grafana.grafana_organization。

community.grafana 1.3.0 中的新增功能

概要

  • 通过组织 API 创建/删除 Grafana 组织。

  • 已在 Grafana v6.5.0 上测试

参数

参数

注释

client_cert

路径

用于 SSL 客户端身份验证的 PEM 格式证书链文件。

此文件也可以包含密钥，如果包含密钥，则不需要 *client_key*

client_key

路径

包含用于 SSL 客户端身份验证的私钥的 PEM 格式文件。

如果 *client_cert* 包含证书和密钥，则不需要此选项。

name

字符串 / 必需

Grafana 组织的名称。

state

字符串

组织是否应该存在于 Grafana 中的状态

选项

  • "present" ← (默认)

  • "absent"

url

别名：grafana_url

字符串 / 必需

Grafana URL。

url_password

别名：grafana_password

字符串

用于 API 身份验证的 Grafana 密码。

默认值： "admin"

url_username

别名：grafana_user

字符串

用于 API 身份验证的 Grafana 用户。

默认值： "admin"

use_proxy

布尔值

如果 false，即使目标主机上的环境变量中定义了代理，它也不会使用代理。

选项

  • false

  • true ← (默认)

validate_certs

布尔值

如果 false，则不会验证 SSL 证书。

这只能在使用自签名证书的个人控制站点上设置为 false。

选项

  • false

  • true ← (默认)

示例

---
- name: Create a Grafana organization
  community.grafana.grafana_organization:
    url: "https://grafana.example.com"
    url_username: admin
    url_password: changeme
    name: orgtest
    state: present

- name: Delete a Grafana organization
  community.grafana.grafana_organization:
    url: "https://grafana.example.com"
    url_username: admin
    url_password: changeme
    name: orgtest
    state: absent

返回值

常见的返回值已在 此处 记录，以下是此模块特有的字段

键

描述

org

复杂类型

关于组织的信息

返回：当 state 为 present 时

address

字典

组织地址

返回：始终返回

示例： {"address1": "", "address2": "", "city": "", "country": "", "state": "", "zipCode": ""}

id

整数

组织 ID

返回：始终返回

示例： [42]

name

字符串

组织名称

返回：始终返回

示例： "['org42']"

作者

  • paytroff (@paytroff)