community.grafana.grafana_team module – Manage Grafana Teams
Note
This module is part of the community.grafana collection (version 1.9.1).
You might already have this collection installed if you are using the ansible
package.
It is not included in ansible-core
.
To check whether it is installed, run ansible-galaxy collection list
.
To install it, use: ansible-galaxy collection install community.grafana
.
You need further requirements to be able to use this module,
see Requirements for details.
To use it in a playbook, specify: community.grafana.grafana_team
.
New in community.grafana 1.0.0
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
Parameter |
Comments |
---|---|
PEM formatted certificate chain file to be used for SSL client authentication. This file can also include the key as well, and if the key is included, client_key is not required |
|
PEM formatted file that contains your private key to be used for SSL client authentication. If client_cert contains both the certificate and key, this option is not required. |
|
The mail address associated with the Team. |
|
Delete the members not found in the list of members found on the Team. Choices:
|
|
The Grafana API key. If set, |
|
List of team members (emails). The list can be enforced with |
|
The name of the Grafana Team. |
|
Skip Grafana version check and try to reach api endpoint anyway. This parameter can be useful if you enabled Choices:
|
|
Delete the members not found in the list of members found on the Team. Choices:
|
|
The Grafana URL. |
|
The Grafana password for API authentication. Default: |
|
The Grafana user for API authentication. Default: |
|
If Choices:
|
|
If This should only set to Choices:
|
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: 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: "[email protected]"
state: absent
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
Information about the Team Returned: On success |
|
The url of the Team avatar on Grafana server Returned: always Sample: |
|
The Team email address Returned: always Sample: |
|
The Team email address Returned: always Sample: |
|
The number of Team members Returned: always Sample: |
|
The list of Team members Returned: always Sample: |
|
The name of the team. Returned: always Sample: |
|
The organization id that the team is part of. Returned: always Sample: |