community.grafana.grafana_folder module – Manage Grafana folders

Note

This module is part of the community.grafana collection (version 2.1.0).

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_folder.

New in community.grafana 1.0.0

Synopsis

  • Create/update/delete Grafana folders through the folders API.

Requirements

The below requirements are needed on the host that executes this module.

  • The folders API is only available starting Grafana 5 and the module will fail if the server version is lower than version 5.

Parameters

Parameter

Comments

client_cert

path

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

client_key

path

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.

grafana_api_key

string

The Grafana API key.

If set, url_username and url_password will be ignored.

name

aliases: title

string / required

The title of the Grafana folder.

org_id

integer

Grafana organization ID in which the datasource should be created.

Not used when grafana_api_key is set, because the grafana_api_key only belongs to one organization.

Mutually exclusive with org_name.

Default: 1

org_name

string

Grafana organization name in which the datasource should be created.

Not used when grafana_api_key is set, because the grafana_api_key only belongs to one organization.

Mutually exclusive with org_id.

parent_uid

string

The parent folder UID.

Available with subfolder feature of Grafana 11.

skip_version_check

boolean

added in community.grafana 1.2.0

Skip Grafana version check and try to reach api endpoint anyway.

This parameter can be useful if you enabled hide_version in grafana.ini

Choices:

  • false ← (default)

  • true

state

string

Delete the members not found in the members parameters from the

list of members found on the folder.

Choices:

  • "present" ← (default)

  • "absent"

uid

string

The folder UID.

url

aliases: grafana_url

string / required

The Grafana URL.

url_password

aliases: grafana_password

string

The Grafana password for API authentication.

Default: "admin"

url_username

aliases: grafana_user

string

The Grafana user for API authentication.

Default: "admin"

use_proxy

boolean

If false, it will not use a proxy, even if one is defined in an environment variable on the target hosts.

Choices:

  • false

  • true ← (default)

validate_certs

boolean

If false, SSL certificates will not be validated.

This should only set to false used on personally controlled sites using self-signed certificates.

Choices:

  • false

  • true ← (default)

Examples

---
- name: Create a folder
  community.grafana.grafana_folder:
      url: "https://grafana.example.com"
      grafana_api_key: "{{ some_api_token_value }}"
      title: "grafana_working_group"
      state: present

- name: Delete a folder
  community.grafana.grafana_folder:
      url: "https://grafana.example.com"
      grafana_api_key: "{{ some_api_token_value }}"
      title: "grafana_working_group"
      state: absent

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key

Description

folder

complex

Information about the folder

Returned: On success

canAdmin

boolean

Boolean specifying if current user can admin in folder

Returned: always

Sample: [false]

canEdit

boolean

Boolean specifying if current user can edit in folder

Returned: always

Sample: [false]

canSave

boolean

Boolean specifying if current user can save in folder

Returned: always

Sample: [false]

created

string

The folder creation date

Returned: always

Sample: "['2018-01-31T17:43:12+01:00']"

createdBy

string

The name of the user who created the folder

Returned: always

Sample: "['admin']"

hasAcl

boolean

Boolean specifying if folder has acl

Returned: always

Sample: [false]

id

integer

The folder identifier

Returned: always

Sample: [42]

orgId

integer

The organization id

Returned: always

Sample: [1]

parentUid

string

The parent folders uid

Returned: always as subfolder

Sample: "['76HjcBH2']"

title

string

The folder title

Returned: always

Sample: "['Department ABC']"

uid

string

The folder uid

Returned: always

Sample: "['nErXDvCkzz']"

updated

string

The date the folder was last updated

Returned: always

Sample: "['2018-01-31T17:43:12+01:00']"

updatedBy

string

The name of the user who last updated the folder

Returned: always

Sample: "['admin']"

url

string

The folder url

Returned: always

Sample: "['/dashboards/f/nErXDvCkzz/department-abc']"

version

integer

The folder version

Returned: always

Sample: [1]

Authors

  • Rémi REY (@rrey)