Spec-Zone.ru › Ansible

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

Примечание

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

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

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

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

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

  • Краткое описание
  • Параметры
  • Примеры
  • Возвращаемые значения

Краткое описание

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

Параметры

Параметр

Комментарии

client_cert

path

Файл цепочки сертификатов в формате PEM для аутентификации SSL-клиента.

Этот файл также может содержать ключ; если ключ включён в файл, параметр client_key не требуется.

client_key

path

Файл в формате PEM с закрытым ключом для аутентификации SSL-клиента.

Если client_cert содержит сертификат и ключ, этот параметр не требуется.

name

string / обязательный

Имя организации Grafana.

state

string

Указывает, должна ли организация присутствовать в Grafana.

Варианты:

  • "present" ← (по умолчанию)
  • "absent"

url

псевдонимы: grafana_url

string / обязательный

URL Grafana.

url_password

псевдонимы: grafana_password

string

Пароль Grafana для аутентификации через API.

По умолчанию: "admin"

url_username

псевдонимы: grafana_user

string

Пользователь Grafana для аутентификации через API.

По умолчанию: "admin"

use_proxy

boolean

Если false, прокси использоваться не будет, даже если он задан в переменной среды на целевых узлах.

Варианты:

  • false
  • true ← (по умолчанию)

validate_certs

boolean

Если 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

complex

Информация об организации

Возвращается: если state имеет значение present

address

dictionary

Адрес организации

Возвращается: всегда

Пример: {"address1": "", "address2": "", "city": "", "country": "", "state": "", "zipCode": ""}

id

integer

Идентификатор организации

Возвращается: всегда

Пример: [42]

name

string

Имя организации

Возвращается: всегда

Пример: "['org42']"

Авторы

  • paytroff (@paytroff)

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

  • Отслеживание проблем
  • Домашняя страница
  • Репозиторий (исходный код)

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

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API