Модуль community.grafana.grafana_organization — Управление организацией Grafana

Примечание

Этот модуль является частью коллекции community.grafana (версия 1.9.1).

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

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

Чтобы использовать её в playbook, укажите: community.grafana.grafana_organization.

Добавлена в community.grafana 1.3.0

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

Обзор

Создание/удаление организации Grafana через API org.
Проверено с Grafana v6.5.0

Параметры

Параметр	Комментарии
client_cert путь	Файл цепочки сертификатов в формате PEM для аутентификации SSL клиента. Этот файл также может содержать ключ, и если ключ включен, client_key не требуется
client_key путь	Файл в формате PEM, содержащий ваш закрытый ключ для аутентификации SSL клиента. Если client_cert содержит как сертификат, так и ключ, этот параметр не требуется.
name строка / обязательно	Название организации Grafana.
state строка	Указать, должна ли организация присутствовать в Grafana или нет Варианты: `"present"` ← (по умолчанию) `"absent"`
url псевдонимы: grafana_url строка / обязательно	URL Grafana.
url_password псевдонимы: grafana_password строка	Пароль Grafana для аутентификации API. По умолчанию: `"admin"`
url_username псевдонимы: grafana_user строка	Пользователь Grafana для аутентификации API. По умолчанию: `"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 присутствует
address словарь	Адрес организации Возвращается: всегда Пример: `{"address1": "", "address2": "", "city": "", "country": "", "state": "", "zipCode": ""}`
id целое число	Идентификатор организации Возвращается: всегда Пример: `[42]`
name строка	Название организации Возвращается: всегда Пример: `"['org42']"`

Авторы

paytroff (@paytroff)

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

© 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/grafana/grafana_organization_module.html