Add 'idempotent' attribute

[felixfontein]

SUMMARY

Adds a new attribute idempotent for module documentation, which states whether (resp. under which circumstances) the module is idempotent.

Related PRs:

• Add 'idempotent' attribute community.dns#238
• Add 'idempotent' attribute community.crypto#833
• Add 'idempotent' attribute community.docker#1022
• Add 'idempotent' attribute community.routeros#337
• Add 'idempotent' attribute community.sops#217

ISSUE TYPE

• Docs Pull Request

COMPONENT NAME

module documentation

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 98.22%. Comparing base (fd17ec8) to head (1867ddb).
Report is 1 commits behind head on main.

Additional details and impacted files

@@           Coverage Diff           @@
##             main     #132   +/-   ##
=======================================
  Coverage   98.22%   98.22%           
=======================================
  Files          34       34           
  Lines        2427     2428    +1     
  Branches      274      274           
=======================================
+ Hits         2384     2385    +1     
  Misses         20       20           
  Partials       23       23           

Flag	Coverage Δ
sanity	27.60% <100.00%> (+0.07%)	⬆️
units	98.09% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[github-actions]

Docs Build 📝

Thank you for contribution!✨

The docs for this PR have been published here:
https://ansible-collections.github.io/community.hrobot/pr/132

You can compare to the docs for the main branch here:
https://ansible-collections.github.io/community.hrobot/branch/main

The docsite for this PR is also available for download as an artifact from this run:
https://github.com/ansible-collections/community.hrobot/actions/runs/12550802038

File changes:

• M boot_module.html
• M failover_ip_info_module.html
• M failover_ip_module.html
• M firewall_info_module.html
• M firewall_module.html
• M reset_module.html
• M reverse_dns_module.html
• M server_info_module.html
• M server_module.html
• M ssh_key_info_module.html
• M ssh_key_module.html
• M v_switch_module.html

Click to see the diff comparison.

NOTE: only file modifications are shown here. New and deleted files are excluded.
See the file list and check the published docs to see those files.

diff --git a/home/runner/work/community.hrobot/community.hrobot/docsbuild/base/boot_module.html b/home/runner/work/community.hrobot/community.hrobot/docsbuild/head/boot_module.html
index e0bea3b..17b08f5 100644
--- a/home/runner/work/community.hrobot/community.hrobot/docsbuild/base/boot_module.html
+++ b/home/runner/work/community.hrobot/community.hrobot/docsbuild/head/boot_module.html
@@ -463,6 +463,15 @@ To check whether it is installed, run <code class="code docutils literal notrans
 <td><div class="ansible-option-cell"><p>Will return details on what has changed (or possibly needs changing in <code class="docutils literal notranslate"><span class="pre">check_mode</span></code>), when in diff mode.</p>
 </div></td>
 </tr>
+<tr class="row-odd"><td><div class="ansible-option-cell">
+<div class="ansibleOptionAnchor" id="attribute-idempotent"></div><p class="ansible-option-title" id="ansible-collections-community-hrobot-boot-module-attribute-idempotent"><strong>idempotent</strong></p>
+<a class="ansibleOptionLink" href="#attribute-idempotent" title="Permalink to this attribute"></a></div></td>
+<td><div class="ansible-option-cell"><p><strong class="ansible-attribute-support-label">Support: </strong><strong class="ansible-attribute-support-full">full</strong></p>
+</div></td>
+<td><div class="ansible-option-cell"><p>When run twice in a row outside check mode, with the same arguments, the second invocation indicates no change.</p>
+<p>This assumes that the system controlled/queried by the module has not changed in a relevant way.</p>
+</div></td>
+</tr>
 </tbody>
 </table>
 </section>
diff --git a/home/runner/work/community.hrobot/community.hrobot/docsbuild/base/failover_ip_info_module.html b/home/runner/work/community.hrobot/community.hrobot/docsbuild/head/failover_ip_info_module.html
index 7e75822..9187711 100644
--- a/home/runner/work/community.hrobot/community.hrobot/docsbuild/base/failover_ip_info_module.html
+++ b/home/runner/work/community.hrobot/community.hrobot/docsbuild/head/failover_ip_info_module.html
@@ -230,6 +230,16 @@ To check whether it is installed, run <code class="code docutils literal notrans
 <td><div class="ansible-option-cell"><p>Will return details on what has changed (or possibly needs changing in <code class="docutils literal notranslate"><span class="pre">check_mode</span></code>), when in diff mode.</p>
 </div></td>
 </tr>
+<tr class="row-odd"><td><div class="ansible-option-cell">
+<div class="ansibleOptionAnchor" id="attribute-idempotent"></div><p class="ansible-option-title" id="ansible-collections-community-hrobot-failover-ip-info-module-attribute-idempotent"><strong>idempotent</strong></p>
+<a class="ansibleOptionLink" href="#attribute-idempotent" title="Permalink to this attribute"></a></div></td>
+<td><div class="ansible-option-cell"><p><strong class="ansible-attribute-support-label">Support: </strong><strong class="ansible-attribute-support-full">full</strong></p>
+<p>This action does not modify state.</p>
+</div></td>
+<td><div class="ansible-option-cell"><p>When run twice in a row outside check mode, with the same arguments, the second invocation indicates no change.</p>
+<p>This assumes that the system controlled/queried by the module has not changed in a relevant way.</p>
+</div></td>
+</tr>
 </tbody>
 </table>
 </section>
diff --git a/home/runner/work/community.hrobot/community.hrobot/docsbuild/base/failover_ip_module.html b/home/runner/work/community.hrobot/community.hrobot/docsbuild/head/failover_ip_module.html
index 8abb68e..7dee65b 100644
--- a/home/runner/work/community.hrobot/community.hrobot/docsbuild/base/failover_ip_module.html
+++ b/home/runner/work/community.hrobot/community.hrobot/docsbuild/head/failover_ip_module.html
@@ -258,6 +258,15 @@ To check whether it is installed, run <code class="code docutils literal notrans
 <td><div class="ansible-option-cell"><p>Will return details on what has changed (or possibly needs changing in <code class="docutils literal notranslate"><span class="pre">check_mode</span></code>), when in diff mode.</p>
 </div></td>
 </tr>
+<tr class="row-odd"><td><div class="ansible-option-cell">
+<div class="ansibleOptionAnchor" id="attribute-idempotent"></div><p class="ansible-option-title" id="ansible-collections-community-hrobot-failover-ip-module-attribute-idempotent"><strong>idempotent</strong></p>
+<a class="ansibleOptionLink" href="#attribute-idempotent" title="Permalink to this attribute"></a></div></td>
+<td><div class="ansible-option-cell"><p><strong class="ansible-attribute-support-label">Support: </strong><strong class="ansible-attribute-support-full">full</strong></p>
+</div></td>
+<td><div class="ansible-option-cell"><p>When run twice in a row outside check mode, with the same arguments, the second invocation indicates no change.</p>
+<p>This assumes that the system controlled/queried by the module has not changed in a relevant way.</p>
+</div></td>
+</tr>
 </tbody>
 </table>
 </section>
diff --git a/home/runner/work/community.hrobot/community.hrobot/docsbuild/base/firewall_info_module.html b/home/runner/work/community.hrobot/community.hrobot/docsbuild/head/firewall_info_module.html
index a150359..0cd8d89 100644
--- a/home/runner/work/community.hrobot/community.hrobot/docsbuild/base/firewall_info_module.html
+++ b/home/runner/work/community.hrobot/community.hrobot/docsbuild/head/firewall_info_module.html
@@ -271,6 +271,16 @@ To check whether it is installed, run <code class="code docutils literal notrans
 <td><div class="ansible-option-cell"><p>Will return details on what has changed (or possibly needs changing in <code class="docutils literal notranslate"><span class="pre">check_mode</span></code>), when in diff mode.</p>
 </div></td>
 </tr>
+<tr class="row-odd"><td><div class="ansible-option-cell">
+<div class="ansibleOptionAnchor" id="attribute-idempotent"></div><p class="ansible-option-title" id="ansible-collections-community-hrobot-firewall-info-module-attribute-idempotent"><strong>idempotent</strong></p>
+<a class="ansibleOptionLink" href="#attribute-idempotent" title="Permalink to this attribute"></a></div></td>
+<td><div class="ansible-option-cell"><p><strong class="ansible-attribute-support-label">Support: </strong><strong class="ansible-attribute-support-full">full</strong></p>
+<p>This action does not modify state.</p>
+</div></td>
+<td><div class="ansible-option-cell"><p>When run twice in a row outside check mode, with the same arguments, the second invocation indicates no change.</p>
+<p>This assumes that the system controlled/queried by the module has not changed in a relevant way.</p>
+</div></td>
+</tr>
 </tbody>
 </table>
 </section>
diff --git a/home/runner/work/community.hrobot/community.hrobot/docsbuild/base/firewall_module.html b/home/runner/work/community.hrobot/community.hrobot/docsbuild/head/firewall_module.html
index 89d5413..29dd1d3 100644
--- a/home/runner/work/community.hrobot/community.hrobot/docsbuild/base/firewall_module.html
+++ b/home/runner/work/community.hrobot/community.hrobot/docsbuild/head/firewall_module.html
@@ -515,6 +515,15 @@ see <a class="reference internal" href="#ansible-collections-community-hrobot-fi
 <td><div class="ansible-option-cell"><p>Will return details on what has changed (or possibly needs changing in <code class="docutils literal notranslate"><span class="pre">check_mode</span></code>), when in diff mode.</p>
 </div></td>
 </tr>
+<tr class="row-odd"><td><div class="ansible-option-cell">
+<div class="ansibleOptionAnchor" id="attribute-idempotent"></div><p class="ansible-option-title" id="ansible-collections-community-hrobot-firewall-module-attribute-idempotent"><strong>idempotent</strong></p>
+<a class="ansibleOptionLink" href="#attribute-idempotent" title="Permalink to this attribute"></a></div></td>
+<td><div class="ansible-option-cell"><p><strong class="ansible-attribute-support-label">Support: </strong><strong class="ansible-attribute-support-full">full</strong></p>
+</div></td>
+<td><div class="ansible-option-cell"><p>When run twice in a row outside check mode, with the same arguments, the second invocation indicates no change.</p>
+<p>This assumes that the system controlled/queried by the module has not changed in a relevant way.</p>
+</div></td>
+</tr>
 </tbody>
 </table>
 </section>
diff --git a/home/runner/work/community.hrobot/community.hrobot/docsbuild/base/reset_module.html b/home/runner/work/community.hrobot/community.hrobot/docsbuild/head/reset_module.html
index fb6a078..02ab12c 100644
--- a/home/runner/work/community.hrobot/community.hrobot/docsbuild/base/reset_module.html
+++ b/home/runner/work/community.hrobot/community.hrobot/docsbuild/head/reset_module.html
@@ -244,6 +244,16 @@ To check whether it is installed, run <code class="code docutils literal notrans
 <td><div class="ansible-option-cell"><p>Will return details on what has changed (or possibly needs changing in <code class="docutils literal notranslate"><span class="pre">check_mode</span></code>), when in diff mode.</p>
 </div></td>
 </tr>
+<tr class="row-odd"><td><div class="ansible-option-cell">
+<div class="ansibleOptionAnchor" id="attribute-idempotent"></div><p class="ansible-option-title" id="ansible-collections-community-hrobot-reset-module-attribute-idempotent"><strong>idempotent</strong></p>
+<a class="ansibleOptionLink" href="#attribute-idempotent" title="Permalink to this attribute"></a></div></td>
+<td><div class="ansible-option-cell"><p><strong class="ansible-attribute-support-label">Support: </strong><strong class="ansible-attribute-support-none">none</strong></p>
+<p>This module performs an action on every invocation.</p>
+</div></td>
+<td><div class="ansible-option-cell"><p>When run twice in a row outside check mode, with the same arguments, the second invocation indicates no change.</p>
+<p>This assumes that the system controlled/queried by the module has not changed in a relevant way.</p>
+</div></td>
+</tr>
 </tbody>
 </table>
 </section>
diff --git a/home/runner/work/community.hrobot/community.hrobot/docsbuild/base/reverse_dns_module.html b/home/runner/work/community.hrobot/community.hrobot/docsbuild/head/reverse_dns_module.html
index ca26a07..1e7ab05 100644
--- a/home/runner/work/community.hrobot/community.hrobot/docsbuild/base/reverse_dns_module.html
+++ b/home/runner/work/community.hrobot/community.hrobot/docsbuild/head/reverse_dns_module.html
@@ -247,6 +247,15 @@ To check whether it is installed, run <code class="code docutils literal notrans
 <td><div class="ansible-option-cell"><p>Will return details on what has changed (or possibly needs changing in <code class="docutils literal notranslate"><span class="pre">check_mode</span></code>), when in diff mode.</p>
 </div></td>
 </tr>
+<tr class="row-odd"><td><div class="ansible-option-cell">
+<div class="ansibleOptionAnchor" id="attribute-idempotent"></div><p class="ansible-option-title" id="ansible-collections-community-hrobot-reverse-dns-module-attribute-idempotent"><strong>idempotent</strong></p>
+<a class="ansibleOptionLink" href="#attribute-idempotent" title="Permalink to this attribute"></a></div></td>
+<td><div class="ansible-option-cell"><p><strong class="ansible-attribute-support-label">Support: </strong><strong class="ansible-attribute-support-full">full</strong></p>
+</div></td>
+<td><div class="ansible-option-cell"><p>When run twice in a row outside check mode, with the same arguments, the second invocation indicates no change.</p>
+<p>This assumes that the system controlled/queried by the module has not changed in a relevant way.</p>
+</div></td>
+</tr>
 </tbody>
 </table>
 </section>
diff --git a/home/runner/work/community.hrobot/community.hrobot/docsbuild/base/server_info_module.html b/home/runner/work/community.hrobot/community.hrobot/docsbuild/head/server_info_module.html
index f23c445..670b12b 100644
--- a/home/runner/work/community.hrobot/community.hrobot/docsbuild/base/server_info_module.html
+++ b/home/runner/work/community.hrobot/community.hrobot/docsbuild/head/server_info_module.html
@@ -250,6 +250,16 @@ To check whether it is installed, run <code class="code docutils literal notrans
 <td><div class="ansible-option-cell"><p>Will return details on what has changed (or possibly needs changing in <code class="docutils literal notranslate"><span class="pre">check_mode</span></code>), when in diff mode.</p>
 </div></td>
 </tr>
+<tr class="row-odd"><td><div class="ansible-option-cell">
+<div class="ansibleOptionAnchor" id="attribute-idempotent"></div><p class="ansible-option-title" id="ansible-collections-community-hrobot-server-info-module-attribute-idempotent"><strong>idempotent</strong></p>
+<a class="ansibleOptionLink" href="#attribute-idempotent" title="Permalink to this attribute"></a></div></td>
+<td><div class="ansible-option-cell"><p><strong class="ansible-attribute-support-label">Support: </strong><strong class="ansible-attribute-support-full">full</strong></p>
+<p>This action does not modify state.</p>
+</div></td>
+<td><div class="ansible-option-cell"><p>When run twice in a row outside check mode, with the same arguments, the second invocation indicates no change.</p>
+<p>This assumes that the system controlled/queried by the module has not changed in a relevant way.</p>
+</div></td>
+</tr>
 </tbody>
 </table>
 </section>
diff --git a/home/runner/work/community.hrobot/community.hrobot/docsbuild/base/server_module.html b/home/runner/work/community.hrobot/community.hrobot/docsbuild/head/server_module.html
index 0cc33b3..d0fdc28 100644
--- a/home/runner/work/community.hrobot/community.hrobot/docsbuild/base/server_module.html
+++ b/home/runner/work/community.hrobot/community.hrobot/docsbuild/head/server_module.html
@@ -236,6 +236,15 @@ To check whether it is installed, run <code class="code docutils literal notrans
 <td><div class="ansible-option-cell"><p>Will return details on what has changed (or possibly needs changing in <code class="docutils literal notranslate"><span class="pre">check_mode</span></code>), when in diff mode.</p>
 </div></td>
 </tr>
+<tr class="row-odd"><td><div class="ansible-option-cell">
+<div class="ansibleOptionAnchor" id="attribute-idempotent"></div><p class="ansible-option-title" id="ansible-collections-community-hrobot-server-module-attribute-idempotent"><strong>idempotent</strong></p>
+<a class="ansibleOptionLink" href="#attribute-idempotent" title="Permalink to this attribute"></a></div></td>
+<td><div class="ansible-option-cell"><p><strong class="ansible-attribute-support-label">Support: </strong><strong class="ansible-attribute-support-full">full</strong></p>
+</div></td>
+<td><div class="ansible-option-cell"><p>When run twice in a row outside check mode, with the same arguments, the second invocation indicates no change.</p>
+<p>This assumes that the system controlled/queried by the module has not changed in a relevant way.</p>
+</div></td>
+</tr>
 </tbody>
 </table>
 </section>
diff --git a/home/runner/work/community.hrobot/community.hrobot/docsbuild/base/ssh_key_info_module.html b/home/runner/work/community.hrobot/community.hrobot/docsbuild/head/ssh_key_info_module.html
index 2d38450..6021549 100644
--- a/home/runner/work/community.hrobot/community.hrobot/docsbuild/base/ssh_key_info_module.html
+++ b/home/runner/work/community.hrobot/community.hrobot/docsbuild/head/ssh_key_info_module.html
@@ -224,6 +224,16 @@ To check whether it is installed, run <code class="code docutils literal notrans
 <td><div class="ansible-option-cell"><p>Will return details on what has changed (or possibly needs changing in <code class="docutils literal notranslate"><span class="pre">check_mode</span></code>), when in diff mode.</p>
 </div></td>
 </tr>
+<tr class="row-odd"><td><div class="ansible-option-cell">
+<div class="ansibleOptionAnchor" id="attribute-idempotent"></div><p class="ansible-option-title" id="ansible-collections-community-hrobot-ssh-key-info-module-attribute-idempotent"><strong>idempotent</strong></p>
+<a class="ansibleOptionLink" href="#attribute-idempotent" title="Permalink to this attribute"></a></div></td>
+<td><div class="ansible-option-cell"><p><strong class="ansible-attribute-support-label">Support: </strong><strong class="ansible-attribute-support-full">full</strong></p>
+<p>This action does not modify state.</p>
+</div></td>
+<td><div class="ansible-option-cell"><p>When run twice in a row outside check mode, with the same arguments, the second invocation indicates no change.</p>
+<p>This assumes that the system controlled/queried by the module has not changed in a relevant way.</p>
+</div></td>
+</tr>
 </tbody>
 </table>
 </section>
diff --git a/home/runner/work/community.hrobot/community.hrobot/docsbuild/base/ssh_key_module.html b/home/runner/work/community.hrobot/community.hrobot/docsbuild/head/ssh_key_module.html
index 8f9fd0a..766af56 100644
--- a/home/runner/work/community.hrobot/community.hrobot/docsbuild/base/ssh_key_module.html
+++ b/home/runner/work/community.hrobot/community.hrobot/docsbuild/head/ssh_key_module.html
@@ -262,6 +262,15 @@ To check whether it is installed, run <code class="code docutils literal notrans
 <td><div class="ansible-option-cell"><p>Will return details on what has changed (or possibly needs changing in <code class="docutils literal notranslate"><span class="pre">check_mode</span></code>), when in diff mode.</p>
 </div></td>
 </tr>
+<tr class="row-odd"><td><div class="ansible-option-cell">
+<div class="ansibleOptionAnchor" id="attribute-idempotent"></div><p class="ansible-option-title" id="ansible-collections-community-hrobot-ssh-key-module-attribute-idempotent"><strong>idempotent</strong></p>
+<a class="ansibleOptionLink" href="#attribute-idempotent" title="Permalink to this attribute"></a></div></td>
+<td><div class="ansible-option-cell"><p><strong class="ansible-attribute-support-label">Support: </strong><strong class="ansible-attribute-support-full">full</strong></p>
+</div></td>
+<td><div class="ansible-option-cell"><p>When run twice in a row outside check mode, with the same arguments, the second invocation indicates no change.</p>
+<p>This assumes that the system controlled/queried by the module has not changed in a relevant way.</p>
+</div></td>
+</tr>
 </tbody>
 </table>
 </section>
diff --git a/home/runner/work/community.hrobot/community.hrobot/docsbuild/base/v_switch_module.html b/home/runner/work/community.hrobot/community.hrobot/docsbuild/head/v_switch_module.html
index 9251d87..3d7d8d0 100644
--- a/home/runner/work/community.hrobot/community.hrobot/docsbuild/base/v_switch_module.html
+++ b/home/runner/work/community.hrobot/community.hrobot/docsbuild/head/v_switch_module.html
@@ -291,6 +291,15 @@ To check whether it is installed, run <code class="code docutils literal notrans
 <td><div class="ansible-option-cell"><p>Will return details on what has changed (or possibly needs changing in <code class="docutils literal notranslate"><span class="pre">check_mode</span></code>), when in diff mode.</p>
 </div></td>
 </tr>
+<tr class="row-odd"><td><div class="ansible-option-cell">
+<div class="ansibleOptionAnchor" id="attribute-idempotent"></div><p class="ansible-option-title" id="ansible-collections-community-hrobot-v-switch-module-attribute-idempotent"><strong>idempotent</strong></p>
+<a class="ansibleOptionLink" href="#attribute-idempotent" title="Permalink to this attribute"></a></div></td>
+<td><div class="ansible-option-cell"><p><strong class="ansible-attribute-support-label">Support: </strong><strong class="ansible-attribute-support-full">full</strong></p>
+</div></td>
+<td><div class="ansible-option-cell"><p>When run twice in a row outside check mode, with the same arguments, the second invocation indicates no change.</p>
+<p>This assumes that the system controlled/queried by the module has not changed in a relevant way.</p>
+</div></td>
+</tr>
 </tbody>
 </table>
 </section>