diff --git a/CHANGELOG.rst b/CHANGELOG.rst index db8f6b6d9..a9d4b1474 100644 --- a/CHANGELOG.rst +++ b/CHANGELOG.rst @@ -4,6 +4,27 @@ checkmk.general Release Notes .. contents:: Topics +v7.6.0 +====== + +Minor Changes +------------- + +- All modules - Cookie-based authentication can now be used without providing ``api_user`` and ``api_secret``. Bearer and basic authentication still require them. +- Checkmk inventory plugin - Credentials can now be provided via ``CHECKMK_VAR_*`` environment variables, ``checkmk_var_*`` Ansible variables, or the ``[checkmk_lookup]`` section in ``ansible.cfg``. Cookie-based authentication is also supported via the new ``api_auth_type`` and ``api_auth_cookie`` options. + +Deprecated Features +------------------- + +- Password module - The ``owner`` parameter was renamed to ``editable_by``. We keep ``owner`` as an alias, but the old name will be removed in a future release. Update your configuration to use ``editable_by``. + +Bugfixes +-------- + +- Module utils - Fix basic authentication being broken due to an indentation error that left ``auth_str`` unassigned. +- Module utils - Fix version comparison to reliably handle patch release numbers greater than 10. +- Password module - Make the module compatible with Checkmk 3.0.0. + v7.5.0 ====== diff --git a/changelogs/.plugin-cache.yaml b/changelogs/.plugin-cache.yaml index deab3f8fb..35091cab3 100644 --- a/changelogs/.plugin-cache.yaml +++ b/changelogs/.plugin-cache.yaml @@ -187,4 +187,4 @@ plugins: strategy: {} test: {} vars: {} -version: 7.5.0 +version: 7.6.0 diff --git a/changelogs/fragments/api.yml b/changelogs/archive/7.6.0/api.yml similarity index 100% rename from changelogs/fragments/api.yml rename to changelogs/archive/7.6.0/api.yml diff --git a/changelogs/fragments/inventory.yml b/changelogs/archive/7.6.0/inventory.yml similarity index 100% rename from changelogs/fragments/inventory.yml rename to changelogs/archive/7.6.0/inventory.yml diff --git a/changelogs/fragments/password.yml b/changelogs/archive/7.6.0/password.yml similarity index 100% rename from changelogs/fragments/password.yml rename to changelogs/archive/7.6.0/password.yml diff --git a/changelogs/changelog.yaml b/changelogs/changelog.yaml index 0495ef7ea..0c56c6ad9 100644 --- a/changelogs/changelog.yaml +++ b/changelogs/changelog.yaml @@ -1663,3 +1663,28 @@ releases: - release_summary.yml - roles.yml release_date: '2026-05-18' + 7.6.0: + changes: + bugfixes: + - Module utils - Fix basic authentication being broken due to an indentation + error that left ``auth_str`` unassigned. + - Module utils - Fix version comparison to reliably handle patch release numbers + greater than 10. + - Password module - Make the module compatible with Checkmk 3.0.0. + deprecated_features: + - Password module - The ``owner`` parameter was renamed to ``editable_by``. + We keep ``owner`` as an alias, but the old name will be removed in a future + release. Update your configuration to use ``editable_by``. + minor_changes: + - All modules - Cookie-based authentication can now be used without providing + ``api_user`` and ``api_secret``. Bearer and basic authentication still require + them. + - Checkmk inventory plugin - Credentials can now be provided via ``CHECKMK_VAR_*`` + environment variables, ``checkmk_var_*`` Ansible variables, or the ``[checkmk_lookup]`` + section in ``ansible.cfg``. Cookie-based authentication is also supported + via the new ``api_auth_type`` and ``api_auth_cookie`` options. + fragments: + - api.yml + - inventory.yml + - password.yml + release_date: '2026-05-22' diff --git a/docs/activation_lookup.rst b/docs/activation_lookup.rst index 9416fefbc..c8c58160f 100644 --- a/docs/activation_lookup.rst +++ b/docs/activation_lookup.rst @@ -22,7 +22,7 @@ checkmk.general.activation lookup -- Get the status of a single activation .. Collection note .. note:: - This lookup plugin is part of the `checkmk.general collection `_ (version 7.5.0). + This lookup plugin is part of the `checkmk.general collection `_ (version 7.6.0). It is not included in ``ansible-core``. To check whether it is installed, run :code:`ansible-galaxy collection list`. @@ -557,6 +557,7 @@ Notes - Alternatively, you can use a shell/command task that runs against localhost and registers the result. - The directory of the play is used as the current working directory. - It is :strong:`NOT` possible to assign other variables to the variables mentioned in the :literal:`vars` section! This is a limitation of Ansible itself. + - Connection parameters are resolved from (in order of precedence) the value set directly on the plugin invocation, an Ansible variable of the form :literal:`checkmk\_var\_\*`\ , an environment variable of the form :literal:`CHECKMK\_VAR\_\*`\ , and the matching key under section :literal:`[checkmk\_lookup]` in :literal:`ansible.cfg`. .. Seealso diff --git a/docs/activation_module.rst b/docs/activation_module.rst index 794f6360f..37ce34b4c 100644 --- a/docs/activation_module.rst +++ b/docs/activation_module.rst @@ -22,7 +22,7 @@ checkmk.general.activation module -- Activate changes in Checkmk .. Collection note .. note:: - This module is part of the `checkmk.general collection `_ (version 7.5.0). + This module is part of the `checkmk.general collection `_ (version 7.6.0). It is not included in ``ansible-core``. To check whether it is installed, run :code:`ansible-galaxy collection list`. @@ -177,7 +177,7 @@ Parameters :ansible-option-aliases:`aliases: automation_secret` - :ansible-option-type:`string` / :ansible-option-required:`required` + :ansible-option-type:`string` .. raw:: html @@ -215,7 +215,7 @@ Parameters :ansible-option-aliases:`aliases: automation_user` - :ansible-option-type:`string` / :ansible-option-required:`required` + :ansible-option-type:`string` .. raw:: html diff --git a/docs/activations_lookup.rst b/docs/activations_lookup.rst index 365c2f125..f16097da4 100644 --- a/docs/activations_lookup.rst +++ b/docs/activations_lookup.rst @@ -22,7 +22,7 @@ checkmk.general.activations lookup -- Get all activations .. Collection note .. note:: - This lookup plugin is part of the `checkmk.general collection `_ (version 7.5.0). + This lookup plugin is part of the `checkmk.general collection `_ (version 7.6.0). It is not included in ``ansible-core``. To check whether it is installed, run :code:`ansible-galaxy collection list`. @@ -500,6 +500,7 @@ Notes - Alternatively, you can use a shell/command task that runs against localhost and registers the result. - The directory of the play is used as the current working directory. - It is :strong:`NOT` possible to assign other variables to the variables mentioned in the :literal:`vars` section! This is a limitation of Ansible itself. + - Connection parameters are resolved from (in order of precedence) the value set directly on the plugin invocation, an Ansible variable of the form :literal:`checkmk\_var\_\*`\ , an environment variable of the form :literal:`CHECKMK\_VAR\_\*`\ , and the matching key under section :literal:`[checkmk\_lookup]` in :literal:`ansible.cfg`. .. Seealso diff --git a/docs/agent_role.rst b/docs/agent_role.rst index 0ac8cfbf6..6c60af81d 100644 --- a/docs/agent_role.rst +++ b/docs/agent_role.rst @@ -20,7 +20,7 @@ checkmk.general.agent role -- Install Checkmk agents .. Collection note .. note:: - This role is part of the `checkmk.general collection `_ (version 7.5.0). + This role is part of the `checkmk.general collection `_ (version 7.6.0). It is not included in ``ansible-core``. To check whether it is installed, run :code:`ansible-galaxy collection list`. @@ -1406,7 +1406,7 @@ Parameters .. rst-class:: ansible-option-line - :ansible-option-default-bold:`Default:` :ansible-option-default:`"2.5.0p2"` + :ansible-option-default-bold:`Default:` :ansible-option-default:`"2.5.0p3"` .. raw:: html diff --git a/docs/aux_tag_module.rst b/docs/aux_tag_module.rst index b34c1050a..d7dee96a2 100644 --- a/docs/aux_tag_module.rst +++ b/docs/aux_tag_module.rst @@ -22,7 +22,7 @@ checkmk.general.aux_tag module -- Manage auxiliary tags in Checkmk .. Collection note .. note:: - This module is part of the `checkmk.general collection `_ (version 7.5.0). + This module is part of the `checkmk.general collection `_ (version 7.6.0). It is not included in ``ansible-core``. To check whether it is installed, run :code:`ansible-galaxy collection list`. @@ -177,7 +177,7 @@ Parameters :ansible-option-aliases:`aliases: automation_secret` - :ansible-option-type:`string` / :ansible-option-required:`required` + :ansible-option-type:`string` .. raw:: html @@ -215,7 +215,7 @@ Parameters :ansible-option-aliases:`aliases: automation_user` - :ansible-option-type:`string` / :ansible-option-required:`required` + :ansible-option-type:`string` .. raw:: html diff --git a/docs/bakery_lookup.rst b/docs/bakery_lookup.rst index 7bfb90887..5b5350a70 100644 --- a/docs/bakery_lookup.rst +++ b/docs/bakery_lookup.rst @@ -22,7 +22,7 @@ checkmk.general.bakery lookup -- Get the bakery status of a Checkmk server .. Collection note .. note:: - This lookup plugin is part of the `checkmk.general collection `_ (version 7.5.0). + This lookup plugin is part of the `checkmk.general collection `_ (version 7.6.0). It is not included in ``ansible-core``. To check whether it is installed, run :code:`ansible-galaxy collection list`. @@ -500,6 +500,7 @@ Notes - Alternatively, you can use a shell/command task that runs against localhost and registers the result. - The directory of the play is used as the current working directory. - It is :strong:`NOT` possible to assign other variables to the variables mentioned in the :literal:`vars` section! This is a limitation of Ansible itself. + - Connection parameters are resolved from (in order of precedence) the value set directly on the plugin invocation, an Ansible variable of the form :literal:`checkmk\_var\_\*`\ , an environment variable of the form :literal:`CHECKMK\_VAR\_\*`\ , and the matching key under section :literal:`[checkmk\_lookup]` in :literal:`ansible.cfg`. .. Seealso diff --git a/docs/bakery_module.rst b/docs/bakery_module.rst index e46962a14..e7d777f84 100644 --- a/docs/bakery_module.rst +++ b/docs/bakery_module.rst @@ -22,7 +22,7 @@ checkmk.general.bakery module -- Trigger baking and signing in the agent bakery .. Collection note .. note:: - This module is part of the `checkmk.general collection `_ (version 7.5.0). + This module is part of the `checkmk.general collection `_ (version 7.6.0). It is not included in ``ansible-core``. To check whether it is installed, run :code:`ansible-galaxy collection list`. @@ -178,7 +178,7 @@ Parameters :ansible-option-aliases:`aliases: automation_secret` - :ansible-option-type:`string` / :ansible-option-required:`required` + :ansible-option-type:`string` .. raw:: html @@ -216,7 +216,7 @@ Parameters :ansible-option-aliases:`aliases: automation_user` - :ansible-option-type:`string` / :ansible-option-required:`required` + :ansible-option-type:`string` .. raw:: html diff --git a/docs/checkmk_inventory.rst b/docs/checkmk_inventory.rst index 08d026711..71a157f42 100644 --- a/docs/checkmk_inventory.rst +++ b/docs/checkmk_inventory.rst @@ -22,7 +22,7 @@ checkmk.general.checkmk inventory -- Dynamic Inventory Source or Checkmk .. Collection note .. note:: - This inventory plugin is part of the `checkmk.general collection `_ (version 7.5.0). + This inventory plugin is part of the `checkmk.general collection `_ (version 7.6.0). It is not included in ``ansible-core``. To check whether it is installed, run :code:`ansible-galaxy collection list`. @@ -106,7 +106,24 @@ Parameters
- Authentication cookie for the Checkmk session. + The authentication cookie value if using cookie\-based authentication. + + + .. rst-class:: ansible-option-line + + :ansible-option-configuration:`Configuration:` + + - INI entry: + + .. code-block:: ini + + [checkmk_lookup] + api_auth_cookie = VALUE + + + - Environment variable: :envvar:`CHECKMK\_VAR\_API\_AUTH\_COOKIE` + + - Variable: checkmk\_var\_api\_auth\_cookie .. raw:: html @@ -143,16 +160,28 @@ Parameters
- Type of authentication to use. + The authentication type to use ('bearer', 'basic', 'cookie'). .. rst-class:: ansible-option-line - :ansible-option-choices:`Choices:` + :ansible-option-default-bold:`Default:` :ansible-option-default:`"bearer"` + + .. rst-class:: ansible-option-line + + :ansible-option-configuration:`Configuration:` + + - INI entry: + + .. code-block:: ini - - :ansible-option-choices-entry-default:`"bearer"` :ansible-option-choices-default-mark:`← (default)` - - :ansible-option-choices-entry:`"basic"` - - :ansible-option-choices-entry:`"cookie"` + [checkmk_lookup] + api_auth_type = bearer + + + - Environment variable: :envvar:`CHECKMK\_VAR\_API\_AUTH\_TYPE` + + - Variable: checkmk\_var\_api\_auth\_type .. raw:: html @@ -180,7 +209,7 @@ Parameters :ansible-option-aliases:`aliases: automation_secret` - :ansible-option-type:`string` / :ansible-option-required:`required` + :ansible-option-type:`string` @@ -193,48 +222,24 @@ Parameters
- The secret to authenticate your automation user. If not set the module will fall back to the environment variable :literal:`CHECKMK\_VAR\_API\_SECRET`. - - - .. raw:: html - -
- - * - .. raw:: html + Automation secret for the REST API access. -
-
-
- - .. _ansible_collections.checkmk.general.checkmk_inventory__parameter-api_user: - .. _ansible_collections.checkmk.general.checkmk_inventory__parameter-automation_user: - - .. rst-class:: ansible-option-title - - **api_user** - - .. raw:: html - - - - .. ansible-option-type-line:: - - :ansible-option-aliases:`aliases: automation_user` - - :ansible-option-type:`string` / :ansible-option-required:`required` + .. rst-class:: ansible-option-line + :ansible-option-configuration:`Configuration:` + - INI entry: - .. raw:: html + .. code-block:: ini -
+ [checkmk_lookup] + api_secret = VALUE - - .. raw:: html -
+ - Environment variable: :envvar:`CHECKMK\_VAR\_API\_SECRET` - The automation user you want to use. It has to be an 'Automation' user, not a normal one. If not set the module will fall back to the environment variable :literal:`CHECKMK\_VAR\_API\_USER`. + - Variable: checkmk\_var\_api\_secret .. raw:: html @@ -244,71 +249,55 @@ Parameters * - .. raw:: html
-
+
+
- .. _ansible_collections.checkmk.general.checkmk_inventory__parameter-client_cert: + .. _ansible_collections.checkmk.general.checkmk_inventory__parameter-api_user: + .. _ansible_collections.checkmk.general.checkmk_inventory__parameter-automation_user: .. rst-class:: ansible-option-title - **client_cert** + **api_user** .. raw:: html - + .. ansible-option-type-line:: - :ansible-option-type:`path` - - - - - .. raw:: html - -
+ :ansible-option-aliases:`aliases: automation_user` - - .. raw:: html + :ansible-option-type:`string` -
- Path to the client certificate file for authentication with the web server hosting Checkmk. This is not a Checkmk feature, but one of Ansible and the respective web server. .. raw:: html
- * - .. raw:: html + - .. raw:: html
-
- - .. _ansible_collections.checkmk.general.checkmk_inventory__parameter-client_key: - - .. rst-class:: ansible-option-title - **client_key** + Automation user for the REST API access. - .. raw:: html - - - - .. ansible-option-type-line:: - - :ansible-option-type:`path` + .. rst-class:: ansible-option-line + :ansible-option-configuration:`Configuration:` + - INI entry: - .. raw:: html + .. code-block:: ini -
+ [checkmk_lookup] + api_user = VALUE - - .. raw:: html -
+ - Environment variable: :envvar:`CHECKMK\_VAR\_API\_USER` - Path to the client certificate key file for authentication with the web server hosting Checkmk. This is not a Checkmk feature, but one of Ansible and the respective web server. + - Variable: checkmk\_var\_api\_user .. raw:: html @@ -428,7 +417,24 @@ Parameters
- The base url of your Checkmk server including the protocol but excluding the site. If not set the module will fall back to the environment variable :literal:`CHECKMK\_VAR\_SERVER\_URL`. + URL of the Checkmk server + + + .. rst-class:: ansible-option-line + + :ansible-option-configuration:`Configuration:` + + - INI entry: + + .. code-block:: ini + + [checkmk_lookup] + server_url = VALUE + + + - Environment variable: :envvar:`CHECKMK\_VAR\_SERVER\_URL` + + - Variable: checkmk\_var\_server\_url .. raw:: html @@ -465,7 +471,24 @@ Parameters
- The site you want to connect to. This will be appended to the server\_url as part of the API request url. If not set the module will fall back to the environment variable :literal:`CHECKMK\_VAR\_SITE`. + Site name. + + + .. rst-class:: ansible-option-line + + :ansible-option-configuration:`Configuration:` + + - INI entry: + + .. code-block:: ini + + [checkmk_lookup] + site = VALUE + + + - Environment variable: :envvar:`CHECKMK\_VAR\_SITE` + + - Variable: checkmk\_var\_site .. raw:: html @@ -502,7 +525,7 @@ Parameters
- Whether to validate the SSL certificate of the Checkmk server. If not set the module will fall back to the environment variable :literal:`CHECKMK\_VAR\_VALIDATE\_CERTS`. + Whether to validate SSL certificates. .. rst-class:: ansible-option-line @@ -513,6 +536,23 @@ Parameters - :ansible-option-choices-entry-default:`true` :ansible-option-choices-default-mark:`← (default)` + .. rst-class:: ansible-option-line + + :ansible-option-configuration:`Configuration:` + + - INI entry: + + .. code-block:: ini + + [checkmk_lookup] + validate_certs = true + + + - Environment variable: :envvar:`CHECKMK\_VAR\_VALIDATE\_CERTS` + + - Variable: checkmk\_var\_validate\_certs + + .. raw:: html
@@ -563,11 +603,24 @@ Parameters
+.. note:: + + Configuration entries listed above for each entry type (Ansible variable, environment variable, and so on) have a low to high priority order. + For example, a variable that is lower in the list will override a variable that is higher up. + The entry types are also ordered by precedence from low to high priority order. + For example, an ansible.cfg entry (further up in the list) is overwritten by an Ansible variable (further down in the list). + .. Attributes .. Notes +Notes +----- + +.. note:: + - Because inventory plugins run before :literal:`group\_vars/` and :literal:`host\_vars/` are loaded, :literal:`checkmk\_var\_\*` values placed there are :strong:`not` visible to this plugin. Sources that :strong:`do` work are extra\-vars (\ :literal:`\-e`\ ), environment variables (\ :literal:`CHECKMK\_VAR\_\*`\ ) and :literal:`ansible.cfg` :literal:`[checkmk\_lookup]` entries. + - Connection parameters are resolved from (in order of precedence) the value set directly on the plugin invocation, an Ansible variable of the form :literal:`checkmk\_var\_\*`\ , an environment variable of the form :literal:`CHECKMK\_VAR\_\*`\ , and the matching key under section :literal:`[checkmk\_lookup]` in :literal:`ansible.cfg`. .. Seealso @@ -593,6 +646,30 @@ Examples groupsources: ["hosttags", "sites"] want_ipv4: False + # --------------------------------------------------------------------------- + # Using environment variables for credentials + # --------------------------------------------------------------------------- + # Connection parameters can be provided via environment variables instead of + # writing them into the inventory file. The supported variables are: + # CHECKMK_VAR_SERVER_URL, CHECKMK_VAR_SITE, + # CHECKMK_VAR_API_USER, CHECKMK_VAR_API_SECRET, + # CHECKMK_VAR_VALIDATE_CERTS, CHECKMK_VAR_API_AUTH_TYPE + + # Minimal inventory file when using environment variables: + plugin: checkmk.general.checkmk + groupsources: ["hosttags", "sites"] + + # --------------------------------------------------------------------------- + # Using Ansible variables for credentials + # --------------------------------------------------------------------------- + # Connection parameters can also be provided via Ansible variables, e.g. + # via extra-vars (`-e`). Note that vars from group_vars/ or host_vars/ + # are NOT visible here, because inventory plugins run before those are loaded. + # The supported variable names follow the scheme checkmk_var_: + # checkmk_var_server_url, checkmk_var_site, + # checkmk_var_api_user, checkmk_var_api_secret, + # checkmk_var_validate_certs, checkmk_var_api_auth_type + .. Facts diff --git a/docs/contact_group_module.rst b/docs/contact_group_module.rst index 0ce944de5..02cec4ccf 100644 --- a/docs/contact_group_module.rst +++ b/docs/contact_group_module.rst @@ -22,7 +22,7 @@ checkmk.general.contact_group module -- Manage contact groups in Checkmk .. Collection note .. note:: - This module is part of the `checkmk.general collection `_ (version 7.5.0). + This module is part of the `checkmk.general collection `_ (version 7.6.0). It is not included in ``ansible-core``. To check whether it is installed, run :code:`ansible-galaxy collection list`. @@ -177,7 +177,7 @@ Parameters :ansible-option-aliases:`aliases: automation_secret` - :ansible-option-type:`string` / :ansible-option-required:`required` + :ansible-option-type:`string` .. raw:: html @@ -215,7 +215,7 @@ Parameters :ansible-option-aliases:`aliases: automation_user` - :ansible-option-type:`string` / :ansible-option-required:`required` + :ansible-option-type:`string` .. raw:: html diff --git a/docs/dcd_module.rst b/docs/dcd_module.rst index 2ce61ea05..c033bcf17 100644 --- a/docs/dcd_module.rst +++ b/docs/dcd_module.rst @@ -22,7 +22,7 @@ checkmk.general.dcd module -- Manage Dynamic Host Management .. Collection note .. note:: - This module is part of the `checkmk.general collection `_ (version 7.5.0). + This module is part of the `checkmk.general collection `_ (version 7.6.0). It is not included in ``ansible-core``. To check whether it is installed, run :code:`ansible-galaxy collection list`. @@ -176,7 +176,7 @@ Parameters :ansible-option-aliases:`aliases: automation_secret` - :ansible-option-type:`string` / :ansible-option-required:`required` + :ansible-option-type:`string` .. raw:: html @@ -214,7 +214,7 @@ Parameters :ansible-option-aliases:`aliases: automation_user` - :ansible-option-type:`string` / :ansible-option-required:`required` + :ansible-option-type:`string` .. raw:: html diff --git a/docs/discovery_module.rst b/docs/discovery_module.rst index ee64e67d7..59139b768 100644 --- a/docs/discovery_module.rst +++ b/docs/discovery_module.rst @@ -22,7 +22,7 @@ checkmk.general.discovery module -- Discover services in Checkmk .. Collection note .. note:: - This module is part of the `checkmk.general collection `_ (version 7.5.0). + This module is part of the `checkmk.general collection `_ (version 7.6.0). It is not included in ``ansible-core``. To check whether it is installed, run :code:`ansible-galaxy collection list`. @@ -176,7 +176,7 @@ Parameters :ansible-option-aliases:`aliases: automation_secret` - :ansible-option-type:`string` / :ansible-option-required:`required` + :ansible-option-type:`string` .. raw:: html @@ -214,7 +214,7 @@ Parameters :ansible-option-aliases:`aliases: automation_user` - :ansible-option-type:`string` / :ansible-option-required:`required` + :ansible-option-type:`string` .. raw:: html diff --git a/docs/downtime_module.rst b/docs/downtime_module.rst index 78894cf8c..2eb03f335 100644 --- a/docs/downtime_module.rst +++ b/docs/downtime_module.rst @@ -22,7 +22,7 @@ checkmk.general.downtime module -- Manage downtimes in Checkmk .. Collection note .. note:: - This module is part of the `checkmk.general collection `_ (version 7.5.0). + This module is part of the `checkmk.general collection `_ (version 7.6.0). It is not included in ``ansible-core``. To check whether it is installed, run :code:`ansible-galaxy collection list`. @@ -176,7 +176,7 @@ Parameters :ansible-option-aliases:`aliases: automation_secret` - :ansible-option-type:`string` / :ansible-option-required:`required` + :ansible-option-type:`string` .. raw:: html @@ -214,7 +214,7 @@ Parameters :ansible-option-aliases:`aliases: automation_user` - :ansible-option-type:`string` / :ansible-option-required:`required` + :ansible-option-type:`string` .. raw:: html diff --git a/docs/environment_variables.rst b/docs/environment_variables.rst index 1164d8045..fd5fae578 100644 --- a/docs/environment_variables.rst +++ b/docs/environment_variables.rst @@ -19,6 +19,7 @@ Environment variables used by the ansible-core configuration are documented in : :ansplugin:`checkmk.general.activation lookup plugin `, :ansplugin:`checkmk.general.activations lookup plugin `, :ansplugin:`checkmk.general.bakery lookup plugin `, + :ansplugin:`checkmk.general.checkmk inventory plugin `, :ansplugin:`checkmk.general.folder lookup plugin `, :ansplugin:`checkmk.general.folders lookup plugin `, :ansplugin:`checkmk.general.host lookup plugin `, @@ -40,6 +41,7 @@ Environment variables used by the ansible-core configuration are documented in : :ansplugin:`checkmk.general.activation lookup plugin `, :ansplugin:`checkmk.general.activations lookup plugin `, :ansplugin:`checkmk.general.bakery lookup plugin `, + :ansplugin:`checkmk.general.checkmk inventory plugin `, :ansplugin:`checkmk.general.folder lookup plugin `, :ansplugin:`checkmk.general.folders lookup plugin `, :ansplugin:`checkmk.general.host lookup plugin `, @@ -61,6 +63,7 @@ Environment variables used by the ansible-core configuration are documented in : :ansplugin:`checkmk.general.activation lookup plugin `, :ansplugin:`checkmk.general.activations lookup plugin `, :ansplugin:`checkmk.general.bakery lookup plugin `, + :ansplugin:`checkmk.general.checkmk inventory plugin `, :ansplugin:`checkmk.general.folder lookup plugin `, :ansplugin:`checkmk.general.folders lookup plugin `, :ansplugin:`checkmk.general.host lookup plugin `, @@ -82,6 +85,7 @@ Environment variables used by the ansible-core configuration are documented in : :ansplugin:`checkmk.general.activation lookup plugin `, :ansplugin:`checkmk.general.activations lookup plugin `, :ansplugin:`checkmk.general.bakery lookup plugin `, + :ansplugin:`checkmk.general.checkmk inventory plugin `, :ansplugin:`checkmk.general.folder lookup plugin `, :ansplugin:`checkmk.general.folders lookup plugin `, :ansplugin:`checkmk.general.host lookup plugin `, @@ -103,6 +107,7 @@ Environment variables used by the ansible-core configuration are documented in : :ansplugin:`checkmk.general.activation lookup plugin `, :ansplugin:`checkmk.general.activations lookup plugin `, :ansplugin:`checkmk.general.bakery lookup plugin `, + :ansplugin:`checkmk.general.checkmk inventory plugin `, :ansplugin:`checkmk.general.folder lookup plugin `, :ansplugin:`checkmk.general.folders lookup plugin `, :ansplugin:`checkmk.general.host lookup plugin `, @@ -124,6 +129,7 @@ Environment variables used by the ansible-core configuration are documented in : :ansplugin:`checkmk.general.activation lookup plugin `, :ansplugin:`checkmk.general.activations lookup plugin `, :ansplugin:`checkmk.general.bakery lookup plugin `, + :ansplugin:`checkmk.general.checkmk inventory plugin `, :ansplugin:`checkmk.general.folder lookup plugin `, :ansplugin:`checkmk.general.folders lookup plugin `, :ansplugin:`checkmk.general.host lookup plugin `, @@ -145,6 +151,7 @@ Environment variables used by the ansible-core configuration are documented in : :ansplugin:`checkmk.general.activation lookup plugin `, :ansplugin:`checkmk.general.activations lookup plugin `, :ansplugin:`checkmk.general.bakery lookup plugin `, + :ansplugin:`checkmk.general.checkmk inventory plugin `, :ansplugin:`checkmk.general.folder lookup plugin `, :ansplugin:`checkmk.general.folders lookup plugin `, :ansplugin:`checkmk.general.host lookup plugin `, diff --git a/docs/folder_lookup.rst b/docs/folder_lookup.rst index 228254ef6..9a5cb69f6 100644 --- a/docs/folder_lookup.rst +++ b/docs/folder_lookup.rst @@ -22,7 +22,7 @@ checkmk.general.folder lookup -- Get folder attributes .. Collection note .. note:: - This lookup plugin is part of the `checkmk.general collection `_ (version 7.5.0). + This lookup plugin is part of the `checkmk.general collection `_ (version 7.6.0). It is not included in ``ansible-core``. To check whether it is installed, run :code:`ansible-galaxy collection list`. @@ -557,6 +557,7 @@ Notes - Alternatively, you can use a shell/command task that runs against localhost and registers the result. - The directory of the play is used as the current working directory. - It is :strong:`NOT` possible to assign other variables to the variables mentioned in the :literal:`vars` section! This is a limitation of Ansible itself. + - Connection parameters are resolved from (in order of precedence) the value set directly on the plugin invocation, an Ansible variable of the form :literal:`checkmk\_var\_\*`\ , an environment variable of the form :literal:`CHECKMK\_VAR\_\*`\ , and the matching key under section :literal:`[checkmk\_lookup]` in :literal:`ansible.cfg`. .. Seealso diff --git a/docs/folder_module.rst b/docs/folder_module.rst index 1aa945fad..e8be74a2d 100644 --- a/docs/folder_module.rst +++ b/docs/folder_module.rst @@ -22,7 +22,7 @@ checkmk.general.folder module -- Manage folders in Checkmk .. Collection note .. note:: - This module is part of the `checkmk.general collection `_ (version 7.5.0). + This module is part of the `checkmk.general collection `_ (version 7.6.0). It is not included in ``ansible-core``. To check whether it is installed, run :code:`ansible-galaxy collection list`. @@ -177,7 +177,7 @@ Parameters :ansible-option-aliases:`aliases: automation_secret` - :ansible-option-type:`string` / :ansible-option-required:`required` + :ansible-option-type:`string` .. raw:: html @@ -215,7 +215,7 @@ Parameters :ansible-option-aliases:`aliases: automation_user` - :ansible-option-type:`string` / :ansible-option-required:`required` + :ansible-option-type:`string` .. raw:: html diff --git a/docs/folders_lookup.rst b/docs/folders_lookup.rst index 46ea88902..e3f81758e 100644 --- a/docs/folders_lookup.rst +++ b/docs/folders_lookup.rst @@ -22,7 +22,7 @@ checkmk.general.folders lookup -- Get various information about a folder .. Collection note .. note:: - This lookup plugin is part of the `checkmk.general collection `_ (version 7.5.0). + This lookup plugin is part of the `checkmk.general collection `_ (version 7.6.0). It is not included in ``ansible-core``. To check whether it is installed, run :code:`ansible-galaxy collection list`. @@ -648,6 +648,7 @@ Notes - Alternatively, you can use a shell/command task that runs against localhost and registers the result. - The directory of the play is used as the current working directory. - It is :strong:`NOT` possible to assign other variables to the variables mentioned in the :literal:`vars` section! This is a limitation of Ansible itself. + - Connection parameters are resolved from (in order of precedence) the value set directly on the plugin invocation, an Ansible variable of the form :literal:`checkmk\_var\_\*`\ , an environment variable of the form :literal:`CHECKMK\_VAR\_\*`\ , and the matching key under section :literal:`[checkmk\_lookup]` in :literal:`ansible.cfg`. .. Seealso diff --git a/docs/host_group_module.rst b/docs/host_group_module.rst index 738fc5ad1..600309cc9 100644 --- a/docs/host_group_module.rst +++ b/docs/host_group_module.rst @@ -22,7 +22,7 @@ checkmk.general.host_group module -- Manage host groups in Checkmk (bulk version .. Collection note .. note:: - This module is part of the `checkmk.general collection `_ (version 7.5.0). + This module is part of the `checkmk.general collection `_ (version 7.6.0). It is not included in ``ansible-core``. To check whether it is installed, run :code:`ansible-galaxy collection list`. @@ -177,7 +177,7 @@ Parameters :ansible-option-aliases:`aliases: automation_secret` - :ansible-option-type:`string` / :ansible-option-required:`required` + :ansible-option-type:`string` .. raw:: html @@ -215,7 +215,7 @@ Parameters :ansible-option-aliases:`aliases: automation_user` - :ansible-option-type:`string` / :ansible-option-required:`required` + :ansible-option-type:`string` .. raw:: html diff --git a/docs/host_lookup.rst b/docs/host_lookup.rst index ba0ef489a..7aabb7206 100644 --- a/docs/host_lookup.rst +++ b/docs/host_lookup.rst @@ -22,7 +22,7 @@ checkmk.general.host lookup -- Get host attributes .. Collection note .. note:: - This lookup plugin is part of the `checkmk.general collection `_ (version 7.5.0). + This lookup plugin is part of the `checkmk.general collection `_ (version 7.6.0). It is not included in ``ansible-core``. To check whether it is installed, run :code:`ansible-galaxy collection list`. @@ -602,6 +602,7 @@ Notes - Alternatively, you can use a shell/command task that runs against localhost and registers the result. - The directory of the play is used as the current working directory. - It is :strong:`NOT` possible to assign other variables to the variables mentioned in the :literal:`vars` section! This is a limitation of Ansible itself. + - Connection parameters are resolved from (in order of precedence) the value set directly on the plugin invocation, an Ansible variable of the form :literal:`checkmk\_var\_\*`\ , an environment variable of the form :literal:`CHECKMK\_VAR\_\*`\ , and the matching key under section :literal:`[checkmk\_lookup]` in :literal:`ansible.cfg`. .. Seealso diff --git a/docs/host_module.rst b/docs/host_module.rst index cc6068793..7963f870a 100644 --- a/docs/host_module.rst +++ b/docs/host_module.rst @@ -22,7 +22,7 @@ checkmk.general.host module -- Manage hosts in Checkmk .. Collection note .. note:: - This module is part of the `checkmk.general collection `_ (version 7.5.0). + This module is part of the `checkmk.general collection `_ (version 7.6.0). It is not included in ``ansible-core``. To check whether it is installed, run :code:`ansible-galaxy collection list`. @@ -211,7 +211,7 @@ Parameters :ansible-option-aliases:`aliases: automation_secret` - :ansible-option-type:`string` / :ansible-option-required:`required` + :ansible-option-type:`string` .. raw:: html @@ -249,7 +249,7 @@ Parameters :ansible-option-aliases:`aliases: automation_user` - :ansible-option-type:`string` / :ansible-option-required:`required` + :ansible-option-type:`string` .. raw:: html diff --git a/docs/hosts_lookup.rst b/docs/hosts_lookup.rst index 8ce22c14a..142b50fd0 100644 --- a/docs/hosts_lookup.rst +++ b/docs/hosts_lookup.rst @@ -22,7 +22,7 @@ checkmk.general.hosts lookup -- Get various information about a host .. Collection note .. note:: - This lookup plugin is part of the `checkmk.general collection `_ (version 7.5.0). + This lookup plugin is part of the `checkmk.general collection `_ (version 7.6.0). It is not included in ``ansible-core``. To check whether it is installed, run :code:`ansible-galaxy collection list`. @@ -546,6 +546,7 @@ Notes - Alternatively, you can use a shell/command task that runs against localhost and registers the result. - The directory of the play is used as the current working directory. - It is :strong:`NOT` possible to assign other variables to the variables mentioned in the :literal:`vars` section! This is a limitation of Ansible itself. + - Connection parameters are resolved from (in order of precedence) the value set directly on the plugin invocation, an Ansible variable of the form :literal:`checkmk\_var\_\*`\ , an environment variable of the form :literal:`CHECKMK\_VAR\_\*`\ , and the matching key under section :literal:`[checkmk\_lookup]` in :literal:`ansible.cfg`. .. Seealso diff --git a/docs/index.rst b/docs/index.rst index f8563d084..91d22709e 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -7,7 +7,7 @@ Checkmk.General =============== -Collection version 7.5.0 +Collection version 7.6.0 .. contents:: :local: diff --git a/docs/ldap_connection_lookup.rst b/docs/ldap_connection_lookup.rst index 4c701f977..591f810ed 100644 --- a/docs/ldap_connection_lookup.rst +++ b/docs/ldap_connection_lookup.rst @@ -22,7 +22,7 @@ checkmk.general.ldap_connection lookup -- Show the configuration of an ldap conn .. Collection note .. note:: - This lookup plugin is part of the `checkmk.general collection `_ (version 7.5.0). + This lookup plugin is part of the `checkmk.general collection `_ (version 7.6.0). It is not included in ``ansible-core``. To check whether it is installed, run :code:`ansible-galaxy collection list`. @@ -557,6 +557,7 @@ Notes - Alternatively, you can use a shell/command task that runs against localhost and registers the result. - The directory of the play is used as the current working directory. - It is :strong:`NOT` possible to assign other variables to the variables mentioned in the :literal:`vars` section! This is a limitation of Ansible itself. + - Connection parameters are resolved from (in order of precedence) the value set directly on the plugin invocation, an Ansible variable of the form :literal:`checkmk\_var\_\*`\ , an environment variable of the form :literal:`CHECKMK\_VAR\_\*`\ , and the matching key under section :literal:`[checkmk\_lookup]` in :literal:`ansible.cfg`. .. Seealso diff --git a/docs/ldap_connections_lookup.rst b/docs/ldap_connections_lookup.rst index 910141ca9..86aa840c9 100644 --- a/docs/ldap_connections_lookup.rst +++ b/docs/ldap_connections_lookup.rst @@ -22,7 +22,7 @@ checkmk.general.ldap_connections lookup -- Get a list of all ldap\_connections .. Collection note .. note:: - This lookup plugin is part of the `checkmk.general collection `_ (version 7.5.0). + This lookup plugin is part of the `checkmk.general collection `_ (version 7.6.0). It is not included in ``ansible-core``. To check whether it is installed, run :code:`ansible-galaxy collection list`. @@ -500,6 +500,7 @@ Notes - Alternatively, you can use a shell/command task that runs against localhost and registers the result. - The directory of the play is used as the current working directory. - It is :strong:`NOT` possible to assign other variables to the variables mentioned in the :literal:`vars` section! This is a limitation of Ansible itself. + - Connection parameters are resolved from (in order of precedence) the value set directly on the plugin invocation, an Ansible variable of the form :literal:`checkmk\_var\_\*`\ , an environment variable of the form :literal:`CHECKMK\_VAR\_\*`\ , and the matching key under section :literal:`[checkmk\_lookup]` in :literal:`ansible.cfg`. .. Seealso diff --git a/docs/ldap_module.rst b/docs/ldap_module.rst index 1591d6e41..360b090ab 100644 --- a/docs/ldap_module.rst +++ b/docs/ldap_module.rst @@ -22,7 +22,7 @@ checkmk.general.ldap module -- Manage LDAP connections .. Collection note .. note:: - This module is part of the `checkmk.general collection `_ (version 7.5.0). + This module is part of the `checkmk.general collection `_ (version 7.6.0). It is not included in ``ansible-core``. To check whether it is installed, run :code:`ansible-galaxy collection list`. @@ -176,7 +176,7 @@ Parameters :ansible-option-aliases:`aliases: automation_secret` - :ansible-option-type:`string` / :ansible-option-required:`required` + :ansible-option-type:`string` .. raw:: html @@ -214,7 +214,7 @@ Parameters :ansible-option-aliases:`aliases: automation_user` - :ansible-option-type:`string` / :ansible-option-required:`required` + :ansible-option-type:`string` .. raw:: html diff --git a/docs/notification_module.rst b/docs/notification_module.rst index ed555ec16..11449e672 100644 --- a/docs/notification_module.rst +++ b/docs/notification_module.rst @@ -22,7 +22,7 @@ checkmk.general.notification module -- Manage notification rules in Checkmk. .. Collection note .. note:: - This module is part of the `checkmk.general collection `_ (version 7.5.0). + This module is part of the `checkmk.general collection `_ (version 7.6.0). It is not included in ``ansible-core``. To check whether it is installed, run :code:`ansible-galaxy collection list`. @@ -177,7 +177,7 @@ Parameters :ansible-option-aliases:`aliases: automation_secret` - :ansible-option-type:`string` / :ansible-option-required:`required` + :ansible-option-type:`string` .. raw:: html @@ -215,7 +215,7 @@ Parameters :ansible-option-aliases:`aliases: automation_user` - :ansible-option-type:`string` / :ansible-option-required:`required` + :ansible-option-type:`string` .. raw:: html diff --git a/docs/password_module.rst b/docs/password_module.rst index df9e6b140..a0a87d872 100644 --- a/docs/password_module.rst +++ b/docs/password_module.rst @@ -22,7 +22,7 @@ checkmk.general.password module -- Manage passwords in Checkmk .. Collection note .. note:: - This module is part of the `checkmk.general collection `_ (version 7.5.0). + This module is part of the `checkmk.general collection `_ (version 7.6.0). It is not included in ``ansible-core``. To check whether it is installed, run :code:`ansible-galaxy collection list`. @@ -177,7 +177,7 @@ Parameters :ansible-option-aliases:`aliases: automation_secret` - :ansible-option-type:`string` / :ansible-option-required:`required` + :ansible-option-type:`string` .. raw:: html @@ -215,7 +215,7 @@ Parameters :ansible-option-aliases:`aliases: automation_user` - :ansible-option-type:`string` / :ansible-option-required:`required` + :ansible-option-type:`string` .. raw:: html @@ -405,21 +405,25 @@ Parameters * - .. raw:: html
-
+
+
- .. _ansible_collections.checkmk.general.password_module__parameter-name: + .. _ansible_collections.checkmk.general.password_module__parameter-editable_by: + .. _ansible_collections.checkmk.general.password_module__parameter-owner: .. rst-class:: ansible-option-title - **name** + **editable_by** .. raw:: html - + .. ansible-option-type-line:: - :ansible-option-type:`string` / :ansible-option-required:`required` + :ansible-option-aliases:`aliases: owner` + + :ansible-option-type:`string` .. raw:: html @@ -429,7 +433,9 @@ Parameters
- A unique identifier for the password. + Each password is owned by a group of users which are able to edit, delete and use existing passwords. + + Use :ansopt:`checkmk.general.password#module:editable\_by` in new playbooks. :ansopt:`checkmk.general.password#module:owner` is a deprecated alias kept for backward compatibility. .. raw:: html @@ -439,21 +445,21 @@ Parameters * - .. raw:: html
-
+
- .. _ansible_collections.checkmk.general.password_module__parameter-owner: + .. _ansible_collections.checkmk.general.password_module__parameter-name: .. rst-class:: ansible-option-title - **owner** + **name** .. raw:: html - + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` / :ansible-option-required:`required` .. raw:: html @@ -463,7 +469,7 @@ Parameters
- Each password is owned by a group of users which are able to edit, delete and use existing passwords. + A unique identifier for the password. .. raw:: html diff --git a/docs/rule_lookup.rst b/docs/rule_lookup.rst index e59d561f9..e934864c3 100644 --- a/docs/rule_lookup.rst +++ b/docs/rule_lookup.rst @@ -22,7 +22,7 @@ checkmk.general.rule lookup -- Show a rule .. Collection note .. note:: - This lookup plugin is part of the `checkmk.general collection `_ (version 7.5.0). + This lookup plugin is part of the `checkmk.general collection `_ (version 7.6.0). It is not included in ``ansible-core``. To check whether it is installed, run :code:`ansible-galaxy collection list`. @@ -537,6 +537,7 @@ Notes - Alternatively, you can use a shell/command task that runs against localhost and registers the result. - The directory of the play is used as the current working directory. - It is :strong:`NOT` possible to assign other variables to the variables mentioned in the :literal:`vars` section! This is a limitation of Ansible itself. + - Connection parameters are resolved from (in order of precedence) the value set directly on the plugin invocation, an Ansible variable of the form :literal:`checkmk\_var\_\*`\ , an environment variable of the form :literal:`CHECKMK\_VAR\_\*`\ , and the matching key under section :literal:`[checkmk\_lookup]` in :literal:`ansible.cfg`. .. Seealso diff --git a/docs/rule_module.rst b/docs/rule_module.rst index b8c89bf51..dd838ffe9 100644 --- a/docs/rule_module.rst +++ b/docs/rule_module.rst @@ -22,7 +22,7 @@ checkmk.general.rule module -- Manage rules in Checkmk .. Collection note .. note:: - This module is part of the `checkmk.general collection `_ (version 7.5.0). + This module is part of the `checkmk.general collection `_ (version 7.6.0). It is not included in ``ansible-core``. To check whether it is installed, run :code:`ansible-galaxy collection list`. @@ -177,7 +177,7 @@ Parameters :ansible-option-aliases:`aliases: automation_secret` - :ansible-option-type:`string` / :ansible-option-required:`required` + :ansible-option-type:`string` .. raw:: html @@ -215,7 +215,7 @@ Parameters :ansible-option-aliases:`aliases: automation_user` - :ansible-option-type:`string` / :ansible-option-required:`required` + :ansible-option-type:`string` .. raw:: html diff --git a/docs/rules_lookup.rst b/docs/rules_lookup.rst index 32a35dc3a..a1d88a2ec 100644 --- a/docs/rules_lookup.rst +++ b/docs/rules_lookup.rst @@ -22,7 +22,7 @@ checkmk.general.rules lookup -- Get a list rules .. Collection note .. note:: - This lookup plugin is part of the `checkmk.general collection `_ (version 7.5.0). + This lookup plugin is part of the `checkmk.general collection `_ (version 7.6.0). It is not included in ``ansible-core``. To check whether it is installed, run :code:`ansible-galaxy collection list`. @@ -660,6 +660,7 @@ Notes - Alternatively, you can use a shell/command task that runs against localhost and registers the result. - The directory of the play is used as the current working directory. - It is :strong:`NOT` possible to assign other variables to the variables mentioned in the :literal:`vars` section! This is a limitation of Ansible itself. + - Connection parameters are resolved from (in order of precedence) the value set directly on the plugin invocation, an Ansible variable of the form :literal:`checkmk\_var\_\*`\ , an environment variable of the form :literal:`CHECKMK\_VAR\_\*`\ , and the matching key under section :literal:`[checkmk\_lookup]` in :literal:`ansible.cfg`. .. Seealso diff --git a/docs/ruleset_lookup.rst b/docs/ruleset_lookup.rst index 90b46b5a6..e79046798 100644 --- a/docs/ruleset_lookup.rst +++ b/docs/ruleset_lookup.rst @@ -22,7 +22,7 @@ checkmk.general.ruleset lookup -- Show a ruleset .. Collection note .. note:: - This lookup plugin is part of the `checkmk.general collection `_ (version 7.5.0). + This lookup plugin is part of the `checkmk.general collection `_ (version 7.6.0). It is not included in ``ansible-core``. To check whether it is installed, run :code:`ansible-galaxy collection list`. @@ -537,6 +537,7 @@ Notes - Alternatively, you can use a shell/command task that runs against localhost and registers the result. - The directory of the play is used as the current working directory. - It is :strong:`NOT` possible to assign other variables to the variables mentioned in the :literal:`vars` section! This is a limitation of Ansible itself. + - Connection parameters are resolved from (in order of precedence) the value set directly on the plugin invocation, an Ansible variable of the form :literal:`checkmk\_var\_\*`\ , an environment variable of the form :literal:`CHECKMK\_VAR\_\*`\ , and the matching key under section :literal:`[checkmk\_lookup]` in :literal:`ansible.cfg`. .. Seealso diff --git a/docs/rulesets_lookup.rst b/docs/rulesets_lookup.rst index 335a26166..b7c4eacec 100644 --- a/docs/rulesets_lookup.rst +++ b/docs/rulesets_lookup.rst @@ -22,7 +22,7 @@ checkmk.general.rulesets lookup -- Search rulesets .. Collection note .. note:: - This lookup plugin is part of the `checkmk.general collection `_ (version 7.5.0). + This lookup plugin is part of the `checkmk.general collection `_ (version 7.6.0). It is not included in ``ansible-core``. To check whether it is installed, run :code:`ansible-galaxy collection list`. @@ -670,6 +670,7 @@ Notes - Alternatively, you can use a shell/command task that runs against localhost and registers the result. - The directory of the play is used as the current working directory. - It is :strong:`NOT` possible to assign other variables to the variables mentioned in the :literal:`vars` section! This is a limitation of Ansible itself. + - Connection parameters are resolved from (in order of precedence) the value set directly on the plugin invocation, an Ansible variable of the form :literal:`checkmk\_var\_\*`\ , an environment variable of the form :literal:`CHECKMK\_VAR\_\*`\ , and the matching key under section :literal:`[checkmk\_lookup]` in :literal:`ansible.cfg`. .. Seealso diff --git a/docs/server_role.rst b/docs/server_role.rst index 602a26c9b..1c1c2ce90 100644 --- a/docs/server_role.rst +++ b/docs/server_role.rst @@ -20,7 +20,7 @@ checkmk.general.server role -- Install and manage Checkmk servers .. Collection note .. note:: - This role is part of the `checkmk.general collection `_ (version 7.5.0). + This role is part of the `checkmk.general collection `_ (version 7.6.0). It is not included in ``ansible-core``. To check whether it is installed, run :code:`ansible-galaxy collection list`. @@ -1563,7 +1563,7 @@ Parameters .. rst-class:: ansible-option-line - :ansible-option-default-bold:`Default:` :ansible-option-default:`"2.5.0p2"` + :ansible-option-default-bold:`Default:` :ansible-option-default:`"2.5.0p3"` .. raw:: html diff --git a/docs/service_group_module.rst b/docs/service_group_module.rst index c2078365c..7726cce17 100644 --- a/docs/service_group_module.rst +++ b/docs/service_group_module.rst @@ -22,7 +22,7 @@ checkmk.general.service_group module -- Manage service groups in Checkmk (bulk v .. Collection note .. note:: - This module is part of the `checkmk.general collection `_ (version 7.5.0). + This module is part of the `checkmk.general collection `_ (version 7.6.0). It is not included in ``ansible-core``. To check whether it is installed, run :code:`ansible-galaxy collection list`. @@ -177,7 +177,7 @@ Parameters :ansible-option-aliases:`aliases: automation_secret` - :ansible-option-type:`string` / :ansible-option-required:`required` + :ansible-option-type:`string` .. raw:: html @@ -215,7 +215,7 @@ Parameters :ansible-option-aliases:`aliases: automation_user` - :ansible-option-type:`string` / :ansible-option-required:`required` + :ansible-option-type:`string` .. raw:: html diff --git a/docs/site_lookup.rst b/docs/site_lookup.rst index 4fbd01724..bf9120f47 100644 --- a/docs/site_lookup.rst +++ b/docs/site_lookup.rst @@ -22,7 +22,7 @@ checkmk.general.site lookup -- Show the configuration of a site .. Collection note .. note:: - This lookup plugin is part of the `checkmk.general collection `_ (version 7.5.0). + This lookup plugin is part of the `checkmk.general collection `_ (version 7.6.0). It is not included in ``ansible-core``. To check whether it is installed, run :code:`ansible-galaxy collection list`. @@ -557,6 +557,7 @@ Notes - Alternatively, you can use a shell/command task that runs against localhost and registers the result. - The directory of the play is used as the current working directory. - It is :strong:`NOT` possible to assign other variables to the variables mentioned in the :literal:`vars` section! This is a limitation of Ansible itself. + - Connection parameters are resolved from (in order of precedence) the value set directly on the plugin invocation, an Ansible variable of the form :literal:`checkmk\_var\_\*`\ , an environment variable of the form :literal:`CHECKMK\_VAR\_\*`\ , and the matching key under section :literal:`[checkmk\_lookup]` in :literal:`ansible.cfg`. .. Seealso diff --git a/docs/site_module.rst b/docs/site_module.rst index 507bc55d7..4bbb71aaa 100644 --- a/docs/site_module.rst +++ b/docs/site_module.rst @@ -22,7 +22,7 @@ checkmk.general.site module -- Manage distributed monitoring in Checkmk .. Collection note .. note:: - This module is part of the `checkmk.general collection `_ (version 7.5.0). + This module is part of the `checkmk.general collection `_ (version 7.6.0). It is not included in ``ansible-core``. To check whether it is installed, run :code:`ansible-galaxy collection list`. @@ -176,7 +176,7 @@ Parameters :ansible-option-aliases:`aliases: automation_secret` - :ansible-option-type:`string` / :ansible-option-required:`required` + :ansible-option-type:`string` .. raw:: html @@ -214,7 +214,7 @@ Parameters :ansible-option-aliases:`aliases: automation_user` - :ansible-option-type:`string` / :ansible-option-required:`required` + :ansible-option-type:`string` .. raw:: html diff --git a/docs/sites_lookup.rst b/docs/sites_lookup.rst index 06c7f9855..19957f298 100644 --- a/docs/sites_lookup.rst +++ b/docs/sites_lookup.rst @@ -22,7 +22,7 @@ checkmk.general.sites lookup -- Get a list of all sites .. Collection note .. note:: - This lookup plugin is part of the `checkmk.general collection `_ (version 7.5.0). + This lookup plugin is part of the `checkmk.general collection `_ (version 7.6.0). It is not included in ``ansible-core``. To check whether it is installed, run :code:`ansible-galaxy collection list`. @@ -500,6 +500,7 @@ Notes - Alternatively, you can use a shell/command task that runs against localhost and registers the result. - The directory of the play is used as the current working directory. - It is :strong:`NOT` possible to assign other variables to the variables mentioned in the :literal:`vars` section! This is a limitation of Ansible itself. + - Connection parameters are resolved from (in order of precedence) the value set directly on the plugin invocation, an Ansible variable of the form :literal:`checkmk\_var\_\*`\ , an environment variable of the form :literal:`CHECKMK\_VAR\_\*`\ , and the matching key under section :literal:`[checkmk\_lookup]` in :literal:`ansible.cfg`. .. Seealso diff --git a/docs/tag_group_module.rst b/docs/tag_group_module.rst index 70ef874e3..e95835a21 100644 --- a/docs/tag_group_module.rst +++ b/docs/tag_group_module.rst @@ -22,7 +22,7 @@ checkmk.general.tag_group module -- Manage tag groups in Checkmk .. Collection note .. note:: - This module is part of the `checkmk.general collection `_ (version 7.5.0). + This module is part of the `checkmk.general collection `_ (version 7.6.0). It is not included in ``ansible-core``. To check whether it is installed, run :code:`ansible-galaxy collection list`. @@ -177,7 +177,7 @@ Parameters :ansible-option-aliases:`aliases: automation_secret` - :ansible-option-type:`string` / :ansible-option-required:`required` + :ansible-option-type:`string` .. raw:: html @@ -215,7 +215,7 @@ Parameters :ansible-option-aliases:`aliases: automation_user` - :ansible-option-type:`string` / :ansible-option-required:`required` + :ansible-option-type:`string` .. raw:: html diff --git a/docs/timeperiod_module.rst b/docs/timeperiod_module.rst index 8d5503aa5..ff1f80afa 100644 --- a/docs/timeperiod_module.rst +++ b/docs/timeperiod_module.rst @@ -22,7 +22,7 @@ checkmk.general.timeperiod module -- Manage time periods in Checkmk .. Collection note .. note:: - This module is part of the `checkmk.general collection `_ (version 7.5.0). + This module is part of the `checkmk.general collection `_ (version 7.6.0). It is not included in ``ansible-core``. To check whether it is installed, run :code:`ansible-galaxy collection list`. @@ -244,7 +244,7 @@ Parameters :ansible-option-aliases:`aliases: automation_secret` - :ansible-option-type:`string` / :ansible-option-required:`required` + :ansible-option-type:`string` .. raw:: html @@ -282,7 +282,7 @@ Parameters :ansible-option-aliases:`aliases: automation_user` - :ansible-option-type:`string` / :ansible-option-required:`required` + :ansible-option-type:`string` .. raw:: html diff --git a/docs/user_module.rst b/docs/user_module.rst index 92d3456da..71709e113 100644 --- a/docs/user_module.rst +++ b/docs/user_module.rst @@ -22,7 +22,7 @@ checkmk.general.user module -- Manage users in Checkmk .. Collection note .. note:: - This module is part of the `checkmk.general collection `_ (version 7.5.0). + This module is part of the `checkmk.general collection `_ (version 7.6.0). It is not included in ``ansible-core``. To check whether it is installed, run :code:`ansible-galaxy collection list`. @@ -177,7 +177,7 @@ Parameters :ansible-option-aliases:`aliases: automation_secret` - :ansible-option-type:`string` / :ansible-option-required:`required` + :ansible-option-type:`string` .. raw:: html @@ -215,7 +215,7 @@ Parameters :ansible-option-aliases:`aliases: automation_user` - :ansible-option-type:`string` / :ansible-option-required:`required` + :ansible-option-type:`string` .. raw:: html diff --git a/docs/version_lookup.rst b/docs/version_lookup.rst index 5002f7416..d29c53e8c 100644 --- a/docs/version_lookup.rst +++ b/docs/version_lookup.rst @@ -22,7 +22,7 @@ checkmk.general.version lookup -- Get the version of a Checkmk server .. Collection note .. note:: - This lookup plugin is part of the `checkmk.general collection `_ (version 7.5.0). + This lookup plugin is part of the `checkmk.general collection `_ (version 7.6.0). It is not included in ``ansible-core``. To check whether it is installed, run :code:`ansible-galaxy collection list`. @@ -500,6 +500,7 @@ Notes - Alternatively, you can use a shell/command task that runs against localhost and registers the result. - The directory of the play is used as the current working directory. - It is :strong:`NOT` possible to assign other variables to the variables mentioned in the :literal:`vars` section! This is a limitation of Ansible itself. + - Connection parameters are resolved from (in order of precedence) the value set directly on the plugin invocation, an Ansible variable of the form :literal:`checkmk\_var\_\*`\ , an environment variable of the form :literal:`CHECKMK\_VAR\_\*`\ , and the matching key under section :literal:`[checkmk\_lookup]` in :literal:`ansible.cfg`. .. Seealso