community.grafana.grafana_plugin (1.8.0) — module

Install collection

Install with ansible-galaxy collection install community.grafana:==1.8.0

Add to requirements.yml

  collections:
    - name: community.grafana
      version: 1.8.0

Description

Install and remove Grafana plugins.

See U(https://grafana.com/docs/plugins/installation/) for upstream documentation.

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

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

Inputs

    
name:
    description:
    - Name of the plugin.
    required: true
    type: str

state:
    choices:
    - present
    - absent
    default: present
    description:
    - Whether the plugin should be installed.
    type: str

version:
    description:
    - Version of the plugin to install.
    - Defaults to C(latest).
    type: str

grafana_repo:
    description:
    - URL to the Grafana plugin repository.
    - 'If omitted, grafana-cli will use the default value: U(https://grafana.com/api/plugins).'
    type: str

validate_certs:
    default: false
    description:
    - Boolean variable to include --insecure while installing pluging
    type: bool

grafana_plugin_url:
    description:
    - Full URL to the plugin zip file instead of downloading the file from U(https://grafana.com/api/plugins).
    - Requires grafana 4.6.x or later.
    type: str

grafana_plugins_dir:
    description:
    - Directory where the Grafana plugin will be installed.
    - If omitted, defaults to C(/var/lib/grafana/plugins).
    type: str

Outputs

version:
  description: version of the installed/removed/updated plugin.
  returned: always
  type: str