mirror of
https://github.com/ansible-collections/community.general.git
synced 2025-06-03 14:59:09 -07:00
Add version_added for all new features (#214)
* Add version_added: 1.0.0 for all new features added before pre-ansible-base. * Add version_added: 1.0.0 for all new features. * Next release will be 0.2.0 * Fix error. * Remove unnecessary warnings.
This commit is contained in:
parent
c081bb6c9c
commit
f9589d78a8
102 changed files with 220 additions and 10 deletions
|
@ -12,6 +12,7 @@ DOCUMENTATION = r'''
|
|||
---
|
||||
module: redis_info
|
||||
short_description: Gather information about Redis servers
|
||||
version_added: '0.2.0'
|
||||
description:
|
||||
- Gathers information and statistics about Redis servers.
|
||||
options:
|
||||
|
|
|
@ -73,6 +73,7 @@ options:
|
|||
required: no
|
||||
default: no
|
||||
type: bool
|
||||
version_added: '0.2.0'
|
||||
force:
|
||||
description:
|
||||
- Continue dump or import even if we get an SQL error.
|
||||
|
@ -80,6 +81,7 @@ options:
|
|||
required: no
|
||||
type: bool
|
||||
default: no
|
||||
version_added: '0.2.0'
|
||||
master_data:
|
||||
description:
|
||||
- Option to dump a master replication server to produce a dump file
|
||||
|
@ -93,18 +95,21 @@ options:
|
|||
type: int
|
||||
choices: [0, 1, 2]
|
||||
default: 0
|
||||
version_added: '0.2.0'
|
||||
skip_lock_tables:
|
||||
description:
|
||||
- Skip locking tables for read. Used when I(state=dump), ignored otherwise.
|
||||
required: no
|
||||
type: bool
|
||||
default: no
|
||||
version_added: '0.2.0'
|
||||
dump_extra_args:
|
||||
description:
|
||||
- Provide additional arguments for mysqldump.
|
||||
Used when I(state=dump) only, ignored otherwise.
|
||||
required: no
|
||||
type: str
|
||||
version_added: '0.2.0'
|
||||
use_shell:
|
||||
description:
|
||||
- Used to prevent C(Broken pipe) errors when the imported I(target) file is compressed.
|
||||
|
@ -113,6 +118,7 @@ options:
|
|||
required: no
|
||||
type: bool
|
||||
default: no
|
||||
version_added: '0.2.0'
|
||||
unsafe_login_password:
|
||||
description:
|
||||
- If C(no), the module will safely use a shell-escaped version of the I(login_password) value.
|
||||
|
@ -120,6 +126,7 @@ options:
|
|||
- Used only when I(state) is C(import) or C(dump) and I(login_password) is passed, ignored otherwise.
|
||||
type: bool
|
||||
default: no
|
||||
version_added: '0.2.0'
|
||||
restrict_config_file:
|
||||
description:
|
||||
- Read only passed I(config_file).
|
||||
|
@ -129,12 +136,14 @@ options:
|
|||
- If this behavior is undesirable, use C(yes) to read only named option file.
|
||||
type: bool
|
||||
default: no
|
||||
version_added: '0.2.0'
|
||||
check_implicit_admin:
|
||||
description:
|
||||
- Check if mysql allows login as root/nopassword before trying supplied credentials.
|
||||
- If success, passed I(login_user)/I(login_password) will be ignored.
|
||||
type: bool
|
||||
default: no
|
||||
version_added: '0.2.0'
|
||||
|
||||
seealso:
|
||||
- module: mysql_info
|
||||
|
@ -291,6 +300,7 @@ executed_commands:
|
|||
returned: if executed
|
||||
type: list
|
||||
sample: ["CREATE DATABASE acme"]
|
||||
version_added: '0.2.0'
|
||||
'''
|
||||
|
||||
import os
|
||||
|
|
|
@ -37,6 +37,7 @@ options:
|
|||
- "Supports elements: C(db_size). Unsupported elements will be ignored"
|
||||
type: list
|
||||
elements: str
|
||||
version_added: '0.2.0'
|
||||
return_empty_dbs:
|
||||
description:
|
||||
- Includes names of empty databases to returned dictionary.
|
||||
|
|
|
@ -15,6 +15,7 @@ description:
|
|||
- Runs arbitrary MySQL queries.
|
||||
- Pay attention, the module does not support check mode!
|
||||
All queries will be executed in autocommit mode.
|
||||
version_added: '0.2.0'
|
||||
options:
|
||||
query:
|
||||
description:
|
||||
|
|
|
@ -115,12 +115,14 @@ options:
|
|||
- Available since MariaDB 10.0.2.
|
||||
choices: [current_pos, slave_pos, disabled]
|
||||
type: str
|
||||
version_added: '0.2.0'
|
||||
master_delay:
|
||||
description:
|
||||
- Time lag behind the master's state (in seconds).
|
||||
- Available from MySQL 5.6.
|
||||
- For more information see U(https://dev.mysql.com/doc/refman/8.0/en/replication-delayed.html).
|
||||
type: int
|
||||
version_added: '0.2.0'
|
||||
connection_name:
|
||||
description:
|
||||
- Name of the master connection.
|
||||
|
@ -128,6 +130,7 @@ options:
|
|||
- Mutually exclusive with I(channel).
|
||||
- For more information see U(https://mariadb.com/kb/en/library/multi-source-replication/).
|
||||
type: str
|
||||
version_added: '0.2.0'
|
||||
channel:
|
||||
description:
|
||||
- Name of replication channel.
|
||||
|
@ -135,11 +138,13 @@ options:
|
|||
- Mutually exclusive with I(connection_name).
|
||||
- For more information see U(https://dev.mysql.com/doc/refman/8.0/en/replication-multi-source.html).
|
||||
type: str
|
||||
version_added: '0.2.0'
|
||||
fail_on_error:
|
||||
description:
|
||||
- Fails on error when calling mysql.
|
||||
type: bool
|
||||
default: False
|
||||
version_added: '0.2.0'
|
||||
|
||||
notes:
|
||||
- If an empty value for the parameter of string type is needed, use an empty string.
|
||||
|
@ -226,6 +231,7 @@ queries:
|
|||
returned: always
|
||||
type: list
|
||||
sample: ["CHANGE MASTER TO MASTER_HOST='master2.example.com',MASTER_PORT=3306"]
|
||||
version_added: '0.2.0'
|
||||
'''
|
||||
|
||||
import os
|
||||
|
|
|
@ -89,14 +89,17 @@ options:
|
|||
description:
|
||||
- User's plugin to authenticate (``CREATE USER user IDENTIFIED WITH plugin``).
|
||||
type: str
|
||||
version_added: '0.2.0'
|
||||
plugin_hash_string:
|
||||
description:
|
||||
- User's plugin hash string (``CREATE USER user IDENTIFIED WITH plugin AS plugin_hash_string``).
|
||||
type: str
|
||||
version_added: '0.2.0'
|
||||
plugin_auth_string:
|
||||
description:
|
||||
- User's plugin auth_string (``CREATE USER user IDENTIFIED WITH plugin BY plugin_auth_string``).
|
||||
type: str
|
||||
version_added: '0.2.0'
|
||||
resource_limits:
|
||||
description:
|
||||
- Limit the user for certain server resources. Provided since MySQL 5.6 / MariaDB 10.2.
|
||||
|
@ -104,6 +107,7 @@ options:
|
|||
C(MAX_CONNECTIONS_PER_HOUR: num), C(MAX_USER_CONNECTIONS: num)."
|
||||
- Used when I(state=present), ignored otherwise.
|
||||
type: dict
|
||||
version_added: '0.2.0'
|
||||
|
||||
notes:
|
||||
- "MySQL server installs with default login_user of 'root' and no password. To secure this user
|
||||
|
|
|
@ -42,6 +42,7 @@ options:
|
|||
type: str
|
||||
choices: ['global', 'persist', 'persist_only']
|
||||
default: global
|
||||
version_added: '0.2.0'
|
||||
|
||||
seealso:
|
||||
- module: mysql_info
|
||||
|
@ -72,6 +73,7 @@ queries:
|
|||
returned: if executed
|
||||
type: list
|
||||
sample: ["SET GLOBAL `read_only` = 1"]
|
||||
version_added: '0.2.0'
|
||||
'''
|
||||
|
||||
import os
|
||||
|
|
|
@ -75,6 +75,7 @@ options:
|
|||
- It makes sense to use C(yes) only when SQL injections are possible.
|
||||
type: bool
|
||||
default: yes
|
||||
version_added: '0.2.0'
|
||||
notes:
|
||||
- Supports PostgreSQL version 9.4+.
|
||||
- COPY command is only allowed to database superusers.
|
||||
|
|
|
@ -101,6 +101,7 @@ options:
|
|||
- Provides additional arguments when I(state) is C(dump).
|
||||
- Cannot be used with dump-file-format-related arguments like ``--format=d``.
|
||||
type: str
|
||||
version_added: '0.2.0'
|
||||
trust_input:
|
||||
description:
|
||||
- If C(no), check whether values of parameters I(owner), I(conn_limit), I(encoding),
|
||||
|
@ -108,6 +109,7 @@ options:
|
|||
- It makes sense to use C(yes) only when SQL injections via the parameters are possible.
|
||||
type: bool
|
||||
default: yes
|
||||
version_added: '0.2.0'
|
||||
seealso:
|
||||
- name: CREATE DATABASE reference
|
||||
description: Complete reference of the CREATE DATABASE command documentation.
|
||||
|
@ -200,6 +202,7 @@ executed_commands:
|
|||
returned: always
|
||||
type: list
|
||||
sample: ["CREATE DATABASE acme"]
|
||||
version_added: '0.2.0'
|
||||
'''
|
||||
|
||||
|
||||
|
|
|
@ -83,6 +83,7 @@ options:
|
|||
- It makes sense to use C(yes) only when SQL injections via the parameters are possible.
|
||||
type: bool
|
||||
default: yes
|
||||
version_added: '0.2.0'
|
||||
seealso:
|
||||
- name: PostgreSQL extensions
|
||||
description: General information about PostgreSQL extensions.
|
||||
|
|
|
@ -88,6 +88,7 @@ options:
|
|||
- Only btree currently supports unique indexes.
|
||||
type: bool
|
||||
default: no
|
||||
version_added: '0.2.0'
|
||||
tablespace:
|
||||
description:
|
||||
- Set a tablespace for the index.
|
||||
|
@ -116,6 +117,7 @@ options:
|
|||
- It makes sense to use C(yes) only when SQL injections via the parameters are possible.
|
||||
type: bool
|
||||
default: yes
|
||||
version_added: '0.2.0'
|
||||
|
||||
seealso:
|
||||
- module: postgresql_table
|
||||
|
|
|
@ -46,6 +46,7 @@ options:
|
|||
- It makes sense to use C(yes) only when SQL injections via I(session_role) are possible.
|
||||
type: bool
|
||||
default: yes
|
||||
version_added: '0.2.0'
|
||||
seealso:
|
||||
- module: postgresql_ping
|
||||
author:
|
||||
|
@ -244,6 +245,7 @@ databases:
|
|||
returned: if configured
|
||||
type: dict
|
||||
sample: { "pub1": { "ownername": "postgres", "puballtables": true, "pubinsert": true, "pubupdate": true } }
|
||||
version_added: '0.2.0'
|
||||
subscriptions:
|
||||
description:
|
||||
- Information about replication subscriptions (available for PostgreSQL 10 and higher)
|
||||
|
@ -253,6 +255,7 @@ databases:
|
|||
type: dict
|
||||
sample:
|
||||
- { "my_subscription": {"ownername": "postgres", "subenabled": true, "subpublications": ["first_publication"] } }
|
||||
version_added: '0.2.0'
|
||||
repl_slots:
|
||||
description:
|
||||
- Replication slots (available in 9.4 and later)
|
||||
|
|
|
@ -101,6 +101,7 @@ options:
|
|||
- Set an owner for the language.
|
||||
- Ignored when I(state=absent).
|
||||
type: str
|
||||
version_added: '0.2.0'
|
||||
trust_input:
|
||||
description:
|
||||
- If C(no), check whether values of parameters I(lang), I(session_role),
|
||||
|
@ -108,6 +109,7 @@ options:
|
|||
- It makes sense to use C(yes) only when SQL injections via the parameters are possible.
|
||||
type: bool
|
||||
default: yes
|
||||
version_added: '0.2.0'
|
||||
seealso:
|
||||
- name: PostgreSQL languages
|
||||
description: General information about PostgreSQL languages.
|
||||
|
|
|
@ -73,6 +73,7 @@ options:
|
|||
- It makes sense to use C(yes) only when SQL injections via the parameters are possible.
|
||||
type: bool
|
||||
default: yes
|
||||
version_added: '0.2.0'
|
||||
seealso:
|
||||
- module: postgresql_user
|
||||
- module: postgresql_privs
|
||||
|
|
|
@ -71,6 +71,7 @@ options:
|
|||
- It makes sense to use C(yes) only when SQL injections via the parameters are possible.
|
||||
type: bool
|
||||
default: yes
|
||||
version_added: '0.2.0'
|
||||
seealso:
|
||||
- module: postgresql_user
|
||||
- module: postgresql_privs
|
||||
|
|
|
@ -27,12 +27,14 @@ options:
|
|||
- Permissions checking for SQL commands is carried out as though
|
||||
the session_role were the one that had logged in originally.
|
||||
type: str
|
||||
version_added: '0.2.0'
|
||||
trust_input:
|
||||
description:
|
||||
- If C(no), check whether a value of I(session_role) is potentially dangerous.
|
||||
- It does make sense to use C(yes) only when SQL injections via I(session_role) are possible.
|
||||
type: bool
|
||||
default: yes
|
||||
version_added: '0.2.0'
|
||||
seealso:
|
||||
- module: postgresql_info
|
||||
author:
|
||||
|
|
|
@ -160,6 +160,7 @@ options:
|
|||
- It makes sense to use C(yes) only when SQL injections via the parameters are possible.
|
||||
type: bool
|
||||
default: yes
|
||||
version_added: '0.2.0'
|
||||
|
||||
notes:
|
||||
- Parameters that accept comma separated lists (I(privs), I(objs), I(roles))
|
||||
|
|
|
@ -64,6 +64,7 @@ options:
|
|||
- Permissions checking for SQL commands is carried out as though
|
||||
the session_role were the one that had logged in originally.
|
||||
type: str
|
||||
version_added: '0.2.0'
|
||||
trust_input:
|
||||
description:
|
||||
- If C(no), check whether values of parameters I(name), I(tables), I(owner),
|
||||
|
@ -71,6 +72,7 @@ options:
|
|||
- It makes sense to use C(yes) only when SQL injections via the parameters are possible.
|
||||
type: bool
|
||||
default: yes
|
||||
version_added: '0.2.0'
|
||||
notes:
|
||||
- PostgreSQL version must be 10 or greater.
|
||||
seealso:
|
||||
|
|
|
@ -67,12 +67,14 @@ options:
|
|||
- Set the client encoding for the current session (e.g. C(UTF-8)).
|
||||
- The default is the encoding defined by the database.
|
||||
type: str
|
||||
version_added: '0.2.0'
|
||||
trust_input:
|
||||
description:
|
||||
- If C(no), check whether a value of I(session_role) is potentially dangerous.
|
||||
- It does make sense to use C(yes) only when SQL injections via I(session_role) are possible.
|
||||
type: bool
|
||||
default: yes
|
||||
version_added: '0.2.0'
|
||||
seealso:
|
||||
- module: postgresql_db
|
||||
author:
|
||||
|
|
|
@ -71,6 +71,7 @@ options:
|
|||
- It makes sense to use C(yes) only when SQL injections via the parameters are possible.
|
||||
type: bool
|
||||
default: yes
|
||||
version_added: '0.2.0'
|
||||
seealso:
|
||||
- name: PostgreSQL schemas
|
||||
description: General information about PostgreSQL schemas.
|
||||
|
|
|
@ -136,6 +136,7 @@ options:
|
|||
- It makes sense to use C(yes) only when SQL injections via the parameters are possible.
|
||||
type: bool
|
||||
default: yes
|
||||
version_added: '0.2.0'
|
||||
notes:
|
||||
- If you do not pass db parameter, sequence will be created in the database
|
||||
named postgres.
|
||||
|
|
|
@ -59,6 +59,7 @@ options:
|
|||
- It does make sense to use C(yes) only when SQL injections are possible.
|
||||
type: bool
|
||||
default: yes
|
||||
version_added: '0.2.0'
|
||||
notes:
|
||||
- Supported version of PostgreSQL is 9.4 and later.
|
||||
- Pay attention, change setting with 'postmaster' context can return changed is true
|
||||
|
|
|
@ -72,6 +72,7 @@ options:
|
|||
- It sense to use C(no) only when SQL injections via I(session_role) are possible.
|
||||
type: bool
|
||||
default: yes
|
||||
version_added: '0.2.0'
|
||||
|
||||
notes:
|
||||
- Physical replication slots were introduced to PostgreSQL with version 9.4,
|
||||
|
|
|
@ -14,6 +14,7 @@ module: postgresql_subscription
|
|||
short_description: Add, update, or remove PostgreSQL subscription
|
||||
description:
|
||||
- Add, update, or remove PostgreSQL subscription.
|
||||
version_added: '0.2.0'
|
||||
|
||||
options:
|
||||
name:
|
||||
|
@ -82,6 +83,7 @@ options:
|
|||
- Permissions checking for SQL commands is carried out as though
|
||||
the session_role were the one that had logged in originally.
|
||||
type: str
|
||||
version_added: '0.2.0'
|
||||
trust_input:
|
||||
description:
|
||||
- If C(no), check whether values of parameters I(name), I(publications), I(owner),
|
||||
|
@ -89,6 +91,7 @@ options:
|
|||
- It makes sense to use C(yes) only when SQL injections via the parameters are possible.
|
||||
type: bool
|
||||
default: yes
|
||||
version_added: '0.2.0'
|
||||
|
||||
notes:
|
||||
- PostgreSQL version must be 10 or greater.
|
||||
|
|
|
@ -99,6 +99,7 @@ options:
|
|||
- It makes sense to use C(yes) only when SQL injections are possible.
|
||||
type: bool
|
||||
default: yes
|
||||
version_added: '0.2.0'
|
||||
notes:
|
||||
- If you do not pass db parameter, tables will be created in the database
|
||||
named postgres.
|
||||
|
|
|
@ -76,6 +76,7 @@ options:
|
|||
- It makes sense to use C(yes) only when SQL injections via the parameters are possible.
|
||||
type: bool
|
||||
default: yes
|
||||
version_added: '0.2.0'
|
||||
|
||||
notes:
|
||||
- I(state=absent) and I(state=present) (the second one if the tablespace doesn't exist) do not
|
||||
|
|
|
@ -141,6 +141,7 @@ options:
|
|||
description:
|
||||
- Add a comment on the user (equal to the COMMENT ON ROLE statement result).
|
||||
type: str
|
||||
version_added: '0.2.0'
|
||||
trust_input:
|
||||
description:
|
||||
- If C(no), check whether values of parameters I(name), I(password), I(privs), I(expires),
|
||||
|
@ -148,6 +149,7 @@ options:
|
|||
- It makes sense to use C(yes) only when SQL injections via the parameters are possible.
|
||||
type: bool
|
||||
default: yes
|
||||
version_added: '0.2.0'
|
||||
notes:
|
||||
- The module creates a user (role) with login privilege by default.
|
||||
Use NOLOGIN role_attr_flags to change this behaviour.
|
||||
|
|
|
@ -13,6 +13,7 @@ module: postgresql_user_obj_stat_info
|
|||
short_description: Gather statistics about PostgreSQL user objects
|
||||
description:
|
||||
- Gathers statistics about PostgreSQL user objects.
|
||||
version_added: '0.2.0'
|
||||
options:
|
||||
filter:
|
||||
description:
|
||||
|
@ -45,6 +46,7 @@ options:
|
|||
- It only makes sense to use C(no) only when SQL injections via I(session_role) are possible.
|
||||
type: bool
|
||||
default: yes
|
||||
version_added: '0.2.0'
|
||||
|
||||
notes:
|
||||
- C(size) and C(total_size) returned values are presented in bytes.
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue