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

Примечание

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

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

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

Для использования в playbook, укажите: community.grafana.grafana_team.

Новое в community.grafana 1.0.0

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

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

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

Требования

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

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

Параметры

Параметр	Комментарии
client_cert path	Файл цепочки сертификатов в формате PEM, который будет использоваться для проверки подлинности клиента SSL. Этот файл также может включать ключ, и если ключ включен, client_key не требуется
client_key path	Файл в формате PEM, содержащий ваш закрытый ключ, который будет использоваться для проверки подлинности клиента SSL. Если client_cert содержит и сертификат, и ключ, этот параметр не требуется.
email string / required	Почтовый адрес, связанный с командой.
enforce_members boolean	Удалить участников, не найденных в параметрах `members` из списка участников, найденных в команде. Варианты: `false` ← (по умолчанию) `true`
grafana_api_key string	API-ключ Grafana. Если задан, `url_username` и `url_password` будут проигнорированы.
members list / elements=string	Список участников команды (почтовые адреса). Список может быть применен с помощью параметра `enforce_members`.
name string / required	Название команды Grafana.
skip_version_check boolean добавлено в community.grafana 1.2.0	Пропустить проверку версии Grafana и попытаться обратиться к конечной точке API в любом случае. Этот параметр может быть полезен, если вы включили `hide_version` в grafana.ini Варианты: `false` ← (по умолчанию) `true`
state string	Удалить участников, не найденных в параметрах `members` из списка участников, найденных в команде. Варианты: `"present"` ← (по умолчанию) `"absent"`
url псевдонимы: grafana_url string / required	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

Значения возврата

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

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

Авторы

Rémi REY (@rrey)

Ссылки на сборку

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