grafana_plugin – Manage Grafana plugins via grafana-cli — Ansible Documentation

- AnsibleFest
- Products
- Community
- Webinars & Training
- Blog

Documentation

# grafana_plugin – Manage Grafana plugins via grafana-cli

New in version 2.5.

- Synopsis
- Parameters
- Examples
- Return Values
- Status

## Synopsis

- Install and remove Grafana plugins.

## Parameters

Parameter | Choices/Defaults | Comments
--- | --- | ---
grafana_plugin_url - |  | Custom Grafana plugin URL. Requires grafana 4.6.x or later.
grafana_plugins_dir - |  | Directory where Grafana plugin will be installed.
grafana_repo - |  | Grafana repository. If not set, gafana-cli will use the default value `https://grafana.net/api/plugins`.
name - / required |  | Name of the plugin.
state - | Choices: absent present ← | Status of the Grafana plugin. If latest is set, the version parameter will be ignored.
version - |  | Version of the plugin to install. Default to latest.

## Examples

    ---
    - name: Install - update Grafana piechart panel plugin
      grafana_plugin:
        name: grafana-piechart-panel
        version: latest
        state: present

## Return Values

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

Key | Returned | Description
--- | --- | ---
version string | allways | version of the installed / removed plugin.

## Status

- This module is not guaranteed to have a backwards compatible interface. [preview]
- This module is maintained by the Ansible Community. [community]

### Authors

- Thierry Sallé (@tsalle)

Hint

If you notice any issues in this documentation you can edit this document to improve it.