[PR #5953/cc3a79bc backport][stable-6] Add attributes to some database modules (#6054)

Add attributes to some database modules (#5953)

Add attributes to some database modules.

(cherry picked from commit cc3a79bc48)

Co-authored-by: Felix Fontein <felix@fontein.de>

plugins/modules/etcd3.py

@@ -16,8 +16,15 @@ short_description: Set or delete key value pairs from an etcd3 cluster
 requirements:
   - etcd3
 description:
-   - Sets or deletes values in etcd3 cluster using its v3 api.
+  - Sets or deletes values in etcd3 cluster using its v3 api.
-   - Needs python etcd3 lib to work
+  - Needs python etcd3 lib to work
+extends_documentation_fragment:
+  - community.general.attributes
+attributes:
+    check_mode:
+        support: full
+    diff_mode:
+        support: none
 options:
     key:
         type: str

plugins/modules/influxdb_database.py

@@ -20,6 +20,11 @@ requirements:
     - "python >= 2.6"
     - "influxdb >= 0.9"
     - requests
+attributes:
+    check_mode:
+        support: full
+    diff_mode:
+        support: none
 options:
     database_name:
         description:
@@ -33,7 +38,8 @@ options:
         default: present
         type: str
 extends_documentation_fragment:
-- community.general.influxdb
+  - community.general.influxdb
+  - community.general.attributes
 
 '''
 

plugins/modules/influxdb_query.py

@@ -18,6 +18,11 @@ author: "René Moser (@resmo)"
 requirements:
   - "python >= 2.6"
   - "influxdb >= 0.9"
+attributes:
+  check_mode:
+    support: full
+  diff_mode:
+    support: none
 options:
   query:
     description:
@@ -30,7 +35,8 @@ options:
     required: true
     type: str
 extends_documentation_fragment:
-- community.general.influxdb
+  - community.general.influxdb
+  - community.general.attributes
 
 '''
 

plugins/modules/influxdb_retention_policy.py

@@ -20,6 +20,11 @@ requirements:
     - "python >= 2.6"
     - "influxdb >= 0.9"
     - requests
+attributes:
+    check_mode:
+        support: full
+    diff_mode:
+        support: none
 options:
     database_name:
         description:
@@ -64,7 +69,8 @@ options:
         type: str
         version_added: '2.0.0'
 extends_documentation_fragment:
-- community.general.influxdb
+  - community.general.influxdb
+  - community.general.attributes
 
 '''
 

plugins/modules/influxdb_user.py

@@ -20,6 +20,11 @@ author: "Vitaliy Zhhuta (@zhhuta)"
 requirements:
   - "python >= 2.6"
   - "influxdb >= 0.9"
+attributes:
+  check_mode:
+    support: full
+  diff_mode:
+    support: none
 options:
   user_name:
     description:
@@ -52,7 +57,8 @@ options:
     type: list
     elements: dict
 extends_documentation_fragment:
-- community.general.influxdb
+  - community.general.influxdb
+  - community.general.attributes
 
 '''
 

plugins/modules/influxdb_write.py

@@ -18,6 +18,11 @@ author: "René Moser (@resmo)"
 requirements:
   - "python >= 2.6"
   - "influxdb >= 0.9"
+attributes:
+  check_mode:
+    support: none
+  diff_mode:
+    support: none
 options:
   data_points:
     description:
@@ -31,7 +36,8 @@ options:
     required: true
     type: str
 extends_documentation_fragment:
-- community.general.influxdb
+  - community.general.influxdb
+  - community.general.attributes
 
 '''
 

plugins/modules/ldap_attrs.py

@@ -40,6 +40,11 @@ author:
   - Maciej Delmanowski (@drybjed)
 requirements:
   - python-ldap
+attributes:
+  check_mode:
+    support: full
+  diff_mode:
+    support: none
 options:
   state:
     required: false
@@ -68,7 +73,8 @@ options:
         attributes specified in the current task. This is useful mostly with
         I(olcAccess) attribute to easily manage LDAP Access Control Lists.
 extends_documentation_fragment:
-- community.general.ldap.documentation
+  - community.general.ldap.documentation
+  - community.general.attributes
 
 '''
 

plugins/modules/ldap_entry.py

@@ -30,6 +30,11 @@ author:
   - Jiri Tyr (@jtyr)
 requirements:
   - python-ldap
+attributes:
+  check_mode:
+    support: full
+  diff_mode:
+    support: none
 options:
   attributes:
     description:
@@ -59,7 +64,8 @@ options:
     default: false
     version_added: 4.6.0
 extends_documentation_fragment:
-- community.general.ldap.documentation
+  - community.general.ldap.documentation
+  - community.general.attributes
 
 '''
 

plugins/modules/ldap_passwd.py

@@ -28,13 +28,19 @@ author:
   - Keller Fuchs (@KellerFuchs)
 requirements:
   - python-ldap
+attributes:
+  check_mode:
+    support: full
+  diff_mode:
+    support: none
 options:
   passwd:
     description:
       - The (plaintext) password to be set for I(dn).
     type: str
 extends_documentation_fragment:
-- community.general.ldap.documentation
+  - community.general.ldap.documentation
+  - community.general.attributes
 
 '''
 

plugins/modules/ldap_search.py

@@ -27,6 +27,11 @@ author:
   - Sebastian Pfahl (@eryx12o45)
 requirements:
   - python-ldap
+attributes:
+  check_mode:
+    support: full
+  diff_mode:
+    support: none
 options:
   dn:
     required: true
@@ -57,7 +62,8 @@ options:
       - Set to C(true) to return the full attribute schema of entries, not
         their attribute values. Overrides I(attrs) when provided.
 extends_documentation_fragment:
-    - community.general.ldap.documentation
+  - community.general.ldap.documentation
+  - community.general.attributes
 """
 
 EXAMPLES = r"""

plugins/modules/mssql_db.py

@@ -15,7 +15,14 @@ DOCUMENTATION = '''
 module: mssql_db
 short_description: Add or remove MSSQL databases from a remote host
 description:
-   - Add or remove MSSQL databases from a remote host.
+  - Add or remove MSSQL databases from a remote host.
+extends_documentation_fragment:
+  - community.general.attributes
+attributes:
+  check_mode:
+    support: none
+  diff_mode:
+    support: none
 options:
   name:
     description:

plugins/modules/mssql_script.py

@@ -18,6 +18,17 @@ version_added: "4.0.0"
 description:
   - Execute SQL scripts on a MSSQL database.
 
+extends_documentation_fragment:
+  - community.general.attributes
+
+attributes:
+    check_mode:
+        support: partial
+        details:
+          - The script will not be executed in check mode.
+    diff_mode:
+        support: none
+
 options:
     name:
         description: Database to run script against.

plugins/modules/odbc.py

@@ -16,6 +16,13 @@ version_added: "1.0.0"
 short_description: Execute SQL via ODBC
 description:
     - Read/Write info via ODBC drivers.
+extends_documentation_fragment:
+    - community.general.attributes
+attributes:
+    check_mode:
+        support: none
+    diff_mode:
+        support: none
 options:
     dsn:
       description:

plugins/modules/redis.py

@@ -16,6 +16,12 @@ description:
    - Unified utility to interact with redis instances.
 extends_documentation_fragment:
    - community.general.redis
+   - community.general.attributes
+attributes:
+    check_mode:
+        support: full
+    diff_mode:
+        support: none
 options:
     command:
         description:

plugins/modules/redis_data.py

@@ -16,6 +16,11 @@ version_added: 3.7.0
 description:
    - Set key value pairs in Redis database.
 author: "Andreas Botzner (@paginabianca)"
+attributes:
+    check_mode:
+        support: full
+    diff_mode:
+        support: none
 options:
     key:
         description:
@@ -59,6 +64,7 @@ options:
 
 extends_documentation_fragment:
   - community.general.redis.documentation
+  - community.general.attributes
 
 seealso:
     - module: community.general.redis_data_incr

plugins/modules/redis_data_incr.py

@@ -17,9 +17,17 @@ description:
    - Increment integers or float keys in Redis database and get new value.
    - Default increment for all keys is 1. For specific increments use the
      I(increment_int) and I(increment_float) options.
-   - When using I(check_mode) the module will try to calculate the value that
-     Redis would return. If the key is not present, 0.0 is used as value.
 author: "Andreas Botzner (@paginabianca)"
+attributes:
+  check_mode:
+    support: partial
+    details:
+      - For C(check_mode) to work, the specified I(redis_user) needs permission to
+        run the C(GET) command on the key, otherwise the module will fail.
+      - When using I(check_mode) the module will try to calculate the value that
+        Redis would return. If the key is not present, 0.0 is used as value.
+  diff_mode:
+    support: none
 options:
   key:
     description:
@@ -42,10 +50,7 @@ options:
 
 extends_documentation_fragment:
   - community.general.redis.documentation
-
+  - community.general.attributes
-notes:
-   - For C(check_mode) to work, the specified I(redis_user) needs permission to
-     run the C(GET) command on the key, otherwise the module will fail.
 
 seealso:
     - module: community.general.redis_data

plugins/modules/riak.py

@@ -14,11 +14,18 @@ DOCUMENTATION = '''
 module: riak
 short_description: This module handles some common Riak operations
 description:
-     - This module can be used to join nodes to a cluster, check
+    - This module can be used to join nodes to a cluster, check
-       the status of the cluster.
+      the status of the cluster.
 author:
     - "James Martin (@jsmartin)"
     - "Drew Kerrigan (@drewkerrigan)"
+extends_documentation_fragment:
+    - community.general.attributes
+attributes:
+  check_mode:
+    support: none
+  diff_mode:
+    support: none
 options:
   command:
     description:

plugins/modules/vertica_configuration.py

@@ -14,6 +14,13 @@ module: vertica_configuration
 short_description: Updates Vertica configuration parameters
 description:
     - Updates Vertica configuration parameters.
+extends_documentation_fragment:
+    - community.general.attributes
+attributes:
+  check_mode:
+    support: full
+  diff_mode:
+    support: none
 options:
   parameter:
     description:

plugins/modules/vertica_role.py

@@ -15,6 +15,13 @@ module: vertica_role
 short_description: Adds or removes Vertica database roles and assigns roles to them
 description:
   - Adds or removes Vertica database role and, optionally, assign other roles.
+extends_documentation_fragment:
+  - community.general.attributes
+attributes:
+  check_mode:
+    support: full
+  diff_mode:
+    support: none
 options:
   role:
     description:

plugins/modules/vertica_schema.py

@@ -20,6 +20,13 @@ description:
   - In such a situation, if the module tries to remove the schema it
     will fail and only remove roles created for the schema if they have
     no dependencies.
+extends_documentation_fragment:
+  - community.general.attributes
+attributes:
+  check_mode:
+    support: full
+  diff_mode:
+    support: none
 options:
   schema:
     description:

plugins/modules/vertica_user.py

@@ -17,6 +17,13 @@ description:
   - A user will not be removed until all the dependencies have been dropped.
   - In such a situation, if the module tries to remove the user it
     will fail and only remove roles granted to the user.
+extends_documentation_fragment:
+  - community.general.attributes
+attributes:
+  check_mode:
+    support: full
+  diff_mode:
+    support: none
 options:
   user:
     description: