community.grafana.grafana_team – Управление командами Grafana
Примечание
Этот плагин входит в коллекцию community.grafana (версия 1.1.0).
Для его установки используйте: ansible-galaxy collection install community.grafana.
Для использования в playbook укажите: community.grafana.grafana_team.
Новое в версии 1.0.0: от community.grafana
Обзор
- Создание/обновление/удаление команд Grafana через API команд.
- Также позволяет добавлять участников в команду (если участники существуют).
- API команд доступен только начиная с Grafana 5, и модуль завершится ошибкой, если версия сервера ниже 5.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| client_cert путь | Файл цепочки сертификатов в формате PEM, используемый для проверки подлинности клиента SSL. Этот файл также может содержать ключ, и если ключ включён, client_key не требуется | |
| client_key путь | Файл в формате PEM, содержащий ваш закрытый ключ для проверки подлинности клиента SSL. Если client_cert содержит как сертификат, так и ключ, этот параметр не требуется. | |
| email строка / обязательно | Адрес электронной почты, связанный с командой. | |
| enforce_members булево |
| Удалить участников, отсутствующих в параметрах members, из списка участников, найденных в команде. |
| grafana_api_key строка | Ключ API Grafana. Если задан, url_username и url_password будут проигнорированы. | |
| members список / элементы=строка | Список участников команды (адреса электронной почты). Список может быть принудительно задан параметром enforce_members. | |
| name строка / обязательно | Название команды Grafana. | |
| state строка |
| Удалить участников, отсутствующих в параметрах members , из списка участников, найденных в команде. |
| url строка / обязательно | URL Grafana. псевдонимы: grafana_url | |
| url_password строка | По умолчанию: "admin" | Пароль Grafana для аутентификации API. псевдонимы: grafana_password |
| url_username строка | По умолчанию: "admin" | Имя пользователя Grafana для аутентификации API. псевдонимы: grafana_user |
| use_proxy булево |
| Если no, прокси не будет использоваться, даже если он определен в переменной окружения на целевых хостах. |
| validate_certs булево |
| Если no, сертификаты SSL не будут проверены.Это следует устанавливать только для no используемых на контролируемых лично сайтах с использованием самоподписанных сертификатов. |
Примеры
---
- 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: yes
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–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/community/grafana/grafana_team_module.html
