-
- When set to True, Disables the resolve message [OK] that is sent when alerting state returns to false
-
-
- .. rst-class:: ansible-option-line
-
- :ansible-option-choices:`Choices:`
-
- - :ansible-option-default-bold:`no` :ansible-option-default:`← (default)`
- - :ansible-option-choices-entry:`yes`
-
- .. raw:: html
-
-
-
- * - .. raw:: html
-
-
-
- Grafana API Key used to authenticate with Grafana.
-
-
- .. raw:: html
-
-
-
- * - .. raw:: html
-
-
-
- Name of the contact point
-
-
- .. raw:: html
-
-
-
- * - .. raw:: html
-
-
-
- Contact point settings
-
-
- .. raw:: html
-
-
-
- * - .. raw:: html
-
-
-
- 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
-
-
-
- * - .. raw:: html
-
-
-
- Contact point type
-
-
- .. raw:: html
-
-
-
- * - .. raw:: html
-
-
-
- Sets the UID of the Contact point.
-
-
- .. raw:: html
-
-
-
-
-.. Attributes
-
-
-.. Notes
-
-
-.. Seealso
-
-
-.. Examples
-
-Examples
---------
-
-.. code-block:: yaml+jinja
-
-
- - name: Create/Update Alerting contact point
- alert_contact_point:
- name: ops-email
- uid: opsemail
- type: email
- settings: {
- addresses: "ops@mydomain.com,devs@mydomain.com"
- }
- stack_slug: "{{ stack_slug }}"
- grafana_api_key: "{{ grafana_api_key }}"
- state: present
-
- - name: Delete Alerting contact point
- alert_contact_point:
- name: ops-email
- uid: opsemail
- type: email
- settings: {
- addresses: "ops@mydomain.com,devs@mydomain.com"
- }
- stack_slug: "{{ stack_slug }}"
- grafana_api_key: "{{ grafana_api_key }}"
- state: absent
-
-
-
-
-.. Facts
-
-
-.. Return values
-
-Return Values
--------------
-Common return values are documented :ref:`here `, 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
-
-
-
-
- .. _ansible_collections.grafana.grafana.alert_contact_point_module__return-output:
-
- .. rst-class:: ansible-option-title
-
- **output**
-
- .. raw:: html
-
-
-
- .. rst-class:: ansible-option-type-line
-
- :ansible-option-type:`dictionary`
-
- .. raw:: html
-
-
-
- Dict object containing Contact point information information
-
-
- .. rst-class:: ansible-option-line
-
- :ansible-option-returned-bold:`Returned:` On success
-
-
- .. raw:: html
-
-
-
-
- * - .. raw:: html
-
-
-
-
- .. _ansible_collections.grafana.grafana.alert_contact_point_module__return-output/disableresolvemessage:
-
- .. rst-class:: ansible-option-title
-
- **disableResolveMessage**
-
- .. raw:: html
-
-
-
- .. rst-class:: ansible-option-type-line
-
- :ansible-option-type:`boolean`
-
- .. raw:: html
-
-
-
- When set to True, Disables the resolve message [OK] that is sent when alerting state returns to false
-
-
- .. rst-class:: ansible-option-line
-
- :ansible-option-returned-bold:`Returned:` state is present and on success
-
-
- .. raw:: html
-
-
-
-
- * - .. raw:: html
-
-
-
-
- .. _ansible_collections.grafana.grafana.alert_contact_point_module__return-output/name:
-
- .. rst-class:: ansible-option-title
-
- **name**
-
- .. raw:: html
-
-
-
- .. rst-class:: ansible-option-type-line
-
- :ansible-option-type:`string`
-
- .. raw:: html
-
-
-
- The name for the contact point
-
-
- .. rst-class:: ansible-option-line
-
- :ansible-option-returned-bold:`Returned:` state is present and on success
-
-
- .. raw:: html
-
-
-
-
- * - .. raw:: html
-
-
-
-
- .. _ansible_collections.grafana.grafana.alert_contact_point_module__return-output/settings:
-
- .. rst-class:: ansible-option-title
-
- **settings**
-
- .. raw:: html
-
-
-
- .. rst-class:: ansible-option-type-line
-
- :ansible-option-type:`dictionary`
-
- .. raw:: html
-
-
-
- Contains contact point settings
-
-
- .. rst-class:: ansible-option-line
-
- :ansible-option-returned-bold:`Returned:` state is present and on success
-
-
- .. raw:: html
-
-
-
-
- * - .. raw:: html
-
-
-
-
- .. _ansible_collections.grafana.grafana.alert_contact_point_module__return-output/type:
-
- .. rst-class:: ansible-option-title
-
- **type**
-
- .. raw:: html
-
-
-
- .. rst-class:: ansible-option-type-line
-
- :ansible-option-type:`string`
-
- .. raw:: html
-
-
-
- The type of contact point
-
-
- .. rst-class:: ansible-option-line
-
- :ansible-option-returned-bold:`Returned:` state is present and on success
-
-
- .. raw:: html
-
-
-
-
- * - .. raw:: html
-
-
-
-
- .. _ansible_collections.grafana.grafana.alert_contact_point_module__return-output/uid:
-
- .. rst-class:: ansible-option-title
-
- **uid**
-
- .. raw:: html
-
-
-
- .. rst-class:: ansible-option-type-line
-
- :ansible-option-type:`string`
-
- .. raw:: html
-
-
-
- The UID for the contact point
-
-
- .. rst-class:: ansible-option-line
-
- :ansible-option-returned-bold:`Returned:` state is present and on success
-
-
- .. raw:: html
-
-
-
-
-
-
-.. Status (Presently only deprecated)
-
-
-.. Authors
-
-Authors
-~~~~~~~
-
-- Ishan Jain (@ishanjainn)
-
-
-
-.. Extra links
-
-Collection links
-~~~~~~~~~~~~~~~~
-
-.. raw:: html
-
-
- Issue Tracker
- Repository (Sources)
-
-
-.. Parsing errors
diff --git a/docs-rst/alert_notification_policy_module.rst b/docs-rst/alert_notification_policy_module.rst
deleted file mode 100644
index 7fbe004..0000000
--- a/docs-rst/alert_notification_policy_module.rst
+++ /dev/null
@@ -1,881 +0,0 @@
-.. 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.alert_notification_policy_module:
-
-.. Anchors: short name for ansible.builtin
-
-.. Anchors: aliases
-
-
-
-.. Title
-
-grafana.grafana.alert_notification_policy module -- Sets the notification policy tree in Grafana Alerting
-+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
-
-.. version_added
-
-.. versionadded:: 0.0.1 of grafana.grafana
-
-.. contents::
- :local:
- :depth: 1
-
-.. Deprecated
-
-
-Synopsis
---------
-
-.. Description
-
-- Set the notification policy tree using Ansible
-
-
-.. Aliases
-
-
-.. Requirements
-
-
-
-
-
-
-.. Options
-
-Parameters
-----------
-
-
-.. rst-class:: ansible-option-table
-
-.. list-table::
- :width: 100%
- :widths: auto
- :header-rows: 1
-
- * - Parameter
- - Comments
-
- * - .. raw:: html
-
-
-
-
- .. _ansible_collections.grafana.grafana.alert_notification_policy_module__parameter-continue:
-
- .. rst-class:: ansible-option-title
-
- **Continue**
-
- .. raw:: html
-
-
-
- .. rst-class:: ansible-option-type-line
-
- :ansible-option-type:`boolean`
-
- .. raw:: html
-
-
-
- Continue matching subsequent sibling nodes if set to `True`.
-
-
- .. rst-class:: ansible-option-line
-
- :ansible-option-choices:`Choices:`
-
- - :ansible-option-default-bold:`no` :ansible-option-default:`← (default)`
- - :ansible-option-choices-entry:`yes`
-
- .. raw:: html
-
-
-
- * - .. raw:: html
-
-
-
-
- .. _ansible_collections.grafana.grafana.alert_notification_policy_module__parameter-grafana_api_key:
-
- .. rst-class:: ansible-option-title
-
- **grafana_api_key**
-
- .. raw:: html
-
-
-
- .. rst-class:: ansible-option-type-line
-
- :ansible-option-type:`string` / :ansible-option-required:`required`
-
- .. raw:: html
-
-
-
- Grafana API Key used to authenticate with Grafana.
-
-
- .. raw:: html
-
-
-
- * - .. raw:: html
-
-
-
-
- .. _ansible_collections.grafana.grafana.alert_notification_policy_module__parameter-groupbystr:
-
- .. rst-class:: ansible-option-title
-
- **GroupByStr**
-
- .. raw:: html
-
-
-
- .. rst-class:: ansible-option-type-line
-
- :ansible-option-type:`list` / :ansible-option-elements:`elements=string`
-
- .. raw:: html
-
-
-
- List of string.
-
- Group alerts when you receive a notification based on labels. If empty it will be inherited from the parent policy.
-
-
- .. rst-class:: ansible-option-line
-
- :ansible-option-default-bold:`Default:` :ansible-option-default:`[]`
-
- .. raw:: html
-
-
-
- * - .. raw:: html
-
-
-
-
- .. _ansible_collections.grafana.grafana.alert_notification_policy_module__parameter-groupinterval:
-
- .. rst-class:: ansible-option-title
-
- **groupInterval**
-
- .. raw:: html
-
-
-
- .. rst-class:: ansible-option-type-line
-
- :ansible-option-type:`string`
-
- .. raw:: html
-
-
-
- The wait time to send a batch of new alerts for that group after the first notification was sent. Inherited from the parent policy if empty.
-
-
- .. rst-class:: ansible-option-line
-
- :ansible-option-default-bold:`Default:` :ansible-option-default:`"5m"`
-
- .. raw:: html
-
-
-
- * - .. raw:: html
-
-
-
-
- .. _ansible_collections.grafana.grafana.alert_notification_policy_module__parameter-groupwait:
-
- .. rst-class:: ansible-option-title
-
- **groupWait**
-
- .. raw:: html
-
-
-
- .. rst-class:: ansible-option-type-line
-
- :ansible-option-type:`string`
-
- .. raw:: html
-
-
-
- The wait time until the initial notification is sent for a new group created by an incoming alert. Inherited from the parent policy if empty.
-
-
- .. rst-class:: ansible-option-line
-
- :ansible-option-default-bold:`Default:` :ansible-option-default:`"30s"`
-
- .. raw:: html
-
-
-
- * - .. raw:: html
-
-
-
-
- .. _ansible_collections.grafana.grafana.alert_notification_policy_module__parameter-mutetimeintervals:
-
- .. rst-class:: ansible-option-title
-
- **MuteTimeIntervals**
-
- .. raw:: html
-
-
-
- .. rst-class:: ansible-option-type-line
-
- :ansible-option-type:`list` / :ansible-option-elements:`elements=string`
-
- .. raw:: html
-
-
-
- List of string.
-
- Add mute timing to policy
-
-
- .. rst-class:: ansible-option-line
-
- :ansible-option-default-bold:`Default:` :ansible-option-default:`[]`
-
- .. raw:: html
-
-
-
- * - .. raw:: html
-
-
-
-
- .. _ansible_collections.grafana.grafana.alert_notification_policy_module__parameter-objectmatchers:
-
- .. rst-class:: ansible-option-title
-
- **objectMatchers**
-
- .. raw:: html
-
-
-
- .. rst-class:: ansible-option-type-line
-
- :ansible-option-type:`string`
-
- .. raw:: html
-
-
-
- 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
-
-
-
- * - .. raw:: html
-
-
-
-
- .. _ansible_collections.grafana.grafana.alert_notification_policy_module__parameter-repeatinterval:
-
- .. rst-class:: ansible-option-title
-
- **repeatInterval**
-
- .. raw:: html
-
-
-
- .. rst-class:: ansible-option-type-line
-
- :ansible-option-type:`string`
-
- .. raw:: html
-
-
-
- The waiting time to resend an alert after they have successfully been sent.
-
-
- .. rst-class:: ansible-option-line
-
- :ansible-option-default-bold:`Default:` :ansible-option-default:`"4h"`
-
- .. raw:: html
-
-
-
- * - .. raw:: html
-
-
-
-
- .. _ansible_collections.grafana.grafana.alert_notification_policy_module__parameter-root_policy_receiver:
-
- .. rst-class:: ansible-option-title
-
- **root_policy_receiver**
-
- .. raw:: html
-
-
-
- .. rst-class:: ansible-option-type-line
-
- :ansible-option-type:`string`
-
- .. raw:: html
-
-
-
- Name of the contact point to set as the default receiver
-
-
- .. rst-class:: ansible-option-line
-
- :ansible-option-default-bold:`Default:` :ansible-option-default:`"grafana-default-email"`
-
- .. raw:: html
-
-
-
- * - .. raw:: html
-
-
-
-
- .. _ansible_collections.grafana.grafana.alert_notification_policy_module__parameter-routes:
-
- .. rst-class:: ansible-option-title
-
- **Routes**
-
- .. raw:: html
-
-
-
- .. rst-class:: ansible-option-type-line
-
- :ansible-option-type:`list` / :ansible-option-elements:`elements=string` / :ansible-option-required:`required`
-
- .. raw:: html
-
-
-
- List of objects
-
- A Route is a node that contains definitions of how to handle alerts.
-
-
- .. raw:: html
-
-
-
- * - .. raw:: html
-
-
-
-
- .. _ansible_collections.grafana.grafana.alert_notification_policy_module__parameter-stack_slug:
-
- .. rst-class:: ansible-option-title
-
- **stack_slug**
-
- .. raw:: html
-
-
-
- .. rst-class:: ansible-option-type-line
-
- :ansible-option-type:`string` / :ansible-option-required:`required`
-
- .. raw:: html
-
-
-
- Name of the Grafana Cloud stack to which the notification policies will be added
-
-
- .. raw:: html
-
-
-
-
-.. Attributes
-
-
-.. Notes
-
-
-.. Seealso
-
-
-.. Examples
-
-Examples
---------
-
-.. code-block:: yaml+jinja
-
-
- - name: Set Notification policy tree
- alert_notification_policy:
- stack_slug: "{{ stack_slug }}"
- grafana_api_key: "{{ grafana_api_key }}"
- routes: [
- {
- receiver: myReceiver,
- object_matchers: [["env", "=", "Production"]],
- }
- ]
-
- - name: Set nested Notification policies
- alert_notification_policy:
- routes: [
- {
- receiver: myReceiver,
- object_matchers: [["env", "=", "Production"],["team", "=", "ops"]],
- routes: [
- {
- receiver: myReceiver2,
- object_matchers: [["region", "=", "eu"]],
- }
- ]
- },
- {
- receiver: myReceiver3,
- object_matchers: [["env", "=", "Staging"]]
- }
- ]
- stack_slug: "{{ stack_slug }}"
- grafana_api_key: "{{ grafana_api_key }}"
-
-
-
-
-.. Facts
-
-
-.. Return values
-
-Return Values
--------------
-Common return values are documented :ref:`here `, 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
-
-
-
-
- .. _ansible_collections.grafana.grafana.alert_notification_policy_module__return-output:
-
- .. rst-class:: ansible-option-title
-
- **output**
-
- .. raw:: html
-
-
-
- .. rst-class:: ansible-option-type-line
-
- :ansible-option-type:`dictionary`
-
- .. raw:: html
-
-
-
- Dict object containing Notification tree information
-
-
- .. rst-class:: ansible-option-line
-
- :ansible-option-returned-bold:`Returned:` On success
-
-
- .. raw:: html
-
-
-
-
- * - .. raw:: html
-
-
-
-
- .. _ansible_collections.grafana.grafana.alert_notification_policy_module__return-output/group_interval:
-
- .. rst-class:: ansible-option-title
-
- **group_interval**
-
- .. raw:: html
-
-
-
- .. rst-class:: ansible-option-type-line
-
- :ansible-option-type:`string`
-
- .. raw:: html
-
-
-
- The waiting time to send a batch of new alerts for that group after the first notification was sent. This is of the parent policy.
-
-
- .. rst-class:: ansible-option-line
-
- :ansible-option-returned-bold:`Returned:` on success
-
-
- .. raw:: html
-
-
-
-
- * - .. raw:: html
-
-
-
-
- .. _ansible_collections.grafana.grafana.alert_notification_policy_module__return-output/group_wait:
-
- .. rst-class:: ansible-option-title
-
- **group_wait**
-
- .. raw:: html
-
-
-
- .. rst-class:: ansible-option-type-line
-
- :ansible-option-type:`string`
-
- .. raw:: html
-
-
-
- The waiting time until the initial notification is sent for a new group created by an incoming alert. This is of the parent policy.
-
-
- .. rst-class:: ansible-option-line
-
- :ansible-option-returned-bold:`Returned:` on success
-
-
- .. raw:: html
-
-
-
-
- * - .. raw:: html
-
-
-
-
- .. _ansible_collections.grafana.grafana.alert_notification_policy_module__return-output/provenance:
-
- .. rst-class:: ansible-option-title
-
- **provenance**
-
- .. raw:: html
-
-
-
- .. rst-class:: ansible-option-type-line
-
- :ansible-option-type:`string`
-
- .. raw:: html
-
-
-
-
- .. rst-class:: ansible-option-line
-
- :ansible-option-returned-bold:`Returned:` on success
-
-
- .. raw:: html
-
-
-
-
- * - .. raw:: html
-
-
-
-
- .. _ansible_collections.grafana.grafana.alert_notification_policy_module__return-output/receiver:
-
- .. rst-class:: ansible-option-title
-
- **receiver**
-
- .. raw:: html
-
-
-
- .. rst-class:: ansible-option-type-line
-
- :ansible-option-type:`string`
-
- .. raw:: html
-
-
-
- The name of the default contact point
-
-
- .. rst-class:: ansible-option-line
-
- :ansible-option-returned-bold:`Returned:` state is present and on success
-
-
- .. raw:: html
-
-
-
-
- * - .. raw:: html
-
-
-
-
- .. _ansible_collections.grafana.grafana.alert_notification_policy_module__return-output/repeat_interval:
-
- .. rst-class:: ansible-option-title
-
- **repeat_interval**
-
- .. raw:: html
-
-
-
- .. rst-class:: ansible-option-type-line
-
- :ansible-option-type:`string`
-
- .. raw:: html
-
-
-
- The waiting time to resend an alert after they have successfully been sent. This is of the parent policy
-
-
- .. rst-class:: ansible-option-line
-
- :ansible-option-returned-bold:`Returned:` on success
-
-
- .. raw:: html
-
-
-
-
- * - .. raw:: html
-
-
-
-
- .. _ansible_collections.grafana.grafana.alert_notification_policy_module__return-output/routes:
-
- .. rst-class:: ansible-option-title
-
- **routes**
-
- .. raw:: html
-
-
-
- .. rst-class:: ansible-option-type-line
-
- :ansible-option-type:`list` / :ansible-option-elements:`elements=string`
-
- .. raw:: html
-
-
-
- The entire notification tree returned as a list
-
-
- .. rst-class:: ansible-option-line
-
- :ansible-option-returned-bold:`Returned:` on success
-
-
- .. raw:: html
-
-
-
-
-
-
-.. Status (Presently only deprecated)
-
-
-.. Authors
-
-Authors
-~~~~~~~
-
-- Ishan Jain (@ishanjainn)
-
-
-
-.. Extra links
-
-Collection links
-~~~~~~~~~~~~~~~~
-
-.. raw:: html
-
-
- Issue Tracker
- Repository (Sources)
-
-
-.. Parsing errors
diff --git a/docs-rst/cloud_api_key_module.rst b/docs-rst/cloud_api_key_module.rst
deleted file mode 100644
index eda9529..0000000
--- a/docs-rst/cloud_api_key_module.rst
+++ /dev/null
@@ -1,372 +0,0 @@
-.. 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.cloud_api_key_module:
-
-.. Anchors: short name for ansible.builtin
-
-.. Anchors: aliases
-
-
-
-.. Title
-
-grafana.grafana.cloud_api_key module -- Manage Grafana Cloud API keys
-+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
-
-.. version_added
-
-.. versionadded:: 0.0.1 of grafana.grafana
-
-.. contents::
- :local:
- :depth: 1
-
-.. Deprecated
-
-
-Synopsis
---------
-
-.. Description
-
-- Create and delete Grafana Cloud API keys using Ansible.
-
-
-.. Aliases
-
-
-.. Requirements
-
-
-
-
-
-
-.. Options
-
-Parameters
-----------
-
-
-.. rst-class:: ansible-option-table
-
-.. list-table::
- :width: 100%
- :widths: auto
- :header-rows: 1
-
- * - Parameter
- - Comments
-
- * - .. raw:: html
-
-
-
-
- .. _ansible_collections.grafana.grafana.cloud_api_key_module__parameter-existing_cloud_api_key:
-
- .. rst-class:: ansible-option-title
-
- **existing_cloud_api_key**
-
- .. raw:: html
-
-
-
- .. rst-class:: ansible-option-type-line
-
- :ansible-option-type:`string` / :ansible-option-required:`required`
-
- .. raw:: html
-
-
-
- CLoud API Key to authenticate with Grafana Cloud.
-
-
- .. raw:: html
-
-
-
- * - .. raw:: html
-
-
-
-
- .. _ansible_collections.grafana.grafana.cloud_api_key_module__parameter-fail_if_already_created:
-
- .. rst-class:: ansible-option-title
-
- **fail_if_already_created**
-
- .. raw:: html
-
-
-
- .. rst-class:: ansible-option-type-line
-
- :ansible-option-type:`boolean`
-
- .. raw:: html
-
-
-
- If set to True, the task will fail if the API key with same name already exists in the Organization.
-
-
- .. rst-class:: ansible-option-line
-
- :ansible-option-choices:`Choices:`
-
- - :ansible-option-choices-entry:`no`
- - :ansible-option-default-bold:`yes` :ansible-option-default:`← (default)`
-
- .. raw:: html
-
-
-
- * - .. raw:: html
-
-
-
-
- .. _ansible_collections.grafana.grafana.cloud_api_key_module__parameter-name:
-
- .. rst-class:: ansible-option-title
-
- **name**
-
- .. raw:: html
-
-
-
- .. rst-class:: ansible-option-type-line
-
- :ansible-option-type:`string` / :ansible-option-required:`required`
-
- .. raw:: html
-
-
-
- Name of the Grafana Cloud API key.
-
-
- .. raw:: html
-
-
-
- * - .. raw:: html
-
-
-
-
- .. _ansible_collections.grafana.grafana.cloud_api_key_module__parameter-org_slug:
-
- .. rst-class:: ansible-option-title
-
- **org_slug**
-
- .. raw:: html
-
-
-
- .. rst-class:: ansible-option-type-line
-
- :ansible-option-type:`string` / :ansible-option-required:`required`
-
- .. raw:: html
-
-
-
- Name of the Grafana Cloud organization in which Cloud API key will be created
-
-
- .. raw:: html
-
-
-
- * - .. raw:: html
-
-
-
-
- .. _ansible_collections.grafana.grafana.cloud_api_key_module__parameter-role:
-
- .. rst-class:: ansible-option-title
-
- **role**
-
- .. raw:: html
-
-
-
- .. rst-class:: ansible-option-type-line
-
- :ansible-option-type:`string` / :ansible-option-required:`required`
-
- .. raw:: html
-
-
-
- Role to be associated with the CLoud API key.
-
-
- .. raw:: html
-
-
-
- * - .. raw:: html
-
-
-
-
- .. _ansible_collections.grafana.grafana.cloud_api_key_module__parameter-state:
-
- .. rst-class:: ansible-option-title
-
- **state**
-
- .. raw:: html
-
-
-
- .. rst-class:: ansible-option-type-line
-
- :ansible-option-type:`string`
-
- .. raw:: html
-
-
-
- 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
-
-
-
-
-.. Attributes
-
-
-.. Notes
-
-
-.. Seealso
-
-
-.. Examples
-
-Examples
---------
-
-.. code-block:: yaml+jinja
-
-
- - name: Create Grafana Cloud API key
- cloud_api_key:
- name: key_name
- role: Admin
- org_slug: "{{ org_slug }}"
- existing_cloud_api_key: "{{ grafana_cloud_api_key }}"
- fail_if_already_created: False
- state: present
-
- - name: Delete Grafana Cloud API key
- cloud_api_key:
- name: key_name
- org_slug: "{{ org_slug }}"
- existing_cloud_api_key: "{{ grafana_cloud_api_key }}"
- state: absent
-
-
-
-
-.. Facts
-
-
-.. Return values
-
-
-.. Status (Presently only deprecated)
-
-
-.. Authors
-
-Authors
-~~~~~~~
-
-- Ishan Jain (@ishanjainn)
-
-
-
-.. Extra links
-
-Collection links
-~~~~~~~~~~~~~~~~
-
-.. raw:: html
-
-
- Issue Tracker
- Repository (Sources)
-
-
-.. Parsing errors
diff --git a/docs-rst/cloud_plugin_module.rst b/docs-rst/cloud_plugin_module.rst
deleted file mode 100644
index 2a66851..0000000
--- a/docs-rst/cloud_plugin_module.rst
+++ /dev/null
@@ -1,548 +0,0 @@
-.. 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.cloud_plugin_module:
-
-.. Anchors: short name for ansible.builtin
-
-.. Anchors: aliases
-
-
-
-.. Title
-
-grafana.grafana.cloud_plugin module -- Manage Grafana Cloud Plugins
-+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
-
-.. version_added
-
-.. versionadded:: 0.0.1 of grafana.grafana
-
-.. contents::
- :local:
- :depth: 1
-
-.. Deprecated
-
-
-Synopsis
---------
-
-.. Description
-
-- Create, Update and delete Grafana Cloud stacks using Ansible.
-
-
-.. Aliases
-
-
-.. Requirements
-
-
-
-
-
-
-.. Options
-
-Parameters
-----------
-
-
-.. rst-class:: ansible-option-table
-
-.. list-table::
- :width: 100%
- :widths: auto
- :header-rows: 1
-
- * - Parameter
- - Comments
-
- * - .. raw:: html
-
-
-
-
- .. _ansible_collections.grafana.grafana.cloud_plugin_module__parameter-cloud_api_key:
-
- .. rst-class:: ansible-option-title
-
- **cloud_api_key**
-
- .. raw:: html
-
-
-
- .. rst-class:: ansible-option-type-line
-
- :ansible-option-type:`string` / :ansible-option-required:`required`
-
- .. raw:: html
-
-
-
- CLoud API Key to authenticate with Grafana Cloud.
-
-
- .. raw:: html
-
-
-
- * - .. raw:: html
-
-
-
-
- .. _ansible_collections.grafana.grafana.cloud_plugin_module__parameter-name:
-
- .. rst-class:: ansible-option-title
-
- **name**
-
- .. raw:: html
-
-
-
- .. rst-class:: ansible-option-type-line
-
- :ansible-option-type:`string` / :ansible-option-required:`required`
-
- .. raw:: html
-
-
-
- Name of the plugin, e.g. grafana-github-datasource .
-
-
- .. raw:: html
-
-
-
- * - .. raw:: html
-
-
-
-
- .. _ansible_collections.grafana.grafana.cloud_plugin_module__parameter-stack_slug:
-
- .. rst-class:: ansible-option-title
-
- **stack_slug**
-
- .. raw:: html
-
-
-
- .. rst-class:: ansible-option-type-line
-
- :ansible-option-type:`string` / :ansible-option-required:`required`
-
- .. raw:: html
-
-
-
- Name of the Grafana Cloud stack to which the plugin will be added
-
-
- .. raw:: html
-
-
-
- * - .. raw:: html
-
-
-
-
- .. _ansible_collections.grafana.grafana.cloud_plugin_module__parameter-state:
-
- .. rst-class:: ansible-option-title
-
- **state**
-
- .. raw:: html
-
-
-
- .. rst-class:: ansible-option-type-line
-
- :ansible-option-type:`string`
-
- .. raw:: html
-
-
-
- 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
-
-
-
- * - .. raw:: html
-
-
-
-
- .. _ansible_collections.grafana.grafana.cloud_plugin_module__parameter-version:
-
- .. rst-class:: ansible-option-title
-
- **version**
-
- .. raw:: html
-
-
-
- .. rst-class:: ansible-option-type-line
-
- :ansible-option-type:`string`
-
- .. raw:: html
-
-
-
- Version of the plugin to install. Defaults to latest.
-
-
- .. rst-class:: ansible-option-line
-
- :ansible-option-default-bold:`Default:` :ansible-option-default:`"latest"`
-
- .. raw:: html
-
-
-
-
-.. Attributes
-
-
-.. Notes
-
-
-.. Seealso
-
-
-.. Examples
-
-Examples
---------
-
-.. code-block:: yaml+jinja
-
-
- - name: Create/Update a plugin
- cloud_plugin:
- name: grafana-github-datasource
- version: 1.0.14
- stack_slug: "{{ stack_slug }}"
- cloud_api_key: "{{ grafana_cloud_api_key }}"
- state: present
-
- - name: Delete a Grafana Cloud stack
- cloud_plugin:
- name: grafana-github-datasource
- 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 `, 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
-
-
-
-
- .. _ansible_collections.grafana.grafana.cloud_plugin_module__return-current_version:
-
- .. rst-class:: ansible-option-title
-
- **current_version**
-
- .. raw:: html
-
-
-
- .. rst-class:: ansible-option-type-line
-
- :ansible-option-type:`string`
-
- .. raw:: html
-
-
-
- Current version of the plugin
-
-
- .. rst-class:: ansible-option-line
-
- :ansible-option-returned-bold:`Returned:` On success
-
-
- .. raw:: html
-
-
-
-
- * - .. raw:: html
-
-
-
-
- .. _ansible_collections.grafana.grafana.cloud_plugin_module__return-latest_version:
-
- .. rst-class:: ansible-option-title
-
- **latest_version**
-
- .. raw:: html
-
-
-
- .. rst-class:: ansible-option-type-line
-
- :ansible-option-type:`string`
-
- .. raw:: html
-
-
-
- Latest version available for the plugin
-
-
- .. rst-class:: ansible-option-line
-
- :ansible-option-returned-bold:`Returned:` On success
-
-
- .. raw:: html
-
-
-
-
- * - .. raw:: html
-
-
-
-
- .. _ansible_collections.grafana.grafana.cloud_plugin_module__return-pluginid:
-
- .. rst-class:: ansible-option-title
-
- **pluginId**
-
- .. raw:: html
-
-
-
- .. rst-class:: ansible-option-type-line
-
- :ansible-option-type:`integer`
-
- .. raw:: html
-
-
-
- Id for the Plugin
-
-
- .. rst-class:: ansible-option-line
-
- :ansible-option-returned-bold:`Returned:` On success
-
-
- .. raw:: html
-
-
-
-
- * - .. raw:: html
-
-
-
-
- .. _ansible_collections.grafana.grafana.cloud_plugin_module__return-pluginname:
-
- .. rst-class:: ansible-option-title
-
- **pluginName**
-
- .. raw:: html
-
-
-
- .. rst-class:: ansible-option-type-line
-
- :ansible-option-type:`string`
-
- .. raw:: html
-
-
-
- Name of the plugin
-
-
- .. rst-class:: ansible-option-line
-
- :ansible-option-returned-bold:`Returned:` On success
-
-
- .. raw:: html
-
-
-
-
- * - .. raw:: html
-
-
-
-
- .. _ansible_collections.grafana.grafana.cloud_plugin_module__return-pluginslug:
-
- .. rst-class:: ansible-option-title
-
- **pluginSlug**
-
- .. raw:: html
-
-
-
- .. rst-class:: ansible-option-type-line
-
- :ansible-option-type:`string`
-
- .. raw:: html
-
-
-
- Slug for the Plugin
-
-
- .. rst-class:: ansible-option-line
-
- :ansible-option-returned-bold:`Returned:` On success
-
-
- .. raw:: html
-
-
-
-
-
-.. Status (Presently only deprecated)
-
-
-.. Authors
-
-Authors
-~~~~~~~
-
-- Ishan Jain (@ishanjainn)
-
-
-
-.. Extra links
-
-Collection links
-~~~~~~~~~~~~~~~~
-
-.. raw:: html
-
-
- Issue Tracker
- Repository (Sources)
-
-
-.. Parsing errors
diff --git a/docs-rst/cloud_stack_module.rst b/docs-rst/cloud_stack_module.rst
deleted file mode 100644
index f8b616b..0000000
--- a/docs-rst/cloud_stack_module.rst
+++ /dev/null
@@ -1,790 +0,0 @@
-.. 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.cloud_stack_module:
-
-.. Anchors: short name for ansible.builtin
-
-.. Anchors: aliases
-
-
-
-.. Title
-
-grafana.grafana.cloud_stack module -- Manage Grafana Cloud stack
-++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
-
-.. version_added
-
-.. versionadded:: 0.0.1 of grafana.grafana
-
-.. contents::
- :local:
- :depth: 1
-
-.. Deprecated
-
-
-Synopsis
---------
-
-.. Description
-
-- Create and delete Grafana Cloud stacks using Ansible.
-
-
-.. Aliases
-
-
-.. Requirements
-
-
-
-
-
-
-.. Options
-
-Parameters
-----------
-
-
-.. rst-class:: ansible-option-table
-
-.. list-table::
- :width: 100%
- :widths: auto
- :header-rows: 1
-
- * - Parameter
- - Comments
-
- * - .. raw:: html
-
-
-
-
- .. _ansible_collections.grafana.grafana.cloud_stack_module__parameter-cloud_api_key:
-
- .. rst-class:: ansible-option-title
-
- **cloud_api_key**
-
- .. raw:: html
-
-
-
- .. rst-class:: ansible-option-type-line
-
- :ansible-option-type:`string` / :ansible-option-required:`required`
-
- .. raw:: html
-
-
-
- CLoud API Key to authenticate with Grafana Cloud.
-
-
- .. raw:: html
-
-
-
- * - .. raw:: html
-
-
-
-
- .. _ansible_collections.grafana.grafana.cloud_stack_module__parameter-name:
-
- .. rst-class:: ansible-option-title
-
- **name**
-
- .. raw:: html
-
-
-
- .. rst-class:: ansible-option-type-line
-
- :ansible-option-type:`string` / :ansible-option-required:`required`
-
- .. raw:: html
-
-
-
- Name of stack. Conventionally matches the URL of the instance. For example, ".grafana.net".
-
-
- .. raw:: html
-
-
-
- * - .. raw:: html
-
-
-
-
- .. _ansible_collections.grafana.grafana.cloud_stack_module__parameter-org_slug:
-
- .. rst-class:: ansible-option-title
-
- **org_slug**
-
- .. raw:: html
-
-
-
- .. rst-class:: ansible-option-type-line
-
- :ansible-option-type:`string`
-
- .. raw:: html
-
-
-
- Name of the organization under which Cloud stack is created.
-
-
- .. raw:: html
-
-
-
- * - .. raw:: html
-
-
-
-
- .. _ansible_collections.grafana.grafana.cloud_stack_module__parameter-region:
-
- .. rst-class:: ansible-option-title
-
- **region**
-
- .. raw:: html
-
-
-
- .. rst-class:: ansible-option-type-line
-
- :ansible-option-type:`string`
-
- .. raw:: html
-
-
-
- Choose a region for your stack.
-
-
- .. rst-class:: ansible-option-line
-
- :ansible-option-choices:`Choices:`
-
- - :ansible-option-default-bold:`us` :ansible-option-default:`← (default)`
- - :ansible-option-choices-entry:`us-azure`
- - :ansible-option-choices-entry:`eu`
- - :ansible-option-choices-entry:`au`
- - :ansible-option-choices-entry:`eu-azure`
- - :ansible-option-choices-entry:`prod-ap-southeast-0`
- - :ansible-option-choices-entry:`prod-gb-south-0`
- - :ansible-option-choices-entry:`prod-eu-west-3`
-
- .. raw:: html
-
-
-
- * - .. raw:: html
-
-
-
-
- .. _ansible_collections.grafana.grafana.cloud_stack_module__parameter-stack_slug:
-
- .. rst-class:: ansible-option-title
-
- **stack_slug**
-
- .. raw:: html
-
-
-
- .. rst-class:: ansible-option-type-line
-
- :ansible-option-type:`string` / :ansible-option-required:`required`
-
- .. raw:: html
-
-
-
- Subdomain of the Grafana instance. For example, if slug is , the instance URL will be https://.grafana.net
-
-
- .. raw:: html
-
-
-
- * - .. raw:: html
-
-
-
-
- .. _ansible_collections.grafana.grafana.cloud_stack_module__parameter-state:
-
- .. rst-class:: ansible-option-title
-
- **state**
-
- .. raw:: html
-
-
-
- .. rst-class:: ansible-option-type-line
-
- :ansible-option-type:`string`
-
- .. raw:: html
-
-
-
- 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
-
-
-
- * - .. raw:: html
-
-
-
-
- .. _ansible_collections.grafana.grafana.cloud_stack_module__parameter-url:
-
- .. rst-class:: ansible-option-title
-
- **url**
-
- .. raw:: html
-
-
-
- .. rst-class:: ansible-option-type-line
-
- :ansible-option-type:`string`
-
- .. raw:: html
-
-
-
- If you use a custom domain for the instance, you can provide it here. For example, “https://grafana.yourdoman.io”.
-
-
- .. rst-class:: ansible-option-line
-
- :ansible-option-default-bold:`Default:` :ansible-option-default:`"https://\.grafana.net"`
-
- .. raw:: html
-
-
-
-
-.. Attributes
-
-
-.. Notes
-
-
-.. Seealso
-
-
-.. Examples
-
-Examples
---------
-
-.. code-block:: yaml+jinja
-
-
- - name: Create a Grafana Cloud stack
- cloud_stack:
- name: company_name
- slug: company_name
- cloud_api_key: "{{ grafana_cloud_api_key }}"
- region: eu
- url: https://grafana.company_name.com
- state: present
-
- - name: Delete a Grafana Cloud stack
- cloud_stack:
- name: company_name
- slug: company_name
- cloud_api_key: "{{ grafana_cloud_api_key }}"
- state: absent
-
-
-
-
-.. Facts
-
-
-.. Return values
-
-Return Values
--------------
-Common return values are documented :ref:`here `, 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
-
-
-
-
- .. _ansible_collections.grafana.grafana.cloud_stack_module__return-alertmanager_name:
-
- .. rst-class:: ansible-option-title
-
- **alertmanager_name**
-
- .. raw:: html
-
-
-
- .. rst-class:: ansible-option-type-line
-
- :ansible-option-type:`string`
-
- .. raw:: html
-
-
-
- Name of the alertmanager instance
-
-
- .. rst-class:: ansible-option-line
-
- :ansible-option-returned-bold:`Returned:` always
-
-
- .. raw:: html
-
-
-
-
- * - .. raw:: html
-
-
-
-
- .. _ansible_collections.grafana.grafana.cloud_stack_module__return-alertmanager_url:
-
- .. rst-class:: ansible-option-title
-
- **alertmanager_url**
-
- .. raw:: html
-
-
-
- .. rst-class:: ansible-option-type-line
-
- :ansible-option-type:`string`
-
- .. raw:: html
-
-
-
- URL of the alertmanager instance
-
-
- .. rst-class:: ansible-option-line
-
- :ansible-option-returned-bold:`Returned:` always
-
-
- .. raw:: html
-
-
-
-
- * - .. raw:: html
-
-
-
-
- .. _ansible_collections.grafana.grafana.cloud_stack_module__return-cluster_slug:
-
- .. rst-class:: ansible-option-title
-
- **cluster_slug**
-
- .. raw:: html
-
-
-
- .. rst-class:: ansible-option-type-line
-
- :ansible-option-type:`string`
-
- .. raw:: html
-
-
-
- Slug for the cluster where the Grafana stack is deployed
-
-
- .. rst-class:: ansible-option-line
-
- :ansible-option-returned-bold:`Returned:` always
-
-
- .. raw:: html
-
-
-
-
- * - .. raw:: html
-
-
-
-
- .. _ansible_collections.grafana.grafana.cloud_stack_module__return-id:
-
- .. rst-class:: ansible-option-title
-
- **id**
-
- .. raw:: html
-
-
-
- .. rst-class:: ansible-option-type-line
-
- :ansible-option-type:`integer`
-
- .. raw:: html
-
-
-
- ID of the Grafana Cloud stack
-
-
- .. rst-class:: ansible-option-line
-
- :ansible-option-returned-bold:`Returned:` always
-
-
- .. raw:: html
-
-
-
-
- * - .. raw:: html
-
-
-
-
- .. _ansible_collections.grafana.grafana.cloud_stack_module__return-loki_url:
-
- .. rst-class:: ansible-option-title
-
- **loki_url**
-
- .. raw:: html
-
-
-
- .. rst-class:: ansible-option-type-line
-
- :ansible-option-type:`string`
-
- .. raw:: html
-
-
-
- URl for the Loki instance
-
-
- .. rst-class:: ansible-option-line
-
- :ansible-option-returned-bold:`Returned:` always
-
-
- .. raw:: html
-
-
-
-
- * - .. raw:: html
-
-
-
-
- .. _ansible_collections.grafana.grafana.cloud_stack_module__return-orgid:
-
- .. rst-class:: ansible-option-title
-
- **orgID**
-
- .. raw:: html
-
-
-
- .. rst-class:: ansible-option-type-line
-
- :ansible-option-type:`integer`
-
- .. raw:: html
-
-
-
- ID of the Grafana Cloud organization
-
-
- .. rst-class:: ansible-option-line
-
- :ansible-option-returned-bold:`Returned:` always
-
-
- .. raw:: html
-
-
-
-
- * - .. raw:: html
-
-
-
-
- .. _ansible_collections.grafana.grafana.cloud_stack_module__return-prometheus_url:
-
- .. rst-class:: ansible-option-title
-
- **prometheus_url**
-
- .. raw:: html
-
-
-
- .. rst-class:: ansible-option-type-line
-
- :ansible-option-type:`string`
-
- .. raw:: html
-
-
-
- URl for the Prometheus instance
-
-
- .. rst-class:: ansible-option-line
-
- :ansible-option-returned-bold:`Returned:` always
-
-
- .. raw:: html
-
-
-
-
- * - .. raw:: html
-
-
-
-
- .. _ansible_collections.grafana.grafana.cloud_stack_module__return-tempo_url:
-
- .. rst-class:: ansible-option-title
-
- **tempo_url**
-
- .. raw:: html
-
-
-
- .. rst-class:: ansible-option-type-line
-
- :ansible-option-type:`string`
-
- .. raw:: html
-
-
-
- URl for the Tempo instance
-
-
- .. rst-class:: ansible-option-line
-
- :ansible-option-returned-bold:`Returned:` always
-
-
- .. raw:: html
-
-
-
-
- * - .. raw:: html
-
-
-
-
- .. _ansible_collections.grafana.grafana.cloud_stack_module__return-url:
-
- .. rst-class:: ansible-option-title
-
- **url**
-
- .. raw:: html
-
-
-
- .. rst-class:: ansible-option-type-line
-
- :ansible-option-type:`string`
-
- .. raw:: html
-
-
-
- URL of the Grafana Cloud stack
-
-
- .. rst-class:: ansible-option-line
-
- :ansible-option-returned-bold:`Returned:` always
-
-
- .. raw:: html
-
-
-
-
-
-.. Status (Presently only deprecated)
-
-
-.. Authors
-
-Authors
-~~~~~~~
-
-- Ishan Jain (@ishanjainn)
-
-
-
-.. Extra links
-
-Collection links
-~~~~~~~~~~~~~~~~
-
-.. raw:: html
-
-
- Issue Tracker
- Repository (Sources)
-
-
-.. Parsing errors
diff --git a/docs-rst/dashboard_module.rst b/docs-rst/dashboard_module.rst
deleted file mode 100644
index cea3df3..0000000
--- a/docs-rst/dashboard_module.rst
+++ /dev/null
@@ -1,670 +0,0 @@
-.. 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
-
-
-
-
- .. _ansible_collections.grafana.grafana.dashboard_module__parameter-cloud_api_key:
-
- .. rst-class:: ansible-option-title
-
- **cloud_api_key**
-
- .. raw:: html
-
-
-
- .. rst-class:: ansible-option-type-line
-
- :ansible-option-type:`string` / :ansible-option-required:`required`
-
- .. raw:: html
-
-
-
- CLoud API Key to authenticate with Grafana Cloud.
-
-
- .. raw:: html
-
-
-
- * - .. raw:: html
-
-
-
-
- .. _ansible_collections.grafana.grafana.dashboard_module__parameter-dashboard:
-
- .. rst-class:: ansible-option-title
-
- **dashboard**
-
- .. raw:: html
-
-
-
- .. rst-class:: ansible-option-type-line
-
- :ansible-option-type:`dictionary` / :ansible-option-required:`required`
-
- .. raw:: html
-
-
-
- JSON source code for dashboard
-
-
- .. raw:: html
-
-
-
- * - .. raw:: html
-
-
-
-
- .. _ansible_collections.grafana.grafana.dashboard_module__parameter-stack_slug:
-
- .. rst-class:: ansible-option-title
-
- **stack_slug**
-
- .. raw:: html
-
-
-
- .. rst-class:: ansible-option-type-line
-
- :ansible-option-type:`string` / :ansible-option-required:`required`
-
- .. raw:: html
-
-
-
- Name of the Grafana Cloud stack to which the notification policies will be added
-
-
- .. raw:: html
-
-
-
- * - .. raw:: html
-
-
-
-
- .. _ansible_collections.grafana.grafana.dashboard_module__parameter-state:
-
- .. rst-class:: ansible-option-title
-
- **state**
-
- .. raw:: html
-
-
-
- .. rst-class:: ansible-option-type-line
-
- :ansible-option-type:`string`
-
- .. raw:: html
-
-
-
- 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
-
-
-
-
-.. 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 `, 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
-
-
-
-
- .. _ansible_collections.grafana.grafana.dashboard_module__return-output:
-
- .. rst-class:: ansible-option-title
-
- **output**
-
- .. raw:: html
-
-
-
- .. rst-class:: ansible-option-type-line
-
- :ansible-option-type:`dictionary`
-
- .. raw:: html
-
-
-
- Dict object containing folder information
-
-
- .. rst-class:: ansible-option-line
-
- :ansible-option-returned-bold:`Returned:` On success
-
-
- .. raw:: html
-
-
-
-
- * - .. raw:: html
-
-
-
-
- .. _ansible_collections.grafana.grafana.dashboard_module__return-output/id:
-
- .. rst-class:: ansible-option-title
-
- **id**
-
- .. raw:: html
-
-
-
- .. rst-class:: ansible-option-type-line
-
- :ansible-option-type:`integer`
-
- .. raw:: html
-
-
-
- The ID for the dashboard
-
-
- .. rst-class:: ansible-option-line
-
- :ansible-option-returned-bold:`Returned:` on success
-
-
- .. raw:: html
-
-
-
-
- * - .. raw:: html
-
-
-
-
- .. _ansible_collections.grafana.grafana.dashboard_module__return-output/message:
-
- .. rst-class:: ansible-option-title
-
- **message**
-
- .. raw:: html
-
-
-
- .. rst-class:: ansible-option-type-line
-
- :ansible-option-type:`string`
-
- .. raw:: html
-
-
-
- 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
-
-
-
-
- * - .. raw:: html
-
-
-
-
- .. _ansible_collections.grafana.grafana.dashboard_module__return-output/slug:
-
- .. rst-class:: ansible-option-title
-
- **slug**
-
- .. raw:: html
-
-
-
- .. rst-class:: ansible-option-type-line
-
- :ansible-option-type:`string`
-
- .. raw:: html
-
-
-
- The slug for the dashboard
-
-
- .. rst-class:: ansible-option-line
-
- :ansible-option-returned-bold:`Returned:` state is present and on success
-
-
- .. raw:: html
-
-
-
-
- * - .. raw:: html
-
-
-
-
- .. _ansible_collections.grafana.grafana.dashboard_module__return-output/status:
-
- .. rst-class:: ansible-option-title
-
- **status**
-
- .. raw:: html
-
-
-
- .. rst-class:: ansible-option-type-line
-
- :ansible-option-type:`string`
-
- .. raw:: html
-
-
-
- The status of the dashboard
-
-
- .. rst-class:: ansible-option-line
-
- :ansible-option-returned-bold:`Returned:` state is present and on success
-
-
- .. raw:: html
-
-
-
-
- * - .. raw:: html
-
-
-
-
- .. _ansible_collections.grafana.grafana.dashboard_module__return-output/title:
-
- .. rst-class:: ansible-option-title
-
- **title**
-
- .. raw:: html
-
-
-
- .. rst-class:: ansible-option-type-line
-
- :ansible-option-type:`string`
-
- .. raw:: html
-
-
-
- The name of the dashboard
-
-
- .. rst-class:: ansible-option-line
-
- :ansible-option-returned-bold:`Returned:` state is absent and on success
-
-
- .. raw:: html
-
-
-
-
- * - .. raw:: html
-
-
-
-
- .. _ansible_collections.grafana.grafana.dashboard_module__return-output/uid:
-
- .. rst-class:: ansible-option-title
-
- **uid**
-
- .. raw:: html
-
-
-
- .. rst-class:: ansible-option-type-line
-
- :ansible-option-type:`string`
-
- .. raw:: html
-
-
-
- The UID for the dashboard
-
-
- .. rst-class:: ansible-option-line
-
- :ansible-option-returned-bold:`Returned:` state is present and on success
-
-
- .. raw:: html
-
-
-
-
- * - .. raw:: html
-
-
-
-
- .. _ansible_collections.grafana.grafana.dashboard_module__return-output/url:
-
- .. rst-class:: ansible-option-title
-
- **url**
-
- .. raw:: html
-
-
-
- .. rst-class:: ansible-option-type-line
-
- :ansible-option-type:`string`
-
- .. raw:: html
-
-
-
- The endpoint for the dashboard
-
-
- .. rst-class:: ansible-option-line
-
- :ansible-option-returned-bold:`Returned:` state is present and on success
-
-
- .. raw:: html
-
-
-
-
- * - .. raw:: html
-
-
-
-
- .. _ansible_collections.grafana.grafana.dashboard_module__return-output/version:
-
- .. rst-class:: ansible-option-title
-
- **version**
-
- .. raw:: html
-
-
-
- .. rst-class:: ansible-option-type-line
-
- :ansible-option-type:`integer`
-
- .. raw:: html
-
-
-
- The version of the dashboard
-
-
- .. rst-class:: ansible-option-line
-
- :ansible-option-returned-bold:`Returned:` state is present and on success
-
-
- .. raw:: html
-
-
-
-
-
-
-.. Status (Presently only deprecated)
-
-
-.. Authors
-
-Authors
-~~~~~~~
-
-- Ishan Jain (@ishanjainn)
-
-
-
-.. Extra links
-
-Collection links
-~~~~~~~~~~~~~~~~
-
-.. raw:: html
-
-
- Issue Tracker
- Repository (Sources)
-
-
-.. Parsing errors
diff --git a/docs-rst/datasource_module.rst b/docs-rst/datasource_module.rst
deleted file mode 100644
index cb21849..0000000
--- a/docs-rst/datasource_module.rst
+++ /dev/null
@@ -1,510 +0,0 @@
-.. 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.datasource_module:
-
-.. Anchors: short name for ansible.builtin
-
-.. Anchors: aliases
-
-
-
-.. Title
-
-grafana.grafana.datasource module -- Manage Data sources in Grafana
-+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
-
-.. version_added
-
-.. versionadded:: 0.0.1 of grafana.grafana
-
-.. contents::
- :local:
- :depth: 1
-
-.. Deprecated
-
-
-Synopsis
---------
-
-.. Description
-
-- Create, Update and delete Data sources using Ansible.
-
-
-.. Aliases
-
-
-.. Requirements
-
-
-
-
-
-
-.. Options
-
-Parameters
-----------
-
-
-.. rst-class:: ansible-option-table
-
-.. list-table::
- :width: 100%
- :widths: auto
- :header-rows: 1
-
- * - Parameter
- - Comments
-
- * - .. raw:: html
-
-
-
-
- .. _ansible_collections.grafana.grafana.datasource_module__parameter-cloud_api_key:
-
- .. rst-class:: ansible-option-title
-
- **cloud_api_key**
-
- .. raw:: html
-
-
-
- .. rst-class:: ansible-option-type-line
-
- :ansible-option-type:`string` / :ansible-option-required:`required`
-
- .. raw:: html
-
-
-
- CLoud API Key to authenticate with Grafana Cloud.
-
-
- .. raw:: html
-
-
-
- * - .. raw:: html
-
-
-
-
- .. _ansible_collections.grafana.grafana.datasource_module__parameter-datasource:
-
- .. rst-class:: ansible-option-title
-
- **datasource**
-
- .. raw:: html
-
-
-
- .. rst-class:: ansible-option-type-line
-
- :ansible-option-type:`dictionary` / :ansible-option-required:`required`
-
- .. raw:: html
-
-
-
- JSON source code for the Data source
-
-
- .. raw:: html
-
-
-
- * - .. raw:: html
-
-
-
-
- .. _ansible_collections.grafana.grafana.datasource_module__parameter-stack_slug:
-
- .. rst-class:: ansible-option-title
-
- **stack_slug**
-
- .. raw:: html
-
-
-
- .. rst-class:: ansible-option-type-line
-
- :ansible-option-type:`string` / :ansible-option-required:`required`
-
- .. raw:: html
-
-
-
- Name of the Grafana Cloud stack to which the notification policies will be added
-
-
- .. raw:: html
-
-
-
- * - .. raw:: html
-
-
-
-
- .. _ansible_collections.grafana.grafana.datasource_module__parameter-state:
-
- .. rst-class:: ansible-option-title
-
- **state**
-
- .. raw:: html
-
-
-
- .. rst-class:: ansible-option-type-line
-
- :ansible-option-type:`string`
-
- .. raw:: html
-
-
-
- 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
-
-
-
-
-.. Attributes
-
-
-.. Notes
-
-
-.. Seealso
-
-
-.. Examples
-
-Examples
---------
-
-.. code-block:: yaml+jinja
-
-
- - name: Create/Update Data sources
- datasource:
- datasource: "{{ lookup('file', 'datasource.json') }}"
- stack_slug: "{{ stack_slug }}"
- cloud_api_key: "{{ grafana_cloud_api_key }}"
- state: present
-
- - name: Delete Data sources
- datasource:
- datasource: "{{ lookup('file', 'datasource.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 `, 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
-
-
-
-
- .. _ansible_collections.grafana.grafana.datasource_module__return-output:
-
- .. rst-class:: ansible-option-title
-
- **output**
-
- .. raw:: html
-
-
-
- .. rst-class:: ansible-option-type-line
-
- :ansible-option-type:`dictionary`
-
- .. raw:: html
-
-
-
- Dict object containing Data source information
-
-
- .. rst-class:: ansible-option-line
-
- :ansible-option-returned-bold:`Returned:` On success
-
-
- .. raw:: html
-
-
-
-
- * - .. raw:: html
-
-
-
-
- .. _ansible_collections.grafana.grafana.datasource_module__return-output/datasource:
-
- .. rst-class:: ansible-option-title
-
- **datasource**
-
- .. raw:: html
-
-
-
- .. rst-class:: ansible-option-type-line
-
- :ansible-option-type:`dictionary`
-
- .. raw:: html
-
-
-
- The response body content for the data source configuration.
-
-
- .. rst-class:: ansible-option-line
-
- :ansible-option-returned-bold:`Returned:` state is present and on success
-
-
- .. raw:: html
-
-
-
-
- * - .. raw:: html
-
-
-
-
- .. _ansible_collections.grafana.grafana.datasource_module__return-output/id:
-
- .. rst-class:: ansible-option-title
-
- **id**
-
- .. raw:: html
-
-
-
- .. rst-class:: ansible-option-type-line
-
- :ansible-option-type:`integer`
-
- .. raw:: html
-
-
-
- The ID assigned to the data source
-
-
- .. rst-class:: ansible-option-line
-
- :ansible-option-returned-bold:`Returned:` on success
-
-
- .. raw:: html
-
-
-
-
- * - .. raw:: html
-
-
-
-
- .. _ansible_collections.grafana.grafana.datasource_module__return-output/message:
-
- .. rst-class:: ansible-option-title
-
- **message**
-
- .. raw:: html
-
-
-
- .. rst-class:: ansible-option-type-line
-
- :ansible-option-type:`string`
-
- .. raw:: html
-
-
-
- The message returned after the operation on the Data source
-
-
- .. rst-class:: ansible-option-line
-
- :ansible-option-returned-bold:`Returned:` on success
-
-
- .. raw:: html
-
-
-
-
- * - .. raw:: html
-
-
-
-
- .. _ansible_collections.grafana.grafana.datasource_module__return-output/name:
-
- .. rst-class:: ansible-option-title
-
- **name**
-
- .. raw:: html
-
-
-
- .. rst-class:: ansible-option-type-line
-
- :ansible-option-type:`string`
-
- .. raw:: html
-
-
-
- The name of the data source defined in the JSON source code
-
-
- .. rst-class:: ansible-option-line
-
- :ansible-option-returned-bold:`Returned:` state is present and on success
-
-
- .. raw:: html
-
-
-
-
-
-
-.. Status (Presently only deprecated)
-
-
-.. Authors
-
-Authors
-~~~~~~~
-
-- Ishan Jain (@ishanjainn)
-
-
-
-.. Extra links
-
-Collection links
-~~~~~~~~~~~~~~~~
-
-.. raw:: html
-
-
- Issue Tracker
- Repository (Sources)
-
-
-.. Parsing errors
diff --git a/docs-rst/folder_module.rst b/docs-rst/folder_module.rst
deleted file mode 100644
index e497a2e..0000000
--- a/docs-rst/folder_module.rst
+++ /dev/null
@@ -1,991 +0,0 @@
-
-.. 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.folder_module:
-
-.. Anchors: short name for ansible.builtin
-
-.. Anchors: aliases
-
-
-
-.. Title
-
-grafana.grafana.folder module -- Manage Folders in Grafana
-++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
-
-.. version_added
-
-.. versionadded:: 0.0.1 of grafana.grafana
-
-.. contents::
- :local:
- :depth: 1
-
-.. Deprecated
-
-
-Synopsis
---------
-
-.. Description
-
-- Create, Update and delete Folders via Ansible.
-
-
-.. Aliases
-
-
-.. Requirements
-
-
-
-
-
-
-.. Options
-
-Parameters
-----------
-
-
-.. rst-class:: ansible-option-table
-
-.. list-table::
- :width: 100%
- :widths: auto
- :header-rows: 1
-
- * - Parameter
- - Comments
-
- * - .. raw:: html
-
-
-
-
- .. _ansible_collections.grafana.grafana.folder_module__parameter-cloud_api_key:
-
- .. rst-class:: ansible-option-title
-
- **cloud_api_key**
-
- .. raw:: html
-
-
-
- .. rst-class:: ansible-option-type-line
-
- :ansible-option-type:`string` / :ansible-option-required:`required`
-
- .. raw:: html
-
-
-
- CLoud API Key to authenticate with Grafana Cloud.
-
-
- .. raw:: html
-
-
-
- * - .. raw:: html
-
-
-
-
- .. _ansible_collections.grafana.grafana.folder_module__parameter-overwrite:
-
- .. rst-class:: ansible-option-title
-
- **overwrite**
-
- .. raw:: html
-
-
-
- .. rst-class:: ansible-option-type-line
-
- :ansible-option-type:`string`
-
- .. raw:: html
-
-
-
- Set to false if you dont want to overwrite existing folder with newer version.
-
-
- .. rst-class:: ansible-option-line
-
- :ansible-option-default-bold:`Default:` :ansible-option-default:`"yes"`
-
- .. raw:: html
-
-
-
- * - .. raw:: html
-
-
-
-
- .. _ansible_collections.grafana.grafana.folder_module__parameter-state:
-
- .. rst-class:: ansible-option-title
-
- **state**
-
- .. raw:: html
-
-
-
- .. rst-class:: ansible-option-type-line
-
- :ansible-option-type:`string`
-
- .. raw:: html
-
-
-
- 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
-
-
-
- * - .. raw:: html
-
-
-
-
- .. _ansible_collections.grafana.grafana.folder_module__parameter-title:
-
- .. rst-class:: ansible-option-title
-
- **title**
-
- .. raw:: html
-
-
-
- .. rst-class:: ansible-option-type-line
-
- :ansible-option-type:`string` / :ansible-option-required:`required`
-
- .. raw:: html
-
-
-
- The title of the folder.
-
-
- .. raw:: html
-
-
-
- * - .. raw:: html
-
-
-
-
- .. _ansible_collections.grafana.grafana.folder_module__parameter-uid:
-
- .. rst-class:: ansible-option-title
-
- **uid**
-
- .. raw:: html
-
-
-
- .. rst-class:: ansible-option-type-line
-
- :ansible-option-type:`string` / :ansible-option-required:`required`
-
- .. raw:: html
-
-
-
- unique identifier for your folder.
-
-
- .. raw:: html
-
-
-
-
-.. Attributes
-
-
-.. Notes
-
-
-.. Seealso
-
-
-.. Examples
-
-Examples
---------
-
-.. code-block:: yaml+jinja
-
-
- - name: Create/Update a Folder in Grafana
- folder:
- title: folder_name
- uid: folder_name
- overwrite: true
- stack_slug: "{{ stack_slug }}"
- cloud_api_key: "{{ grafana_cloud_api_key }}"
- state: present
-
- - name: Delete a Folder in Grafana
- folder:
- uid: folder_name
- 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 `, 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
-
-
-
-
- .. _ansible_collections.grafana.grafana.folder_module__return-output:
-
- .. rst-class:: ansible-option-title
-
- **output**
-
- .. raw:: html
-
-
-
- .. rst-class:: ansible-option-type-line
-
- :ansible-option-type:`dictionary`
-
- .. raw:: html
-
-
-
- Dict object containing folder information
-
-
- .. rst-class:: ansible-option-line
-
- :ansible-option-returned-bold:`Returned:` On success
-
-
- .. raw:: html
-
-
-
-
- * - .. raw:: html
-
-
-
-
- .. _ansible_collections.grafana.grafana.folder_module__return-output/canadmin:
-
- .. rst-class:: ansible-option-title
-
- **canAdmin**
-
- .. raw:: html
-
-
-
- .. rst-class:: ansible-option-type-line
-
- :ansible-option-type:`boolean`
-
- .. raw:: html
-
-
-
- Boolean value specifying if current user can admin in folder
-
-
- .. rst-class:: ansible-option-line
-
- :ansible-option-returned-bold:`Returned:` state is present and on success
-
-
- .. raw:: html
-
-
-
-
- * - .. raw:: html
-
-
-
-
- .. _ansible_collections.grafana.grafana.folder_module__return-output/candelete:
-
- .. rst-class:: ansible-option-title
-
- **canDelete**
-
- .. raw:: html
-
-
-
- .. rst-class:: ansible-option-type-line
-
- :ansible-option-type:`boolean`
-
- .. raw:: html
-
-
-
- Boolean value specifying if current user can delete the folder
-
-
- .. rst-class:: ansible-option-line
-
- :ansible-option-returned-bold:`Returned:` state is present and on success
-
-
- .. raw:: html
-
-
-
-
- * - .. raw:: html
-
-
-
-
- .. _ansible_collections.grafana.grafana.folder_module__return-output/canedit:
-
- .. rst-class:: ansible-option-title
-
- **canEdit**
-
- .. raw:: html
-
-
-
- .. rst-class:: ansible-option-type-line
-
- :ansible-option-type:`boolean`
-
- .. raw:: html
-
-
-
- Boolean value specifying if current user can edit in folder
-
-
- .. rst-class:: ansible-option-line
-
- :ansible-option-returned-bold:`Returned:` state is present and on success
-
-
- .. raw:: html
-
-
-
-
- * - .. raw:: html
-
-
-
-
- .. _ansible_collections.grafana.grafana.folder_module__return-output/cansave:
-
- .. rst-class:: ansible-option-title
-
- **canSave**
-
- .. raw:: html
-
-
-
- .. rst-class:: ansible-option-type-line
-
- :ansible-option-type:`boolean`
-
- .. raw:: html
-
-
-
- Boolean value specifying if current user can save in folder
-
-
- .. rst-class:: ansible-option-line
-
- :ansible-option-returned-bold:`Returned:` state is present and on success
-
-
- .. raw:: html
-
-
-
-
- * - .. raw:: html
-
-
-
-
- .. _ansible_collections.grafana.grafana.folder_module__return-output/created:
-
- .. rst-class:: ansible-option-title
-
- **created**
-
- .. raw:: html
-
-
-
- .. rst-class:: ansible-option-type-line
-
- :ansible-option-type:`string`
-
- .. raw:: html
-
-
-
- The date when folder was created
-
-
- .. rst-class:: ansible-option-line
-
- :ansible-option-returned-bold:`Returned:` state is present and on success
-
-
- .. raw:: html
-
-
-
-
- * - .. raw:: html
-
-
-
-
- .. _ansible_collections.grafana.grafana.folder_module__return-output/createdby:
-
- .. rst-class:: ansible-option-title
-
- **createdBy**
-
- .. raw:: html
-
-
-
- .. rst-class:: ansible-option-type-line
-
- :ansible-option-type:`string`
-
- .. raw:: html
-
-
-
- The name of the user who created the folder
-
-
- .. rst-class:: ansible-option-line
-
- :ansible-option-returned-bold:`Returned:` state is present and on success
-
-
- .. raw:: html
-
-
-
-
- * - .. raw:: html
-
-
-
-
- .. _ansible_collections.grafana.grafana.folder_module__return-output/hasacl:
-
- .. rst-class:: ansible-option-title
-
- **hasAcl**
-
- .. raw:: html
-
-
-
- .. rst-class:: ansible-option-type-line
-
- :ansible-option-type:`boolean`
-
- .. raw:: html
-
-
-
- Boolean value specifying if folder has acl
-
-
- .. rst-class:: ansible-option-line
-
- :ansible-option-returned-bold:`Returned:` state is present and on success
-
-
- .. raw:: html
-
-
-
-
- * - .. raw:: html
-
-
-
-
- .. _ansible_collections.grafana.grafana.folder_module__return-output/id:
-
- .. rst-class:: ansible-option-title
-
- **id**
-
- .. raw:: html
-
-
-
- .. rst-class:: ansible-option-type-line
-
- :ansible-option-type:`integer`
-
- .. raw:: html
-
-
-
- The ID for the folder
-
-
- .. rst-class:: ansible-option-line
-
- :ansible-option-returned-bold:`Returned:` on success
-
-
- .. raw:: html
-
-
-
-
- * - .. raw:: html
-
-
-
-
- .. _ansible_collections.grafana.grafana.folder_module__return-output/message:
-
- .. rst-class:: ansible-option-title
-
- **message**
-
- .. raw:: html
-
-
-
- .. rst-class:: ansible-option-type-line
-
- :ansible-option-type:`string`
-
- .. raw:: html
-
-
-
- The message returned after the operation on the folder
-
-
- .. rst-class:: ansible-option-line
-
- :ansible-option-returned-bold:`Returned:` state is absent and on success
-
-
- .. raw:: html
-
-
-
-
- * - .. raw:: html
-
-
-
-
- .. _ansible_collections.grafana.grafana.folder_module__return-output/title:
-
- .. rst-class:: ansible-option-title
-
- **title**
-
- .. raw:: html
-
-
-
- .. rst-class:: ansible-option-type-line
-
- :ansible-option-type:`string`
-
- .. raw:: html
-
-
-
- The name of the folder
-
-
- .. rst-class:: ansible-option-line
-
- :ansible-option-returned-bold:`Returned:` on success
-
-
- .. raw:: html
-
-
-
-
- * - .. raw:: html
-
-
-
-
- .. _ansible_collections.grafana.grafana.folder_module__return-output/uid:
-
- .. rst-class:: ansible-option-title
-
- **uid**
-
- .. raw:: html
-
-
-
- .. rst-class:: ansible-option-type-line
-
- :ansible-option-type:`string`
-
- .. raw:: html
-
-
-
- The UID for the folder
-
-
- .. rst-class:: ansible-option-line
-
- :ansible-option-returned-bold:`Returned:` state is present and on success
-
-
- .. raw:: html
-
-
-
-
- * - .. raw:: html
-
-
-
-
- .. _ansible_collections.grafana.grafana.folder_module__return-output/updated:
-
- .. rst-class:: ansible-option-title
-
- **updated**
-
- .. raw:: html
-
-
-
- .. rst-class:: ansible-option-type-line
-
- :ansible-option-type:`string`
-
- .. raw:: html
-
-
-
- The date when the folder was last updated
-
-
- .. rst-class:: ansible-option-line
-
- :ansible-option-returned-bold:`Returned:` state is present and on success
-
-
- .. raw:: html
-
-
-
-
- * - .. raw:: html
-
-
-
-
- .. _ansible_collections.grafana.grafana.folder_module__return-output/updatedby:
-
- .. rst-class:: ansible-option-title
-
- **updatedBy**
-
- .. raw:: html
-
-
-
- .. rst-class:: ansible-option-type-line
-
- :ansible-option-type:`string`
-
- .. raw:: html
-
-
-
- The name of the user who last updated the folder
-
-
- .. rst-class:: ansible-option-line
-
- :ansible-option-returned-bold:`Returned:` state is present and on success
-
-
- .. raw:: html
-
-
-
-
- * - .. raw:: html
-
-
-
-
- .. _ansible_collections.grafana.grafana.folder_module__return-output/url:
-
- .. rst-class:: ansible-option-title
-
- **url**
-
- .. raw:: html
-
-
-
- .. rst-class:: ansible-option-type-line
-
- :ansible-option-type:`string`
-
- .. raw:: html
-
-
-
- The URl for the folder
-
-
- .. rst-class:: ansible-option-line
-
- :ansible-option-returned-bold:`Returned:` state is present and on success
-
-
- .. raw:: html
-
-
-
-
- * - .. raw:: html
-
-
-
-
- .. _ansible_collections.grafana.grafana.folder_module__return-output/version:
-
- .. rst-class:: ansible-option-title
-
- **version**
-
- .. raw:: html
-
-
-
- .. rst-class:: ansible-option-type-line
-
- :ansible-option-type:`integer`
-
- .. raw:: html
-
-
-
- The version of the folder
-
-
- .. rst-class:: ansible-option-line
-
- :ansible-option-returned-bold:`Returned:` state is present and on success
-
-
- .. raw:: html
-
-
-
-
-
-
-.. Status (Presently only deprecated)
-
-
-.. Authors
-
-Authors
-~~~~~~~
-
-- Ishan Jain (@ishanjainn)
-
-
-
-.. Extra links
-
-Collection links
-~~~~~~~~~~~~~~~~
-
-.. raw:: html
-
-
- Issue Tracker
- Repository (Sources)
-
-
-.. Parsing errors
diff --git a/docs-rst/index.rst b/docs-rst/index.rst
deleted file mode 100644
index 295708d..0000000
--- a/docs-rst/index.rst
+++ /dev/null
@@ -1,70 +0,0 @@
-.. _plugins_in_grafana.grafana:
-
-Grafana.Grafana
-===============
-
-Collection version 0.0.5
-
-.. contents::
- :local:
- :depth: 1
-
-Description
------------
-
-Ansible collection to manage Grafana resources
-
-**Authors:**
-
-* Grafana Labs
-* Ishan Jain
-
-.. raw:: html
-
-
- Issue Tracker
- Repository (Sources)
-
-
-
-
-.. toctree::
- :maxdepth: 1
-
-
-Plugin Index
-------------
-
-These are the plugins in the grafana.grafana collection:
-
-
-Modules
-~~~~~~~
-
-* :ref:`alert_contact_point module ` -- Manage Alerting Contact points in Grafana
-* :ref:`alert_notification_policy module ` -- Sets the notification policy tree in Grafana Alerting
-* :ref:`cloud_api_key module ` -- Manage Grafana Cloud API keys
-* :ref:`cloud_plugin module ` -- Manage Grafana Cloud Plugins
-* :ref:`cloud_stack module ` -- Manage Grafana Cloud stack
-* :ref:`dashboard module ` -- Manage Dashboards in Grafana
-* :ref:`datasource module ` -- Manage Data sources in Grafana
-* :ref:`folder module ` -- Manage Folders in Grafana
-
-
-
-.. seealso::
-
- List of :ref:`collections ` with docs hosted here.
-
-.. toctree::
- :maxdepth: 1
- :hidden:
-
- alert_contact_point_module
- alert_notification_policy_module
- cloud_api_key_module
- cloud_plugin_module
- cloud_stack_module
- dashboard_module
- datasource_module
- folder_module
\ No newline at end of file