+
+ The URL of the EDA controller.
+
+ If not set, the value of the \ :literal:`CONTROLLER\_URL`\ environment variable will be used.
+
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+ Password used for authentication.
+
+ If not set, the value of the \ :literal:`CONTROLLER\_PASSWORD`\ environment variable will be used.
+
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+ Username used for authentication.
+
+ If not set, the value of the \ :literal:`CONTROLLER\_USERNAME`\ environment variable will be used.
+
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+ The name of the rulebook activation.
+
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+ Timeout in seconds for the connection with the EDA controller.
+
+ If not set, the value of the \ :literal:`CONTROLLER\_TIMEOUT`\ environment variable will be used.
+
+
+ .. rst-class:: ansible-option-line
+
+ :ansible-option-default-bold:`Default:` :ansible-option-default:`10.0`
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+ Whether to allow insecure connections to Ansible Automation Platform EDA Controller instance.
+
+ If \ :literal:`no`\ , SSL certificates will not be validated.
+
+ This should only be used on personally controlled sites using self-signed certificates.
+
+ If value not set, will try environment variable \ :literal:`CONTROLLER\_VERIFY\_SSL`\
+
+
+ .. rst-class:: ansible-option-line
+
+ :ansible-option-choices:`Choices:`
+
+ - :ansible-option-choices-entry:`false`
+ - :ansible-option-choices-entry-default:`true` :ansible-option-choices-default-mark:`← (default)`
+
+
+ .. raw:: html
+
+
+
+
+.. Attributes
+
+
+.. Notes
+
+
+.. Seealso
+
+
+.. Examples
+
+Examples
+--------
+
+.. code-block:: yaml+jinja
+
+
+ - name: Get information about a rulebook activation
+ ansible.eda.activation_info:
+ name: "Example Rulebook Activation"
+
+ - name: List all rulebook activations
+ ansible.eda.activation_info:
+
+
+
+
+.. Facts
+
+
+.. Return values
+
+Return Values
+-------------
+Common return values are documented :ref:`here `, the following are the fields unique to this module:
+
+.. tabularcolumns:: \X{1}{3}\X{2}{3}
+
+.. list-table::
+ :width: 100%
+ :widths: auto
+ :header-rows: 1
+ :class: longtable ansible-option-table
+
+ * - Key
+ - Description
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.ansible.eda.activation_info_module__return-activations:
+
+ .. rst-class:: ansible-option-title
+
+ **activations**
+
+ .. raw:: html
+
+
+
+ .. ansible-option-type-line::
+
+ :ansible-option-type:`list` / :ansible-option-elements:`elements=dictionary`
+
+ .. raw:: html
+
+
+
+ Information about rulebook activations.
+
+
+ .. rst-class:: ansible-option-line
+
+ :ansible-option-returned-bold:`Returned:` always
+
+ .. rst-class:: ansible-option-line
+ .. rst-class:: ansible-option-sample
+
+ :ansible-option-sample-bold:`Sample:` :ansible-rv-sample-value:`[{"awx\_token\_id": 1, "created\_at": "2024-08-10T14:22:30.123Z", "current\_job\_id": "2", "decision\_environment\_id": 1, "description": "A test activation", "eda\_credentials": [], "event\_streams": [], "extra\_var": "", "id": 1, "is\_enabled": true, "k8s\_service\_name": "", "log\_level": "info", "modified\_at": "2024-08-15T11:45:00.987Z", "name": "Test activation", "organization\_id": 1, "project\_id": 2, "restart\_count": 2, "restart\_policy": "on-failure", "rulebook\_id": 1, "rulebook\_name": "Test rulebook", "rules\_count": 2, "rules\_fired\_count": 2, "status": "running", "status\_message": "Activation is running successfully.", "swap\_single\_source": false, "webhooks": []}]`
+
+
+ .. raw:: html
+
+
+
+
+
+.. Status (Presently only deprecated)
+
+
+.. Authors
+
+Authors
+~~~~~~~
+
+- Alina Buzachis (@alinabuzachis)
+
+
+
+.. Extra links
+
+Collection links
+~~~~~~~~~~~~~~~~
+
+.. ansible-links::
+
+ - title: "Issue Tracker"
+ url: "https://github.com/ansible/event-driven-ansible/issues"
+ external: true
+ - title: "Homepage"
+ url: "http://ansible.com/event-driven"
+ external: true
+ - title: "Repository (Sources)"
+ url: "https://github.com/ansible/event-driven-ansible"
+ external: true
+
+
+.. Parsing errors
+
diff --git a/docs/rst/activation_module.rst b/docs/rst/activation_module.rst
new file mode 100644
index 00000000..b8b668fd
--- /dev/null
+++ b/docs/rst/activation_module.rst
@@ -0,0 +1,1075 @@
+
+.. Document meta
+
+:orphan:
+
+.. |antsibull-internal-nbsp| unicode:: 0xA0
+ :trim:
+
+.. meta::
+ :antsibull-docs: 2.12.0
+
+.. Anchors
+
+.. _ansible_collections.ansible.eda.activation_module:
+
+.. Anchors: short name for ansible.builtin
+
+.. Title
+
+ansible.eda.activation module -- Manage rulebook activations in the EDA Controller
+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
+
+.. Collection note
+
+.. note::
+ This module is part of the `ansible.eda collection `_ (version 1.4.7).
+
+ 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 ansible.eda`.
+
+ To use it in a playbook, specify: :code:`ansible.eda.activation`.
+
+.. version_added
+
+
+.. contents::
+ :local:
+ :depth: 1
+
+.. Deprecated
+
+
+Synopsis
+--------
+
+.. Description
+
+- This module allows the user to create or delete rulebook activations in the EDA Controller.
+
+
+.. Aliases
+
+
+.. Requirements
+
+
+
+
+
+
+.. Options
+
+Parameters
+----------
+
+.. tabularcolumns:: \X{1}{3}\X{2}{3}
+
+.. list-table::
+ :width: 100%
+ :widths: auto
+ :header-rows: 1
+ :class: longtable ansible-option-table
+
+ * - Parameter
+ - Comments
+
+ * - .. raw:: html
+
+
+
+
+
+
+ .. _ansible_collections.ansible.eda.activation_module__parameter-awx_token:
+ .. _ansible_collections.ansible.eda.activation_module__parameter-awx_token_name:
+ .. _ansible_collections.ansible.eda.activation_module__parameter-token:
+
+ .. rst-class:: ansible-option-title
+
+ **awx_token_name**
+
+ .. raw:: html
+
+
+
+ .. ansible-option-type-line::
+
+ :ansible-option-aliases:`aliases: awx_token, token`
+
+ :ansible-option-type:`string`
+
+ .. raw:: html
+
+
+
+ The token ID of the AWX controller.
+
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.ansible.eda.activation_module__parameter-controller_host:
+
+ .. rst-class:: ansible-option-title
+
+ **controller_host**
+
+ .. raw:: html
+
+
+
+ .. ansible-option-type-line::
+
+ :ansible-option-type:`string` / :ansible-option-required:`required`
+
+ :ansible-option-versionadded:`added in ansible.eda 2.0.0`
+
+
+ .. raw:: html
+
+
+
+ The URL of the EDA controller.
+
+ If not set, the value of the \ :literal:`CONTROLLER\_URL`\ environment variable will be used.
+
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.ansible.eda.activation_module__parameter-controller_password:
+
+ .. rst-class:: ansible-option-title
+
+ **controller_password**
+
+ .. raw:: html
+
+
+
+ .. ansible-option-type-line::
+
+ :ansible-option-type:`string`
+
+ :ansible-option-versionadded:`added in ansible.eda 2.0.0`
+
+
+ .. raw:: html
+
+
+
+ Password used for authentication.
+
+ If not set, the value of the \ :literal:`CONTROLLER\_PASSWORD`\ environment variable will be used.
+
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.ansible.eda.activation_module__parameter-controller_username:
+
+ .. rst-class:: ansible-option-title
+
+ **controller_username**
+
+ .. raw:: html
+
+
+
+ .. ansible-option-type-line::
+
+ :ansible-option-type:`string`
+
+ :ansible-option-versionadded:`added in ansible.eda 2.0.0`
+
+
+ .. raw:: html
+
+
+
+ Username used for authentication.
+
+ If not set, the value of the \ :literal:`CONTROLLER\_USERNAME`\ environment variable will be used.
+
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+
+ .. _ansible_collections.ansible.eda.activation_module__parameter-decision_environment:
+ .. _ansible_collections.ansible.eda.activation_module__parameter-decision_environment_name:
+
+ .. rst-class:: ansible-option-title
+
+ **decision_environment_name**
+
+ .. raw:: html
+
+
+
+ .. ansible-option-type-line::
+
+ :ansible-option-aliases:`aliases: decision_environment`
+
+ :ansible-option-type:`string`
+
+ .. raw:: html
+
+
+
+ The name of the decision environment associated with the rulebook activation.
+
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.ansible.eda.activation_module__parameter-description:
+
+ .. rst-class:: ansible-option-title
+
+ **description**
+
+ .. raw:: html
+
+
+
+ .. ansible-option-type-line::
+
+ :ansible-option-type:`string`
+
+ .. raw:: html
+
+
+
+ The description of the rulebook activation.
+
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+
+ .. _ansible_collections.ansible.eda.activation_module__parameter-credentials:
+ .. _ansible_collections.ansible.eda.activation_module__parameter-eda_credentials:
+
+ .. rst-class:: ansible-option-title
+
+ **eda_credentials**
+
+ .. raw:: html
+
+
+
+ .. ansible-option-type-line::
+
+ :ansible-option-aliases:`aliases: credentials`
+
+ :ansible-option-type:`list` / :ansible-option-elements:`elements=string`
+
+ .. raw:: html
+
+
+
+ A list of IDs for EDA credentials used by the rulebook activation.
+
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.ansible.eda.activation_module__parameter-enabled:
+
+ .. rst-class:: ansible-option-title
+
+ **enabled**
+
+ .. raw:: html
+
+
+
+ .. ansible-option-type-line::
+
+ :ansible-option-type:`boolean`
+
+ .. raw:: html
+
+
+
+ Whether the rulebook activation is enabled or not.
+
+
+ .. rst-class:: ansible-option-line
+
+ :ansible-option-choices:`Choices:`
+
+ - :ansible-option-choices-entry:`false`
+ - :ansible-option-choices-entry-default:`true` :ansible-option-choices-default-mark:`← (default)`
+
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.ansible.eda.activation_module__parameter-event_streams:
+
+ .. rst-class:: ansible-option-title
+
+ **event_streams**
+
+ .. raw:: html
+
+
+
+ .. ansible-option-type-line::
+
+ :ansible-option-type:`list` / :ansible-option-elements:`elements=integer`
+
+ .. raw:: html
+
+
+
+ A list of IDs representing the event streams that this rulebook activation listens to.
+
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.ansible.eda.activation_module__parameter-extra_vars:
+
+ .. rst-class:: ansible-option-title
+
+ **extra_vars**
+
+ .. raw:: html
+
+
+
+ .. ansible-option-type-line::
+
+ :ansible-option-type:`string`
+
+ .. raw:: html
+
+
+
+ The extra variables for the rulebook activation.
+
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.ansible.eda.activation_module__parameter-k8s_service_name:
+
+ .. rst-class:: ansible-option-title
+
+ **k8s_service_name**
+
+ .. raw:: html
+
+
+
+ .. ansible-option-type-line::
+
+ :ansible-option-type:`string`
+
+ .. raw:: html
+
+
+
+ The name of the Kubernetes service associated with this rulebook activation.
+
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.ansible.eda.activation_module__parameter-log_level:
+
+ .. rst-class:: ansible-option-title
+
+ **log_level**
+
+ .. raw:: html
+
+
+
+ .. ansible-option-type-line::
+
+ :ansible-option-type:`string`
+
+ .. raw:: html
+
+
+
+ Allow setting the desired log level.
+
+
+ .. rst-class:: ansible-option-line
+
+ :ansible-option-choices:`Choices:`
+
+ - :ansible-option-choices-entry-default:`"debug"` :ansible-option-choices-default-mark:`← (default)`
+ - :ansible-option-choices-entry:`"info"`
+ - :ansible-option-choices-entry:`"error"`
+
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.ansible.eda.activation_module__parameter-name:
+
+ .. rst-class:: ansible-option-title
+
+ **name**
+
+ .. raw:: html
+
+
+
+ .. ansible-option-type-line::
+
+ :ansible-option-type:`string` / :ansible-option-required:`required`
+
+ .. raw:: html
+
+
+
+ The name of the rulebook activation.
+
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+
+ .. _ansible_collections.ansible.eda.activation_module__parameter-organization:
+ .. _ansible_collections.ansible.eda.activation_module__parameter-organization_name:
+
+ .. rst-class:: ansible-option-title
+
+ **organization_name**
+
+ .. raw:: html
+
+
+
+ .. ansible-option-type-line::
+
+ :ansible-option-aliases:`aliases: organization`
+
+ :ansible-option-type:`string`
+
+ .. raw:: html
+
+
+
+ The name of the organization.
+
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+
+ .. _ansible_collections.ansible.eda.activation_module__parameter-project:
+ .. _ansible_collections.ansible.eda.activation_module__parameter-project_name:
+
+ .. rst-class:: ansible-option-title
+
+ **project_name**
+
+ .. raw:: html
+
+
+
+ .. ansible-option-type-line::
+
+ :ansible-option-aliases:`aliases: project`
+
+ :ansible-option-type:`string`
+
+ .. raw:: html
+
+
+
+ The name of the project associated with the rulebook activation.
+
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.ansible.eda.activation_module__parameter-request_timeout:
+
+ .. rst-class:: ansible-option-title
+
+ **request_timeout**
+
+ .. raw:: html
+
+
+
+ .. ansible-option-type-line::
+
+ :ansible-option-type:`float`
+
+ :ansible-option-versionadded:`added in ansible.eda 2.0.0`
+
+
+ .. raw:: html
+
+
+
+ Timeout in seconds for the connection with the EDA controller.
+
+ If not set, the value of the \ :literal:`CONTROLLER\_TIMEOUT`\ environment variable will be used.
+
+
+ .. rst-class:: ansible-option-line
+
+ :ansible-option-default-bold:`Default:` :ansible-option-default:`10.0`
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.ansible.eda.activation_module__parameter-restart_policy:
+
+ .. rst-class:: ansible-option-title
+
+ **restart_policy**
+
+ .. raw:: html
+
+
+
+ .. ansible-option-type-line::
+
+ :ansible-option-type:`string`
+
+ .. raw:: html
+
+
+
+ The restart policy for the rulebook activation.
+
+
+ .. rst-class:: ansible-option-line
+
+ :ansible-option-choices:`Choices:`
+
+ - :ansible-option-choices-entry:`"on-failure"`
+ - :ansible-option-choices-entry-default:`"always"` :ansible-option-choices-default-mark:`← (default)`
+ - :ansible-option-choices-entry:`"never"`
+
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+
+ .. _ansible_collections.ansible.eda.activation_module__parameter-rulebook:
+ .. _ansible_collections.ansible.eda.activation_module__parameter-rulebook_name:
+
+ .. rst-class:: ansible-option-title
+
+ **rulebook_name**
+
+ .. raw:: html
+
+
+
+ .. ansible-option-type-line::
+
+ :ansible-option-aliases:`aliases: rulebook`
+
+ :ansible-option-type:`string`
+
+ .. raw:: html
+
+
+
+ The name of the rulebook associated with the rulebook activation.
+
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.ansible.eda.activation_module__parameter-state:
+
+ .. rst-class:: ansible-option-title
+
+ **state**
+
+ .. raw:: html
+
+
+
+ .. ansible-option-type-line::
+
+ :ansible-option-type:`string`
+
+ .. raw:: html
+
+
+
+ Desired state of the resource.
+
+
+ .. rst-class:: ansible-option-line
+
+ :ansible-option-choices:`Choices:`
+
+ - :ansible-option-choices-entry-default:`"present"` :ansible-option-choices-default-mark:`← (default)`
+ - :ansible-option-choices-entry:`"absent"`
+
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.ansible.eda.activation_module__parameter-swap_single_source:
+
+ .. rst-class:: ansible-option-title
+
+ **swap_single_source**
+
+ .. raw:: html
+
+
+
+ .. ansible-option-type-line::
+
+ :ansible-option-type:`boolean`
+
+ .. raw:: html
+
+
+
+ Allow swapping of single sources in a rulebook without name match.
+
+
+ .. rst-class:: ansible-option-line
+
+ :ansible-option-choices:`Choices:`
+
+ - :ansible-option-choices-entry:`false`
+ - :ansible-option-choices-entry-default:`true` :ansible-option-choices-default-mark:`← (default)`
+
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.ansible.eda.activation_module__parameter-validate_certs:
+
+ .. rst-class:: ansible-option-title
+
+ **validate_certs**
+
+ .. raw:: html
+
+
+
+ .. ansible-option-type-line::
+
+ :ansible-option-type:`boolean`
+
+ :ansible-option-versionadded:`added in ansible.eda 2.0.0`
+
+
+ .. raw:: html
+
+
+
+ Whether to allow insecure connections to Ansible Automation Platform EDA Controller instance.
+
+ If \ :literal:`no`\ , SSL certificates will not be validated.
+
+ This should only be used on personally controlled sites using self-signed certificates.
+
+ If value not set, will try environment variable \ :literal:`CONTROLLER\_VERIFY\_SSL`\
+
+
+ .. rst-class:: ansible-option-line
+
+ :ansible-option-choices:`Choices:`
+
+ - :ansible-option-choices-entry:`false`
+ - :ansible-option-choices-entry-default:`true` :ansible-option-choices-default-mark:`← (default)`
+
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.ansible.eda.activation_module__parameter-webhooks:
+
+ .. rst-class:: ansible-option-title
+
+ **webhooks**
+
+ .. raw:: html
+
+
+
+ .. ansible-option-type-line::
+
+ :ansible-option-type:`list` / :ansible-option-elements:`elements=string`
+
+ .. raw:: html
+
+
+
+ A list of webhook IDs associated with the rulebook activation.
+
+
+ .. raw:: html
+
+
+
+
+.. Attributes
+
+
+.. Notes
+
+Notes
+-----
+
+.. note::
+ - Rulebook Activation API does not support PATCH method, due to this reason the module will not perform any modification when an existing rulebook activation is found.
+
+.. Seealso
+
+
+.. Examples
+
+Examples
+--------
+
+.. code-block:: yaml+jinja
+
+
+ - name: Create a rulebook activation
+ ansible.eda.activation:
+ name: "Example Rulebook Activation"
+ description: "Example Rulebook Activation description"
+ project_name: "Example Project"
+ rulebook_name: "hello_controller.yml"
+ decision_environment_name: "Example Decision Environment"
+ enabled: False
+ awx_token_name: "Example Token"
+
+ - name: Delete a rulebook activation
+ ansible.eda.activation:
+ name: "Example Rulebook Activation"
+ state: absent
+
+
+
+
+.. Facts
+
+
+.. Return values
+
+Return Values
+-------------
+Common return values are documented :ref:`here `, the following are the fields unique to this module:
+
+.. tabularcolumns:: \X{1}{3}\X{2}{3}
+
+.. list-table::
+ :width: 100%
+ :widths: auto
+ :header-rows: 1
+ :class: longtable ansible-option-table
+
+ * - Key
+ - Description
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.ansible.eda.activation_module__return-id:
+
+ .. rst-class:: ansible-option-title
+
+ **id**
+
+ .. raw:: html
+
+
+
+ .. ansible-option-type-line::
+
+ :ansible-option-type:`integer`
+
+ .. raw:: html
+
+
+
+ ID of the rulebook activation.
+
+
+ .. rst-class:: ansible-option-line
+
+ :ansible-option-returned-bold:`Returned:` when exists
+
+ .. rst-class:: ansible-option-line
+ .. rst-class:: ansible-option-sample
+
+ :ansible-option-sample-bold:`Sample:` :ansible-rv-sample-value:`37`
+
+
+ .. raw:: html
+
+
+
+
+
+.. Status (Presently only deprecated)
+
+
+.. Authors
+
+Authors
+~~~~~~~
+
+- Nikhil Jain (@jainnikhil30)
+- Alina Buzachis (@alinabuzachis)
+
+
+
+.. Extra links
+
+Collection links
+~~~~~~~~~~~~~~~~
+
+.. ansible-links::
+
+ - title: "Issue Tracker"
+ url: "https://github.com/ansible/event-driven-ansible/issues"
+ external: true
+ - title: "Homepage"
+ url: "http://ansible.com/event-driven"
+ external: true
+ - title: "Repository (Sources)"
+ url: "https://github.com/ansible/event-driven-ansible"
+ external: true
+
+
+.. Parsing errors
+
diff --git a/docs/rst/controller_token_module.rst b/docs/rst/controller_token_module.rst
new file mode 100644
index 00000000..394b13a3
--- /dev/null
+++ b/docs/rst/controller_token_module.rst
@@ -0,0 +1,583 @@
+
+.. Document meta
+
+:orphan:
+
+.. |antsibull-internal-nbsp| unicode:: 0xA0
+ :trim:
+
+.. meta::
+ :antsibull-docs: 2.12.0
+
+.. Anchors
+
+.. _ansible_collections.ansible.eda.controller_token_module:
+
+.. Anchors: short name for ansible.builtin
+
+.. Title
+
+ansible.eda.controller_token module -- Manage AWX tokens in EDA controller
+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
+
+.. Collection note
+
+.. note::
+ This module is part of the `ansible.eda collection `_ (version 1.4.7).
+
+ 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 ansible.eda`.
+
+ To use it in a playbook, specify: :code:`ansible.eda.controller_token`.
+
+.. version_added
+
+.. rst-class:: ansible-version-added
+
+New in ansible.eda 2.0.0
+
+.. contents::
+ :local:
+ :depth: 1
+
+.. Deprecated
+
+
+Synopsis
+--------
+
+.. Description
+
+- This module allows the user to manage AWX tokens in a EDA controller.
+
+
+.. Aliases
+
+
+.. Requirements
+
+
+
+
+
+
+.. Options
+
+Parameters
+----------
+
+.. tabularcolumns:: \X{1}{3}\X{2}{3}
+
+.. list-table::
+ :width: 100%
+ :widths: auto
+ :header-rows: 1
+ :class: longtable ansible-option-table
+
+ * - Parameter
+ - Comments
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.ansible.eda.controller_token_module__parameter-controller_host:
+
+ .. rst-class:: ansible-option-title
+
+ **controller_host**
+
+ .. raw:: html
+
+
+
+ .. ansible-option-type-line::
+
+ :ansible-option-type:`string` / :ansible-option-required:`required`
+
+ :ansible-option-versionadded:`added in ansible.eda 2.0.0`
+
+
+ .. raw:: html
+
+
+
+ The URL of the EDA controller.
+
+ If not set, the value of the \ :literal:`CONTROLLER\_URL`\ environment variable will be used.
+
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.ansible.eda.controller_token_module__parameter-controller_password:
+
+ .. rst-class:: ansible-option-title
+
+ **controller_password**
+
+ .. raw:: html
+
+
+
+ .. ansible-option-type-line::
+
+ :ansible-option-type:`string`
+
+ :ansible-option-versionadded:`added in ansible.eda 2.0.0`
+
+
+ .. raw:: html
+
+
+
+ Password used for authentication.
+
+ If not set, the value of the \ :literal:`CONTROLLER\_PASSWORD`\ environment variable will be used.
+
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.ansible.eda.controller_token_module__parameter-controller_username:
+
+ .. rst-class:: ansible-option-title
+
+ **controller_username**
+
+ .. raw:: html
+
+
+
+ .. ansible-option-type-line::
+
+ :ansible-option-type:`string`
+
+ :ansible-option-versionadded:`added in ansible.eda 2.0.0`
+
+
+ .. raw:: html
+
+
+
+ Username used for authentication.
+
+ If not set, the value of the \ :literal:`CONTROLLER\_USERNAME`\ environment variable will be used.
+
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.ansible.eda.controller_token_module__parameter-description:
+
+ .. rst-class:: ansible-option-title
+
+ **description**
+
+ .. raw:: html
+
+
+
+ .. ansible-option-type-line::
+
+ :ansible-option-type:`string`
+
+ .. raw:: html
+
+
+
+ The description of the project.
+
+ Required when \ :ansopt:`ansible.eda.controller\_token#module:state=present`\ .
+
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.ansible.eda.controller_token_module__parameter-name:
+
+ .. rst-class:: ansible-option-title
+
+ **name**
+
+ .. raw:: html
+
+
+
+ .. ansible-option-type-line::
+
+ :ansible-option-type:`string` / :ansible-option-required:`required`
+
+ .. raw:: html
+
+
+
+ The name of the AWX token.
+
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.ansible.eda.controller_token_module__parameter-request_timeout:
+
+ .. rst-class:: ansible-option-title
+
+ **request_timeout**
+
+ .. raw:: html
+
+
+
+ .. ansible-option-type-line::
+
+ :ansible-option-type:`float`
+
+ :ansible-option-versionadded:`added in ansible.eda 2.0.0`
+
+
+ .. raw:: html
+
+
+
+ Timeout in seconds for the connection with the EDA controller.
+
+ If not set, the value of the \ :literal:`CONTROLLER\_TIMEOUT`\ environment variable will be used.
+
+
+ .. rst-class:: ansible-option-line
+
+ :ansible-option-default-bold:`Default:` :ansible-option-default:`10.0`
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.ansible.eda.controller_token_module__parameter-state:
+
+ .. rst-class:: ansible-option-title
+
+ **state**
+
+ .. raw:: html
+
+
+
+ .. ansible-option-type-line::
+
+ :ansible-option-type:`string`
+
+ .. raw:: html
+
+
+
+ Desired state of the resource.
+
+
+ .. rst-class:: ansible-option-line
+
+ :ansible-option-choices:`Choices:`
+
+ - :ansible-option-choices-entry-default:`"present"` :ansible-option-choices-default-mark:`← (default)`
+ - :ansible-option-choices-entry:`"absent"`
+
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.ansible.eda.controller_token_module__parameter-token:
+
+ .. rst-class:: ansible-option-title
+
+ **token**
+
+ .. raw:: html
+
+
+
+ .. ansible-option-type-line::
+
+ :ansible-option-type:`string`
+
+ .. raw:: html
+
+
+
+ The AWX token value.
+
+ Required when \ :ansopt:`ansible.eda.controller\_token#module:state=present`\ .
+
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.ansible.eda.controller_token_module__parameter-validate_certs:
+
+ .. rst-class:: ansible-option-title
+
+ **validate_certs**
+
+ .. raw:: html
+
+
+
+ .. ansible-option-type-line::
+
+ :ansible-option-type:`boolean`
+
+ :ansible-option-versionadded:`added in ansible.eda 2.0.0`
+
+
+ .. raw:: html
+
+
+
+ Whether to allow insecure connections to Ansible Automation Platform EDA Controller instance.
+
+ If \ :literal:`no`\ , SSL certificates will not be validated.
+
+ This should only be used on personally controlled sites using self-signed certificates.
+
+ If value not set, will try environment variable \ :literal:`CONTROLLER\_VERIFY\_SSL`\
+
+
+ .. rst-class:: ansible-option-line
+
+ :ansible-option-choices:`Choices:`
+
+ - :ansible-option-choices-entry:`false`
+ - :ansible-option-choices-entry-default:`true` :ansible-option-choices-default-mark:`← (default)`
+
+
+ .. raw:: html
+
+
+
+
+.. Attributes
+
+
+.. Notes
+
+Notes
+-----
+
+.. note::
+ - Controller Token API does not support PATCH method, due to this reason the module deletes and re-creates the token when existing controller token is found. This will cause module to report changed, every time update is called.
+
+.. Seealso
+
+
+.. Examples
+
+Examples
+--------
+
+.. code-block:: yaml+jinja
+
+
+ - name: Create AWX token
+ ansible.eda.controller_token:
+ controller_host: https://my_eda_host/
+ controller_username: admin
+ controller_password: MySuperSecretPassw0rd
+ name: "Example AWX token"
+ description: "Example AWX token description"
+ token: ""
+ state: present
+ no_log: true
+
+ - name: Delete AWX token
+ ansible.eda.controller_token:
+ controller_host: https://my_eda_host/
+ controller_username: admin
+ controller_password: MySuperSecretPassw0rd
+ name: "Example AWX token"
+ state: absent
+
+
+
+
+.. Facts
+
+
+.. Return values
+
+Return Values
+-------------
+Common return values are documented :ref:`here `, the following are the fields unique to this module:
+
+.. tabularcolumns:: \X{1}{3}\X{2}{3}
+
+.. list-table::
+ :width: 100%
+ :widths: auto
+ :header-rows: 1
+ :class: longtable ansible-option-table
+
+ * - Key
+ - Description
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.ansible.eda.controller_token_module__return-id:
+
+ .. rst-class:: ansible-option-title
+
+ **id**
+
+ .. raw:: html
+
+
+
+ .. ansible-option-type-line::
+
+ :ansible-option-type:`string`
+
+ .. raw:: html
+
+
+
+ ID of the managed AWX token.
+
+
+ .. rst-class:: ansible-option-line
+
+ :ansible-option-returned-bold:`Returned:` when state is 'present' and successful
+
+ .. rst-class:: ansible-option-line
+ .. rst-class:: ansible-option-sample
+
+ :ansible-option-sample-bold:`Sample:` :ansible-rv-sample-value:`"123"`
+
+
+ .. raw:: html
+
+
+
+
+
+.. Status (Presently only deprecated)
+
+
+.. Authors
+
+Authors
+~~~~~~~
+
+- Abhijeet Kasurde (@akasurde)
+
+
+
+.. Extra links
+
+Collection links
+~~~~~~~~~~~~~~~~
+
+.. ansible-links::
+
+ - title: "Issue Tracker"
+ url: "https://github.com/ansible/event-driven-ansible/issues"
+ external: true
+ - title: "Homepage"
+ url: "http://ansible.com/event-driven"
+ external: true
+ - title: "Repository (Sources)"
+ url: "https://github.com/ansible/event-driven-ansible"
+ external: true
+
+
+.. Parsing errors
+
diff --git a/docs/rst/credential_info_module.rst b/docs/rst/credential_info_module.rst
new file mode 100644
index 00000000..30d2b111
--- /dev/null
+++ b/docs/rst/credential_info_module.rst
@@ -0,0 +1,452 @@
+
+.. Document meta
+
+:orphan:
+
+.. |antsibull-internal-nbsp| unicode:: 0xA0
+ :trim:
+
+.. meta::
+ :antsibull-docs: 2.12.0
+
+.. Anchors
+
+.. _ansible_collections.ansible.eda.credential_info_module:
+
+.. Anchors: short name for ansible.builtin
+
+.. Title
+
+ansible.eda.credential_info module -- List credentials in the EDA Controller
+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
+
+.. Collection note
+
+.. note::
+ This module is part of the `ansible.eda collection `_ (version 1.4.7).
+
+ 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 ansible.eda`.
+
+ To use it in a playbook, specify: :code:`ansible.eda.credential_info`.
+
+.. version_added
+
+.. rst-class:: ansible-version-added
+
+New in ansible.eda 2.0.0
+
+.. contents::
+ :local:
+ :depth: 1
+
+.. Deprecated
+
+
+Synopsis
+--------
+
+.. Description
+
+- List credentials in the EDA controller.
+
+
+.. Aliases
+
+
+.. Requirements
+
+
+
+
+
+
+.. Options
+
+Parameters
+----------
+
+.. tabularcolumns:: \X{1}{3}\X{2}{3}
+
+.. list-table::
+ :width: 100%
+ :widths: auto
+ :header-rows: 1
+ :class: longtable ansible-option-table
+
+ * - Parameter
+ - Comments
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.ansible.eda.credential_info_module__parameter-controller_host:
+
+ .. rst-class:: ansible-option-title
+
+ **controller_host**
+
+ .. raw:: html
+
+
+
+ .. ansible-option-type-line::
+
+ :ansible-option-type:`string` / :ansible-option-required:`required`
+
+ :ansible-option-versionadded:`added in ansible.eda 2.0.0`
+
+
+ .. raw:: html
+
+
+
+ The URL of the EDA controller.
+
+ If not set, the value of the \ :literal:`CONTROLLER\_URL`\ environment variable will be used.
+
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.ansible.eda.credential_info_module__parameter-controller_password:
+
+ .. rst-class:: ansible-option-title
+
+ **controller_password**
+
+ .. raw:: html
+
+
+
+ .. ansible-option-type-line::
+
+ :ansible-option-type:`string`
+
+ :ansible-option-versionadded:`added in ansible.eda 2.0.0`
+
+
+ .. raw:: html
+
+
+
+ Password used for authentication.
+
+ If not set, the value of the \ :literal:`CONTROLLER\_PASSWORD`\ environment variable will be used.
+
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.ansible.eda.credential_info_module__parameter-controller_username:
+
+ .. rst-class:: ansible-option-title
+
+ **controller_username**
+
+ .. raw:: html
+
+
+
+ .. ansible-option-type-line::
+
+ :ansible-option-type:`string`
+
+ :ansible-option-versionadded:`added in ansible.eda 2.0.0`
+
+
+ .. raw:: html
+
+
+
+ Username used for authentication.
+
+ If not set, the value of the \ :literal:`CONTROLLER\_USERNAME`\ environment variable will be used.
+
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.ansible.eda.credential_info_module__parameter-name:
+
+ .. rst-class:: ansible-option-title
+
+ **name**
+
+ .. raw:: html
+
+
+
+ .. ansible-option-type-line::
+
+ :ansible-option-type:`string`
+
+ .. raw:: html
+
+
+
+ The name of the credential.
+
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.ansible.eda.credential_info_module__parameter-request_timeout:
+
+ .. rst-class:: ansible-option-title
+
+ **request_timeout**
+
+ .. raw:: html
+
+
+
+ .. ansible-option-type-line::
+
+ :ansible-option-type:`float`
+
+ :ansible-option-versionadded:`added in ansible.eda 2.0.0`
+
+
+ .. raw:: html
+
+
+
+ Timeout in seconds for the connection with the EDA controller.
+
+ If not set, the value of the \ :literal:`CONTROLLER\_TIMEOUT`\ environment variable will be used.
+
+
+ .. rst-class:: ansible-option-line
+
+ :ansible-option-default-bold:`Default:` :ansible-option-default:`10.0`
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.ansible.eda.credential_info_module__parameter-validate_certs:
+
+ .. rst-class:: ansible-option-title
+
+ **validate_certs**
+
+ .. raw:: html
+
+
+
+ .. ansible-option-type-line::
+
+ :ansible-option-type:`boolean`
+
+ :ansible-option-versionadded:`added in ansible.eda 2.0.0`
+
+
+ .. raw:: html
+
+
+
+ Whether to allow insecure connections to Ansible Automation Platform EDA Controller instance.
+
+ If \ :literal:`no`\ , SSL certificates will not be validated.
+
+ This should only be used on personally controlled sites using self-signed certificates.
+
+ If value not set, will try environment variable \ :literal:`CONTROLLER\_VERIFY\_SSL`\
+
+
+ .. rst-class:: ansible-option-line
+
+ :ansible-option-choices:`Choices:`
+
+ - :ansible-option-choices-entry:`false`
+ - :ansible-option-choices-entry-default:`true` :ansible-option-choices-default-mark:`← (default)`
+
+
+ .. raw:: html
+
+
+
+
+.. Attributes
+
+
+.. Notes
+
+
+.. Seealso
+
+
+.. Examples
+
+Examples
+--------
+
+.. code-block:: yaml+jinja
+
+
+ - name: Get information about a credential
+ ansible.eda.credential_info:
+ name: "Test"
+
+ - name: List all credentials
+ ansible.eda.credential_info:
+
+
+
+
+.. Facts
+
+
+.. Return values
+
+Return Values
+-------------
+Common return values are documented :ref:`here `, the following are the fields unique to this module:
+
+.. tabularcolumns:: \X{1}{3}\X{2}{3}
+
+.. list-table::
+ :width: 100%
+ :widths: auto
+ :header-rows: 1
+ :class: longtable ansible-option-table
+
+ * - Key
+ - Description
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.ansible.eda.credential_info_module__return-credentials:
+
+ .. rst-class:: ansible-option-title
+
+ **credentials**
+
+ .. raw:: html
+
+
+
+ .. ansible-option-type-line::
+
+ :ansible-option-type:`list` / :ansible-option-elements:`elements=dictionary`
+
+ .. raw:: html
+
+
+
+ Information about credentials.
+
+
+ .. rst-class:: ansible-option-line
+
+ :ansible-option-returned-bold:`Returned:` always
+
+ .. rst-class:: ansible-option-line
+ .. rst-class:: ansible-option-sample
+
+ :ansible-option-sample-bold:`Sample:` :ansible-rv-sample-value:`[{"created\_at": "2024-08-14T08:57:55.151787Z", "credential\_type": {"id": 1, "kind": "scm", "name": "Source Control", "namespace": "scm"}, "description": "This is a test credential", "id": 24, "inputs": {"password": "$encrypted$", "username": "testuser"}, "managed": false, "modified\_at": "2024-08-14T08:57:56.324925Z", "name": "New Test Credential", "organization": {"description": "The default organization", "id": 1, "name": "Default"}, "references": null}]`
+
+
+ .. raw:: html
+
+
+
+
+
+.. Status (Presently only deprecated)
+
+
+.. Authors
+
+Authors
+~~~~~~~
+
+- Alina Buzachis (@alinabuzachis)
+
+
+
+.. Extra links
+
+Collection links
+~~~~~~~~~~~~~~~~
+
+.. ansible-links::
+
+ - title: "Issue Tracker"
+ url: "https://github.com/ansible/event-driven-ansible/issues"
+ external: true
+ - title: "Homepage"
+ url: "http://ansible.com/event-driven"
+ external: true
+ - title: "Repository (Sources)"
+ url: "https://github.com/ansible/event-driven-ansible"
+ external: true
+
+
+.. Parsing errors
+
diff --git a/docs/rst/credential_module.rst b/docs/rst/credential_module.rst
new file mode 100644
index 00000000..68e9f472
--- /dev/null
+++ b/docs/rst/credential_module.rst
@@ -0,0 +1,675 @@
+
+.. Document meta
+
+:orphan:
+
+.. |antsibull-internal-nbsp| unicode:: 0xA0
+ :trim:
+
+.. meta::
+ :antsibull-docs: 2.12.0
+
+.. Anchors
+
+.. _ansible_collections.ansible.eda.credential_module:
+
+.. Anchors: short name for ansible.builtin
+
+.. Title
+
+ansible.eda.credential module -- Manage credentials in EDA Controller
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
+
+.. Collection note
+
+.. note::
+ This module is part of the `ansible.eda collection `_ (version 1.4.7).
+
+ 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 ansible.eda`.
+
+ To use it in a playbook, specify: :code:`ansible.eda.credential`.
+
+.. version_added
+
+.. rst-class:: ansible-version-added
+
+New in ansible.eda 2.0.0
+
+.. contents::
+ :local:
+ :depth: 1
+
+.. Deprecated
+
+
+Synopsis
+--------
+
+.. Description
+
+- This module allows the user to create, update or delete a credential in EDA controller.
+
+
+.. Aliases
+
+
+.. Requirements
+
+
+
+
+
+
+.. Options
+
+Parameters
+----------
+
+.. tabularcolumns:: \X{1}{3}\X{2}{3}
+
+.. list-table::
+ :width: 100%
+ :widths: auto
+ :header-rows: 1
+ :class: longtable ansible-option-table
+
+ * - Parameter
+ - Comments
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.ansible.eda.credential_module__parameter-controller_host:
+
+ .. rst-class:: ansible-option-title
+
+ **controller_host**
+
+ .. raw:: html
+
+
+
+ .. ansible-option-type-line::
+
+ :ansible-option-type:`string` / :ansible-option-required:`required`
+
+ :ansible-option-versionadded:`added in ansible.eda 2.0.0`
+
+
+ .. raw:: html
+
+
+
+ The URL of the EDA controller.
+
+ If not set, the value of the \ :literal:`CONTROLLER\_URL`\ environment variable will be used.
+
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.ansible.eda.credential_module__parameter-controller_password:
+
+ .. rst-class:: ansible-option-title
+
+ **controller_password**
+
+ .. raw:: html
+
+
+
+ .. ansible-option-type-line::
+
+ :ansible-option-type:`string`
+
+ :ansible-option-versionadded:`added in ansible.eda 2.0.0`
+
+
+ .. raw:: html
+
+
+
+ Password used for authentication.
+
+ If not set, the value of the \ :literal:`CONTROLLER\_PASSWORD`\ environment variable will be used.
+
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.ansible.eda.credential_module__parameter-controller_username:
+
+ .. rst-class:: ansible-option-title
+
+ **controller_username**
+
+ .. raw:: html
+
+
+
+ .. ansible-option-type-line::
+
+ :ansible-option-type:`string`
+
+ :ansible-option-versionadded:`added in ansible.eda 2.0.0`
+
+
+ .. raw:: html
+
+
+
+ Username used for authentication.
+
+ If not set, the value of the \ :literal:`CONTROLLER\_USERNAME`\ environment variable will be used.
+
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.ansible.eda.credential_module__parameter-credential_type_name:
+
+ .. rst-class:: ansible-option-title
+
+ **credential_type_name**
+
+ .. raw:: html
+
+
+
+ .. ansible-option-type-line::
+
+ :ansible-option-type:`string`
+
+ .. raw:: html
+
+
+
+ The name of the credential type.
+
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.ansible.eda.credential_module__parameter-description:
+
+ .. rst-class:: ansible-option-title
+
+ **description**
+
+ .. raw:: html
+
+
+
+ .. ansible-option-type-line::
+
+ :ansible-option-type:`string`
+
+ .. raw:: html
+
+
+
+ Description of the credential.
+
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.ansible.eda.credential_module__parameter-inputs:
+
+ .. rst-class:: ansible-option-title
+
+ **inputs**
+
+ .. raw:: html
+
+
+
+ .. ansible-option-type-line::
+
+ :ansible-option-type:`dictionary`
+
+ .. raw:: html
+
+
+
+ Credential inputs where the keys are var names used in templating.
+
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.ansible.eda.credential_module__parameter-name:
+
+ .. rst-class:: ansible-option-title
+
+ **name**
+
+ .. raw:: html
+
+
+
+ .. ansible-option-type-line::
+
+ :ansible-option-type:`string` / :ansible-option-required:`required`
+
+ .. raw:: html
+
+
+
+ Name of the credential.
+
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.ansible.eda.credential_module__parameter-new_name:
+
+ .. rst-class:: ansible-option-title
+
+ **new_name**
+
+ .. raw:: html
+
+
+
+ .. ansible-option-type-line::
+
+ :ansible-option-type:`string`
+
+ .. raw:: html
+
+
+
+ Setting this option will change the existing name (lookup via name).
+
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+
+ .. _ansible_collections.ansible.eda.credential_module__parameter-org_name:
+ .. _ansible_collections.ansible.eda.credential_module__parameter-organization_name:
+
+ .. rst-class:: ansible-option-title
+
+ **organization_name**
+
+ .. raw:: html
+
+
+
+ .. ansible-option-type-line::
+
+ :ansible-option-aliases:`aliases: org_name`
+
+ :ansible-option-type:`integer`
+
+ .. raw:: html
+
+
+
+ The name of the organization.
+
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.ansible.eda.credential_module__parameter-request_timeout:
+
+ .. rst-class:: ansible-option-title
+
+ **request_timeout**
+
+ .. raw:: html
+
+
+
+ .. ansible-option-type-line::
+
+ :ansible-option-type:`float`
+
+ :ansible-option-versionadded:`added in ansible.eda 2.0.0`
+
+
+ .. raw:: html
+
+
+
+ Timeout in seconds for the connection with the EDA controller.
+
+ If not set, the value of the \ :literal:`CONTROLLER\_TIMEOUT`\ environment variable will be used.
+
+
+ .. rst-class:: ansible-option-line
+
+ :ansible-option-default-bold:`Default:` :ansible-option-default:`10.0`
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.ansible.eda.credential_module__parameter-state:
+
+ .. rst-class:: ansible-option-title
+
+ **state**
+
+ .. raw:: html
+
+
+
+ .. ansible-option-type-line::
+
+ :ansible-option-type:`string`
+
+ .. raw:: html
+
+
+
+ Desired state of the resource.
+
+
+ .. rst-class:: ansible-option-line
+
+ :ansible-option-choices:`Choices:`
+
+ - :ansible-option-choices-entry-default:`"present"` :ansible-option-choices-default-mark:`← (default)`
+ - :ansible-option-choices-entry:`"absent"`
+
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.ansible.eda.credential_module__parameter-validate_certs:
+
+ .. rst-class:: ansible-option-title
+
+ **validate_certs**
+
+ .. raw:: html
+
+
+
+ .. ansible-option-type-line::
+
+ :ansible-option-type:`boolean`
+
+ :ansible-option-versionadded:`added in ansible.eda 2.0.0`
+
+
+ .. raw:: html
+
+
+
+ Whether to allow insecure connections to Ansible Automation Platform EDA Controller instance.
+
+ If \ :literal:`no`\ , SSL certificates will not be validated.
+
+ This should only be used on personally controlled sites using self-signed certificates.
+
+ If value not set, will try environment variable \ :literal:`CONTROLLER\_VERIFY\_SSL`\
+
+
+ .. rst-class:: ansible-option-line
+
+ :ansible-option-choices:`Choices:`
+
+ - :ansible-option-choices-entry:`false`
+ - :ansible-option-choices-entry-default:`true` :ansible-option-choices-default-mark:`← (default)`
+
+
+ .. raw:: html
+
+
+
+
+.. Attributes
+
+
+.. Notes
+
+
+.. Seealso
+
+
+.. Examples
+
+Examples
+--------
+
+.. code-block:: yaml+jinja
+
+
+ - name: Create an EDA Credential
+ ansible.eda.credential:
+ name: "Example Credential"
+ description: "Example credential description"
+ inputs:
+ field1: "field1"
+ credential_type_name: "GitLab Personal Access Token"
+
+ - name: Delete an EDA Credential
+ ansible.eda.credential:
+ name: "Example Credential"
+ state: absent
+
+
+
+
+.. Facts
+
+
+.. Return values
+
+Return Values
+-------------
+Common return values are documented :ref:`here `, the following are the fields unique to this module:
+
+.. tabularcolumns:: \X{1}{3}\X{2}{3}
+
+.. list-table::
+ :width: 100%
+ :widths: auto
+ :header-rows: 1
+ :class: longtable ansible-option-table
+
+ * - Key
+ - Description
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.ansible.eda.credential_module__return-id:
+
+ .. rst-class:: ansible-option-title
+
+ **id**
+
+ .. raw:: html
+
+
+
+ .. ansible-option-type-line::
+
+ :ansible-option-type:`integer`
+
+ .. raw:: html
+
+
+
+ ID of the credential.
+
+
+ .. rst-class:: ansible-option-line
+
+ :ansible-option-returned-bold:`Returned:` when exists
+
+ .. rst-class:: ansible-option-line
+ .. rst-class:: ansible-option-sample
+
+ :ansible-option-sample-bold:`Sample:` :ansible-rv-sample-value:`24`
+
+
+ .. raw:: html
+
+
+
+
+
+.. Status (Presently only deprecated)
+
+
+.. Authors
+
+Authors
+~~~~~~~
+
+- Nikhil Jain (@jainnikhil30)
+- Alina Buzachis (@alinabuzachis)
+
+
+
+.. Extra links
+
+Collection links
+~~~~~~~~~~~~~~~~
+
+.. ansible-links::
+
+ - title: "Issue Tracker"
+ url: "https://github.com/ansible/event-driven-ansible/issues"
+ external: true
+ - title: "Homepage"
+ url: "http://ansible.com/event-driven"
+ external: true
+ - title: "Repository (Sources)"
+ url: "https://github.com/ansible/event-driven-ansible"
+ external: true
+
+
+.. Parsing errors
+
diff --git a/docs/rst/credential_type_info_module.rst b/docs/rst/credential_type_info_module.rst
new file mode 100644
index 00000000..c2690d43
--- /dev/null
+++ b/docs/rst/credential_type_info_module.rst
@@ -0,0 +1,452 @@
+
+.. Document meta
+
+:orphan:
+
+.. |antsibull-internal-nbsp| unicode:: 0xA0
+ :trim:
+
+.. meta::
+ :antsibull-docs: 2.12.0
+
+.. Anchors
+
+.. _ansible_collections.ansible.eda.credential_type_info_module:
+
+.. Anchors: short name for ansible.builtin
+
+.. Title
+
+ansible.eda.credential_type_info module -- List credential types in EDA Controller
+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
+
+.. Collection note
+
+.. note::
+ This module is part of the `ansible.eda collection `_ (version 1.4.7).
+
+ 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 ansible.eda`.
+
+ To use it in a playbook, specify: :code:`ansible.eda.credential_type_info`.
+
+.. version_added
+
+.. rst-class:: ansible-version-added
+
+New in ansible.eda 2.0.0
+
+.. contents::
+ :local:
+ :depth: 1
+
+.. Deprecated
+
+
+Synopsis
+--------
+
+.. Description
+
+- List credential types in EDA controller.
+
+
+.. Aliases
+
+
+.. Requirements
+
+
+
+
+
+
+.. Options
+
+Parameters
+----------
+
+.. tabularcolumns:: \X{1}{3}\X{2}{3}
+
+.. list-table::
+ :width: 100%
+ :widths: auto
+ :header-rows: 1
+ :class: longtable ansible-option-table
+
+ * - Parameter
+ - Comments
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.ansible.eda.credential_type_info_module__parameter-controller_host:
+
+ .. rst-class:: ansible-option-title
+
+ **controller_host**
+
+ .. raw:: html
+
+
+
+ .. ansible-option-type-line::
+
+ :ansible-option-type:`string` / :ansible-option-required:`required`
+
+ :ansible-option-versionadded:`added in ansible.eda 2.0.0`
+
+
+ .. raw:: html
+
+
+
+ The URL of the EDA controller.
+
+ If not set, the value of the \ :literal:`CONTROLLER\_URL`\ environment variable will be used.
+
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.ansible.eda.credential_type_info_module__parameter-controller_password:
+
+ .. rst-class:: ansible-option-title
+
+ **controller_password**
+
+ .. raw:: html
+
+
+
+ .. ansible-option-type-line::
+
+ :ansible-option-type:`string`
+
+ :ansible-option-versionadded:`added in ansible.eda 2.0.0`
+
+
+ .. raw:: html
+
+
+
+ Password used for authentication.
+
+ If not set, the value of the \ :literal:`CONTROLLER\_PASSWORD`\ environment variable will be used.
+
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.ansible.eda.credential_type_info_module__parameter-controller_username:
+
+ .. rst-class:: ansible-option-title
+
+ **controller_username**
+
+ .. raw:: html
+
+
+
+ .. ansible-option-type-line::
+
+ :ansible-option-type:`string`
+
+ :ansible-option-versionadded:`added in ansible.eda 2.0.0`
+
+
+ .. raw:: html
+
+
+
+ Username used for authentication.
+
+ If not set, the value of the \ :literal:`CONTROLLER\_USERNAME`\ environment variable will be used.
+
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.ansible.eda.credential_type_info_module__parameter-name:
+
+ .. rst-class:: ansible-option-title
+
+ **name**
+
+ .. raw:: html
+
+
+
+ .. ansible-option-type-line::
+
+ :ansible-option-type:`string`
+
+ .. raw:: html
+
+
+
+ The name of the credential type.
+
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.ansible.eda.credential_type_info_module__parameter-request_timeout:
+
+ .. rst-class:: ansible-option-title
+
+ **request_timeout**
+
+ .. raw:: html
+
+
+
+ .. ansible-option-type-line::
+
+ :ansible-option-type:`float`
+
+ :ansible-option-versionadded:`added in ansible.eda 2.0.0`
+
+
+ .. raw:: html
+
+
+
+ Timeout in seconds for the connection with the EDA controller.
+
+ If not set, the value of the \ :literal:`CONTROLLER\_TIMEOUT`\ environment variable will be used.
+
+
+ .. rst-class:: ansible-option-line
+
+ :ansible-option-default-bold:`Default:` :ansible-option-default:`10.0`
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.ansible.eda.credential_type_info_module__parameter-validate_certs:
+
+ .. rst-class:: ansible-option-title
+
+ **validate_certs**
+
+ .. raw:: html
+
+
+
+ .. ansible-option-type-line::
+
+ :ansible-option-type:`boolean`
+
+ :ansible-option-versionadded:`added in ansible.eda 2.0.0`
+
+
+ .. raw:: html
+
+
+
+ Whether to allow insecure connections to Ansible Automation Platform EDA Controller instance.
+
+ If \ :literal:`no`\ , SSL certificates will not be validated.
+
+ This should only be used on personally controlled sites using self-signed certificates.
+
+ If value not set, will try environment variable \ :literal:`CONTROLLER\_VERIFY\_SSL`\
+
+
+ .. rst-class:: ansible-option-line
+
+ :ansible-option-choices:`Choices:`
+
+ - :ansible-option-choices-entry:`false`
+ - :ansible-option-choices-entry-default:`true` :ansible-option-choices-default-mark:`← (default)`
+
+
+ .. raw:: html
+
+
+
+
+.. Attributes
+
+
+.. Notes
+
+
+.. Seealso
+
+
+.. Examples
+
+Examples
+--------
+
+.. code-block:: yaml+jinja
+
+
+ - name: Get information about a credential type
+ ansible.eda.credential_type_info:
+ name: "Test"
+
+ - name: List all credential types
+ ansible.eda.credential_type_info:
+
+
+
+
+.. Facts
+
+
+.. Return values
+
+Return Values
+-------------
+Common return values are documented :ref:`here `, the following are the fields unique to this module:
+
+.. tabularcolumns:: \X{1}{3}\X{2}{3}
+
+.. list-table::
+ :width: 100%
+ :widths: auto
+ :header-rows: 1
+ :class: longtable ansible-option-table
+
+ * - Key
+ - Description
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.ansible.eda.credential_type_info_module__return-credential_types:
+
+ .. rst-class:: ansible-option-title
+
+ **credential_types**
+
+ .. raw:: html
+
+
+
+ .. ansible-option-type-line::
+
+ :ansible-option-type:`list` / :ansible-option-elements:`elements=dictionary`
+
+ .. raw:: html
+
+
+
+ Information about the credential types.
+
+
+ .. rst-class:: ansible-option-line
+
+ :ansible-option-returned-bold:`Returned:` always
+
+ .. rst-class:: ansible-option-line
+ .. rst-class:: ansible-option-sample
+
+ :ansible-option-sample-bold:`Sample:` :ansible-rv-sample-value:`[{"created\_at": "2024-08-14T08:30:14.806638Z", "description": "A test credential type", "id": 37, "injectors": {"extra\_vars": {"field1": "field1"}}, "inputs": {"fields": [{"id": "field1", "label": "Field 5", "type": "string"}]}, "kind": "cloud", "managed": false, "modified\_at": "2024-08-14T08:30:14.807549Z", "name": "Example", "namespace": null}]`
+
+
+ .. raw:: html
+
+
+
+
+
+.. Status (Presently only deprecated)
+
+
+.. Authors
+
+Authors
+~~~~~~~
+
+- Alina Buzachis (@alinabuzachis)
+
+
+
+.. Extra links
+
+Collection links
+~~~~~~~~~~~~~~~~
+
+.. ansible-links::
+
+ - title: "Issue Tracker"
+ url: "https://github.com/ansible/event-driven-ansible/issues"
+ external: true
+ - title: "Homepage"
+ url: "http://ansible.com/event-driven"
+ external: true
+ - title: "Repository (Sources)"
+ url: "https://github.com/ansible/event-driven-ansible"
+ external: true
+
+
+.. Parsing errors
+
diff --git a/docs/rst/credential_type_module.rst b/docs/rst/credential_type_module.rst
new file mode 100644
index 00000000..e2b799f6
--- /dev/null
+++ b/docs/rst/credential_type_module.rst
@@ -0,0 +1,642 @@
+
+.. Document meta
+
+:orphan:
+
+.. |antsibull-internal-nbsp| unicode:: 0xA0
+ :trim:
+
+.. meta::
+ :antsibull-docs: 2.12.0
+
+.. Anchors
+
+.. _ansible_collections.ansible.eda.credential_type_module:
+
+.. Anchors: short name for ansible.builtin
+
+.. Title
+
+ansible.eda.credential_type module -- Manage credential types in EDA Controller
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
+
+.. Collection note
+
+.. note::
+ This module is part of the `ansible.eda collection `_ (version 1.4.7).
+
+ 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 ansible.eda`.
+
+ To use it in a playbook, specify: :code:`ansible.eda.credential_type`.
+
+.. version_added
+
+.. rst-class:: ansible-version-added
+
+New in ansible.eda 2.0.0
+
+.. contents::
+ :local:
+ :depth: 1
+
+.. Deprecated
+
+
+Synopsis
+--------
+
+.. Description
+
+- This module allows the user to create, update or delete a credential type in EDA controller.
+
+
+.. Aliases
+
+
+.. Requirements
+
+
+
+
+
+
+.. Options
+
+Parameters
+----------
+
+.. tabularcolumns:: \X{1}{3}\X{2}{3}
+
+.. list-table::
+ :width: 100%
+ :widths: auto
+ :header-rows: 1
+ :class: longtable ansible-option-table
+
+ * - Parameter
+ - Comments
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.ansible.eda.credential_type_module__parameter-controller_host:
+
+ .. rst-class:: ansible-option-title
+
+ **controller_host**
+
+ .. raw:: html
+
+
+
+ .. ansible-option-type-line::
+
+ :ansible-option-type:`string` / :ansible-option-required:`required`
+
+ :ansible-option-versionadded:`added in ansible.eda 2.0.0`
+
+
+ .. raw:: html
+
+
+
+ The URL of the EDA controller.
+
+ If not set, the value of the \ :literal:`CONTROLLER\_URL`\ environment variable will be used.
+
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.ansible.eda.credential_type_module__parameter-controller_password:
+
+ .. rst-class:: ansible-option-title
+
+ **controller_password**
+
+ .. raw:: html
+
+
+
+ .. ansible-option-type-line::
+
+ :ansible-option-type:`string`
+
+ :ansible-option-versionadded:`added in ansible.eda 2.0.0`
+
+
+ .. raw:: html
+
+
+
+ Password used for authentication.
+
+ If not set, the value of the \ :literal:`CONTROLLER\_PASSWORD`\ environment variable will be used.
+
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.ansible.eda.credential_type_module__parameter-controller_username:
+
+ .. rst-class:: ansible-option-title
+
+ **controller_username**
+
+ .. raw:: html
+
+
+
+ .. ansible-option-type-line::
+
+ :ansible-option-type:`string`
+
+ :ansible-option-versionadded:`added in ansible.eda 2.0.0`
+
+
+ .. raw:: html
+
+
+
+ Username used for authentication.
+
+ If not set, the value of the \ :literal:`CONTROLLER\_USERNAME`\ environment variable will be used.
+
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.ansible.eda.credential_type_module__parameter-description:
+
+ .. rst-class:: ansible-option-title
+
+ **description**
+
+ .. raw:: html
+
+
+
+ .. ansible-option-type-line::
+
+ :ansible-option-type:`string`
+
+ .. raw:: html
+
+
+
+ The description of the credential type to give more detail about it.
+
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.ansible.eda.credential_type_module__parameter-injectors:
+
+ .. rst-class:: ansible-option-title
+
+ **injectors**
+
+ .. raw:: html
+
+
+
+ .. ansible-option-type-line::
+
+ :ansible-option-type:`dictionary`
+
+ .. raw:: html
+
+
+
+ Injectors of the credential type.
+
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.ansible.eda.credential_type_module__parameter-inputs:
+
+ .. rst-class:: ansible-option-title
+
+ **inputs**
+
+ .. raw:: html
+
+
+
+ .. ansible-option-type-line::
+
+ :ansible-option-type:`dictionary`
+
+ .. raw:: html
+
+
+
+ Inputs of the credential type.
+
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.ansible.eda.credential_type_module__parameter-name:
+
+ .. rst-class:: ansible-option-title
+
+ **name**
+
+ .. raw:: html
+
+
+
+ .. ansible-option-type-line::
+
+ :ansible-option-type:`string` / :ansible-option-required:`required`
+
+ .. raw:: html
+
+
+
+ The name of the credential type.
+
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.ansible.eda.credential_type_module__parameter-new_name:
+
+ .. rst-class:: ansible-option-title
+
+ **new_name**
+
+ .. raw:: html
+
+
+
+ .. ansible-option-type-line::
+
+ :ansible-option-type:`string`
+
+ .. raw:: html
+
+
+
+ Setting this option will change the existing name.
+
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.ansible.eda.credential_type_module__parameter-request_timeout:
+
+ .. rst-class:: ansible-option-title
+
+ **request_timeout**
+
+ .. raw:: html
+
+
+
+ .. ansible-option-type-line::
+
+ :ansible-option-type:`float`
+
+ :ansible-option-versionadded:`added in ansible.eda 2.0.0`
+
+
+ .. raw:: html
+
+
+
+ Timeout in seconds for the connection with the EDA controller.
+
+ If not set, the value of the \ :literal:`CONTROLLER\_TIMEOUT`\ environment variable will be used.
+
+
+ .. rst-class:: ansible-option-line
+
+ :ansible-option-default-bold:`Default:` :ansible-option-default:`10.0`
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.ansible.eda.credential_type_module__parameter-state:
+
+ .. rst-class:: ansible-option-title
+
+ **state**
+
+ .. raw:: html
+
+
+
+ .. ansible-option-type-line::
+
+ :ansible-option-type:`string`
+
+ .. raw:: html
+
+
+
+ Desired state of the resource.
+
+
+ .. rst-class:: ansible-option-line
+
+ :ansible-option-choices:`Choices:`
+
+ - :ansible-option-choices-entry-default:`"present"` :ansible-option-choices-default-mark:`← (default)`
+ - :ansible-option-choices-entry:`"absent"`
+
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.ansible.eda.credential_type_module__parameter-validate_certs:
+
+ .. rst-class:: ansible-option-title
+
+ **validate_certs**
+
+ .. raw:: html
+
+
+
+ .. ansible-option-type-line::
+
+ :ansible-option-type:`boolean`
+
+ :ansible-option-versionadded:`added in ansible.eda 2.0.0`
+
+
+ .. raw:: html
+
+
+
+ Whether to allow insecure connections to Ansible Automation Platform EDA Controller instance.
+
+ If \ :literal:`no`\ , SSL certificates will not be validated.
+
+ This should only be used on personally controlled sites using self-signed certificates.
+
+ If value not set, will try environment variable \ :literal:`CONTROLLER\_VERIFY\_SSL`\
+
+
+ .. rst-class:: ansible-option-line
+
+ :ansible-option-choices:`Choices:`
+
+ - :ansible-option-choices-entry:`false`
+ - :ansible-option-choices-entry-default:`true` :ansible-option-choices-default-mark:`← (default)`
+
+
+ .. raw:: html
+
+
+
+
+.. Attributes
+
+
+.. Notes
+
+
+.. Seealso
+
+
+.. Examples
+
+Examples
+--------
+
+.. code-block:: yaml+jinja
+
+
+ - name: Create a credential type
+ ansible.eda.credential_type:
+ name: "Test"
+ state: present
+ description: "A test credential type"
+ inputs:
+ fields:
+ - id: "Field1"
+ type: "string"
+ label: "Label1"
+ injectors:
+ extra_vars:
+ field1: "field1"
+
+ - name: Delete a credential type
+ ansible.eda.credential_type:
+ name: "Test"
+ state: absent
+
+
+
+
+.. Facts
+
+
+.. Return values
+
+Return Values
+-------------
+Common return values are documented :ref:`here `, the following are the fields unique to this module:
+
+.. tabularcolumns:: \X{1}{3}\X{2}{3}
+
+.. list-table::
+ :width: 100%
+ :widths: auto
+ :header-rows: 1
+ :class: longtable ansible-option-table
+
+ * - Key
+ - Description
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.ansible.eda.credential_type_module__return-id:
+
+ .. rst-class:: ansible-option-title
+
+ **id**
+
+ .. raw:: html
+
+
+
+ .. ansible-option-type-line::
+
+ :ansible-option-type:`integer`
+
+ .. raw:: html
+
+
+
+ ID of the credential type.
+
+
+ .. rst-class:: ansible-option-line
+
+ :ansible-option-returned-bold:`Returned:` when exists
+
+ .. rst-class:: ansible-option-line
+ .. rst-class:: ansible-option-sample
+
+ :ansible-option-sample-bold:`Sample:` :ansible-rv-sample-value:`37`
+
+
+ .. raw:: html
+
+
+
+
+
+.. Status (Presently only deprecated)
+
+
+.. Authors
+
+Authors
+~~~~~~~
+
+- Alina Buzachis (@alinabuzachis)
+
+
+
+.. Extra links
+
+Collection links
+~~~~~~~~~~~~~~~~
+
+.. ansible-links::
+
+ - title: "Issue Tracker"
+ url: "https://github.com/ansible/event-driven-ansible/issues"
+ external: true
+ - title: "Homepage"
+ url: "http://ansible.com/event-driven"
+ external: true
+ - title: "Repository (Sources)"
+ url: "https://github.com/ansible/event-driven-ansible"
+ external: true
+
+
+.. Parsing errors
+
diff --git a/docs/rst/decision_environment_info_module.rst b/docs/rst/decision_environment_info_module.rst
new file mode 100644
index 00000000..18cc4522
--- /dev/null
+++ b/docs/rst/decision_environment_info_module.rst
@@ -0,0 +1,458 @@
+
+.. Document meta
+
+:orphan:
+
+.. |antsibull-internal-nbsp| unicode:: 0xA0
+ :trim:
+
+.. meta::
+ :antsibull-docs: 2.12.0
+
+.. Anchors
+
+.. _ansible_collections.ansible.eda.decision_environment_info_module:
+
+.. Anchors: short name for ansible.builtin
+
+.. Title
+
+ansible.eda.decision_environment_info module -- List a decision environment in EDA Controller
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
+
+.. Collection note
+
+.. note::
+ This module is part of the `ansible.eda collection `_ (version 1.4.7).
+
+ 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 ansible.eda`.
+
+ To use it in a playbook, specify: :code:`ansible.eda.decision_environment_info`.
+
+.. version_added
+
+.. rst-class:: ansible-version-added
+
+New in ansible.eda 2.0.0
+
+.. contents::
+ :local:
+ :depth: 1
+
+.. Deprecated
+
+
+Synopsis
+--------
+
+.. Description
+
+- This module allows user to list a decision environment in a EDA controller.
+
+
+.. Aliases
+
+
+.. Requirements
+
+
+
+
+
+
+.. Options
+
+Parameters
+----------
+
+.. tabularcolumns:: \X{1}{3}\X{2}{3}
+
+.. list-table::
+ :width: 100%
+ :widths: auto
+ :header-rows: 1
+ :class: longtable ansible-option-table
+
+ * - Parameter
+ - Comments
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.ansible.eda.decision_environment_info_module__parameter-controller_host:
+
+ .. rst-class:: ansible-option-title
+
+ **controller_host**
+
+ .. raw:: html
+
+
+
+ .. ansible-option-type-line::
+
+ :ansible-option-type:`string` / :ansible-option-required:`required`
+
+ :ansible-option-versionadded:`added in ansible.eda 2.0.0`
+
+
+ .. raw:: html
+
+
+
+ The URL of the EDA controller.
+
+ If not set, the value of the \ :literal:`CONTROLLER\_URL`\ environment variable will be used.
+
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.ansible.eda.decision_environment_info_module__parameter-controller_password:
+
+ .. rst-class:: ansible-option-title
+
+ **controller_password**
+
+ .. raw:: html
+
+
+
+ .. ansible-option-type-line::
+
+ :ansible-option-type:`string`
+
+ :ansible-option-versionadded:`added in ansible.eda 2.0.0`
+
+
+ .. raw:: html
+
+
+
+ Password used for authentication.
+
+ If not set, the value of the \ :literal:`CONTROLLER\_PASSWORD`\ environment variable will be used.
+
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.ansible.eda.decision_environment_info_module__parameter-controller_username:
+
+ .. rst-class:: ansible-option-title
+
+ **controller_username**
+
+ .. raw:: html
+
+
+
+ .. ansible-option-type-line::
+
+ :ansible-option-type:`string`
+
+ :ansible-option-versionadded:`added in ansible.eda 2.0.0`
+
+
+ .. raw:: html
+
+
+
+ Username used for authentication.
+
+ If not set, the value of the \ :literal:`CONTROLLER\_USERNAME`\ environment variable will be used.
+
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.ansible.eda.decision_environment_info_module__parameter-name:
+
+ .. rst-class:: ansible-option-title
+
+ **name**
+
+ .. raw:: html
+
+
+
+ .. ansible-option-type-line::
+
+ :ansible-option-type:`string`
+
+ .. raw:: html
+
+
+
+ The name of the decision environment.
+
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.ansible.eda.decision_environment_info_module__parameter-request_timeout:
+
+ .. rst-class:: ansible-option-title
+
+ **request_timeout**
+
+ .. raw:: html
+
+
+
+ .. ansible-option-type-line::
+
+ :ansible-option-type:`float`
+
+ :ansible-option-versionadded:`added in ansible.eda 2.0.0`
+
+
+ .. raw:: html
+
+
+
+ Timeout in seconds for the connection with the EDA controller.
+
+ If not set, the value of the \ :literal:`CONTROLLER\_TIMEOUT`\ environment variable will be used.
+
+
+ .. rst-class:: ansible-option-line
+
+ :ansible-option-default-bold:`Default:` :ansible-option-default:`10.0`
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.ansible.eda.decision_environment_info_module__parameter-validate_certs:
+
+ .. rst-class:: ansible-option-title
+
+ **validate_certs**
+
+ .. raw:: html
+
+
+
+ .. ansible-option-type-line::
+
+ :ansible-option-type:`boolean`
+
+ :ansible-option-versionadded:`added in ansible.eda 2.0.0`
+
+
+ .. raw:: html
+
+
+
+ Whether to allow insecure connections to Ansible Automation Platform EDA Controller instance.
+
+ If \ :literal:`no`\ , SSL certificates will not be validated.
+
+ This should only be used on personally controlled sites using self-signed certificates.
+
+ If value not set, will try environment variable \ :literal:`CONTROLLER\_VERIFY\_SSL`\
+
+
+ .. rst-class:: ansible-option-line
+
+ :ansible-option-choices:`Choices:`
+
+ - :ansible-option-choices-entry:`false`
+ - :ansible-option-choices-entry-default:`true` :ansible-option-choices-default-mark:`← (default)`
+
+
+ .. raw:: html
+
+
+
+
+.. Attributes
+
+
+.. Notes
+
+
+.. Seealso
+
+
+.. Examples
+
+Examples
+--------
+
+.. code-block:: yaml+jinja
+
+
+ - name: List all EDA Decision Environments
+ ansible.eda.decision_environment_info:
+ controller_host: https://my_eda_host/
+ controller_username: admin
+ controller_password: MySuperSecretPassw0rd
+
+ - name: List a particular EDA Decision Environments
+ ansible.eda.decision_environment_info:
+ controller_host: https://my_eda_host/
+ controller_username: admin
+ controller_password: MySuperSecretPassw0rd
+ name: Example
+
+
+
+
+.. Facts
+
+
+.. Return values
+
+Return Values
+-------------
+Common return values are documented :ref:`here `, the following are the fields unique to this module:
+
+.. tabularcolumns:: \X{1}{3}\X{2}{3}
+
+.. list-table::
+ :width: 100%
+ :widths: auto
+ :header-rows: 1
+ :class: longtable ansible-option-table
+
+ * - Key
+ - Description
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.ansible.eda.decision_environment_info_module__return-decision_environments:
+
+ .. rst-class:: ansible-option-title
+
+ **decision_environments**
+
+ .. raw:: html
+
+
+
+ .. ansible-option-type-line::
+
+ :ansible-option-type:`list` / :ansible-option-elements:`elements=string`
+
+ .. raw:: html
+
+
+
+ List of dict containing information about decision environments
+
+
+ .. rst-class:: ansible-option-line
+
+ :ansible-option-returned-bold:`Returned:` when exists
+
+ .. rst-class:: ansible-option-line
+ .. rst-class:: ansible-option-sample
+
+ :ansible-option-sample-bold:`Sample:` :ansible-rv-sample-value:`[{"created\_at": "2024-08-15T21:12:52.218969Z", "description": "Example decision environment description", "eda\_credential\_id": null, "id": 35, "image\_url": "https://quay.io/repository/ansible/eda-server", "modified\_at": "2024-08-15T21:12:52.218994Z", "name": "Example Decision environment", "organization\_id": 1}]`
+
+
+ .. raw:: html
+
+
+
+
+
+.. Status (Presently only deprecated)
+
+
+.. Authors
+
+Authors
+~~~~~~~
+
+- Abhijeet Kasurde (@akasurde)
+
+
+
+.. Extra links
+
+Collection links
+~~~~~~~~~~~~~~~~
+
+.. ansible-links::
+
+ - title: "Issue Tracker"
+ url: "https://github.com/ansible/event-driven-ansible/issues"
+ external: true
+ - title: "Homepage"
+ url: "http://ansible.com/event-driven"
+ external: true
+ - title: "Repository (Sources)"
+ url: "https://github.com/ansible/event-driven-ansible"
+ external: true
+
+
+.. Parsing errors
+
diff --git a/docs/rst/decision_environment_module.rst b/docs/rst/decision_environment_module.rst
new file mode 100644
index 00000000..d30cc447
--- /dev/null
+++ b/docs/rst/decision_environment_module.rst
@@ -0,0 +1,652 @@
+
+.. Document meta
+
+:orphan:
+
+.. |antsibull-internal-nbsp| unicode:: 0xA0
+ :trim:
+
+.. meta::
+ :antsibull-docs: 2.12.0
+
+.. Anchors
+
+.. _ansible_collections.ansible.eda.decision_environment_module:
+
+.. Anchors: short name for ansible.builtin
+
+.. Title
+
+ansible.eda.decision_environment module -- Create, update or delete decision environment in EDA Controller
+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
+
+.. Collection note
+
+.. note::
+ This module is part of the `ansible.eda collection `_ (version 1.4.7).
+
+ 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 ansible.eda`.
+
+ To use it in a playbook, specify: :code:`ansible.eda.decision_environment`.
+
+.. version_added
+
+.. rst-class:: ansible-version-added
+
+New in ansible.eda 2.0.0
+
+.. contents::
+ :local:
+ :depth: 1
+
+.. Deprecated
+
+
+Synopsis
+--------
+
+.. Description
+
+- This module allows user to create, update or delete decision environment in a EDA controller.
+
+
+.. Aliases
+
+
+.. Requirements
+
+
+
+
+
+
+.. Options
+
+Parameters
+----------
+
+.. tabularcolumns:: \X{1}{3}\X{2}{3}
+
+.. list-table::
+ :width: 100%
+ :widths: auto
+ :header-rows: 1
+ :class: longtable ansible-option-table
+
+ * - Parameter
+ - Comments
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.ansible.eda.decision_environment_module__parameter-controller_host:
+
+ .. rst-class:: ansible-option-title
+
+ **controller_host**
+
+ .. raw:: html
+
+
+
+ .. ansible-option-type-line::
+
+ :ansible-option-type:`string` / :ansible-option-required:`required`
+
+ :ansible-option-versionadded:`added in ansible.eda 2.0.0`
+
+
+ .. raw:: html
+
+
+
+ The URL of the EDA controller.
+
+ If not set, the value of the \ :literal:`CONTROLLER\_URL`\ environment variable will be used.
+
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.ansible.eda.decision_environment_module__parameter-controller_password:
+
+ .. rst-class:: ansible-option-title
+
+ **controller_password**
+
+ .. raw:: html
+
+
+
+ .. ansible-option-type-line::
+
+ :ansible-option-type:`string`
+
+ :ansible-option-versionadded:`added in ansible.eda 2.0.0`
+
+
+ .. raw:: html
+
+
+
+ Password used for authentication.
+
+ If not set, the value of the \ :literal:`CONTROLLER\_PASSWORD`\ environment variable will be used.
+
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.ansible.eda.decision_environment_module__parameter-controller_username:
+
+ .. rst-class:: ansible-option-title
+
+ **controller_username**
+
+ .. raw:: html
+
+
+
+ .. ansible-option-type-line::
+
+ :ansible-option-type:`string`
+
+ :ansible-option-versionadded:`added in ansible.eda 2.0.0`
+
+
+ .. raw:: html
+
+
+
+ Username used for authentication.
+
+ If not set, the value of the \ :literal:`CONTROLLER\_USERNAME`\ environment variable will be used.
+
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.ansible.eda.decision_environment_module__parameter-credential:
+
+ .. rst-class:: ansible-option-title
+
+ **credential**
+
+ .. raw:: html
+
+
+
+ .. ansible-option-type-line::
+
+ :ansible-option-type:`string`
+
+ .. raw:: html
+
+
+
+ Name of the credential to associate with the decision environment.
+
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.ansible.eda.decision_environment_module__parameter-description:
+
+ .. rst-class:: ansible-option-title
+
+ **description**
+
+ .. raw:: html
+
+
+
+ .. ansible-option-type-line::
+
+ :ansible-option-type:`string`
+
+ .. raw:: html
+
+
+
+ The description of the decision environment.
+
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.ansible.eda.decision_environment_module__parameter-image_url:
+
+ .. rst-class:: ansible-option-title
+
+ **image_url**
+
+ .. raw:: html
+
+
+
+ .. ansible-option-type-line::
+
+ :ansible-option-type:`string`
+
+ .. raw:: html
+
+
+
+ Image URL of the decision environment.
+
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.ansible.eda.decision_environment_module__parameter-name:
+
+ .. rst-class:: ansible-option-title
+
+ **name**
+
+ .. raw:: html
+
+
+
+ .. ansible-option-type-line::
+
+ :ansible-option-type:`string` / :ansible-option-required:`required`
+
+ .. raw:: html
+
+
+
+ The name of the decision environment.
+
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.ansible.eda.decision_environment_module__parameter-new_name:
+
+ .. rst-class:: ansible-option-title
+
+ **new_name**
+
+ .. raw:: html
+
+
+
+ .. ansible-option-type-line::
+
+ :ansible-option-type:`string`
+
+ .. raw:: html
+
+
+
+ Setting this option will change the existing name.
+
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.ansible.eda.decision_environment_module__parameter-request_timeout:
+
+ .. rst-class:: ansible-option-title
+
+ **request_timeout**
+
+ .. raw:: html
+
+
+
+ .. ansible-option-type-line::
+
+ :ansible-option-type:`float`
+
+ :ansible-option-versionadded:`added in ansible.eda 2.0.0`
+
+
+ .. raw:: html
+
+
+
+ Timeout in seconds for the connection with the EDA controller.
+
+ If not set, the value of the \ :literal:`CONTROLLER\_TIMEOUT`\ environment variable will be used.
+
+
+ .. rst-class:: ansible-option-line
+
+ :ansible-option-default-bold:`Default:` :ansible-option-default:`10.0`
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.ansible.eda.decision_environment_module__parameter-state:
+
+ .. rst-class:: ansible-option-title
+
+ **state**
+
+ .. raw:: html
+
+
+
+ .. ansible-option-type-line::
+
+ :ansible-option-type:`string`
+
+ .. raw:: html
+
+
+
+ Desired state of the resource.
+
+
+ .. rst-class:: ansible-option-line
+
+ :ansible-option-choices:`Choices:`
+
+ - :ansible-option-choices-entry-default:`"present"` :ansible-option-choices-default-mark:`← (default)`
+ - :ansible-option-choices-entry:`"absent"`
+
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.ansible.eda.decision_environment_module__parameter-validate_certs:
+
+ .. rst-class:: ansible-option-title
+
+ **validate_certs**
+
+ .. raw:: html
+
+
+
+ .. ansible-option-type-line::
+
+ :ansible-option-type:`boolean`
+
+ :ansible-option-versionadded:`added in ansible.eda 2.0.0`
+
+
+ .. raw:: html
+
+
+
+ Whether to allow insecure connections to Ansible Automation Platform EDA Controller instance.
+
+ If \ :literal:`no`\ , SSL certificates will not be validated.
+
+ This should only be used on personally controlled sites using self-signed certificates.
+
+ If value not set, will try environment variable \ :literal:`CONTROLLER\_VERIFY\_SSL`\
+
+
+ .. rst-class:: ansible-option-line
+
+ :ansible-option-choices:`Choices:`
+
+ - :ansible-option-choices-entry:`false`
+ - :ansible-option-choices-entry-default:`true` :ansible-option-choices-default-mark:`← (default)`
+
+
+ .. raw:: html
+
+
+
+
+.. Attributes
+
+
+.. Notes
+
+
+.. Seealso
+
+
+.. Examples
+
+Examples
+--------
+
+.. code-block:: yaml+jinja
+
+
+ - name: Create EDA Decision Environment
+ ansible.eda.decision_environment:
+ controller_host: https://my_eda_host/
+ controller_username: admin
+ controller_password: MySuperSecretPassw0rd
+ name: "Example Decision Environment"
+ description: "Example Decision Environment description"
+ image_url: "quay.io/test"
+ credential: "Example Credential"
+ state: present
+
+ - name: Update the name of the Decision Environment
+ ansible.eda.decision_environment:
+ controller_host: https://my_eda_host/
+ controller_username: admin
+ controller_password: MySuperSecretPassw0rd
+ name: "Example Decision Environment"
+ new_name: "Latest Example Decision Environment"
+ state: present
+
+ - name: Delete the the Decision Environment
+ ansible.eda.decision_environment:
+ controller_host: https://my_eda_host/
+ controller_username: admin
+ controller_password: MySuperSecretPassw0rd
+ name: "Example Decision Environment"
+ state: absent
+
+
+
+
+.. Facts
+
+
+.. Return values
+
+Return Values
+-------------
+Common return values are documented :ref:`here `, the following are the fields unique to this module:
+
+.. tabularcolumns:: \X{1}{3}\X{2}{3}
+
+.. list-table::
+ :width: 100%
+ :widths: auto
+ :header-rows: 1
+ :class: longtable ansible-option-table
+
+ * - Key
+ - Description
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.ansible.eda.decision_environment_module__return-id:
+
+ .. rst-class:: ansible-option-title
+
+ **id**
+
+ .. raw:: html
+
+
+
+ .. ansible-option-type-line::
+
+ :ansible-option-type:`integer`
+
+ .. raw:: html
+
+
+
+ ID of the decision environment
+
+
+ .. rst-class:: ansible-option-line
+
+ :ansible-option-returned-bold:`Returned:` when exists
+
+ .. rst-class:: ansible-option-line
+ .. rst-class:: ansible-option-sample
+
+ :ansible-option-sample-bold:`Sample:` :ansible-rv-sample-value:`37`
+
+
+ .. raw:: html
+
+
+
+
+
+.. Status (Presently only deprecated)
+
+
+.. Authors
+
+Authors
+~~~~~~~
+
+- Nikhil Jain (@jainnikhil30)
+- Abhijeet Kasurde (@akasurde)
+
+
+
+.. Extra links
+
+Collection links
+~~~~~~~~~~~~~~~~
+
+.. ansible-links::
+
+ - title: "Issue Tracker"
+ url: "https://github.com/ansible/event-driven-ansible/issues"
+ external: true
+ - title: "Homepage"
+ url: "http://ansible.com/event-driven"
+ external: true
+ - title: "Repository (Sources)"
+ url: "https://github.com/ansible/event-driven-ansible"
+ external: true
+
+
+.. Parsing errors
+
diff --git a/docs/rst/environment_variables.rst b/docs/rst/environment_variables.rst
new file mode 100644
index 00000000..3007982b
--- /dev/null
+++ b/docs/rst/environment_variables.rst
@@ -0,0 +1,15 @@
+
+:orphan:
+
+.. meta::
+ :antsibull-docs: 2.12.0
+
+.. _list_of_collection_env_vars:
+
+Index of all Collection Environment Variables
+=============================================
+
+The following index documents all environment variables declared by plugins in collections.
+Environment variables used by the ansible-core configuration are documented in :ref:`ansible_configuration_settings`.
+
+No environment variables have been defined.
diff --git a/docs/rst/index.rst b/docs/rst/index.rst
new file mode 100644
index 00000000..8d6a13d6
--- /dev/null
+++ b/docs/rst/index.rst
@@ -0,0 +1,89 @@
+
+
+.. meta::
+ :antsibull-docs: 2.12.0
+
+
+.. _plugins_in_ansible.eda:
+
+Ansible.Eda
+===========
+
+Collection version 1.4.7
+
+.. contents::
+ :local:
+ :depth: 1
+
+Description
+-----------
+
+Event-Driven Ansible
+
+**Authors:**
+
+* bthomass@redhat.com
+* jpisciot@redhat.com
+
+**Supported ansible-core versions:**
+
+* 2.15.0 or newer
+
+.. ansible-links::
+
+ - title: "Issue Tracker"
+ url: "https://github.com/ansible/event-driven-ansible/issues"
+ external: true
+ - title: "Homepage"
+ url: "http://ansible.com/event-driven"
+ external: true
+ - title: "Repository (Sources)"
+ url: "https://github.com/ansible/event-driven-ansible"
+ external: true
+
+
+
+
+.. toctree::
+ :maxdepth: 1
+
+Plugin Index
+------------
+
+These are the plugins in the ansible.eda collection:
+
+
+Modules
+~~~~~~~
+
+* :ansplugin:`activation module ` -- Manage rulebook activations in the EDA Controller
+* :ansplugin:`activation_info module ` -- List rulebook activations in the EDA Controller
+* :ansplugin:`controller_token module ` -- Manage AWX tokens in EDA controller
+* :ansplugin:`credential module ` -- Manage credentials in EDA Controller
+* :ansplugin:`credential_info module ` -- List credentials in the EDA Controller
+* :ansplugin:`credential_type module ` -- Manage credential types in EDA Controller
+* :ansplugin:`credential_type_info module ` -- List credential types in EDA Controller
+* :ansplugin:`decision_environment module ` -- Create, update or delete decision environment in EDA Controller
+* :ansplugin:`decision_environment_info module ` -- List a decision environment in EDA Controller
+* :ansplugin:`project module ` -- Create, update or delete project in EDA Controller
+* :ansplugin:`project_info module ` -- List projects in EDA Controller
+* :ansplugin:`user module ` -- Manage users in EDA controller
+
+.. toctree::
+ :maxdepth: 1
+ :hidden:
+
+ activation_module
+ activation_info_module
+ controller_token_module
+ credential_module
+ credential_info_module
+ credential_type_module
+ credential_type_info_module
+ decision_environment_module
+ decision_environment_info_module
+ project_module
+ project_info_module
+ user_module
+
+
diff --git a/docs/rst/project_info_module.rst b/docs/rst/project_info_module.rst
new file mode 100644
index 00000000..f8fe8d3e
--- /dev/null
+++ b/docs/rst/project_info_module.rst
@@ -0,0 +1,462 @@
+
+.. Document meta
+
+:orphan:
+
+.. |antsibull-internal-nbsp| unicode:: 0xA0
+ :trim:
+
+.. meta::
+ :antsibull-docs: 2.12.0
+
+.. Anchors
+
+.. _ansible_collections.ansible.eda.project_info_module:
+
+.. Anchors: short name for ansible.builtin
+
+.. Title
+
+ansible.eda.project_info module -- List projects in EDA Controller
+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
+
+.. Collection note
+
+.. note::
+ This module is part of the `ansible.eda collection `_ (version 1.4.7).
+
+ 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 ansible.eda`.
+
+ To use it in a playbook, specify: :code:`ansible.eda.project_info`.
+
+.. version_added
+
+.. rst-class:: ansible-version-added
+
+New in ansible.eda 2.0.0
+
+.. contents::
+ :local:
+ :depth: 1
+
+.. Deprecated
+
+
+Synopsis
+--------
+
+.. Description
+
+- This module allows user to list project in a EDA controller.
+
+
+.. Aliases
+
+
+.. Requirements
+
+
+
+
+
+
+.. Options
+
+Parameters
+----------
+
+.. tabularcolumns:: \X{1}{3}\X{2}{3}
+
+.. list-table::
+ :width: 100%
+ :widths: auto
+ :header-rows: 1
+ :class: longtable ansible-option-table
+
+ * - Parameter
+ - Comments
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.ansible.eda.project_info_module__parameter-controller_host:
+
+ .. rst-class:: ansible-option-title
+
+ **controller_host**
+
+ .. raw:: html
+
+
+
+ .. ansible-option-type-line::
+
+ :ansible-option-type:`string` / :ansible-option-required:`required`
+
+ :ansible-option-versionadded:`added in ansible.eda 2.0.0`
+
+
+ .. raw:: html
+
+
+
+ The URL of the EDA controller.
+
+ If not set, the value of the \ :literal:`CONTROLLER\_URL`\ environment variable will be used.
+
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.ansible.eda.project_info_module__parameter-controller_password:
+
+ .. rst-class:: ansible-option-title
+
+ **controller_password**
+
+ .. raw:: html
+
+
+
+ .. ansible-option-type-line::
+
+ :ansible-option-type:`string`
+
+ :ansible-option-versionadded:`added in ansible.eda 2.0.0`
+
+
+ .. raw:: html
+
+
+
+ Password used for authentication.
+
+ If not set, the value of the \ :literal:`CONTROLLER\_PASSWORD`\ environment variable will be used.
+
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.ansible.eda.project_info_module__parameter-controller_username:
+
+ .. rst-class:: ansible-option-title
+
+ **controller_username**
+
+ .. raw:: html
+
+
+
+ .. ansible-option-type-line::
+
+ :ansible-option-type:`string`
+
+ :ansible-option-versionadded:`added in ansible.eda 2.0.0`
+
+
+ .. raw:: html
+
+
+
+ Username used for authentication.
+
+ If not set, the value of the \ :literal:`CONTROLLER\_USERNAME`\ environment variable will be used.
+
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.ansible.eda.project_info_module__parameter-name:
+
+ .. rst-class:: ansible-option-title
+
+ **name**
+
+ .. raw:: html
+
+
+
+ .. ansible-option-type-line::
+
+ :ansible-option-type:`string`
+
+ .. raw:: html
+
+
+
+ The name of the project.
+
+ Return information about particular project available on EDA Controller.
+
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.ansible.eda.project_info_module__parameter-request_timeout:
+
+ .. rst-class:: ansible-option-title
+
+ **request_timeout**
+
+ .. raw:: html
+
+
+
+ .. ansible-option-type-line::
+
+ :ansible-option-type:`float`
+
+ :ansible-option-versionadded:`added in ansible.eda 2.0.0`
+
+
+ .. raw:: html
+
+
+
+ Timeout in seconds for the connection with the EDA controller.
+
+ If not set, the value of the \ :literal:`CONTROLLER\_TIMEOUT`\ environment variable will be used.
+
+
+ .. rst-class:: ansible-option-line
+
+ :ansible-option-default-bold:`Default:` :ansible-option-default:`10.0`
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.ansible.eda.project_info_module__parameter-validate_certs:
+
+ .. rst-class:: ansible-option-title
+
+ **validate_certs**
+
+ .. raw:: html
+
+
+
+ .. ansible-option-type-line::
+
+ :ansible-option-type:`boolean`
+
+ :ansible-option-versionadded:`added in ansible.eda 2.0.0`
+
+
+ .. raw:: html
+
+
+
+ Whether to allow insecure connections to Ansible Automation Platform EDA Controller instance.
+
+ If \ :literal:`no`\ , SSL certificates will not be validated.
+
+ This should only be used on personally controlled sites using self-signed certificates.
+
+ If value not set, will try environment variable \ :literal:`CONTROLLER\_VERIFY\_SSL`\
+
+
+ .. rst-class:: ansible-option-line
+
+ :ansible-option-choices:`Choices:`
+
+ - :ansible-option-choices-entry:`false`
+ - :ansible-option-choices-entry-default:`true` :ansible-option-choices-default-mark:`← (default)`
+
+
+ .. raw:: html
+
+
+
+
+.. Attributes
+
+
+.. Notes
+
+
+.. Seealso
+
+
+.. Examples
+
+Examples
+--------
+
+.. code-block:: yaml+jinja
+
+
+ - name: List a particular project
+ ansible.eda.project_info:
+ controller_host: https://my_eda_host/
+ controller_username: admin
+ controller_password: MySuperSecretPassw0rd
+ name: "Example"
+ register: r
+
+ - name: List all projects
+ ansible.eda.project_info:
+ controller_host: https://my_eda_host/
+ controller_username: admin
+ controller_password: MySuperSecretPassw0rd
+ register: r
+
+
+
+
+.. Facts
+
+
+.. Return values
+
+Return Values
+-------------
+Common return values are documented :ref:`here `, the following are the fields unique to this module:
+
+.. tabularcolumns:: \X{1}{3}\X{2}{3}
+
+.. list-table::
+ :width: 100%
+ :widths: auto
+ :header-rows: 1
+ :class: longtable ansible-option-table
+
+ * - Key
+ - Description
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.ansible.eda.project_info_module__return-projects:
+
+ .. rst-class:: ansible-option-title
+
+ **projects**
+
+ .. raw:: html
+
+
+
+ .. ansible-option-type-line::
+
+ :ansible-option-type:`list` / :ansible-option-elements:`elements=string`
+
+ .. raw:: html
+
+
+
+ List of dicts containing information about projects
+
+
+ .. rst-class:: ansible-option-line
+
+ :ansible-option-returned-bold:`Returned:` success
+
+ .. rst-class:: ansible-option-line
+ .. rst-class:: ansible-option-sample
+
+ :ansible-option-sample-bold:`Sample:` :ansible-rv-sample-value:`[{"created\_at": "2024-08-12T20:35:28.367702Z", "description": "", "eda\_credential\_id": null, "git\_hash": "417b4dbe9b3472fd64212ef8233b865585e5ade3", "id": 17, "import\_error": null, "import\_state": "completed", "modified\_at": "2024-08-12T20:35:28.367724Z", "name": "Sample Example Project", "organization\_id": 1, "proxy": "", "scm\_branch": "", "scm\_refspec": "", "scm\_type": "git", "signature\_validation\_credential\_id": null, "url": "https://github.com/ansible/ansible-ui", "verify\_ssl": true}]`
+
+
+ .. raw:: html
+
+
+
+
+
+.. Status (Presently only deprecated)
+
+
+.. Authors
+
+Authors
+~~~~~~~
+
+- Abhijeet Kasurde (@akasurde)
+
+
+
+.. Extra links
+
+Collection links
+~~~~~~~~~~~~~~~~
+
+.. ansible-links::
+
+ - title: "Issue Tracker"
+ url: "https://github.com/ansible/event-driven-ansible/issues"
+ external: true
+ - title: "Homepage"
+ url: "http://ansible.com/event-driven"
+ external: true
+ - title: "Repository (Sources)"
+ url: "https://github.com/ansible/event-driven-ansible"
+ external: true
+
+
+.. Parsing errors
+
diff --git a/docs/rst/project_module.rst b/docs/rst/project_module.rst
new file mode 100644
index 00000000..9c2ec27d
--- /dev/null
+++ b/docs/rst/project_module.rst
@@ -0,0 +1,593 @@
+
+.. Document meta
+
+:orphan:
+
+.. |antsibull-internal-nbsp| unicode:: 0xA0
+ :trim:
+
+.. meta::
+ :antsibull-docs: 2.12.0
+
+.. Anchors
+
+.. _ansible_collections.ansible.eda.project_module:
+
+.. Anchors: short name for ansible.builtin
+
+.. Title
+
+ansible.eda.project module -- Create, update or delete project in EDA Controller
+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
+
+.. Collection note
+
+.. note::
+ This module is part of the `ansible.eda collection `_ (version 1.4.7).
+
+ 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 ansible.eda`.
+
+ To use it in a playbook, specify: :code:`ansible.eda.project`.
+
+.. version_added
+
+.. rst-class:: ansible-version-added
+
+New in ansible.eda 2.0.0
+
+.. contents::
+ :local:
+ :depth: 1
+
+.. Deprecated
+
+
+Synopsis
+--------
+
+.. Description
+
+- This module allows user to create, update or delete project in a EDA controller.
+
+
+.. Aliases
+
+
+.. Requirements
+
+
+
+
+
+
+.. Options
+
+Parameters
+----------
+
+.. tabularcolumns:: \X{1}{3}\X{2}{3}
+
+.. list-table::
+ :width: 100%
+ :widths: auto
+ :header-rows: 1
+ :class: longtable ansible-option-table
+
+ * - Parameter
+ - Comments
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.ansible.eda.project_module__parameter-controller_host:
+
+ .. rst-class:: ansible-option-title
+
+ **controller_host**
+
+ .. raw:: html
+
+
+
+ .. ansible-option-type-line::
+
+ :ansible-option-type:`string` / :ansible-option-required:`required`
+
+ :ansible-option-versionadded:`added in ansible.eda 2.0.0`
+
+
+ .. raw:: html
+
+
+
+ The URL of the EDA controller.
+
+ If not set, the value of the \ :literal:`CONTROLLER\_URL`\ environment variable will be used.
+
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.ansible.eda.project_module__parameter-controller_password:
+
+ .. rst-class:: ansible-option-title
+
+ **controller_password**
+
+ .. raw:: html
+
+
+
+ .. ansible-option-type-line::
+
+ :ansible-option-type:`string`
+
+ :ansible-option-versionadded:`added in ansible.eda 2.0.0`
+
+
+ .. raw:: html
+
+
+
+ Password used for authentication.
+
+ If not set, the value of the \ :literal:`CONTROLLER\_PASSWORD`\ environment variable will be used.
+
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.ansible.eda.project_module__parameter-controller_username:
+
+ .. rst-class:: ansible-option-title
+
+ **controller_username**
+
+ .. raw:: html
+
+
+
+ .. ansible-option-type-line::
+
+ :ansible-option-type:`string`
+
+ :ansible-option-versionadded:`added in ansible.eda 2.0.0`
+
+
+ .. raw:: html
+
+
+
+ Username used for authentication.
+
+ If not set, the value of the \ :literal:`CONTROLLER\_USERNAME`\ environment variable will be used.
+
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.ansible.eda.project_module__parameter-credential:
+
+ .. rst-class:: ansible-option-title
+
+ **credential**
+
+ .. raw:: html
+
+
+
+ .. ansible-option-type-line::
+
+ :ansible-option-type:`string`
+
+ .. raw:: html
+
+
+
+ The name of the credential to associate with the project.
+
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.ansible.eda.project_module__parameter-description:
+
+ .. rst-class:: ansible-option-title
+
+ **description**
+
+ .. raw:: html
+
+
+
+ .. ansible-option-type-line::
+
+ :ansible-option-type:`string`
+
+ .. raw:: html
+
+
+
+ The description of the project.
+
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.ansible.eda.project_module__parameter-name:
+
+ .. rst-class:: ansible-option-title
+
+ **name**
+
+ .. raw:: html
+
+
+
+ .. ansible-option-type-line::
+
+ :ansible-option-type:`string` / :ansible-option-required:`required`
+
+ .. raw:: html
+
+
+
+ The name of the project.
+
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.ansible.eda.project_module__parameter-new_name:
+
+ .. rst-class:: ansible-option-title
+
+ **new_name**
+
+ .. raw:: html
+
+
+
+ .. ansible-option-type-line::
+
+ :ansible-option-type:`string`
+
+ .. raw:: html
+
+
+
+ Setting this option will change the existing name.
+
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.ansible.eda.project_module__parameter-request_timeout:
+
+ .. rst-class:: ansible-option-title
+
+ **request_timeout**
+
+ .. raw:: html
+
+
+
+ .. ansible-option-type-line::
+
+ :ansible-option-type:`float`
+
+ :ansible-option-versionadded:`added in ansible.eda 2.0.0`
+
+
+ .. raw:: html
+
+
+
+ Timeout in seconds for the connection with the EDA controller.
+
+ If not set, the value of the \ :literal:`CONTROLLER\_TIMEOUT`\ environment variable will be used.
+
+
+ .. rst-class:: ansible-option-line
+
+ :ansible-option-default-bold:`Default:` :ansible-option-default:`10.0`
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.ansible.eda.project_module__parameter-state:
+
+ .. rst-class:: ansible-option-title
+
+ **state**
+
+ .. raw:: html
+
+
+
+ .. ansible-option-type-line::
+
+ :ansible-option-type:`string`
+
+ .. raw:: html
+
+
+
+ Desired state of the resource.
+
+
+ .. rst-class:: ansible-option-line
+
+ :ansible-option-choices:`Choices:`
+
+ - :ansible-option-choices-entry-default:`"present"` :ansible-option-choices-default-mark:`← (default)`
+ - :ansible-option-choices-entry:`"absent"`
+
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.ansible.eda.project_module__parameter-url:
+
+ .. rst-class:: ansible-option-title
+
+ **url**
+
+ .. raw:: html
+
+
+
+ .. ansible-option-type-line::
+
+ :ansible-option-type:`string`
+
+ .. raw:: html
+
+
+
+ The git URL of the project.
+
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.ansible.eda.project_module__parameter-validate_certs:
+
+ .. rst-class:: ansible-option-title
+
+ **validate_certs**
+
+ .. raw:: html
+
+
+
+ .. ansible-option-type-line::
+
+ :ansible-option-type:`boolean`
+
+ :ansible-option-versionadded:`added in ansible.eda 2.0.0`
+
+
+ .. raw:: html
+
+
+
+ Whether to allow insecure connections to Ansible Automation Platform EDA Controller instance.
+
+ If \ :literal:`no`\ , SSL certificates will not be validated.
+
+ This should only be used on personally controlled sites using self-signed certificates.
+
+ If value not set, will try environment variable \ :literal:`CONTROLLER\_VERIFY\_SSL`\
+
+
+ .. rst-class:: ansible-option-line
+
+ :ansible-option-choices:`Choices:`
+
+ - :ansible-option-choices-entry:`false`
+ - :ansible-option-choices-entry-default:`true` :ansible-option-choices-default-mark:`← (default)`
+
+
+ .. raw:: html
+
+
+
+
+.. Attributes
+
+
+.. Notes
+
+
+.. Seealso
+
+
+.. Examples
+
+Examples
+--------
+
+.. code-block:: yaml+jinja
+
+
+ - name: Create EDA Projects
+ ansible.eda.project:
+ controller_host: https://my_eda_host/
+ controller_username: admin
+ controller_password: MySuperSecretPassw0rd
+ name: "Example Project"
+ description: "Example project description"
+ url: "https://example.com/project1"
+ state: present
+
+ - name: Update the name of the project
+ ansible.eda.project:
+ controller_host: https://my_eda_host/
+ controller_username: admin
+ controller_password: MySuperSecretPassw0rd
+ name: "Example Project"
+ new_name: "Latest Example Project"
+ description: "Example project description"
+ url: "https://example.com/project1"
+ state: present
+
+ - name: Delete the project
+ ansible.eda.project:
+ controller_host: https://my_eda_host/
+ controller_username: admin
+ controller_password: MySuperSecretPassw0rd
+ name: "Example Project"
+ state: absent
+
+
+
+
+.. Facts
+
+
+.. Return values
+
+
+.. Status (Presently only deprecated)
+
+
+.. Authors
+
+Authors
+~~~~~~~
+
+- Nikhil Jain (@jainnikhil30)
+- Abhijeet Kasurde (@akasurde)
+
+
+
+.. Extra links
+
+Collection links
+~~~~~~~~~~~~~~~~
+
+.. ansible-links::
+
+ - title: "Issue Tracker"
+ url: "https://github.com/ansible/event-driven-ansible/issues"
+ external: true
+ - title: "Homepage"
+ url: "http://ansible.com/event-driven"
+ external: true
+ - title: "Repository (Sources)"
+ url: "https://github.com/ansible/event-driven-ansible"
+ external: true
+
+
+.. Parsing errors
+
diff --git a/docs/rst/user_module.rst b/docs/rst/user_module.rst
new file mode 100644
index 00000000..b8ec7ccb
--- /dev/null
+++ b/docs/rst/user_module.rst
@@ -0,0 +1,779 @@
+
+.. Document meta
+
+:orphan:
+
+.. |antsibull-internal-nbsp| unicode:: 0xA0
+ :trim:
+
+.. meta::
+ :antsibull-docs: 2.12.0
+
+.. Anchors
+
+.. _ansible_collections.ansible.eda.user_module:
+
+.. Anchors: short name for ansible.builtin
+
+.. Title
+
+ansible.eda.user module -- Manage users in EDA controller
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
+
+.. Collection note
+
+.. note::
+ This module is part of the `ansible.eda collection `_ (version 1.4.7).
+
+ 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 ansible.eda`.
+
+ To use it in a playbook, specify: :code:`ansible.eda.user`.
+
+.. version_added
+
+.. rst-class:: ansible-version-added
+
+New in ansible.eda 2.0.0
+
+.. contents::
+ :local:
+ :depth: 1
+
+.. Deprecated
+
+
+Synopsis
+--------
+
+.. Description
+
+- This module allows the user to create, update or delete users in a EDA controller.
+
+
+.. Aliases
+
+
+.. Requirements
+
+
+
+
+
+
+.. Options
+
+Parameters
+----------
+
+.. tabularcolumns:: \X{1}{3}\X{2}{3}
+
+.. list-table::
+ :width: 100%
+ :widths: auto
+ :header-rows: 1
+ :class: longtable ansible-option-table
+
+ * - Parameter
+ - Comments
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.ansible.eda.user_module__parameter-controller_host:
+
+ .. rst-class:: ansible-option-title
+
+ **controller_host**
+
+ .. raw:: html
+
+
+
+ .. ansible-option-type-line::
+
+ :ansible-option-type:`string` / :ansible-option-required:`required`
+
+ :ansible-option-versionadded:`added in ansible.eda 2.0.0`
+
+
+ .. raw:: html
+
+
+
+ The URL of the EDA controller.
+
+ If not set, the value of the \ :literal:`CONTROLLER\_URL`\ environment variable will be used.
+
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.ansible.eda.user_module__parameter-controller_password:
+
+ .. rst-class:: ansible-option-title
+
+ **controller_password**
+
+ .. raw:: html
+
+
+
+ .. ansible-option-type-line::
+
+ :ansible-option-type:`string`
+
+ :ansible-option-versionadded:`added in ansible.eda 2.0.0`
+
+
+ .. raw:: html
+
+
+
+ Password used for authentication.
+
+ If not set, the value of the \ :literal:`CONTROLLER\_PASSWORD`\ environment variable will be used.
+
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.ansible.eda.user_module__parameter-controller_username:
+
+ .. rst-class:: ansible-option-title
+
+ **controller_username**
+
+ .. raw:: html
+
+
+
+ .. ansible-option-type-line::
+
+ :ansible-option-type:`string`
+
+ :ansible-option-versionadded:`added in ansible.eda 2.0.0`
+
+
+ .. raw:: html
+
+
+
+ Username used for authentication.
+
+ If not set, the value of the \ :literal:`CONTROLLER\_USERNAME`\ environment variable will be used.
+
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.ansible.eda.user_module__parameter-email:
+
+ .. rst-class:: ansible-option-title
+
+ **email**
+
+ .. raw:: html
+
+
+
+ .. ansible-option-type-line::
+
+ :ansible-option-type:`string`
+
+ .. raw:: html
+
+
+
+ Email address of the user.
+
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.ansible.eda.user_module__parameter-first_name:
+
+ .. rst-class:: ansible-option-title
+
+ **first_name**
+
+ .. raw:: html
+
+
+
+ .. ansible-option-type-line::
+
+ :ansible-option-type:`string`
+
+ .. raw:: html
+
+
+
+ First name of the user.
+
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.ansible.eda.user_module__parameter-is_superuser:
+
+ .. rst-class:: ansible-option-title
+
+ **is_superuser**
+
+ .. raw:: html
+
+
+
+ .. ansible-option-type-line::
+
+ :ansible-option-type:`boolean`
+
+ .. raw:: html
+
+
+
+ Make user as superuser.
+
+
+ .. rst-class:: ansible-option-line
+
+ :ansible-option-choices:`Choices:`
+
+ - :ansible-option-choices-entry-default:`false` :ansible-option-choices-default-mark:`← (default)`
+ - :ansible-option-choices-entry:`true`
+
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.ansible.eda.user_module__parameter-last_name:
+
+ .. rst-class:: ansible-option-title
+
+ **last_name**
+
+ .. raw:: html
+
+
+
+ .. ansible-option-type-line::
+
+ :ansible-option-type:`string`
+
+ .. raw:: html
+
+
+
+ Last name of the user.
+
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.ansible.eda.user_module__parameter-new_username:
+
+ .. rst-class:: ansible-option-title
+
+ **new_username**
+
+ .. raw:: html
+
+
+
+ .. ansible-option-type-line::
+
+ :ansible-option-type:`string`
+
+ .. raw:: html
+
+
+
+ Setting this option will change the existing username.
+
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.ansible.eda.user_module__parameter-password:
+
+ .. rst-class:: ansible-option-title
+
+ **password**
+
+ .. raw:: html
+
+
+
+ .. ansible-option-type-line::
+
+ :ansible-option-type:`string`
+
+ .. raw:: html
+
+
+
+ Write-only field used to change the password.
+
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.ansible.eda.user_module__parameter-request_timeout:
+
+ .. rst-class:: ansible-option-title
+
+ **request_timeout**
+
+ .. raw:: html
+
+
+
+ .. ansible-option-type-line::
+
+ :ansible-option-type:`float`
+
+ :ansible-option-versionadded:`added in ansible.eda 2.0.0`
+
+
+ .. raw:: html
+
+
+
+ Timeout in seconds for the connection with the EDA controller.
+
+ If not set, the value of the \ :literal:`CONTROLLER\_TIMEOUT`\ environment variable will be used.
+
+
+ .. rst-class:: ansible-option-line
+
+ :ansible-option-default-bold:`Default:` :ansible-option-default:`10.0`
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.ansible.eda.user_module__parameter-state:
+
+ .. rst-class:: ansible-option-title
+
+ **state**
+
+ .. raw:: html
+
+
+
+ .. ansible-option-type-line::
+
+ :ansible-option-type:`string`
+
+ .. raw:: html
+
+
+
+ Desired state of the resource.
+
+
+ .. rst-class:: ansible-option-line
+
+ :ansible-option-choices:`Choices:`
+
+ - :ansible-option-choices-entry-default:`"present"` :ansible-option-choices-default-mark:`← (default)`
+ - :ansible-option-choices-entry:`"absent"`
+
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.ansible.eda.user_module__parameter-update_secrets:
+
+ .. rst-class:: ansible-option-title
+
+ **update_secrets**
+
+ .. raw:: html
+
+
+
+ .. ansible-option-type-line::
+
+ :ansible-option-type:`boolean`
+
+ .. raw:: html
+
+
+
+ \ :ansval:`true`\ will always change password if user specifies password, even if API gives $encrypted$ for password.
+
+ \ :ansval:`false`\ will only set the password if other values change too.
+
+
+ .. rst-class:: ansible-option-line
+
+ :ansible-option-choices:`Choices:`
+
+ - :ansible-option-choices-entry:`false`
+ - :ansible-option-choices-entry-default:`true` :ansible-option-choices-default-mark:`← (default)`
+
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.ansible.eda.user_module__parameter-username:
+
+ .. rst-class:: ansible-option-title
+
+ **username**
+
+ .. raw:: html
+
+
+
+ .. ansible-option-type-line::
+
+ :ansible-option-type:`string` / :ansible-option-required:`required`
+
+ .. raw:: html
+
+
+
+ The name of the user.
+
+ 150 characters or fewer.
+
+ Name can contain letters, digits and ('@', '.', '+', '-', '\_') only.
+
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.ansible.eda.user_module__parameter-validate_certs:
+
+ .. rst-class:: ansible-option-title
+
+ **validate_certs**
+
+ .. raw:: html
+
+
+
+ .. ansible-option-type-line::
+
+ :ansible-option-type:`boolean`
+
+ :ansible-option-versionadded:`added in ansible.eda 2.0.0`
+
+
+ .. raw:: html
+
+
+
+ Whether to allow insecure connections to Ansible Automation Platform EDA Controller instance.
+
+ If \ :literal:`no`\ , SSL certificates will not be validated.
+
+ This should only be used on personally controlled sites using self-signed certificates.
+
+ If value not set, will try environment variable \ :literal:`CONTROLLER\_VERIFY\_SSL`\
+
+
+ .. rst-class:: ansible-option-line
+
+ :ansible-option-choices:`Choices:`
+
+ - :ansible-option-choices-entry:`false`
+ - :ansible-option-choices-entry-default:`true` :ansible-option-choices-default-mark:`← (default)`
+
+
+ .. raw:: html
+
+
+
+
+.. Attributes
+
+
+.. Notes
+
+
+.. Seealso
+
+
+.. Examples
+
+Examples
+--------
+
+.. code-block:: yaml+jinja
+
+
+ - name: Create EDA user
+ ansible.eda.user:
+ controller_host: https://my_eda_host/
+ controller_username: admin
+ controller_password: MySuperSecretPassw0rd
+ username: "test_collection_user"
+ first_name: "Test Collection User"
+ last_name: "Test Collection User"
+ email: "test@test.com"
+ password: "test"
+ is_superuser: True
+ state: present
+ no_log: true
+
+ - name: Delete user
+ ansible.eda.user:
+ controller_host: https://my_eda_host/
+ controller_username: admin
+ controller_password: MySuperSecretPassw0rd
+ username: "test_collection_user"
+ state: absent
+
+ - name: Update the username
+ ansible.eda.user:
+ username: "test_collection_user"
+ new_username: "test_collection_user_updated"
+ first_name: "Test Collection User"
+ last_name: "Test Collection User"
+ email: "test@test.com"
+ password: "test"
+
+
+
+
+.. Facts
+
+
+.. Return values
+
+Return Values
+-------------
+Common return values are documented :ref:`here `, the following are the fields unique to this module:
+
+.. tabularcolumns:: \X{1}{3}\X{2}{3}
+
+.. list-table::
+ :width: 100%
+ :widths: auto
+ :header-rows: 1
+ :class: longtable ansible-option-table
+
+ * - Key
+ - Description
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.ansible.eda.user_module__return-id:
+
+ .. rst-class:: ansible-option-title
+
+ **id**
+
+ .. raw:: html
+
+
+
+ .. ansible-option-type-line::
+
+ :ansible-option-type:`string`
+
+ .. raw:: html
+
+
+
+ ID of the managed AWX token.
+
+
+ .. rst-class:: ansible-option-line
+
+ :ansible-option-returned-bold:`Returned:` when state is 'present' and successful
+
+ .. rst-class:: ansible-option-line
+ .. rst-class:: ansible-option-sample
+
+ :ansible-option-sample-bold:`Sample:` :ansible-rv-sample-value:`"123"`
+
+
+ .. raw:: html
+
+
+
+
+
+.. Status (Presently only deprecated)
+
+
+.. Authors
+
+Authors
+~~~~~~~
+
+- Nikhil Jain (@jainnikhil30)
+- Abhijeet Kasurde (@akasurde)
+
+
+
+.. Extra links
+
+Collection links
+~~~~~~~~~~~~~~~~
+
+.. ansible-links::
+
+ - title: "Issue Tracker"
+ url: "https://github.com/ansible/event-driven-ansible/issues"
+ external: true
+ - title: "Homepage"
+ url: "http://ansible.com/event-driven"
+ external: true
+ - title: "Repository (Sources)"
+ url: "https://github.com/ansible/event-driven-ansible"
+ external: true
+
+
+.. Parsing errors
+
diff --git a/tox.ini b/tox.ini
index e899acc6..fcdef096 100644
--- a/tox.ini
+++ b/tox.ini
@@ -4,12 +4,19 @@
# cspell: ignore TOXPYTHON setenv passenv REQPASS PYTHONPYCACHEPREFIX PYTHONIOENCODING PYTHONBREAKPOINT notest envdir envname toxworkdir junitxml
[tox]
-envlist = lint, darglint, unit, sanity, integration, coverage
+envlist =
+ lint
+ darglint
+ docs
+ unit
+ sanity
+ integration
+ coverage
skipsdist = true # this repo is not a python package
isolated_build = true
requires =
tox >= 4.6.3
- tox-extra >= 2.0.0 # bindep check
+ ; tox-extra >= 2.0.0 # bindep check
setuptools >= 65.3.0 # editable installs
[testenv]
@@ -113,3 +120,17 @@ commands =
ansible-test coverage combine --export={envdir}
# produces tests/output/reports/coverage.xml
ansible-test coverage xml --requirements
+
+[testenv:docs]
+description = Generate plugins documentation under /docs directory using antsibull-docs
+deps =
+ ansible-core
+ -r docs/requirements.txt
+commands_pre =
+ ansible-galaxy collection install .
+commands =
+ antsibull-docs sphinx-init --use-current --squash-hierarchy ansible.eda --dest-dir docs
+ bash ./docs/build.sh
+allowlist_externals =
+ mkdir
+ bash