671 lines
14 KiB
ReStructuredText
671 lines
14 KiB
ReStructuredText
.. Document meta
|
|
|
|
:orphan:
|
|
|
|
.. |antsibull-internal-nbsp| unicode:: 0xA0
|
|
:trim:
|
|
|
|
.. role:: ansible-attribute-support-label
|
|
.. role:: ansible-attribute-support-property
|
|
.. role:: ansible-attribute-support-full
|
|
.. role:: ansible-attribute-support-partial
|
|
.. role:: ansible-attribute-support-none
|
|
.. role:: ansible-attribute-support-na
|
|
.. role:: ansible-option-type
|
|
.. role:: ansible-option-elements
|
|
.. role:: ansible-option-required
|
|
.. role:: ansible-option-versionadded
|
|
.. role:: ansible-option-aliases
|
|
.. role:: ansible-option-choices
|
|
.. role:: ansible-option-choices-entry
|
|
.. role:: ansible-option-default
|
|
.. role:: ansible-option-default-bold
|
|
.. role:: ansible-option-configuration
|
|
.. role:: ansible-option-returned-bold
|
|
.. role:: ansible-option-sample-bold
|
|
|
|
.. Anchors
|
|
|
|
.. _ansible_collections.grafana.grafana.dashboard_module:
|
|
|
|
.. Anchors: short name for ansible.builtin
|
|
|
|
.. Anchors: aliases
|
|
|
|
|
|
|
|
.. Title
|
|
|
|
grafana.grafana.dashboard module -- Manage Dashboards in Grafana
|
|
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
|
|
|
|
.. version_added
|
|
|
|
.. versionadded:: 0.0.1 of grafana.grafana
|
|
|
|
.. contents::
|
|
:local:
|
|
:depth: 1
|
|
|
|
.. Deprecated
|
|
|
|
|
|
Synopsis
|
|
--------
|
|
|
|
.. Description
|
|
|
|
- Create, Update and delete Dashboards using Ansible.
|
|
|
|
|
|
.. Aliases
|
|
|
|
|
|
.. Requirements
|
|
|
|
|
|
|
|
|
|
|
|
|
|
.. Options
|
|
|
|
Parameters
|
|
----------
|
|
|
|
|
|
.. rst-class:: ansible-option-table
|
|
|
|
.. list-table::
|
|
:width: 100%
|
|
:widths: auto
|
|
:header-rows: 1
|
|
|
|
* - Parameter
|
|
- Comments
|
|
|
|
* - .. raw:: html
|
|
|
|
<div class="ansible-option-cell">
|
|
<div class="ansibleOptionAnchor" id="parameter-cloud_api_key"></div>
|
|
|
|
.. _ansible_collections.grafana.grafana.dashboard_module__parameter-cloud_api_key:
|
|
|
|
.. rst-class:: ansible-option-title
|
|
|
|
**cloud_api_key**
|
|
|
|
.. raw:: html
|
|
|
|
<a class="ansibleOptionLink" href="#parameter-cloud_api_key" title="Permalink to this option"></a>
|
|
|
|
.. rst-class:: ansible-option-type-line
|
|
|
|
:ansible-option-type:`string` / :ansible-option-required:`required`
|
|
|
|
.. raw:: html
|
|
|
|
</div>
|
|
|
|
- .. raw:: html
|
|
|
|
<div class="ansible-option-cell">
|
|
|
|
CLoud API Key to authenticate with Grafana Cloud.
|
|
|
|
|
|
.. raw:: html
|
|
|
|
</div>
|
|
|
|
* - .. raw:: html
|
|
|
|
<div class="ansible-option-cell">
|
|
<div class="ansibleOptionAnchor" id="parameter-dashboard"></div>
|
|
|
|
.. _ansible_collections.grafana.grafana.dashboard_module__parameter-dashboard:
|
|
|
|
.. rst-class:: ansible-option-title
|
|
|
|
**dashboard**
|
|
|
|
.. raw:: html
|
|
|
|
<a class="ansibleOptionLink" href="#parameter-dashboard" title="Permalink to this option"></a>
|
|
|
|
.. rst-class:: ansible-option-type-line
|
|
|
|
:ansible-option-type:`dictionary` / :ansible-option-required:`required`
|
|
|
|
.. raw:: html
|
|
|
|
</div>
|
|
|
|
- .. raw:: html
|
|
|
|
<div class="ansible-option-cell">
|
|
|
|
JSON source code for dashboard
|
|
|
|
|
|
.. raw:: html
|
|
|
|
</div>
|
|
|
|
* - .. raw:: html
|
|
|
|
<div class="ansible-option-cell">
|
|
<div class="ansibleOptionAnchor" id="parameter-stack_slug"></div>
|
|
|
|
.. _ansible_collections.grafana.grafana.dashboard_module__parameter-stack_slug:
|
|
|
|
.. rst-class:: ansible-option-title
|
|
|
|
**stack_slug**
|
|
|
|
.. raw:: html
|
|
|
|
<a class="ansibleOptionLink" href="#parameter-stack_slug" title="Permalink to this option"></a>
|
|
|
|
.. rst-class:: ansible-option-type-line
|
|
|
|
:ansible-option-type:`string` / :ansible-option-required:`required`
|
|
|
|
.. raw:: html
|
|
|
|
</div>
|
|
|
|
- .. raw:: html
|
|
|
|
<div class="ansible-option-cell">
|
|
|
|
Name of the Grafana Cloud stack to which the notification policies will be added
|
|
|
|
|
|
.. raw:: html
|
|
|
|
</div>
|
|
|
|
* - .. raw:: html
|
|
|
|
<div class="ansible-option-cell">
|
|
<div class="ansibleOptionAnchor" id="parameter-state"></div>
|
|
|
|
.. _ansible_collections.grafana.grafana.dashboard_module__parameter-state:
|
|
|
|
.. rst-class:: ansible-option-title
|
|
|
|
**state**
|
|
|
|
.. raw:: html
|
|
|
|
<a class="ansibleOptionLink" href="#parameter-state" title="Permalink to this option"></a>
|
|
|
|
.. rst-class:: ansible-option-type-line
|
|
|
|
:ansible-option-type:`string`
|
|
|
|
.. raw:: html
|
|
|
|
</div>
|
|
|
|
- .. raw:: html
|
|
|
|
<div class="ansible-option-cell">
|
|
|
|
State for the Grafana CLoud stack.
|
|
|
|
|
|
.. rst-class:: ansible-option-line
|
|
|
|
:ansible-option-choices:`Choices:`
|
|
|
|
- :ansible-option-default-bold:`present` :ansible-option-default:`← (default)`
|
|
- :ansible-option-choices-entry:`absent`
|
|
|
|
.. raw:: html
|
|
|
|
</div>
|
|
|
|
|
|
.. Attributes
|
|
|
|
|
|
.. Notes
|
|
|
|
|
|
.. Seealso
|
|
|
|
|
|
.. Examples
|
|
|
|
Examples
|
|
--------
|
|
|
|
.. code-block:: yaml+jinja
|
|
|
|
|
|
- name: Create/Update a dashboard
|
|
dashboard:
|
|
datasource: "{{ lookup('file', 'dashboard.json') }}"
|
|
stack_slug: "{{ stack_slug }}"
|
|
cloud_api_key: "{{ grafana_cloud_api_key }}"
|
|
state: present
|
|
|
|
- name: Delete dashboard
|
|
dashboard:
|
|
datasource: "{{ lookup('file', 'dashboard.json') }}"
|
|
stack_slug: "{{ stack_slug }}"
|
|
cloud_api_key: "{{ grafana_cloud_api_key }}"
|
|
state: absent
|
|
|
|
|
|
|
|
|
|
.. Facts
|
|
|
|
|
|
.. Return values
|
|
|
|
Return Values
|
|
-------------
|
|
Common return values are documented :ref:`here <common_return_values>`, the following are the fields unique to this module:
|
|
|
|
.. rst-class:: ansible-option-table
|
|
|
|
.. list-table::
|
|
:width: 100%
|
|
:widths: auto
|
|
:header-rows: 1
|
|
|
|
* - Key
|
|
- Description
|
|
|
|
* - .. raw:: html
|
|
|
|
<div class="ansible-option-cell">
|
|
<div class="ansibleOptionAnchor" id="return-output"></div>
|
|
|
|
.. _ansible_collections.grafana.grafana.dashboard_module__return-output:
|
|
|
|
.. rst-class:: ansible-option-title
|
|
|
|
**output**
|
|
|
|
.. raw:: html
|
|
|
|
<a class="ansibleOptionLink" href="#return-output" title="Permalink to this return value"></a>
|
|
|
|
.. rst-class:: ansible-option-type-line
|
|
|
|
:ansible-option-type:`dictionary`
|
|
|
|
.. raw:: html
|
|
|
|
</div>
|
|
|
|
- .. raw:: html
|
|
|
|
<div class="ansible-option-cell">
|
|
|
|
Dict object containing folder information
|
|
|
|
|
|
.. rst-class:: ansible-option-line
|
|
|
|
:ansible-option-returned-bold:`Returned:` On success
|
|
|
|
|
|
.. raw:: html
|
|
|
|
</div>
|
|
|
|
|
|
* - .. raw:: html
|
|
|
|
<div class="ansible-option-indent"></div><div class="ansible-option-cell">
|
|
<div class="ansibleOptionAnchor" id="return-output/id"></div>
|
|
|
|
.. _ansible_collections.grafana.grafana.dashboard_module__return-output/id:
|
|
|
|
.. rst-class:: ansible-option-title
|
|
|
|
**id**
|
|
|
|
.. raw:: html
|
|
|
|
<a class="ansibleOptionLink" href="#return-output/id" title="Permalink to this return value"></a>
|
|
|
|
.. rst-class:: ansible-option-type-line
|
|
|
|
:ansible-option-type:`integer`
|
|
|
|
.. raw:: html
|
|
|
|
</div>
|
|
|
|
- .. raw:: html
|
|
|
|
<div class="ansible-option-indent-desc"></div><div class="ansible-option-cell">
|
|
|
|
The ID for the dashboard
|
|
|
|
|
|
.. rst-class:: ansible-option-line
|
|
|
|
:ansible-option-returned-bold:`Returned:` on success
|
|
|
|
|
|
.. raw:: html
|
|
|
|
</div>
|
|
|
|
|
|
* - .. raw:: html
|
|
|
|
<div class="ansible-option-indent"></div><div class="ansible-option-cell">
|
|
<div class="ansibleOptionAnchor" id="return-output/message"></div>
|
|
|
|
.. _ansible_collections.grafana.grafana.dashboard_module__return-output/message:
|
|
|
|
.. rst-class:: ansible-option-title
|
|
|
|
**message**
|
|
|
|
.. raw:: html
|
|
|
|
<a class="ansibleOptionLink" href="#return-output/message" title="Permalink to this return value"></a>
|
|
|
|
.. rst-class:: ansible-option-type-line
|
|
|
|
:ansible-option-type:`string`
|
|
|
|
.. raw:: html
|
|
|
|
</div>
|
|
|
|
- .. raw:: html
|
|
|
|
<div class="ansible-option-indent-desc"></div><div class="ansible-option-cell">
|
|
|
|
The message returned after the operation on the dashboard
|
|
|
|
|
|
.. rst-class:: ansible-option-line
|
|
|
|
:ansible-option-returned-bold:`Returned:` state is absent and on success
|
|
|
|
|
|
.. raw:: html
|
|
|
|
</div>
|
|
|
|
|
|
* - .. raw:: html
|
|
|
|
<div class="ansible-option-indent"></div><div class="ansible-option-cell">
|
|
<div class="ansibleOptionAnchor" id="return-output/slug"></div>
|
|
|
|
.. _ansible_collections.grafana.grafana.dashboard_module__return-output/slug:
|
|
|
|
.. rst-class:: ansible-option-title
|
|
|
|
**slug**
|
|
|
|
.. raw:: html
|
|
|
|
<a class="ansibleOptionLink" href="#return-output/slug" title="Permalink to this return value"></a>
|
|
|
|
.. rst-class:: ansible-option-type-line
|
|
|
|
:ansible-option-type:`string`
|
|
|
|
.. raw:: html
|
|
|
|
</div>
|
|
|
|
- .. raw:: html
|
|
|
|
<div class="ansible-option-indent-desc"></div><div class="ansible-option-cell">
|
|
|
|
The slug for the dashboard
|
|
|
|
|
|
.. rst-class:: ansible-option-line
|
|
|
|
:ansible-option-returned-bold:`Returned:` state is present and on success
|
|
|
|
|
|
.. raw:: html
|
|
|
|
</div>
|
|
|
|
|
|
* - .. raw:: html
|
|
|
|
<div class="ansible-option-indent"></div><div class="ansible-option-cell">
|
|
<div class="ansibleOptionAnchor" id="return-output/status"></div>
|
|
|
|
.. _ansible_collections.grafana.grafana.dashboard_module__return-output/status:
|
|
|
|
.. rst-class:: ansible-option-title
|
|
|
|
**status**
|
|
|
|
.. raw:: html
|
|
|
|
<a class="ansibleOptionLink" href="#return-output/status" title="Permalink to this return value"></a>
|
|
|
|
.. rst-class:: ansible-option-type-line
|
|
|
|
:ansible-option-type:`string`
|
|
|
|
.. raw:: html
|
|
|
|
</div>
|
|
|
|
- .. raw:: html
|
|
|
|
<div class="ansible-option-indent-desc"></div><div class="ansible-option-cell">
|
|
|
|
The status of the dashboard
|
|
|
|
|
|
.. rst-class:: ansible-option-line
|
|
|
|
:ansible-option-returned-bold:`Returned:` state is present and on success
|
|
|
|
|
|
.. raw:: html
|
|
|
|
</div>
|
|
|
|
|
|
* - .. raw:: html
|
|
|
|
<div class="ansible-option-indent"></div><div class="ansible-option-cell">
|
|
<div class="ansibleOptionAnchor" id="return-output/title"></div>
|
|
|
|
.. _ansible_collections.grafana.grafana.dashboard_module__return-output/title:
|
|
|
|
.. rst-class:: ansible-option-title
|
|
|
|
**title**
|
|
|
|
.. raw:: html
|
|
|
|
<a class="ansibleOptionLink" href="#return-output/title" title="Permalink to this return value"></a>
|
|
|
|
.. rst-class:: ansible-option-type-line
|
|
|
|
:ansible-option-type:`string`
|
|
|
|
.. raw:: html
|
|
|
|
</div>
|
|
|
|
- .. raw:: html
|
|
|
|
<div class="ansible-option-indent-desc"></div><div class="ansible-option-cell">
|
|
|
|
The name of the dashboard
|
|
|
|
|
|
.. rst-class:: ansible-option-line
|
|
|
|
:ansible-option-returned-bold:`Returned:` state is absent and on success
|
|
|
|
|
|
.. raw:: html
|
|
|
|
</div>
|
|
|
|
|
|
* - .. raw:: html
|
|
|
|
<div class="ansible-option-indent"></div><div class="ansible-option-cell">
|
|
<div class="ansibleOptionAnchor" id="return-output/uid"></div>
|
|
|
|
.. _ansible_collections.grafana.grafana.dashboard_module__return-output/uid:
|
|
|
|
.. rst-class:: ansible-option-title
|
|
|
|
**uid**
|
|
|
|
.. raw:: html
|
|
|
|
<a class="ansibleOptionLink" href="#return-output/uid" title="Permalink to this return value"></a>
|
|
|
|
.. rst-class:: ansible-option-type-line
|
|
|
|
:ansible-option-type:`string`
|
|
|
|
.. raw:: html
|
|
|
|
</div>
|
|
|
|
- .. raw:: html
|
|
|
|
<div class="ansible-option-indent-desc"></div><div class="ansible-option-cell">
|
|
|
|
The UID for the dashboard
|
|
|
|
|
|
.. rst-class:: ansible-option-line
|
|
|
|
:ansible-option-returned-bold:`Returned:` state is present and on success
|
|
|
|
|
|
.. raw:: html
|
|
|
|
</div>
|
|
|
|
|
|
* - .. raw:: html
|
|
|
|
<div class="ansible-option-indent"></div><div class="ansible-option-cell">
|
|
<div class="ansibleOptionAnchor" id="return-output/url"></div>
|
|
|
|
.. _ansible_collections.grafana.grafana.dashboard_module__return-output/url:
|
|
|
|
.. rst-class:: ansible-option-title
|
|
|
|
**url**
|
|
|
|
.. raw:: html
|
|
|
|
<a class="ansibleOptionLink" href="#return-output/url" title="Permalink to this return value"></a>
|
|
|
|
.. rst-class:: ansible-option-type-line
|
|
|
|
:ansible-option-type:`string`
|
|
|
|
.. raw:: html
|
|
|
|
</div>
|
|
|
|
- .. raw:: html
|
|
|
|
<div class="ansible-option-indent-desc"></div><div class="ansible-option-cell">
|
|
|
|
The endpoint for the dashboard
|
|
|
|
|
|
.. rst-class:: ansible-option-line
|
|
|
|
:ansible-option-returned-bold:`Returned:` state is present and on success
|
|
|
|
|
|
.. raw:: html
|
|
|
|
</div>
|
|
|
|
|
|
* - .. raw:: html
|
|
|
|
<div class="ansible-option-indent"></div><div class="ansible-option-cell">
|
|
<div class="ansibleOptionAnchor" id="return-output/version"></div>
|
|
|
|
.. _ansible_collections.grafana.grafana.dashboard_module__return-output/version:
|
|
|
|
.. rst-class:: ansible-option-title
|
|
|
|
**version**
|
|
|
|
.. raw:: html
|
|
|
|
<a class="ansibleOptionLink" href="#return-output/version" title="Permalink to this return value"></a>
|
|
|
|
.. rst-class:: ansible-option-type-line
|
|
|
|
:ansible-option-type:`integer`
|
|
|
|
.. raw:: html
|
|
|
|
</div>
|
|
|
|
- .. raw:: html
|
|
|
|
<div class="ansible-option-indent-desc"></div><div class="ansible-option-cell">
|
|
|
|
The version of the dashboard
|
|
|
|
|
|
.. rst-class:: ansible-option-line
|
|
|
|
:ansible-option-returned-bold:`Returned:` state is present and on success
|
|
|
|
|
|
.. raw:: html
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
.. Status (Presently only deprecated)
|
|
|
|
|
|
.. Authors
|
|
|
|
Authors
|
|
~~~~~~~
|
|
|
|
- Ishan Jain (@ishanjainn)
|
|
|
|
|
|
|
|
.. Extra links
|
|
|
|
Collection links
|
|
~~~~~~~~~~~~~~~~
|
|
|
|
.. raw:: html
|
|
|
|
<p class="ansible-links">
|
|
<a href="https://github.com/grafana/grafana-ansible-collection/issues" aria-role="button" target="_blank" rel="noopener external">Issue Tracker</a>
|
|
<a href="https://github.com/grafana/grafana-ansible-collection" aria-role="button" target="_blank" rel="noopener external">Repository (Sources)</a>
|
|
</p>
|
|
|
|
.. Parsing errors
|