community.grafana.grafana_team – Manage Grafana Teams¶
Note
This plugin is part of the community.grafana collection (version 1.2.1).
To install it use: ansible-galaxy collection install community.grafana
.
To use it in a playbook, specify: community.grafana.grafana_team
.
New in version 1.0.0: of community.grafana
Synopsis¶
Create/update/delete Grafana Teams through the Teams API.
Also allows to add members in the team (if members exists).
Requirements¶
The below requirements are needed on the host that executes this module.
The Teams API is only available starting Grafana 5 and the module will fail if the server version is lower than version 5.
Parameters¶
Examples¶
---
- 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: "[email protected]"
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: "[email protected]"
members:
- [email protected]
- [email protected]
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: "[email protected]"
members:
- [email protected]
- [email protected]
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: "[email protected]"
state: absent
Return Values¶
Common return values are documented here, the following are the fields unique to this module:
Key | Returned | Description | |
---|---|---|---|
team
complex
|
On success |
Information about the Team
|
|
avatarUrl
string
|
always |
The url of the Team avatar on Grafana server
Sample:
['/avatar/a7440323a684ea47406313a33156e5e9']
|
|
email
string
|
always |
The Team email address
Sample:
|
|
id
integer
|
always |
The Team email address
Sample:
[42]
|
|
memberCount
integer
|
always |
The number of Team members
Sample:
[42]
|
|
members
list
/ elements=string
|
always |
The list of Team members
Sample:
[['[email protected]']]
|
|
name
string
|
always |
The name of the team.
Sample:
['grafana_working_group']
|
|
orgId
integer
|
always |
The organization id that the team is part of.
Sample:
[1]
|
Authors¶
Rémi REY (@rrey)