Модуль community.grafana.grafana_team — управление командами Grafana

Примечание

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

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

Для установки используйте: ansible-galaxy collection install community.grafana. Для использования этого модуля необходимы дополнительные требования; подробности см. в разделе Требования.

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

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

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

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

Создание, обновление и удаление команд Grafana через Teams API.
Также позволяет добавлять участников в команду (если участники существуют).

Требования

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

Teams API доступен только начиная с Grafana 5; модуль завершится с ошибкой, если версия сервера ниже 5.

Параметры

Параметр	Комментарии
client_cert path	Файл цепочки сертификатов в формате PEM, используемый для аутентификации SSL-клиента. Этот файл также может содержать ключ; если ключ включён, параметр client_key не требуется.
client_key path	Файл в формате PEM, содержащий закрытый ключ для аутентификации SSL-клиента. Если client_cert содержит и сертификат, и ключ, этот параметр не требуется.
email string / обязательный
enforce_members boolean	Удалять участников, отсутствующих в параметрах `members`, из списка участников команды. Варианты: `false` ← (по умолчанию) `true`
grafana_api_key string	Ключ API Grafana. Если задан, параметры `url_username` и `url_password` игнорируются.
members list / элементы=string	Список участников команды (адреса электронной почты). Список можно принудительно синхронизировать с помощью параметра `enforce_members`.
name string / обязательный	Название команды Grafana.
org_id integer	ID организации Grafana, в которой должна быть создана команда. Не используется, если задан `grafana_api_key`, поскольку `grafana_api_key` относится только к одной организации. Взаимоисключающий параметр с `org_name`. По умолчанию: `1`
org_name string	Название организации Grafana, в которой должна быть создана команда. Не используется, если задан `grafana_api_key`, поскольку `grafana_api_key` относится только к одной организации. Взаимоисключающий параметр с `org_id`.
skip_version_check boolean добавлено в community.grafana 1.2.0	Пропустить проверку версии Grafana и в любом случае попытаться обратиться к конечной точке API. Этот параметр может быть полезен, если в grafana.ini включён параметр `hide_version`. Варианты: `false` ← (по умолчанию) `true`
state string	Удалять участников, отсутствующих в параметрах `members`, из списка участников команды. Варианты: `"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 team
  community.grafana.grafana_team:
    url: "https://grafana.example.com"
    grafana_api_key: "{{ some_api_token_value }}"
    name: "grafana_working_group"
    email: "foo.bar@example.com"
    state: present

- name: Create a team with members
  community.grafana.grafana_team:
    url: "https://grafana.example.com"
    grafana_api_key: "{{ some_api_token_value }}"
    name: "grafana_working_group"
    email: "foo.bar@example.com"
    members:
      - john.doe@example.com
      - jane.doe@example.com
    state: present

- name: Create a team with members and enforce the list of members
  community.grafana.grafana_team:
    url: "https://grafana.example.com"
    grafana_api_key: "{{ some_api_token_value }}"
    name: "grafana_working_group"
    email: "foo.bar@example.com"
    members:
      - john.doe@example.com
      - jane.doe@example.com
    enforce_members: true
    state: present

- name: Delete a team
  community.grafana.grafana_team:
    url: "https://grafana.example.com"
    grafana_api_key: "{{ some_api_token_value }}"
    name: "grafana_working_group"
    email: "foo.bar@example.com"
    state: absent

- name: Create a team in a specific organization by name
  community.grafana.grafana_team:
    url: "https://grafana.example.com"
    url_username: "admin"
    url_password: "admin"
    name: "foo_team"
    email: "foo@example.com"
    org_name: "Main Org."
    state: present

- name: Create a team in a specific organization by ID
  community.grafana.grafana_team:
    url: "https://grafana.example.com"
    url_username: "admin"
    url_password: "admin"
    name: "bar_team"
    email: "bar@example.com"
    org_id: 3
    state: present

Возвращаемые значения

Общие возвращаемые значения описаны здесь; ниже перечислены поля, уникальные для этого модуля:

Ключ	Описание
team complex	Информация о команде Возвращается: при успешном выполнении
avatarUrl string	URL аватара команды на сервере Grafana Возвращается: всегда Пример: `"['/avatar/a7440323a684ea47406313a33156e5e9']"`
email string	Адрес электронной почты команды Возвращается: всегда Пример: `"['foo.bar@example.com']"`
id integer	Адрес электронной почты команды Возвращается: всегда Пример: `[42]`
memberCount integer	Количество участников команды Возвращается: всегда Пример: `[42]`
members list / элементы=string	Список участников команды Возвращается: всегда Пример: `[["john.doe@exemple.com"]]`
name string	Название команды. Возвращается: всегда Пример: `"['grafana_working_group']"`
orgId integer	ID организации, к которой относится команда. Возвращается: всегда Пример: `[1]`

Авторы

Rémi REY (@rrey)

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

© 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_team_module.html