1
0
Fork 0
mirror of https://github.com/ansible-collections/community.general.git synced 2024-09-14 20:13:21 +02:00

Add attributes to some database modules (#5953)

Add attributes to some database modules.
This commit is contained in:
Felix Fontein 2023-02-24 09:23:04 +01:00 committed by GitHub
parent cc29b16536
commit cc3a79bc48
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
21 changed files with 158 additions and 20 deletions

View file

@ -16,8 +16,15 @@ short_description: Set or delete key value pairs from an etcd3 cluster
requirements: requirements:
- etcd3 - etcd3
description: 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: options:
key: key:
type: str type: str

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

@ -15,7 +15,14 @@ DOCUMENTATION = '''
module: mssql_db module: mssql_db
short_description: Add or remove MSSQL databases from a remote host short_description: Add or remove MSSQL databases from a remote host
description: 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: options:
name: name:
description: description:

View file

@ -18,6 +18,17 @@ version_added: "4.0.0"
description: description:
- Execute SQL scripts on a MSSQL database. - 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: options:
name: name:
description: Database to run script against. description: Database to run script against.

View file

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

View file

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

View file

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

View file

@ -17,9 +17,17 @@ description:
- Increment integers or float keys in Redis database and get new value. - Increment integers or float keys in Redis database and get new value.
- Default increment for all keys is 1. For specific increments use the - Default increment for all keys is 1. For specific increments use the
I(increment_int) and I(increment_float) options. 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)" 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: options:
key: key:
description: description:
@ -42,10 +50,7 @@ options:
extends_documentation_fragment: extends_documentation_fragment:
- community.general.redis.documentation - 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: seealso:
- module: community.general.redis_data - module: community.general.redis_data

View file

@ -14,11 +14,18 @@ DOCUMENTATION = '''
module: riak module: riak
short_description: This module handles some common Riak operations short_description: This module handles some common Riak operations
description: 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: author:
- "James Martin (@jsmartin)" - "James Martin (@jsmartin)"
- "Drew Kerrigan (@drewkerrigan)" - "Drew Kerrigan (@drewkerrigan)"
extends_documentation_fragment:
- community.general.attributes
attributes:
check_mode:
support: none
diff_mode:
support: none
options: options:
command: command:
description: description:

View file

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

View file

@ -15,6 +15,13 @@ module: vertica_role
short_description: Adds or removes Vertica database roles and assigns roles to them short_description: Adds or removes Vertica database roles and assigns roles to them
description: description:
- Adds or removes Vertica database role and, optionally, assign other roles. - 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: options:
role: role:
description: description:

View file

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

View file

@ -17,6 +17,13 @@ description:
- A user will not be removed until all the dependencies have been dropped. - 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 - In such a situation, if the module tries to remove the user it
will fail and only remove roles granted to the user. 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: options:
user: user:
description: description: