diff --git a/docs/alert_contact_point_module.rst b/docs/alert_contact_point_module.rst index e69de29..8a50766 100644 --- a/docs/alert_contact_point_module.rst +++ b/docs/alert_contact_point_module.rst @@ -0,0 +1,682 @@ +.. 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_contact_point_module: + +.. Anchors: short name for ansible.builtin + +.. Anchors: aliases + + + +.. Title + +grafana.grafana.alert_contact_point module -- Manage Alerting Contact points in Grafana ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ + +.. Collection note + +.. note:: + This module is part of the `grafana.grafana collection `_ (version 0.0.5). + + 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 :code:`ansible-galaxy collection list`. + + To install it, use: :code:`ansible-galaxy collection install grafana.grafana`. + + To use it in a playbook, specify: :code:`grafana.grafana.alert_contact_point`. + +.. version_added + +.. versionadded:: 0.0.1 of grafana.grafana + +.. contents:: + :local: + :depth: 1 + +.. Deprecated + + +Synopsis +-------- + +.. Description + +- Create, Update and delete Contact points 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_contact_point_module__parameter-disableresolvemessage: + + .. rst-class:: ansible-option-title + + **DisableResolveMessage** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`boolean` + + .. raw:: html + +
+ + - .. 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-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_contact_point_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 + +
+ + - .. raw:: html + +
+ + Grafana API Key used to authenticate with Grafana. + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.grafana.grafana.alert_contact_point_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 + +
+ + - .. raw:: html + +
+ + Name of the contact point + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.grafana.grafana.alert_contact_point_module__parameter-settings: + + .. rst-class:: ansible-option-title + + **settings** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`dictionary` / :ansible-option-required:`required` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Contact point settings + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.grafana.grafana.alert_contact_point_module__parameter-state: + + .. rst-class:: ansible-option-title + + **state** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` + + .. 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 + +
+
+ + .. _ansible_collections.grafana.grafana.alert_contact_point_module__parameter-type: + + .. rst-class:: ansible-option-title + + **type** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` / :ansible-option-required:`required` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Contact point type + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.grafana.grafana.alert_contact_point_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 + +
+ + - .. 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 + +
+ + - .. 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 + +
+ + - .. 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 + +
+ + - .. 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 + +
+ + - .. 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 + +
+ + - .. 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 + +
+ + - .. 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 + + + +.. Parsing errors