community.general New Module: Keycloak Role Composites

New Module: Keycloak Role Composites

Open bratwurzt opened this issue 2 years ago • 5 comments

SUMMARY

Add keycloak_role_composites module to provide management of composite roles.

ISSUE TYPE

New Module Pull Request

COMPONENT NAME

keycloak_role_composites

ADDITIONAL INFORMATION

Example:

- name: Map a client role to a composite role, authentication with credentials
  community.general.keycloak_role_composites:
    realm: MyCustomRealm
    auth_client_id: admin-cli
    auth_keycloak_url: https://auth.example.com/auth
    auth_realm: master
    auth_username: USERNAME
    auth_password: PASSWORD
    state: present
    composite_role:
      name: composite_role_name
      id: composite_role_id
    client_id: client1
    role_client_id: client2
    roles:
      - name: role_of_client2_name1
        id: role_id1
      - name: role_of_client2_name2
        id: role_id2
  delegate_to: localhost

- name: Map a realm role to a composite role, authentication with credentials
  community.general.keycloak_role_composites:
    realm: MyCustomRealm
    auth_client_id: admin-cli
    auth_keycloak_url: https://auth.example.com/auth
    auth_realm: master
    auth_username: USERNAME
    auth_password: PASSWORD
    state: present
    composite_role:
      name: composite_role_name
      id: composite_role_id
    roles:
      - name: role_of_realm_name1
        id: role_id1
      - name: role_of_realm_name2
        id: role_id2
  delegate_to: localhost

Jul 06 '22 08:07 bratwurzt

cc @Gaetan2907 @eikef @ndclt click here for bot help

Jul 06 '22 08:07 ansibullbot

Docs Build 📝

Thank you for contribution!✨

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

File changes:

A collections/community/general/identity.keycloak.keycloak_role_composites_module.html

A collections/community/general/keycloak_role_composites_module.html

M collections/community/general/gitlab_project_variable_module.html

M collections/community/general/gitlab_protected_branch_module.html

M collections/community/general/gitlab_runner_module.html

M collections/community/general/index.html

M collections/community/general/keycloak_role_module.html

M collections/community/general/keycloak_user_federation_module.html

M collections/community/general/memset_dns_reload_module.html

M collections/community/general/memset_memstore_info_module.html

M collections/community/general/memset_server_info_module.html

M collections/community/general/memset_zone_domain_module.html

M collections/community/general/memset_zone_module.html

M collections/community/general/memset_zone_record_module.html

M collections/community/general/mksysb_module.html

M collections/community/general/modprobe_module.html

M collections/community/general/mqtt_module.html

M collections/community/general/mssql_db_module.html

M collections/community/general/mssql_script_module.html

M collections/community/general/nagios_module.html

M collections/community/general/netcup_dns_module.html

M collections/community/general/newrelic_deployment_module.html

M collections/community/general/nexmo_module.html

M collections/community/general/nginx_status_info_module.html

M collections/community/general/nictagadm_module.html

M collections/community/general/npm_module.html

M collections/community/general/nsupdate_module.html

M collections/community/general/oci_vcn_module.html

M collections/community/general/ohai_module.html

M collections/community/general/omapi_host_module.html

M collections/community/general/one_host_module.html

M collections/community/general/one_vm_module.html

M collections/community/general/oneandone_firewall_policy_module.html

M collections/community/general/oneandone_load_balancer_module.html

M collections/community/general/oneandone_monitoring_policy_module.html

M collections/community/general/oneandone_private_network_module.html

M collections/community/general/oneandone_public_ip_module.html

M collections/community/general/oneandone_server_module.html

M collections/community/general/onepassword_info_module.html

M collections/community/general/oneview_ethernet_network_info_module.html

M collections/community/general/oneview_fc_network_info_module.html

M collections/community/general/oneview_fc_network_module.html

M collections/community/general/oneview_san_manager_info_module.html

M collections/community/general/online_server_info_module.html

M collections/community/general/online_user_info_module.html

M collections/community/general/open_iscsi_module.html

M collections/community/general/openbsd_pkg_module.html

M collections/community/general/opendj_backendprop_module.html

M collections/community/general/openwrt_init_module.html

M collections/community/general/opkg_module.html

M collections/community/general/pacemaker_cluster_module.html

M collections/community/general/packet_device_module.html

M collections/community/general/packet_ip_subnet_module.html

M collections/community/general/packet_project_module.html

M collections/community/general/packet_sshkey_module.html

M collections/community/general/packet_volume_attachment_module.html

M collections/community/general/packet_volume_module.html

M collections/community/general/pacman_module.html

M collections/community/general/pingdom_module.html

M collections/community/general/pip_package_info_module.html

M collections/community/general/pipx_module.html

M collections/community/general/pkg5_publisher_module.html

M collections/community/general/pkgin_module.html

M collections/community/general/pkgng_module.html

M collections/community/general/pritunl_user_info_module.html

M collections/community/general/profitbricks_datacenter_module.html

M collections/community/general/profitbricks_module.html

M collections/community/general/profitbricks_nic_module.html

M collections/community/general/profitbricks_volume_attachments_module.html

M collections/community/general/profitbricks_volume_module.html

M collections/community/general/proxmox_disk_module.html

M collections/community/general/proxmox_domain_info_module.html

M collections/community/general/proxmox_group_info_module.html

M collections/community/general/proxmox_kvm_module.html

M collections/community/general/proxmox_module.html

M collections/community/general/proxmox_nic_module.html

M collections/community/general/proxmox_snap_module.html

M collections/community/general/proxmox_tasks_info_module.html

M collections/community/general/proxmox_template_module.html

M collections/community/general/proxmox_user_info_module.html

M collections/community/general/pubnub_blocks_module.html

M collections/community/general/pulp_repo_module.html

M collections/index_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.

The diff output was truncated because it exceeded the maximum size.

diff --git a/home/runner/work/community.general/community.general/docsbuild/base/collections/community/general/gitlab_project_variable_module.html b/home/runner/work/community.general/community.general/docsbuild/head/collections/community/general/gitlab_project_variable_module.html
index f59e117..3c32595 100644
--- a/home/runner/work/community.general/community.general/docsbuild/base/collections/community/general/gitlab_project_variable_module.html
+++ b/home/runner/work/community.general/community.general/docsbuild/head/collections/community/general/gitlab_project_variable_module.html
@@ -22,7 +22,7 @@
         <script src="../../../_static/sphinx_highlight.js"></script>
     <script src="../../../_static/js/theme.js"></script>
     <link rel="search" title="Search" href="../../../search.html" />
-    <link rel="next" title="community.general.gitlab_protected_branch module – (un)Marking existing branches for protection" href="gitlab_protected_branch_module.html" />
+    <link rel="next" title="community.general.gitlab_protected_branch module – Manage protection of existing branches" href="gitlab_protected_branch_module.html" />
     <link rel="prev" title="community.general.gitlab_project_members module – Manage project members on GitLab Server" href="gitlab_project_members_module.html" /><!-- extra head elements for Ansible beyond RTD Sphinx Theme -->
 
 
@@ -480,7 +480,7 @@ see <a class="reference internal" href="#ansible-collections-community-general-g
 
 <footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
         <a href="gitlab_project_members_module.html" class="btn btn-neutral float-left" title="community.general.gitlab_project_members module – Manage project members on GitLab Server" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
-        <a href="gitlab_protected_branch_module.html" class="btn btn-neutral float-right" title="community.general.gitlab_protected_branch module – (un)Marking existing branches for protection" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
+        <a href="gitlab_protected_branch_module.html" class="btn btn-neutral float-right" title="community.general.gitlab_protected_branch module – Manage protection of existing branches" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
     </div>
 
   <hr/>
diff --git a/home/runner/work/community.general/community.general/docsbuild/base/collections/community/general/gitlab_protected_branch_module.html b/home/runner/work/community.general/community.general/docsbuild/head/collections/community/general/gitlab_protected_branch_module.html
index 52f06ff..17d0e36 100644
--- a/home/runner/work/community.general/community.general/docsbuild/base/collections/community/general/gitlab_protected_branch_module.html
+++ b/home/runner/work/community.general/community.general/docsbuild/head/collections/community/general/gitlab_protected_branch_module.html
@@ -4,7 +4,7 @@
   <meta charset="utf-8" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>community.general.gitlab_protected_branch module – (un)Marking existing branches for protection &mdash; Ansible collections  documentation</title>
+  <title>community.general.gitlab_protected_branch module – Manage protection of existing branches &mdash; Ansible collections  documentation</title>
       <link rel="stylesheet" href="../../../_static/pygments.css" type="text/css" />
       <link rel="stylesheet" href="../../../_static/css/ansible.css" type="text/css" />
       <link rel="stylesheet" href="../../../_static/antsibull-minimal.css" type="text/css" />
@@ -117,7 +117,7 @@
           <li class="breadcrumb-item"><a href="../../index.html">Collection Index</a></li>
           <li class="breadcrumb-item"><a href="../index.html">Collections in the Community Namespace</a></li>
           <li class="breadcrumb-item"><a href="index.html">Community.General</a></li>
-      <li class="breadcrumb-item active">community.general.gitlab_protected_branch module – (un)Marking existing branches for protection</li>
+      <li class="breadcrumb-item active">community.general.gitlab_protected_branch module – Manage protection of existing branches</li>
       <li class="wy-breadcrumbs-aside">
               <!-- User defined GitHub URL -->
               <a href="https://github.com/ansible-collections/community.general/edit/main/plugins/modules/gitlab_protected_branch.py?description=%23%23%23%23%23%20SUMMARY%0A%3C!—%20Your%20description%20here%20–%3E%0A%0A%0A%23%23%23%23%23%20ISSUE%20TYPE%0A-%20Docs%20Pull%20Request%0A%0A%2Blabel:%20docsite_pr" class="fa fa-github"> Edit on GitHub</a>
@@ -130,8 +130,8 @@
   
            <div itemprop="articleBody">
              
-  <span class="target" id="ansible-collections-community-general-gitlab-protected-branch-module"></span><section id="community-general-gitlab-protected-branch-module-un-marking-existing-branches-for-protection">
-<h1>community.general.gitlab_protected_branch module – (un)Marking existing branches for protection<a class="headerlink" href="#community-general-gitlab-protected-branch-module-un-marking-existing-branches-for-protection" title="Permalink to this heading"></a></h1>
+  <span class="target" id="ansible-collections-community-general-gitlab-protected-branch-module"></span><section id="community-general-gitlab-protected-branch-module-manage-protection-of-existing-branches">
+<h1>community.general.gitlab_protected_branch module – Manage protection of existing branches<a class="headerlink" href="#community-general-gitlab-protected-branch-module-manage-protection-of-existing-branches" title="Permalink to this heading"></a></h1>
 <div class="admonition note">
 <p class="admonition-title">Note</p>
 <p>This module is part of the <a class="reference external" href="https://galaxy.ansible.com/community/general">community.general collection</a> (version 6.1.0).</p>
@@ -262,7 +262,7 @@ see <a class="reference internal" href="#ansible-collections-community-general-g
 <div class="ansibleOptionAnchor" id="parameter-state"></div><p class="ansible-option-title" id="ansible-collections-community-general-gitlab-protected-branch-module-parameter-state"><strong>state</strong></p>
 <a class="ansibleOptionLink" href="#parameter-state" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
 </div></td>
-<td><div class="ansible-option-cell"><p>Create or delete proteced branch.</p>
+<td><div class="ansible-option-cell"><p>Create or delete protected branch.</p>
 <p class="ansible-option-line"><span class="ansible-option-choices">Choices:</span></p>
 <ul class="simple">
 <li><p><code class="ansible-option-default-bold docutils literal notranslate"><span class="pre">&quot;present&quot;</span></code> <span class="ansible-option-choices-default-mark">← (default)</span></p></li>
diff --git a/home/runner/work/community.general/community.general/docsbuild/base/collections/community/general/gitlab_runner_module.html b/home/runner/work/community.general/community.general/docsbuild/head/collections/community/general/gitlab_runner_module.html
index 2b3ad84..93be39c 100644
--- a/home/runner/work/community.general/community.general/docsbuild/base/collections/community/general/gitlab_runner_module.html
+++ b/home/runner/work/community.general/community.general/docsbuild/head/collections/community/general/gitlab_runner_module.html
@@ -23,7 +23,7 @@
     <script src="../../../_static/js/theme.js"></script>
     <link rel="search" title="Search" href="../../../search.html" />
     <link rel="next" title="community.general.gitlab_user module – Creates/updates/deletes/blocks/unblocks GitLab Users" href="gitlab_user_module.html" />
-    <link rel="prev" title="community.general.gitlab_protected_branch module – (un)Marking existing branches for protection" href="gitlab_protected_branch_module.html" /><!-- extra head elements for Ansible beyond RTD Sphinx Theme -->
+    <link rel="prev" title="community.general.gitlab_protected_branch module – Manage protection of existing branches" href="gitlab_protected_branch_module.html" /><!-- extra head elements for Ansible beyond RTD Sphinx Theme -->
 
 
 
@@ -476,7 +476,7 @@ see <a class="reference internal" href="#ansible-collections-community-general-g
           
 
 <footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
-        <a href="gitlab_protected_branch_module.html" class="btn btn-neutral float-left" title="community.general.gitlab_protected_branch module – (un)Marking existing branches for protection" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
+        <a href="gitlab_protected_branch_module.html" class="btn btn-neutral float-left" title="community.general.gitlab_protected_branch module – Manage protection of existing branches" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
         <a href="gitlab_user_module.html" class="btn btn-neutral float-right" title="community.general.gitlab_user module – Creates/updates/deletes/blocks/unblocks GitLab Users" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
     </div>
 
diff --git a/home/runner/work/community.general/community.general/docsbuild/base/collections/community/general/index.html b/home/runner/work/community.general/community.general/docsbuild/head/collections/community/general/index.html
index 709f9b2..7e8a04b 100644
--- a/home/runner/work/community.general/community.general/docsbuild/base/collections/community/general/index.html
+++ b/home/runner/work/community.general/community.general/docsbuild/head/collections/community/general/index.html
@@ -288,7 +288,7 @@
 <li><p><a class="reference internal" href="gitlab_project_module.html#ansible-collections-community-general-gitlab-project-module"><span class="std std-ref">gitlab_project module</span></a> – Creates/updates/deletes GitLab Projects</p></li>
 <li><p><a class="reference internal" href="gitlab_project_members_module.html#ansible-collections-community-general-gitlab-project-members-module"><span class="std std-ref">gitlab_project_members module</span></a> – Manage project members on GitLab Server</p></li>
 <li><p><a class="reference internal" href="gitlab_project_variable_module.html#ansible-collections-community-general-gitlab-project-variable-module"><span class="std std-ref">gitlab_project_variable module</span></a> – Creates/updates/deletes GitLab Projects Variables</p></li>
-<li><p><a class="reference internal" href="gitlab_protected_branch_module.html#ansible-collections-community-general-gitlab-protected-branch-module"><span class="std std-ref">gitlab_protected_branch module</span></a> – (un)Marking existing branches for protection</p></li>
+<li><p><a class="reference internal" href="gitlab_protected_branch_module.html#ansible-collections-community-general-gitlab-protected-branch-module"><span class="std std-ref">gitlab_protected_branch module</span></a> – Manage protection of existing branches</p></li>
 <li><p><a class="reference internal" href="gitlab_runner_module.html#ansible-collections-community-general-gitlab-runner-module"><span class="std std-ref">gitlab_runner module</span></a> – Create, modify and delete GitLab Runners</p></li>
 <li><p><a class="reference internal" href="gitlab_user_module.html#ansible-collections-community-general-gitlab-user-module"><span class="std std-ref">gitlab_user module</span></a> – Creates/updates/deletes/blocks/unblocks GitLab Users</p></li>
 <li><p><a class="reference internal" href="grove_module.html#ansible-collections-community-general-grove-module"><span class="std std-ref">grove module</span></a> – Sends a notification to a grove.io channel</p></li>
@@ -393,6 +393,7 @@
 <li><p><a class="reference internal" href="keycloak_realm_module.html#ansible-collections-community-general-keycloak-realm-module"><span class="std std-ref">keycloak_realm module</span></a> – Allows administration of Keycloak realm via Keycloak API</p></li>
 <li><p><a class="reference internal" href="keycloak_realm_info_module.html#ansible-collections-community-general-keycloak-realm-info-module"><span class="std std-ref">keycloak_realm_info module</span></a> – Allows obtaining Keycloak realm public information via Keycloak API</p></li>
 <li><p><a class="reference internal" href="keycloak_role_module.html#ansible-collections-community-general-keycloak-role-module"><span class="std std-ref">keycloak_role module</span></a> – Allows administration of Keycloak roles via Keycloak API</p></li>
+<li><p><a class="reference internal" href="keycloak_role_composites_module.html#ansible-collections-community-general-keycloak-role-composites-module"><span class="std std-ref">keycloak_role_composites module</span></a> – Allows administration of Keycloak composite roles with the Keycloak API</p></li>
 <li><p><a class="reference internal" href="keycloak_user_federation_module.html#ansible-collections-community-general-keycloak-user-federation-module"><span class="std std-ref">keycloak_user_federation module</span></a> – Allows administration of Keycloak user federations via Keycloak API</p></li>
 <li><p><a class="reference internal" href="keycloak_user_rolemapping_module.html#ansible-collections-community-general-keycloak-user-rolemapping-module"><span class="std std-ref">keycloak_user_rolemapping module</span></a> – Allows administration of Keycloak user_rolemapping with the Keycloak API</p></li>
 <li><p><a class="reference internal" href="keyring_module.html#ansible-collections-community-general-keyring-module"><span class="std std-ref">keyring module</span></a> – Set or delete a passphrase using the Operating System’s native keyring</p></li>
@@ -440,52 +441,52 @@
 <li><p><a class="reference internal" href="mattermost_module.html#ansible-collections-community-general-mattermost-module"><span class="std std-ref">mattermost module</span></a> – Send Mattermost notifications</p></li>
 <li><p><a class="reference internal" href="maven_artifact_module.html#ansible-collections-community-general-maven-artifact-module"><span class="std std-ref">maven_artifact module</span></a> – Downloads an Artifact from a Maven Repository</p></li>
 <li><p><a class="reference internal" href="memset_dns_reload_module.html#ansible-collections-community-general-memset-dns-reload-module"><span class="std std-ref">memset_dns_reload module</span></a> – Request reload of Memset’s DNS infrastructure,</p></li>
-<li><p><a class="reference internal" href="memset_memstore_info_module.html#ansible-collections-community-general-memset-memstore-info-module"><span class="std std-ref">memset_memstore_info module</span></a> – Retrieve Memstore product usage information.</p></li>
-<li><p><a class="reference internal" href="memset_server_info_module.html#ansible-collections-community-general-memset-server-info-module"><span class="std std-ref">memset_server_info module</span></a> – Retrieve server information.</p></li>
-<li><p><a class="reference internal" href="memset_zone_module.html#ansible-collections-community-general-memset-zone-module"><span class="std std-ref">memset_zone module</span></a> – Creates and deletes Memset DNS zones.</p></li>
-<li><p><a class="reference internal" href="memset_zone_domain_module.html#ansible-collections-community-general-memset-zone-domain-module"><span class="std std-ref">memset_zone_domain module</span></a> – Create and delete domains in Memset DNS zones.</p></li>
-<li><p><a class="reference internal" href="memset_zone_record_module.html#ansible-collections-community-general-memset-zone-record-module"><span class="std std-ref">memset_zone_record module</span></a> – Create and delete records in Memset DNS zones.</p></li>
-<li><p><a class="reference internal" href="mksysb_module.html#ansible-collections-community-general-mksysb-module"><span class="std std-ref">mksysb module</span></a> – Generates AIX mksysb rootvg backups.</p></li>
+<li><p><a class="reference internal" href="memset_memstore_info_module.html#ansible-collections-community-general-memset-memstore-info-module"><span class="std std-ref">memset_memstore_info module</span></a> – Retrieve Memstore product usage information</p></li>
+<li><p><a class="reference internal" href="memset_server_info_module.html#ansible-collections-community-general-memset-server-info-module"><span class="std std-ref">memset_server_info module</span></a> – Retrieve server information</p></li>
+<li><p><a class="reference internal" href="memset_zone_module.html#ansible-collections-community-general-memset-zone-module"><span class="std std-ref">memset_zone module</span></a> – Creates and deletes Memset DNS zones</p></li>
+<li><p><a class="reference internal" href="memset_zone_domain_module.html#ansible-collections-community-general-memset-zone-domain-module"><span class="std std-ref">memset_zone_domain module</span></a> – Create and delete domains in Memset DNS zones</p></li>
+<li><p><a class="reference internal" href="memset_zone_record_module.html#ansible-collections-community-general-memset-zone-record-module"><span class="std std-ref">memset_zone_record module</span></a> – Create and delete records in Memset DNS zones</p></li>
+<li><p><a class="reference internal" href="mksysb_module.html#ansible-collections-community-general-mksysb-module"><span class="std std-ref">mksysb module</span></a> – Generates AIX mksysb rootvg backups</p></li>
 <li><p><a class="reference internal" href="modprobe_module.html#ansible-collections-community-general-modprobe-module"><span class="std std-ref">modprobe module</span></a> – Load or unload kernel modules</p></li>
 <li><p><a class="reference internal" href="monit_module.html#ansible-collections-community-general-monit-module"><span class="std std-ref">monit module</span></a> – Manage the state of a program monitored via Monit</p></li>
 <li><p><a class="reference internal" href="mqtt_module.html#ansible-collections-community-general-mqtt-module"><span class="std std-ref">mqtt module</span></a> – Publish a message on an MQTT topic for the IoT</p></li>
-<li><p><a class="reference internal" href="mssql_db_module.html#ansible-collections-community-general-mssql-db-module"><span class="std std-ref">mssql_db module</span></a> – Add or remove MSSQL databases from a remote host.</p></li>
+<li><p><a class="reference internal" href="mssql_db_module.html#ansible-collections-community-general-mssql-db-module"><span class="std std-ref">mssql_db module</span></a> – Add or remove MSSQL databases from a remote host</p></li>
 <li><p><a class="reference internal" href="mssql_script_module.html#ansible-collections-community-general-mssql-script-module"><span class="std std-ref">mssql_script module</span></a> – Execute SQL scripts on a MSSQL database</p></li>
-<li><p><a class="reference internal" href="nagios_module.html#ansible-collections-community-general-nagios-module"><span class="std std-ref">nagios module</span></a> – Perform common tasks in Nagios related to downtime and notifications.</p></li>
-<li><p><a class="reference internal" href="netcup_dns_module.html#ansible-collections-community-general-netcup-dns-module"><span class="std std-ref">netcup_dns module</span></a> – manage Netcup DNS records</p></li>
+<li><p><a class="reference internal" href="nagios_module.html#ansible-collections-community-general-nagios-module"><span class="std std-ref">nagios module</span></a> – Perform common tasks in Nagios related to downtime and notifications</p></li>
+<li><p><a class="reference internal" href="netcup_dns_module.html#ansible-collections-community-general-netcup-dns-module"><span class="std std-ref">netcup_dns module</span></a> – Manage Netcup DNS records</p></li>
 <li><p><a class="reference internal" href="newrelic_deployment_module.html#ansible-collections-community-general-newrelic-deployment-module"><span class="std std-ref">newrelic_deployment module</span></a> – Notify New Relic about app deployments</p></li>
 <li><p><a class="reference internal" href="nexmo_module.html#ansible-collections-community-general-nexmo-module"><span class="std std-ref">nexmo module</span></a> – Send a SMS via nexmo</p></li>
-<li><p><a class="reference internal" href="nginx_status_info_module.html#ansible-collections-community-general-nginx-status-info-module"><span class="std std-ref">nginx_status_info module</span></a> – Retrieve information on nginx status.</p></li>
+<li><p><a class="reference internal" href="nginx_status_info_module.html#ansible-collections-community-general-nginx-status-info-module"><span class="std std-ref">nginx_status_info module</span></a> – Retrieve information on nginx status</p></li>
 <li><p><a class="reference internal" href="nictagadm_module.html#ansible-collections-community-general-nictagadm-module"><span class="std std-ref">nictagadm module</span></a> – Manage nic tags on SmartOS systems</p></li>
 <li><p><a class="reference internal" href="nmcli_module.html#ansible-collections-community-general-nmcli-module"><span class="std std-ref">nmcli module</span></a> – Manage Networking</p></li>
 <li><p><a class="reference internal" href="nomad_job_module.html#ansible-collections-community-general-nomad-job-module"><span class="std std-ref">nomad_job module</span></a> – Launch a Nomad Job</p></li>
 <li><p><a class="reference internal" href="nomad_job_info_module.html#ansible-collections-community-general-nomad-job-info-module"><span class="std std-ref">nomad_job_info module</span></a> – Get Nomad Jobs info</p></li>
 <li><p><a class="reference internal" href="nosh_module.html#ansible-collections-community-general-nosh-module"><span class="std std-ref">nosh module</span></a> – Manage services with nosh</p></li>
 <li><p><a class="reference internal" href="npm_module.html#ansible-collections-community-general-npm-module"><span class="std std-ref">npm module</span></a> – Manage node.js packages with npm</p></li>
-<li><p><a class="reference internal" href="nsupdate_module.html#ansible-collections-community-general-nsupdate-module"><span class="std std-ref">nsupdate module</span></a> – Manage DNS records.</p></li>
+<li><p><a class="reference internal" href="nsupdate_module.html#ansible-collections-community-general-nsupdate-module"><span class="std std-ref">nsupdate module</span></a> – Manage DNS records</p></li>
 <li><p><a class="reference internal" href="oci_vcn_module.html#ansible-collections-community-general-oci-vcn-module"><span class="std std-ref">oci_vcn module</span></a> – Manage Virtual Cloud Networks(VCN) in OCI</p></li>
 <li><p><a class="reference internal" href="odbc_module.html#ansible-collections-community-general-odbc-module"><span class="std std-ref">odbc module</span></a> – Execute SQL via ODBC</p></li>
 <li><p><a class="reference internal" href="office_365_connector_card_module.html#ansible-collections-community-general-office-365-connector-card-module"><span class="std std-ref">office_365_connector_card module</span></a> – Use webhooks to create Connector Card messages within an Office 365 group</p></li>
 <li><p><a class="reference internal" href="ohai_module.html#ansible-collections-community-general-ohai-module"><span class="std std-ref">ohai module</span></a> – Returns inventory data from <em>Ohai</em></p></li>
-<li><p><a class="reference internal" href="omapi_host_module.html#ansible-collections-community-general-omapi-host-module"><span class="std std-ref">omapi_host module</span></a> – Setup OMAPI hosts.</p></li>
+<li><p><a class="reference internal" href="omapi_host_module.html#ansible-collections-community-general-omapi-host-module"><span class="std std-ref">omapi_host module</span></a> – Setup OMAPI hosts</p></li>
 <li><p><a class="reference internal" href="one_host_module.html#ansible-collections-community-general-one-host-module"><span class="std std-ref">one_host module</span></a> – Manages OpenNebula Hosts</p></li>
 <li><p><a class="reference internal" href="one_image_module.html#ansible-collections-community-general-one-image-module"><span class="std std-ref">one_image module</span></a> – Manages OpenNebula images</p></li>
 <li><p><a class="reference internal" href="one_image_info_module.html#ansible-collections-community-general-one-image-info-module"><span class="std std-ref">one_image_info module</span></a> – Gather information on OpenNebula images</p></li>
 <li><p><a class="reference internal" href="one_service_module.html#ansible-collections-community-general-one-service-module"><span class="std std-ref">one_service module</span></a> – Deploy and manage OpenNebula services</p></li>
 <li><p><a class="reference internal" href="one_template_module.html#ansible-collections-community-general-one-template-module"><span class="std std-ref">one_template module</span></a> – Manages OpenNebula templates</p></li>
 <li><p><a class="reference internal" href="one_vm_module.html#ansible-collections-community-general-one-vm-module"><span class="std std-ref">one_vm module</span></a> – Creates or terminates OpenNebula instances</p></li>
-<li><p><a class="reference internal" href="oneandone_firewall_policy_module.html#ansible-collections-community-general-oneandone-firewall-policy-module"><span class="std std-ref">oneandone_firewall_policy module</span></a> – Configure 1&amp;1 firewall policy.</p></li>
-<li><p><a class="reference internal" href="oneandone_load_balancer_module.html#ansible-collections-community-general-oneandone-load-balancer-module"><span class="std std-ref">oneandone_load_balancer module</span></a> – Configure 1&amp;1 load balancer.</p></li>
-<li><p><a class="reference internal" href="oneandone_monitoring_policy_module.html#ansible-collections-community-general-oneandone-monitoring-policy-module"><span class="std std-ref">oneandone_monitoring_policy module</span></a> – Configure 1&amp;1 monitoring policy.</p></li>
-<li><p><a class="reference internal" href="oneandone_private_network_module.html#ansible-collections-community-general-oneandone-private-network-module"><span class="std std-ref">oneandone_private_network module</span></a> – Configure 1&amp;1 private networking.</p></li>
-<li><p><a class="reference internal" href="oneandone_public_ip_module.html#ansible-collections-community-general-oneandone-public-ip-module"><span class="std std-ref">oneandone_public_ip module</span></a> – Configure 1&amp;1 public IPs.</p></li>
-<li><p><a class="reference internal" href="oneandone_server_module.html#ansible-collections-community-general-oneandone-server-module"><span class="std std-ref">oneandone_server module</span></a> – Create, destroy, start, stop, and reboot a 1&amp;1 Host server.</p></li>
+<li><p><a class="reference internal" href="oneandone_firewall_policy_module.html#ansible-collections-community-general-oneandone-firewall-policy-module"><span class="std std-ref">oneandone_firewall_policy module</span></a> – Configure 1&amp;1 firewall policy</p></li>
+<li><p><a class="reference internal" href="oneandone_load_balancer_module.html#ansible-collections-community-general-oneandone-load-balancer-module"><span class="std std-ref">oneandone_load_balancer module</span></a> – Configure 1&amp;1 load balancer</p></li>
+<li><p><a class="reference internal" href="oneandone_monitoring_policy_module.html#ansible-collections-community-general-oneandone-monitoring-policy-module"><span class="std std-ref">oneandone_monitoring_policy module</span></a> – Configure 1&amp;1 monitoring policy</p></li>
+<li><p><a class="reference internal" href="oneandone_private_network_module.html#ansible-collections-community-general-oneandone-private-network-module"><span class="std std-ref">oneandone_private_network module</span></a> – Configure 1&amp;1 private networking</p></li>
+<li><p><a class="reference internal" href="oneandone_public_ip_module.html#ansible-collections-community-general-oneandone-public-ip-module"><span class="std std-ref">oneandone_public_ip module</span></a> – Configure 1&amp;1 public IPs</p></li>
+<li><p><a class="reference internal" href="oneandone_server_module.html#ansible-collections-community-general-oneandone-server-module"><span class="std std-ref">oneandone_server module</span></a> – Create, destroy, start, stop, and reboot a 1&amp;1 Host server</p></li>
 <li><p><a class="reference internal" href="onepassword_info_module.html#ansible-collections-community-general-onepassword-info-module"><span class="std std-ref">onepassword_info module</span></a> – Gather items from 1Password</p></li>
 <li><p><a class="reference internal" href="oneview_datacenter_info_module.html#ansible-collections-community-general-oneview-datacenter-info-module"><span class="std std-ref">oneview_datacenter_info module</span></a> – Retrieve information about the OneView Data Centers</p></li>
 <li><p><a class="reference internal" href="oneview_enclosure_info_module.html#ansible-collections-community-general-oneview-enclosure-info-module"><span class="std std-ref">oneview_enclosure_info module</span></a> – Retrieve information about one or more Enclosures</p></li>
 <li><p><a class="reference internal" href="oneview_ethernet_network_module.html#ansible-collections-community-general-oneview-ethernet-network-module"><span class="std std-ref">oneview_ethernet_network module</span></a> – Manage OneView Ethernet Network resources</p></li>
 <li><p><a class="reference internal" href="oneview_ethernet_network_info_module.html#ansible-collections-community-general-oneview-ethernet-network-info-module"><span class="std std-ref">oneview_ethernet_network_info module</span></a> – Retrieve the information about one or more of the OneView Ethernet Networks</p></li>
-<li><p><a class="reference internal" href="oneview_fc_network_module.html#ansible-collections-community-general-oneview-fc-network-module"><span class="std std-ref">oneview_fc_network module</span></a> – Manage OneView Fibre Channel Network resources.</p></li>
+<li><p><a class="reference internal" href="oneview_fc_network_module.html#ansible-collections-community-general-oneview-fc-network-module"><span class="std std-ref">oneview_fc_network module</span></a> – Manage OneView Fibre Channel Network resources</p></li>
 <li><p><a class="reference internal" href="oneview_fc_network_info_module.html#ansible-collections-community-general-oneview-fc-network-info-module"><span class="std std-ref">oneview_fc_network_info module</span></a> – Retrieve the information about one or more of the OneView Fibre Channel Networks</p></li>
 <li><p><a class="reference internal" href="oneview_fcoe_network_module.html#ansible-collections-community-general-oneview-fcoe-network-module"><span class="std std-ref">oneview_fcoe_network module</span></a> – Manage OneView FCoE Network resources</p></li>
 <li><p><a class="reference internal" href="oneview_fcoe_network_info_module.html#ansible-collections-community-general-oneview-fcoe-network-info-module"><span class="std std-ref">oneview_fcoe_network_info module</span></a> – Retrieve the information about one or more of the OneView FCoE Networks</p></li>
@@ -495,24 +496,24 @@
 <li><p><a class="reference internal" href="oneview_network_set_info_module.html#ansible-collections-community-general-oneview-network-set-info-module"><span class="std std-ref">oneview_network_set_info module</span></a> – Retrieve information about the OneView Network Sets</p></li>
 <li><p><a class="reference internal" href="oneview_san_manager_module.html#ansible-collections-community-general-oneview-san-manager-module"><span class="std std-ref">oneview_san_manager module</span></a> – Manage OneView SAN Manager resources</p></li>
 <li><p><a class="reference internal" href="oneview_san_manager_info_module.html#ansible-collections-community-general-oneview-san-manager-info-module"><span class="std std-ref">oneview_san_manager_info module</span></a> – Retrieve information about one or more of the OneView SAN Managers</p></li>
-<li><p><a class="reference internal" href="online_server_info_module.html#ansible-collections-community-general-online-server-info-module"><span class="std std-ref">online_server_info module</span></a> – Gather information about Online servers.</p></li>
-<li><p><a class="reference internal" href="online_user_info_module.html#ansible-collections-community-general-online-user-info-module"><span class="std std-ref">online_user_info module</span></a> – Gather information about Online user.</p></li>
+<li><p><a class="reference internal" href="online_server_info_module.html#ansible-collections-community-general-online-server-info-module"><span class="std std-ref">online_server_info module</span></a> – Gather information about Online servers</p></li>
+<li><p><a class="reference internal" href="online_user_info_module.html#ansible-collections-community-general-online-user-info-module"><span class="std std-ref">online_user_info module</span></a> – Gather information about Online user</p></li>
 <li><p><a class="reference internal" href="open_iscsi_module.html#ansible-collections-community-general-open-iscsi-module"><span class="std std-ref">open_iscsi module</span></a> – Manage iSCSI targets with Open-iSCSI</p></li>
 <li><p><a class="reference internal" href="openbsd_pkg_module.html#ansible-collections-community-general-openbsd-pkg-module"><span class="std std-ref">openbsd_pkg module</span></a> – Manage packages on OpenBSD</p></li>
-<li><p><a class="reference internal" href="opendj_backendprop_module.html#ansible-collections-community-general-opendj-backendprop-module"><span class="std std-ref">opendj_backendprop module</span></a> – Will update the backend configuration of OpenDJ via the dsconfig set-backend-prop command.</p></li>
-<li><p><a class="reference internal" href="openwrt_init_module.html#ansible-collections-community-general-openwrt-init-module"><span class="std std-ref">openwrt_init module</span></a> – Manage services on OpenWrt.</p></li>
+<li><p><a class="reference internal" href="opendj_backendprop_module.html#ansible-collections-community-general-opendj-backendprop-module"><span class="std std-ref">opendj_backendprop module</span></a> – Will update the backend configuration of OpenDJ via the dsconfig set-backend-prop command</p></li>
+<li><p><a class="reference internal" href="openwrt_init_module.html#ansible-collections-community-general-openwrt-init-module"><span class="std std-ref">openwrt_init module</span></a> – Manage services on OpenWrt</p></li>
 <li><p><a class="reference internal" href="opkg_module.html#ansible-collections-community-general-opkg-module"><span class="std std-ref">opkg module</span></a> – Package manager for OpenWrt</p></li>
 <li><p><a class="reference internal" href="osx_defaults_module.html#ansible-collections-community-general-osx-defaults-module"><span class="std std-ref">osx_defaults module</span></a> – Manage macOS user defaults</p></li>
 <li><p><a class="reference internal" href="ovh_ip_failover_module.html#ansible-collections-community-general-ovh-ip-failover-module"><span class="std std-ref">ovh_ip_failover module</span></a> – Manage OVH IP failover address</p></li>
 <li><p><a class="reference internal" href="ovh_ip_loadbalancing_backend_module.html#ansible-collections-community-general-ovh-ip-loadbalancing-backend-module"><span class="std std-ref">ovh_ip_loadbalancing_backend module</span></a> – Manage OVH IP LoadBalancing backends</p></li>
 <li><p><a class="reference internal" href="ovh_monthly_billing_module.html#ansible-collections-community-general-ovh-monthly-billing-module"><span class="std std-ref">ovh_monthly_billing module</span></a> – Manage OVH monthly billing</p></li>
 <li><p><a class="reference internal" href="pacemaker_cluster_module.html#ansible-collections-community-general-pacemaker-cluster-module"><span class="std std-ref">pacemaker_cluster module</span></a> – Manage pacemaker clusters</p></li>
-<li><p><a class="reference internal" href="packet_device_module.html#ansible-collections-community-general-packet-device-module"><span class="std std-ref">packet_device module</span></a> – Manage a bare metal server in the Packet Host.</p></li>
-<li><p><a class="reference internal" href="packet_ip_subnet_module.html#ansible-collections-community-general-packet-ip-subnet-module"><span class="std std-ref">packet_ip_subnet module</span></a> – Assign IP subnet to a bare metal server.</p></li>
-<li><p><a class="reference internal" href="packet_project_module.html#ansible-collections-community-general-packet-project-module"><span class="std std-ref">packet_project module</span></a> – Create/delete a project in Packet host.</p></li>
-<li><p><a class="reference internal" href="packet_sshkey_module.html#ansible-collections-community-general-packet-sshkey-module"><span class="std std-ref">packet_sshkey module</span></a> – Create/delete an SSH key in Packet host.</p></li>
-<li><p><a class="reference internal" href="packet_volume_module.html#ansible-collections-community-general-packet-volume-module"><span class="std std-ref">packet_volume module</span></a> – Create/delete a volume in Packet host.</p></li>
-<li><p><a class="reference internal" href="packet_volume_attachment_module.html#ansible-collections-community-general-packet-volume-attachment-module"><span class="std std-ref">packet_volume_attachment module</span></a> – Attach/detach a volume to a device in the Packet host.</p></li>
+<li><p><a class="reference internal" href="packet_device_module.html#ansible-collections-community-general-packet-device-module"><span class="std std-ref">packet_device module</span></a> – Manage a bare metal server in the Packet Host</p></li>
+<li><p><a class="reference internal" href="packet_ip_subnet_module.html#ansible-collections-community-general-packet-ip-subnet-module"><span class="std std-ref">packet_ip_subnet module</span></a> – Assign IP subnet to a bare metal server</p></li>
+<li><p><a class="reference internal" href="packet_project_module.html#ansible-collections-community-general-packet-project-module"><span class="std std-ref">packet_project module</span></a> – Create/delete a project in Packet host</p></li>
+<li><p><a class="reference internal" href="packet_sshkey_module.html#ansible-collections-community-general-packet-sshkey-module"><span class="std std-ref">packet_sshkey module</span></a> – Create/delete an SSH key in Packet host</p></li>
+<li><p><a class="reference internal" href="packet_volume_module.html#ansible-collections-community-general-packet-volume-module"><span class="std std-ref">packet_volume module</span></a> – Create/delete a volume in Packet host</p></li>
+<li><p><a class="reference internal" href="packet_volume_attachment_module.html#ansible-collections-community-general-packet-volume-attachment-module"><span class="std std-ref">packet_volume_attachment module</span></a> – Attach/detach a volume to a device in the Packet host</p></li>
 <li><p><a class="reference internal" href="pacman_module.html#ansible-collections-community-general-pacman-module"><span class="std std-ref">pacman module</span></a> – Manage packages with <em>pacman</em></p></li>
 <li><p><a class="reference internal" href="pacman_key_module.html#ansible-collections-community-general-pacman-key-module"><span class="std std-ref">pacman_key module</span></a> – Manage pacman’s list of trusted keys</p></li>
 <li><p><a class="reference internal" href="pagerduty_module.html#ansible-collections-community-general-pagerduty-module"><span class="std std-ref">pagerduty module</span></a> – Create PagerDuty maintenance windows</p></li>
@@ -525,12 +526,12 @@
 <li><p><a class="reference internal" href="pear_module.html#ansible-collections-community-general-pear-module"><span class="std std-ref">pear module</span></a> – Manage pear/pecl packages</p></li>
 <li><p><a class="reference internal" href="pids_module.html#ansible-collections-community-general-pids-module"><span class="std std-ref">pids module</span></a> – Retrieves process IDs list if the process is running otherwise return empty list</p></li>
 <li><p><a class="reference internal" href="pingdom_module.html#ansible-collections-community-general-pingdom-module"><span class="std std-ref">pingdom module</span></a> – Pause/unpause Pingdom alerts</p></li>
-<li><p><a class="reference internal" href="pip_package_info_module.html#ansible-collections-community-general-pip-package-info-module"><span class="std std-ref">pip_package_info module</span></a> – pip package information</p></li>
+<li><p><a class="reference internal" href="pip_package_info_module.html#ansible-collections-community-general-pip-package-info-module"><span class="std std-ref">pip_package_info module</span></a> – Pip package information</p></li>
 <li><p><a class="reference internal" href="pipx_module.html#ansible-collections-community-general-pipx-module"><span class="std std-ref">pipx module</span></a> – Manages applications installed with pipx</p></li>
 <li><p><a class="reference internal" href="pipx_info_module.html#ansible-collections-community-general-pipx-info-module"><span class="std std-ref">pipx_info module</span></a> – Rretrieves information about applications installed with pipx</p></li>
 <li><p><a class="reference internal" href="pkg5_module.html#ansible-collections-community-general-pkg5-module"><span class="std std-ref">pkg5 module</span></a> – Manages packages with the Solaris 11 Image Packaging System</p></li>
 <li><p><a class="reference internal" href="pkg5_publisher_module.html#ansible-collections-community-general-pkg5-publisher-module"><span class="std std-ref">pkg5_publisher module</span></a> – Manages Solaris 11 Image Packaging System publishers</p></li>
-<li><p><a class="reference internal" href="pkgin_module.html#ansible-collections-community-general-pkgin-module"><span class="std std-ref">pkgin module</span></a> – Package manager for SmartOS, NetBSD, et al.</p></li>
+<li><p><a class="reference internal" href="pkgin_module.html#ansible-collections-community-general-pkgin-module"><span class="std std-ref">pkgin module</span></a> – Package manager for SmartOS, NetBSD, et al</p></li>
 <li><p><a class="reference internal" href="pkgng_module.html#ansible-collections-community-general-pkgng-module"><span class="std std-ref">pkgng module</span></a> – Package manager for FreeBSD &gt;= 9.0</p></li>
 <li><p><a class="reference internal" href="pkgutil_module.html#ansible-collections-community-general-pkgutil-module"><span class="std std-ref">pkgutil module</span></a> – OpenCSW package management on Solaris</p></li>
 <li><p><a class="reference internal" href="pmem_module.html#ansible-collections-community-general-pmem-module"><span class="std std-ref">pmem module</span></a> – Configure Intel Optane Persistent Memory modules</p></li>
@@ -540,23 +541,23 @@
 <li><p><a class="reference internal" href="pritunl_org_info_module.html#ansible-collections-community-general-pritunl-org-info-module"><span class="std std-ref">pritunl_org_info module</span></a> – List Pritunl Organizations using the Pritunl API</p></li>
 <li><p><a class="reference internal" href="pritunl_user_module.html#ansible-collections-community-general-pritunl-user-module"><span class="std std-ref">pritunl_user module</span></a> – Manage Pritunl Users using the Pritunl API</p></li>
 <li><p><a class="reference internal" href="pritunl_user_info_module.html#ansible-collections-community-general-pritunl-user-info-module"><span class="std std-ref">pritunl_user_info module</span></a> – List Pritunl Users using the Pritunl API</p></li>
-<li><p><a class="reference internal" href="profitbricks_module.html#ansible-collections-community-general-profitbricks-module"><span class="std std-ref">profitbricks module</span></a> – Create, destroy, start, stop, and reboot a ProfitBricks virtual machine.</p></li>
-<li><p><a class="reference internal" href="profitbricks_datacenter_module.html#ansible-collections-community-general-profitbricks-datacenter-module"><span class="std std-ref">profitbricks_datacenter module</span></a> – Create or destroy a ProfitBricks Virtual Datacenter.</p></li>
-<li><p><a class="reference internal" href="profitbricks_nic_module.html#ansible-collections-community-general-profitbricks-nic-module"><span class="std std-ref">profitbricks_nic module</span></a> – Create or Remove a NIC.</p></li>
-<li><p><a class="reference internal" href="profitbricks_volume_module.html#ansible-collections-community-general-profitbricks-volume-module"><span class="std std-ref">profitbricks_volume module</span></a> – Create or destroy a volume.</p></li>
-<li><p><a class="reference internal" href="profitbricks_volume_attachments_module.html#ansible-collections-community-general-profitbricks-volume-attachments-module"><span class="std std-ref">profitbricks_volume_attachments module</span></a> – Attach or detach a volume.</p></li>
-<li><p><a class="reference internal" href="proxmox_module.html#ansible-collections-community-general-proxmox-module"><span class="std std-ref">proxmox module</span></a> – management of instances in Proxmox VE cluster</p></li>
-<li><p><a class="reference internal" href="proxmox_disk_module.html#ansible-collections-community-general-proxmox-disk-module"><span class="std std-ref">proxmox_disk module</span></a> – Management of a disk of a Qemu(KVM) VM in a Proxmox VE cluster.</p></li>
+<li><p><a class="reference internal" href="profitbricks_module.html#ansible-collections-community-general-profitbricks-module"><span class="std std-ref">profitbricks module</span></a> – Create, destroy, start, stop, and reboot a ProfitBricks virtual machine</p></li>
+<li><p><a class="reference internal" href="profitbricks_datacenter_module.html#ansible-collections-community-general-profitbricks-datacenter-module"><span class="std std-ref">profitbricks_datacenter module</span></a> – Create or destroy a ProfitBricks Virtual Datacenter</p></li>
+<li><p><a class="reference internal" href="profitbricks_nic_module.html#ansible-collections-community-general-profitbricks-nic-module"><span class="std std-ref">profitbricks_nic module</span></a> – Create or Remove a NIC</p></li>
+<li><p><a class="reference internal" href="profitbricks_volume_module.html#ansible-collections-community-general-profitbricks-volume-module"><span class="std std-ref">profitbricks_volume module</span></a> – Create or destroy a volume</p></li>
+<li><p><a class="reference internal" href="profitbricks_volume_attachments_module.html#ansible-collections-community-general-profitbricks-volume-attachments-module"><span class="std std-ref">profitbricks_volume_attachments module</span></a> – Attach or detach a volume</p></li>
+<li><p><a class="reference internal" href="proxmox_module.html#ansible-collections-community-general-proxmox-module"><span class="std std-ref">proxmox module</span></a> – Management of instances in Proxmox VE cluster</p></li>
+<li><p><a class="reference internal" href="proxmox_disk_module.html#ansible-collections-community-general-proxmox-disk-module"><span class="std std-ref">proxmox_disk module</span></a> – Management of a disk of a Qemu(KVM) VM in a Proxmox VE cluster</p></li>
 <li><p><a class="reference internal" href="proxmox_domain_info_module.html#ansible-collections-community-general-proxmox-domain-info-module"><span class="std std-ref">proxmox_domain_info module</span></a> – Retrieve information about one or more Proxmox VE domains</p></li>
 <li><p><a class="reference internal" href="proxmox_group_info_module.html#ansible-collections-community-general-proxmox-group-info-module"><span class="std std-ref">proxmox_group_info module</span></a> – Retrieve information about one or more Proxmox VE groups</p></li>
-<li><p><a class="reference internal" href="proxmox_kvm_module.html#ansible-collections-community-general-proxmox-kvm-module"><span class="std std-ref">proxmox_kvm module</span></a> – Management of Qemu(KVM) Virtual Machines in Proxmox VE cluster.</p></li>
-<li><p><a class="reference internal" href="proxmox_nic_module.html#ansible-collections-community-general-proxmox-nic-module"><span class="std std-ref">proxmox_nic module</span></a> – Management of a NIC of a Qemu(KVM) VM in a Proxmox VE cluster.</p></li>
+<li><p><a class="reference internal" href="proxmox_kvm_module.html#ansible-collections-community-general-proxmox-kvm-module"><span class="std std-ref">proxmox_kvm module</span></a> – Management of Qemu(KVM) Virtual Machines in Proxmox VE cluster</p></li>
+<li><p><a class="reference internal" href="proxmox_nic_module.html#ansible-collections-community-general-proxmox-nic-module"><span class="std std-ref">proxmox_nic module</span></a> – Management of a NIC of a Qemu(KVM) VM in a Proxmox VE cluster</p></li>
 <li><p><a class="reference internal" href="proxmox_snap_module.html#ansible-collections-community-general-proxmox-snap-module"><span class="std std-ref">proxmox_snap module</span></a> – Snapshot management of instances in Proxmox VE cluster</p></li>
 <li><p><a class="reference internal" href="proxmox_storage_info_module.html#ansible-collections-community-general-proxmox-storage-info-module"><span class="std std-ref">proxmox_storage_info module</span></a> – Retrieve information about one or more Proxmox VE storages</p></li>
 <li><p><a class="reference internal" href="proxmox_tasks_info_module.html#ansible-collections-community-general-proxmox-tasks-info-module"><span class="std std-ref">proxmox_tasks_info module</span></a> – Retrieve information about one or more Proxmox VE tasks</p></li>
-<li><p><a class="reference internal" href="proxmox_template_module.html#ansible-collections-community-general-proxmox-template-module"><span class="std std-ref">proxmox_template module</span></a> – management of OS templates in Proxmox VE cluster</p></li>
+<li><p><a class="reference internal" href="proxmox_template_module.html#ansible-collections-community-general-proxmox-template-module"><span class="std std-ref">proxmox_template module</span></a> – Management of OS templates in Proxmox VE cluster</p></li>
 <li><p><a class="reference internal" href="proxmox_user_info_module.html#ansible-collections-community-general-proxmox-user-info-module"><span class="std std-ref">proxmox_user_info module</span></a> – Retrieve information about one or more Proxmox VE users</p></li>
-<li><p><a class="reference internal" href="pubnub_blocks_module.html#ansible-collections-community-general-pubnub-blocks-module"><span class="std std-ref">pubnub_blocks module</span></a> – PubNub blocks management module.</p></li>
+<li><p><a class="reference internal" href="pubnub_blocks_module.html#ansible-collections-community-general-pubnub-blocks-module"><span class="std std-ref">pubnub_blocks module</span></a> – PubNub blocks management module</p></li>
 <li><p><a class="reference internal" href="pulp_repo_module.html#ansible-collections-community-general-pulp-repo-module"><span class="std std-ref">pulp_repo module</span></a> – Add or remove Pulp repos from a remote host.</p></li>
 <li><p><a class="reference internal" href="puppet_module.html#ansible-collections-community-general-puppet-module"><span class="std std-ref">puppet module</span></a> – Runs puppet</p></li>
 <li><p><a class="reference internal" href="pushbullet_module.html#ansible-collections-community-general-pushbullet-module"><span class="std std-ref">pushbullet module</span></a> – Sends notifications to Pushbullet</p></li>
diff --git a/home/runner/work/community.general/community.general/docsbuild/base/collections/community/general/keycloak_role_module.html b/home/runner/work/community.general/community.general/docsbuild/head/collections/community/general/keycloak_role_module.html
index 20f2bcd..d1ca1a9 100644
--- a/home/runner/work/community.general/community.general/docsbuild/base/collections/community/general/keycloak_role_module.html
+++ b/home/runner/work/community.general/community.general/docsbuild/head/collections/community/general/keycloak_role_module.html
@@ -22,7 +22,7 @@
         <script src="../../../_static/sphinx_highlight.js"></script>
     <script src="../../../_static/js/theme.js"></script>
     <link rel="search" title="Search" href="../../../search.html" />
-    <link rel="next" title="community.general.keycloak_user_federation module – Allows administration of Keycloak user federations via Keycloak API" href="keycloak_user_federation_module.html" />
+    <link rel="next" title="community.general.keycloak_role_composites module – Allows administration of Keycloak composite roles with the Keycloak API" href="keycloak_role_composites_module.html" />
     <link rel="prev" title="community.general.keycloak_realm_info module – Allows obtaining Keycloak realm public information via Keycloak API" href="keycloak_realm_info_module.html" /><!-- extra head elements for Ansible beyond RTD Sphinx Theme -->
 
 
@@ -449,7 +449,7 @@
 
 <footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
         <a href="keycloak_realm_info_module.html" class="btn btn-neutral float-left" title="community.general.keycloak_realm_info module – Allows obtaining Keycloak realm public information via Keycloak API" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
-        <a href="keycloak_user_federation_module.html" class="btn btn-neutral float-right" title="community.general.keycloak_user_federation module – Allows administration of Keycloak user federations via Keycloak API" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
+        <a href="keycloak_role_composites_module.html" class="btn btn-neutral float-right" title="community.general.keycloak_role_composites module – Allows administration of Keycloak composite roles with the Keycloak API" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
     </div>
 
   <hr/>
diff --git a/home/runner/work/community.general/community.general/docsbuild/base/collections/community/general/keycloak_user_federation_module.html b/home/runner/work/community.general/community.general/docsbuild/head/collections/community/general/keycloak_user_federation_module.html
index 3d01664..48add3b 100644
--- a/home/runner/work/community.general/community.general/docsbuild/base/collections/community/general/keycloak_user_federation_module.html
+++ b/home/runner/work/community.general/community.general/docsbuild/head/collections/community/general/keycloak_user_federation_module.html
@@ -23,7 +23,7 @@
     <script src="../../../_static/js/theme.js"></script>
     <link rel="search" title="Search" href="../../../search.html" />
     <link rel="next" title="community.general.keycloak_user_rolemapping module – Allows administration of Keycloak user_rolemapping with the Keycloak API" href="keycloak_user_rolemapping_module.html" />
-    <link rel="prev" title="community.general.keycloak_role module – Allows administration of Keycloak roles via Keycloak API" href="keycloak_role_module.html" /><!-- extra head elements for Ansible beyond RTD Sphinx Theme -->
+    <link rel="prev" title="community.general.keycloak_role_composites module – Allows administration of Keycloak composite roles with the Keycloak API" href="keycloak_role_composites_module.html" /><!-- extra head elements for Ansible beyond RTD Sphinx Theme -->
 
 
 
@@ -1004,7 +1004,7 @@
           
 
 <footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
-        <a href="keycloak_role_module.html" class="btn btn-neutral float-left" title="community.general.keycloak_role module – Allows administration of Keycloak roles via Keycloak API" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
+        <a href="keycloak_role_composites_module.html" class="btn btn-neutral float-left" title="community.general.keycloak_role_composites module – Allows administration of Keycloak composite roles with the Keycloak API" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
         <a href="keycloak_user_rolemapping_module.html" class="btn btn-neutral float-right" title="community.general.keycloak_user_rolemapping module – Allows administration of Keycloak user_rolemapping with the Keycloak API" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
     </div>
 
diff --git a/home/runner/work/community.general/community.general/docsbuild/base/collections/community/general/memset_dns_reload_module.html b/home/runner/work/community.general/community.general/docsbuild/head/collections/community/general/memset_dns_reload_module.html
index 2599b83..caef3c7 100644
--- a/home/runner/work/community.general/community.general/docsbuild/base/collections/community/general/memset_dns_reload_module.html
+++ b/home/runner/work/community.general/community.general/docsbuild/head/collections/community/general/memset_dns_reload_module.html
@@ -22,7 +22,7 @@
         <script src="../../../_static/sphinx_highlight.js"></script>
     <script src="../../../_static/js/theme.js"></script>
     <link rel="search" title="Search" href="../../../search.html" />
-    <link rel="next" title="community.general.memset_memstore_info module – Retrieve Memstore product usage information." href="memset_memstore_info_module.html" />
+    <link rel="next" title="community.general.memset_memstore_info module – Retrieve Memstore product usage information" href="memset_memstore_info_module.html" />
     <link rel="prev" title="community.general.maven_artifact module – Downloads an Artifact from a Maven Repository" href="maven_artifact_module.html" /><!-- extra head elements for Ansible beyond RTD Sphinx Theme -->
 
 
@@ -293,7 +293,7 @@
 
 <footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
         <a href="maven_artifact_module.html" class="btn btn-neutral float-left" title="community.general.maven_artifact module – Downloads an Artifact from a Maven Repository" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
-        <a href="memset_memstore_info_module.html" class="btn btn-neutral float-right" title="community.general.memset_memstore_info module – Retrieve Memstore product usage information." accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
+        <a href="memset_memstore_info_module.html" class="btn btn-neutral float-right" title="community.general.memset_memstore_info module – Retrieve Memstore product usage information" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
     </div>
 
   <hr/>
diff --git a/home/runner/work/community.general/community.general/docsbuild/base/collections/community/general/memset_memstore_info_module.html b/home/runner/work/community.general/community.general/docsbuild/head/collections/community/general/memset_memstore_info_module.html
index 00e3f44..4619585 100644
--- a/home/runner/work/community.general/community.general/docsbuild/base/collections/community/general/memset_memstore_info_module.html
+++ b/home/runner/work/community.general/community.general/docsbuild/head/collections/community/general/memset_memstore_info_module.html
@@ -4,7 +4,7 @@
   <meta charset="utf-8" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>community.general.memset_memstore_info module – Retrieve Memstore product usage information. &mdash; Ansible collections  documentation</title>
+  <title>community.general.memset_memstore_info module – Retrieve Memstore product usage information &mdash; Ansible collections  documentation</title>

Jul 06 '22 09:07 github-actions[bot]

The test ansible-test sanity --test pylint [explain] failed with 1 error:

plugins/modules/identity/keycloak/keycloak_role_composites.py:352:43: undefined-variable: Undefined variable 'uid'

The test ansible-test sanity --test validate-modules [explain] failed with 5 errors:

plugins/modules/identity/keycloak/keycloak_role_composites.py:0:0: missing-suboption-docs: Argument 'composite_role' in argument_spec has sub-options but documentation does not define it
plugins/modules/identity/keycloak/keycloak_role_composites.py:0:0: parameter-type-not-in-doc: Argument 'id' in argument_spec found in composite_role defines type as 'str' but documentation doesn't define type
plugins/modules/identity/keycloak/keycloak_role_composites.py:0:0: parameter-type-not-in-doc: Argument 'name' in argument_spec found in composite_role defines type as 'str' but documentation doesn't define type
plugins/modules/identity/keycloak/keycloak_role_composites.py:0:0: undocumented-parameter: Argument 'id' found in composite_role is listed in the argument_spec, but not documented in the module documentation
plugins/modules/identity/keycloak/keycloak_role_composites.py:0:0: undocumented-parameter: Argument 'name' found in composite_role is listed in the argument_spec, but not documented in the module documentation

The test ansible-test sanity --test pylint [explain] failed with 2 errors:

plugins/module_utils/identity/keycloak/keycloak.py:629:27: undefined-variable: Undefined variable 'URL_USER_ROLEMAPPINGS'
plugins/module_utils/identity/keycloak/keycloak.py:659:43: undefined-variable: Undefined variable 'URL_CLIENT_USER_ROLEMAPPINGS'

The test ansible-test sanity --test pylint [explain] failed with 1 error:

plugins/modules/identity/keycloak/keycloak_role_composites.py:352:43: undefined-variable: Undefined variable 'uid'

The test ansible-test sanity --test pylint [explain] failed with 2 errors:

plugins/module_utils/identity/keycloak/keycloak.py:629:27: undefined-variable: Undefined variable 'URL_USER_ROLEMAPPINGS'
plugins/module_utils/identity/keycloak/keycloak.py:659:43: undefined-variable: Undefined variable 'URL_CLIENT_USER_ROLEMAPPINGS'

The test ansible-test sanity --test pylint [explain] failed with 2 errors:

plugins/module_utils/identity/keycloak/keycloak.py:629:27: undefined-variable: Undefined variable 'URL_USER_ROLEMAPPINGS'
plugins/module_utils/identity/keycloak/keycloak.py:659:43: undefined-variable: Undefined variable 'URL_CLIENT_USER_ROLEMAPPINGS'

The test ansible-test sanity --test validate-modules [explain] failed with 5 errors:

plugins/modules/identity/keycloak/keycloak_role_composites.py:0:0: missing-suboption-docs: Argument 'composite_role' in argument_spec has sub-options but documentation does not define it
plugins/modules/identity/keycloak/keycloak_role_composites.py:0:0: parameter-type-not-in-doc: Argument 'id' in argument_spec found in composite_role defines type as 'str' but documentation doesn't define type
plugins/modules/identity/keycloak/keycloak_role_composites.py:0:0: parameter-type-not-in-doc: Argument 'name' in argument_spec found in composite_role defines type as 'str' but documentation doesn't define type
plugins/modules/identity/keycloak/keycloak_role_composites.py:0:0: undocumented-parameter: Argument 'id' found in composite_role is listed in the argument_spec, but not documented in the module documentation
plugins/modules/identity/keycloak/keycloak_role_composites.py:0:0: undocumented-parameter: Argument 'name' found in composite_role is listed in the argument_spec, but not documented in the module documentation

The test ansible-test sanity --test validate-modules [explain] failed with 5 errors:

plugins/modules/identity/keycloak/keycloak_role_composites.py:0:0: missing-suboption-docs: Argument 'composite_role' in argument_spec has sub-options but documentation does not define it
plugins/modules/identity/keycloak/keycloak_role_composites.py:0:0: parameter-type-not-in-doc: Argument 'id' in argument_spec found in composite_role defines type as 'str' but documentation doesn't define type
plugins/modules/identity/keycloak/keycloak_role_composites.py:0:0: parameter-type-not-in-doc: Argument 'name' in argument_spec found in composite_role defines type as 'str' but documentation doesn't define type
plugins/modules/identity/keycloak/keycloak_role_composites.py:0:0: undocumented-parameter: Argument 'id' found in composite_role is listed in the argument_spec, but not documented in the module documentation
plugins/modules/identity/keycloak/keycloak_role_composites.py:0:0: undocumented-parameter: Argument 'name' found in composite_role is listed in the argument_spec, but not documented in the module documentation

The test ansible-test sanity --test validate-modules [explain] failed with 5 errors:

plugins/modules/identity/keycloak/keycloak_role_composites.py:0:0: missing-suboption-docs: Argument 'composite_role' in argument_spec has sub-options but documentation does not define it
plugins/modules/identity/keycloak/keycloak_role_composites.py:0:0: parameter-type-not-in-doc: Argument 'id' in argument_spec found in composite_role defines type as 'str' but documentation doesn't define type
plugins/modules/identity/keycloak/keycloak_role_composites.py:0:0: parameter-type-not-in-doc: Argument 'name' in argument_spec found in composite_role defines type as 'str' but documentation doesn't define type
plugins/modules/identity/keycloak/keycloak_role_composites.py:0:0: undocumented-parameter: Argument 'id' found in composite_role is listed in the argument_spec, but not documented in the module documentation
plugins/modules/identity/keycloak/keycloak_role_composites.py:0:0: undocumented-parameter: Argument 'name' found in composite_role is listed in the argument_spec, but not documented in the module documentation

The test ansible-test sanity --test pylint [explain] failed with 1 error:

plugins/modules/identity/keycloak/keycloak_role_composites.py:352:43: undefined-variable: Undefined variable 'uid'

The test ansible-test sanity --test pylint [explain] failed with 1 error:

plugins/modules/identity/keycloak/keycloak_role_composites.py:352:43: undefined-variable: Undefined variable 'uid'

The test ansible-test sanity --test pylint [explain] failed with 2 errors:

plugins/module_utils/identity/keycloak/keycloak.py:629:27: undefined-variable: Undefined variable 'URL_USER_ROLEMAPPINGS'
plugins/module_utils/identity/keycloak/keycloak.py:659:43: undefined-variable: Undefined variable 'URL_CLIENT_USER_ROLEMAPPINGS'

click here for bot help

Jul 06 '22 09:07 ansibullbot

@felixfontein Hi, there are errors with poor description - I can't really fix those.

Jul 12 '22 13:07 bratwurzt

@bratwurzt please ignore them for now, they are some (I identified at least two different) generic CI errors that show up in all CI runs (that cover more than very few things) since ~yesterday. I'll fix them, but I probably won't get to it until later today.

Jul 12 '22 14:07 felixfontein

@bratwurzt Should we not rather extend keycloak_role to support composites instead?

Add composite: true switch, and a roles list?

Oct 18 '22 08:10 mhuysamen

Please note that in #5461 the collection repository was restructured to remove the directory tree in plugins/modules/, and the corresponding tree in tests/unit/plugins/modules/. Your PR adds new files into this hierarchy. Please rebase with the current main branch and move your files directly into plugins/modules/. You also can remove the changes to meta/runtime.yml, these are not needed anymore (the corresponding section was removed from CONTRIBUTING.md), and make sure to adjust the new entries in .github/BOTMETA.yml as well.

Nov 03 '22 06:11 felixfontein

@bratwurzt This PR was evaluated as a potentially problematic PR for the following reasons:

More than 50 changed files.
More than 50 commits.

Such PR can only be merged by human. Contact a Core team member to review this PR on IRC: #ansible-devel on Libera.chat IRC

click here for bot help

Nov 07 '22 13:11 ansibullbot

@felixfontein could we merge this asap? I can't refactor this another time, I'll get fired :D

Nov 08 '22 14:11 bratwurzt

Hm, it looks like some internal error: HTTP Error 403: rate limit exceeded

Nov 09 '22 15:11 bratwurzt

Please do not forget https://github.com/ansible-collections/community.general/pull/4931#discussion_r1017020664.

Nov 09 '22 17:11 felixfontein

needs_info

Dec 30 '22 21:12 felixfontein

Hello. I think it is not really good idea to use "id: role_id1". When we create role with ansible - we do not know roles ids, so we can not use it. So usecase - use ansible to create roles, then get roles ids, write them to composites playbook and run it. Am I right? @bratwurzt

Jan 31 '23 09:01 nauevg

@bratwurzt This pullrequest is waiting for your response. Please respond or the pullrequest will be closed.

click here for bot help

Jan 31 '23 09:01 ansibullbot

Hello. I think it is not really good idea to use "id: role_id1". When we create role with ansible - we do not know roles ids, so we can not use it. So usecase - use ansible to create roles, then get roles ids, write them to composites playbook and run it. Am I right? @bratwurzt

The idea is that it significantly enhances performance of a deploy when a huge number of roles are used in composite roles. The code is structured so it checks for id when only names is used - check the options for composite_role parameter. That way when ansible deploy creates roles in another task devops can store them and use them in subsequent role-dependant tasks (e.g. keycloak_client_rolemapping, keycloak_user_rolemapping, keycloak_role_composites)

Feb 02 '23 08:02 bratwurzt

needs_info

Mar 26 '23 07:03 felixfontein

I'm not working on this project at the moment. I will finish it when I have time.

On Sun, 26 Mar 2023, 09:44 Felix Fontein, @.***> wrote:

needs_info

— Reply to this email directly, view it on GitHub https://github.com/ansible-collections/community.general/pull/4931#issuecomment-1484021946, or unsubscribe https://github.com/notifications/unsubscribe-auth/AHK2CV242LFTT3BK54XL5XDW576VRANCNFSM52Y6HOVQ . You are receiving this because you commented.Message ID: @.***>

Mar 26 '23 15:03 mhuysamen

@bratwurzt This pullrequest is waiting for your response. Please respond or the pullrequest will be closed.

click here for bot help

Apr 27 '23 07:04 ansibullbot

cc @mattock click here for bot help

Apr 27 '23 07:04 ansibullbot

@bratwurzt You have not responded to information requests in this pullrequest so we will assume it no longer affects you. If you are still interested in this, please create a new pullrequest with the requested information.

click here for bot help

Jun 03 '23 06:06 ansibullbot

community.general community.general copied to clipboard

New Module: Keycloak Role Composites

SUMMARY

ISSUE TYPE

COMPONENT NAME

ADDITIONAL INFORMATION

Docs Build 📝

community.general
community.general copied to clipboard