mirror of
https://github.com/ansible-collections/community.general.git
synced 2026-05-07 05:42:50 +00:00
Clean up module documentation (#36909)
* Clean up module documentation This PR includes: - Removal of `default: None` (and variations) - Removal of `required: false` - Fixing booleans and `type: bool` where required * Fix remaining (new) validation issues
This commit is contained in:
@@ -33,49 +33,36 @@ options:
|
||||
state:
|
||||
description:
|
||||
- Desired state of a plugin.
|
||||
required: False
|
||||
choices: ["present", "absent"]
|
||||
default: present
|
||||
url:
|
||||
description:
|
||||
- Set exact URL to download the plugin from (Only works for ES 1.x)
|
||||
required: False
|
||||
default: None
|
||||
timeout:
|
||||
description:
|
||||
- "Timeout setting: 30s, 1m, 1h..."
|
||||
- Only valid for Elasticsearch < 5.0. This option is ignored for Elasticsearch > 5.0.
|
||||
required: False
|
||||
default: 1m
|
||||
plugin_bin:
|
||||
description:
|
||||
- Location of the plugin binary. If this file is not found, the default plugin binaries will be used.
|
||||
- The default changed in Ansible 2.4 to None.
|
||||
required: False
|
||||
default: None
|
||||
plugin_dir:
|
||||
description:
|
||||
- Your configured plugin directory specified in Elasticsearch
|
||||
required: False
|
||||
default: /usr/share/elasticsearch/plugins/
|
||||
proxy_host:
|
||||
description:
|
||||
- Proxy host to use during plugin installation
|
||||
required: False
|
||||
default: None
|
||||
version_added: "2.1"
|
||||
proxy_port:
|
||||
description:
|
||||
- Proxy port to use during plugin installation
|
||||
required: False
|
||||
default: None
|
||||
version_added: "2.1"
|
||||
version:
|
||||
description:
|
||||
- Version of the plugin to be installed.
|
||||
If plugin exists with previous version, it will NOT be updated
|
||||
required: False
|
||||
default: None
|
||||
'''
|
||||
|
||||
EXAMPLES = '''
|
||||
|
||||
@@ -31,42 +31,33 @@ options:
|
||||
state:
|
||||
description:
|
||||
- Desired state of a plugin.
|
||||
required: False
|
||||
choices: ["present", "absent"]
|
||||
default: present
|
||||
url:
|
||||
description:
|
||||
- Set exact URL to download the plugin from.
|
||||
For local file, prefix its absolute path with file://
|
||||
required: False
|
||||
default: None
|
||||
timeout:
|
||||
description:
|
||||
- "Timeout setting: 30s, 1m, 1h..."
|
||||
required: False
|
||||
default: 1m
|
||||
plugin_bin:
|
||||
description:
|
||||
- Location of the plugin binary
|
||||
required: False
|
||||
default: /opt/kibana/bin/kibana
|
||||
plugin_dir:
|
||||
description:
|
||||
- Your configured plugin directory specified in Kibana
|
||||
required: False
|
||||
default: /opt/kibana/installedPlugins/
|
||||
version:
|
||||
description:
|
||||
- Version of the plugin to be installed.
|
||||
If plugin exists with previous version, it will NOT be updated if C(force) is not set to yes
|
||||
required: False
|
||||
default: None
|
||||
force:
|
||||
description:
|
||||
- Delete and re-install the plugin. Can be useful for plugins update
|
||||
required: False
|
||||
choices: ["yes", "no"]
|
||||
default: no
|
||||
type: bool
|
||||
default: 'no'
|
||||
'''
|
||||
|
||||
EXAMPLES = '''
|
||||
|
||||
@@ -41,7 +41,6 @@ options:
|
||||
master_host:
|
||||
description:
|
||||
- The host of the master instance [slave command]
|
||||
default: null
|
||||
master_port:
|
||||
description:
|
||||
- The port of the master instance [slave command]
|
||||
|
||||
@@ -28,47 +28,35 @@ options:
|
||||
command:
|
||||
description:
|
||||
- The command you would like to perform against the cluster.
|
||||
required: false
|
||||
default: null
|
||||
choices: ['ping', 'kv_test', 'join', 'plan', 'commit']
|
||||
config_dir:
|
||||
description:
|
||||
- The path to the riak configuration directory
|
||||
required: false
|
||||
default: /etc/riak
|
||||
http_conn:
|
||||
description:
|
||||
- The ip address and port that is listening for Riak HTTP queries
|
||||
required: false
|
||||
default: 127.0.0.1:8098
|
||||
target_node:
|
||||
description:
|
||||
- The target node for certain operations (join, ping)
|
||||
required: false
|
||||
default: riak@127.0.0.1
|
||||
wait_for_handoffs:
|
||||
description:
|
||||
- Number of seconds to wait for handoffs to complete.
|
||||
required: false
|
||||
default: null
|
||||
wait_for_ring:
|
||||
description:
|
||||
- Number of seconds to wait for all nodes to agree on the ring.
|
||||
required: false
|
||||
default: null
|
||||
wait_for_service:
|
||||
description:
|
||||
- Waits for a riak service to come online before continuing.
|
||||
required: false
|
||||
default: None
|
||||
choices: ['kv']
|
||||
validate_certs:
|
||||
description:
|
||||
- If C(no), SSL certificates will not be validated. This should only be used
|
||||
on personally controlled sites using self-signed certificates.
|
||||
required: false
|
||||
type: bool
|
||||
default: 'yes'
|
||||
choices: ['yes', 'no']
|
||||
version_added: 1.5.1
|
||||
'''
|
||||
|
||||
|
||||
@@ -27,33 +27,23 @@ options:
|
||||
login_user:
|
||||
description:
|
||||
- The username used to authenticate with
|
||||
required: false
|
||||
default: null
|
||||
login_password:
|
||||
description:
|
||||
- The password used to authenticate with
|
||||
required: false
|
||||
default: null
|
||||
login_host:
|
||||
description:
|
||||
- The host running the database
|
||||
required: false
|
||||
default: localhost
|
||||
login_port:
|
||||
description:
|
||||
- The port to connect to
|
||||
required: false
|
||||
default: 27017
|
||||
login_database:
|
||||
description:
|
||||
- The database where login credentials are stored
|
||||
required: false
|
||||
default: null
|
||||
replica_set:
|
||||
description:
|
||||
- Replica set to connect to (automatically connects to primary for writes)
|
||||
required: false
|
||||
default: null
|
||||
database:
|
||||
description:
|
||||
- The name of the database to add/remove the user from
|
||||
@@ -61,8 +51,8 @@ options:
|
||||
ssl:
|
||||
description:
|
||||
- Whether to use an SSL connection when connecting to the database
|
||||
required: false
|
||||
default: false
|
||||
type: bool
|
||||
default: 'no'
|
||||
param:
|
||||
description:
|
||||
- MongoDB administrative parameter to modify
|
||||
@@ -74,7 +64,6 @@ options:
|
||||
param_type:
|
||||
description:
|
||||
- Define the parameter value (str, int)
|
||||
required: false
|
||||
default: str
|
||||
|
||||
notes:
|
||||
|
||||
@@ -26,35 +26,25 @@ options:
|
||||
login_user:
|
||||
description:
|
||||
- The username used to authenticate with
|
||||
required: false
|
||||
default: null
|
||||
login_password:
|
||||
description:
|
||||
- The password used to authenticate with
|
||||
required: false
|
||||
default: null
|
||||
login_host:
|
||||
description:
|
||||
- The host running the database
|
||||
required: false
|
||||
default: localhost
|
||||
login_port:
|
||||
description:
|
||||
- The port to connect to
|
||||
required: false
|
||||
default: 27017
|
||||
login_database:
|
||||
version_added: "2.0"
|
||||
description:
|
||||
- The database where login credentials are stored
|
||||
required: false
|
||||
default: null
|
||||
replica_set:
|
||||
version_added: "1.6"
|
||||
description:
|
||||
- Replica set to connect to (automatically connects to primary for writes)
|
||||
required: false
|
||||
default: null
|
||||
database:
|
||||
description:
|
||||
- The name of the database to add/remove the user from
|
||||
@@ -63,23 +53,18 @@ options:
|
||||
description:
|
||||
- The name of the user to add or remove
|
||||
required: true
|
||||
default: null
|
||||
aliases: [ 'user' ]
|
||||
password:
|
||||
description:
|
||||
- The password to use for the user
|
||||
required: false
|
||||
default: null
|
||||
ssl:
|
||||
version_added: "1.8"
|
||||
description:
|
||||
- Whether to use an SSL connection when connecting to the database
|
||||
default: False
|
||||
ssl_cert_reqs:
|
||||
version_added: "2.2"
|
||||
description:
|
||||
- Specifies whether a certificate is required from the other side of the connection, and whether it will be validated if provided.
|
||||
required: false
|
||||
default: "CERT_REQUIRED"
|
||||
choices: ["CERT_REQUIRED", "CERT_OPTIONAL", "CERT_NONE"]
|
||||
roles:
|
||||
@@ -91,16 +76,13 @@ options:
|
||||
'dbAdminAnyDatabase'
|
||||
- "Or the following dictionary '{ db: DATABASE_NAME, role: ROLE_NAME }'."
|
||||
- "This param requires pymongo 2.5+. If it is a string, mongodb 2.4+ is also required. If it is a dictionary, mongo 2.6+ is required."
|
||||
required: false
|
||||
default: "readWrite"
|
||||
state:
|
||||
description:
|
||||
- The database user state
|
||||
required: false
|
||||
default: present
|
||||
choices: [ "present", "absent" ]
|
||||
update_password:
|
||||
required: false
|
||||
default: always
|
||||
choices: ['always', 'on_create']
|
||||
version_added: "2.1"
|
||||
|
||||
@@ -26,45 +26,35 @@ options:
|
||||
description:
|
||||
- name of the database to add or remove
|
||||
required: true
|
||||
default: null
|
||||
aliases: [ db ]
|
||||
login_user:
|
||||
description:
|
||||
- The username used to authenticate with
|
||||
required: false
|
||||
default: null
|
||||
login_password:
|
||||
description:
|
||||
- The password used to authenticate with
|
||||
required: false
|
||||
default: null
|
||||
login_host:
|
||||
description:
|
||||
- Host running the database
|
||||
required: false
|
||||
login_port:
|
||||
description:
|
||||
- Port of the MSSQL server. Requires login_host be defined as other then localhost if login_port is used
|
||||
required: false
|
||||
default: 1433
|
||||
state:
|
||||
description:
|
||||
- The database state
|
||||
required: false
|
||||
default: present
|
||||
choices: [ "present", "absent", "import" ]
|
||||
target:
|
||||
description:
|
||||
- Location, on the remote host, of the dump file to read from or write to. Uncompressed SQL
|
||||
files (C(.sql)) files are supported.
|
||||
required: false
|
||||
autocommit:
|
||||
description:
|
||||
- Automatically commit the change only if the import succeed. Sometimes it is necessary to use autocommit=true, since some content can't be changed
|
||||
within a transaction.
|
||||
required: false
|
||||
default: false
|
||||
choices: [ "false", "true" ]
|
||||
type: bool
|
||||
default: 'no'
|
||||
notes:
|
||||
- Requires the pymssql Python package on the remote host. For Ubuntu, this
|
||||
is as easy as pip install pymssql (See M(pip).)
|
||||
|
||||
@@ -28,40 +28,33 @@ options:
|
||||
- name=all May only be provided if I(state) is C(dump) or C(import).
|
||||
- if name=all Works like --all-databases option for mysqldump (Added in 2.0)
|
||||
required: true
|
||||
default: null
|
||||
aliases: [ db ]
|
||||
state:
|
||||
description:
|
||||
- The database state
|
||||
required: false
|
||||
default: present
|
||||
choices: [ "present", "absent", "dump", "import" ]
|
||||
collation:
|
||||
description:
|
||||
- Collation mode (sorting). This only applies to new table/databases and does not update existing ones, this is a limitation of MySQL.
|
||||
required: false
|
||||
default: null
|
||||
encoding:
|
||||
description:
|
||||
- Encoding mode to use, examples include C(utf8) or C(latin1_swedish_ci)
|
||||
required: false
|
||||
default: null
|
||||
target:
|
||||
description:
|
||||
- Location, on the remote host, of the dump file to read from or write to. Uncompressed SQL
|
||||
files (C(.sql)) as well as bzip2 (C(.bz2)), gzip (C(.gz)) and xz (Added in 2.0) compressed files are supported.
|
||||
required: false
|
||||
single_transaction:
|
||||
description:
|
||||
- Execute the dump in a single transaction
|
||||
required: false
|
||||
default: false
|
||||
type: bool
|
||||
default: 'no'
|
||||
version_added: "2.1"
|
||||
quick:
|
||||
description:
|
||||
- Option used for dumping large tables
|
||||
required: false
|
||||
default: true
|
||||
type: bool
|
||||
default: 'yes'
|
||||
version_added: "2.1"
|
||||
author: "Ansible Core Team"
|
||||
requirements:
|
||||
|
||||
@@ -29,7 +29,6 @@ options:
|
||||
description:
|
||||
- module operating mode. Could be getslave (SHOW SLAVE STATUS), getmaster (SHOW MASTER STATUS), changemaster (CHANGE MASTER TO), startslave
|
||||
(START SLAVE), stopslave (STOP SLAVE), resetslave (RESET SLAVE), resetslaveall (RESET SLAVE ALL)
|
||||
required: False
|
||||
choices:
|
||||
- getslave
|
||||
- getmaster
|
||||
@@ -88,8 +87,6 @@ options:
|
||||
master_auto_position:
|
||||
description:
|
||||
- does the host uses GTID based replication or not
|
||||
required: false
|
||||
default: null
|
||||
version_added: "2.0"
|
||||
|
||||
extends_documentation_fragment: mysql
|
||||
|
||||
@@ -28,28 +28,23 @@ options:
|
||||
password:
|
||||
description:
|
||||
- set the user's password.
|
||||
required: false
|
||||
default: null
|
||||
encrypted:
|
||||
description:
|
||||
- Indicate that the 'password' field is a `mysql_native_password` hash
|
||||
required: false
|
||||
choices: [ "yes", "no" ]
|
||||
default: "no"
|
||||
type: bool
|
||||
default: 'no'
|
||||
version_added: "2.0"
|
||||
host:
|
||||
description:
|
||||
- the 'host' part of the MySQL username
|
||||
required: false
|
||||
default: localhost
|
||||
host_all:
|
||||
description:
|
||||
- override the host option, making ansible apply changes to
|
||||
all hostnames for a given user. This option cannot be used
|
||||
when creating users
|
||||
required: false
|
||||
choices: [ "yes", "no" ]
|
||||
default: "no"
|
||||
type: bool
|
||||
default: 'no'
|
||||
version_added: "2.1"
|
||||
priv:
|
||||
description:
|
||||
@@ -62,39 +57,32 @@ options:
|
||||
exactly as returned by a C(SHOW GRANT) statement. If not followed,
|
||||
the module will always report changes. It includes grouping columns
|
||||
by permission (C(SELECT(col1,col2)) instead of C(SELECT(col1),SELECT(col2))).
|
||||
required: false
|
||||
default: null
|
||||
append_privs:
|
||||
description:
|
||||
- Append the privileges defined by priv to the existing ones for this
|
||||
user instead of overwriting existing ones.
|
||||
required: false
|
||||
choices: [ "yes", "no" ]
|
||||
default: "no"
|
||||
type: bool
|
||||
default: 'no'
|
||||
version_added: "1.4"
|
||||
sql_log_bin:
|
||||
description:
|
||||
- Whether binary logging should be enabled or disabled for the connection.
|
||||
required: false
|
||||
choices: ["yes", "no" ]
|
||||
default: "yes"
|
||||
type: bool
|
||||
default: 'yes'
|
||||
version_added: "2.1"
|
||||
state:
|
||||
description:
|
||||
- Whether the user should exist. When C(absent), removes
|
||||
the user.
|
||||
required: false
|
||||
default: present
|
||||
choices: [ "present", "absent" ]
|
||||
check_implicit_admin:
|
||||
description:
|
||||
- Check if mysql allows login as root/nopassword before trying supplied credentials.
|
||||
required: false
|
||||
choices: [ "yes", "no" ]
|
||||
default: "no"
|
||||
type: bool
|
||||
default: 'no'
|
||||
version_added: "1.3"
|
||||
update_password:
|
||||
required: false
|
||||
default: always
|
||||
choices: ['always', 'on_create']
|
||||
version_added: "2.0"
|
||||
|
||||
@@ -24,34 +24,23 @@ options:
|
||||
description:
|
||||
- name of the database to add or remove
|
||||
required: true
|
||||
default: null
|
||||
aliases: [ db ]
|
||||
owner:
|
||||
description:
|
||||
- Name of the role to set as owner of the database
|
||||
required: false
|
||||
default: null
|
||||
template:
|
||||
description:
|
||||
- Template used to create the database
|
||||
required: false
|
||||
default: null
|
||||
encoding:
|
||||
description:
|
||||
- Encoding of the database
|
||||
required: false
|
||||
default: null
|
||||
lc_collate:
|
||||
description:
|
||||
- Collation order (LC_COLLATE) to use in the database. Must match collation order of template database unless C(template0) is used as template.
|
||||
required: false
|
||||
default: null
|
||||
lc_ctype:
|
||||
description:
|
||||
- Character classification (LC_CTYPE) to use in the database (e.g. lower, upper, ...) Must match LC_CTYPE of template database unless C(template0)
|
||||
is used as template.
|
||||
required: false
|
||||
default: null
|
||||
state:
|
||||
description: |
|
||||
The database state. present implies that the database should be created if necessary.
|
||||
@@ -61,7 +50,6 @@ options:
|
||||
(Added in 2.4) The format of the backup will be detected based on the target name.
|
||||
Supported compression formats for dump and restore are: .bz2, .gz, and .xz
|
||||
Supported formats for dump and restore are: .sql and .tar
|
||||
required: false
|
||||
default: present
|
||||
choices: [ "present", "absent", "dump", "restore" ]
|
||||
target:
|
||||
|
||||
@@ -24,36 +24,27 @@ options:
|
||||
description:
|
||||
- name of the extension to add or remove
|
||||
required: true
|
||||
default: null
|
||||
db:
|
||||
description:
|
||||
- name of the database to add or remove the extension to/from
|
||||
required: true
|
||||
default: null
|
||||
login_user:
|
||||
description:
|
||||
- The username used to authenticate with
|
||||
required: false
|
||||
default: null
|
||||
login_password:
|
||||
description:
|
||||
- The password used to authenticate with
|
||||
required: false
|
||||
default: null
|
||||
login_host:
|
||||
description:
|
||||
- Host running the database
|
||||
required: false
|
||||
default: localhost
|
||||
port:
|
||||
description:
|
||||
- Database port to connect to.
|
||||
required: false
|
||||
default: 5432
|
||||
state:
|
||||
description:
|
||||
- The database extension state
|
||||
required: false
|
||||
default: present
|
||||
choices: [ "present", "absent" ]
|
||||
notes:
|
||||
|
||||
@@ -36,63 +36,51 @@ options:
|
||||
description:
|
||||
- name of the procedural language to add, remove or change
|
||||
required: true
|
||||
default: null
|
||||
trust:
|
||||
description:
|
||||
- make this language trusted for the selected db
|
||||
required: false
|
||||
default: no
|
||||
type: bool
|
||||
default: 'no'
|
||||
choices: [ "yes", "no" ]
|
||||
db:
|
||||
description:
|
||||
- name of database where the language will be added, removed or changed
|
||||
required: false
|
||||
default: null
|
||||
force_trust:
|
||||
description:
|
||||
- marks the language as trusted, even if it's marked as untrusted in pg_pltemplate.
|
||||
- use with care!
|
||||
required: false
|
||||
default: no
|
||||
choices: [ "yes", "no" ]
|
||||
type: bool
|
||||
default: 'no'
|
||||
fail_on_drop:
|
||||
description:
|
||||
- if C(yes), fail when removing a language. Otherwise just log and continue
|
||||
- in some cases, it is not possible to remove a language (used by the db-system). When dependencies block the removal, consider using C(cascade).
|
||||
required: false
|
||||
type: bool
|
||||
default: 'yes'
|
||||
choices: [ "yes", "no" ]
|
||||
cascade:
|
||||
description:
|
||||
- when dropping a language, also delete object that depend on this language.
|
||||
- only used when C(state=absent).
|
||||
required: false
|
||||
default: no
|
||||
choices: [ "yes", "no" ]
|
||||
type: bool
|
||||
default: 'no'
|
||||
port:
|
||||
description:
|
||||
- Database port to connect to.
|
||||
required: false
|
||||
default: 5432
|
||||
login_user:
|
||||
description:
|
||||
- User used to authenticate with PostgreSQL
|
||||
required: false
|
||||
default: postgres
|
||||
login_password:
|
||||
description:
|
||||
- Password used to authenticate with PostgreSQL (must match C(login_user))
|
||||
required: false
|
||||
default: null
|
||||
login_host:
|
||||
description:
|
||||
- Host running PostgreSQL where you want to execute the actions.
|
||||
required: false
|
||||
default: localhost
|
||||
state:
|
||||
description:
|
||||
- The state of the language for the selected database
|
||||
required: false
|
||||
default: present
|
||||
choices: [ "present", "absent" ]
|
||||
notes:
|
||||
|
||||
@@ -33,18 +33,15 @@ options:
|
||||
description:
|
||||
- If C(present), the specified privileges are granted, if C(absent) they
|
||||
are revoked.
|
||||
required: no
|
||||
default: present
|
||||
choices: [present, absent]
|
||||
privs:
|
||||
description:
|
||||
- Comma separated list of privileges to grant/revoke.
|
||||
- 'Alias: I(priv)'
|
||||
required: no
|
||||
type:
|
||||
description:
|
||||
- Type of database object to set privileges on.
|
||||
required: no
|
||||
default: table
|
||||
choices: [table, sequence, function, database,
|
||||
schema, language, tablespace, group]
|
||||
@@ -61,13 +58,11 @@ options:
|
||||
replaced with commas (needed to specify function signatures, see
|
||||
examples)'
|
||||
- 'Alias: I(obj)'
|
||||
required: no
|
||||
schema:
|
||||
description:
|
||||
- Schema that contains the database objects specified via I(objs).
|
||||
- May only be provided if I(type) is C(table), C(sequence) or
|
||||
C(function). Defaults to C(public) in these cases.
|
||||
required: no
|
||||
roles:
|
||||
description:
|
||||
- Comma separated list of role (user/group) names to set permissions for.
|
||||
@@ -83,25 +78,19 @@ options:
|
||||
make no changes.
|
||||
- I(grant_option) only has an effect if I(state) is C(present).
|
||||
- 'Alias: I(admin_option)'
|
||||
required: no
|
||||
choices: ['yes', 'no']
|
||||
type: bool
|
||||
host:
|
||||
description:
|
||||
- Database host address. If unspecified, connect via Unix socket.
|
||||
- 'Alias: I(login_host)'
|
||||
default: null
|
||||
required: no
|
||||
port:
|
||||
description:
|
||||
- Database port to connect to.
|
||||
required: no
|
||||
default: 5432
|
||||
unix_socket:
|
||||
description:
|
||||
- Path to a Unix domain socket for local connections.
|
||||
- 'Alias: I(login_unix_socket)'
|
||||
required: false
|
||||
default: null
|
||||
login:
|
||||
description:
|
||||
- The username to authenticate with.
|
||||
@@ -111,14 +100,11 @@ options:
|
||||
description:
|
||||
- The password to authenticate with.
|
||||
- 'Alias: I(login_password))'
|
||||
default: null
|
||||
required: no
|
||||
ssl_mode:
|
||||
description:
|
||||
- Determines whether or with what priority a secure SSL TCP/IP connection will be negotiated with the server.
|
||||
- See https://www.postgresql.org/docs/current/static/libpq-ssl.html for more information on the modes.
|
||||
- Default of C(prefer) matches libpq default.
|
||||
required: false
|
||||
default: prefer
|
||||
choices: [disable, allow, prefer, require, verify-ca, verify-full]
|
||||
version_added: '2.3'
|
||||
@@ -126,8 +112,6 @@ options:
|
||||
description:
|
||||
- Specifies the name of a file containing SSL certificate authority (CA) certificate(s). If the file exists, the server's certificate will be
|
||||
verified to be signed by one of these authorities.
|
||||
required: false
|
||||
default: null
|
||||
version_added: '2.3'
|
||||
notes:
|
||||
- Default authentication assumes that postgresql_privs is run by the
|
||||
|
||||
@@ -24,46 +24,33 @@ options:
|
||||
description:
|
||||
- Name of the schema to add or remove.
|
||||
required: true
|
||||
default: null
|
||||
database:
|
||||
description:
|
||||
- Name of the database to connect to.
|
||||
required: false
|
||||
default: postgres
|
||||
login_user:
|
||||
description:
|
||||
- The username used to authenticate with.
|
||||
required: false
|
||||
default: null
|
||||
login_password:
|
||||
description:
|
||||
- The password used to authenticate with.
|
||||
required: false
|
||||
default: null
|
||||
login_host:
|
||||
description:
|
||||
- Host running the database.
|
||||
required: false
|
||||
default: localhost
|
||||
login_unix_socket:
|
||||
description:
|
||||
- Path to a Unix domain socket for local connections.
|
||||
required: false
|
||||
default: null
|
||||
owner:
|
||||
description:
|
||||
- Name of the role to set as owner of the schema.
|
||||
required: false
|
||||
default: null
|
||||
port:
|
||||
description:
|
||||
- Database port to connect to.
|
||||
required: false
|
||||
default: 5432
|
||||
state:
|
||||
description:
|
||||
- The schema state.
|
||||
required: false
|
||||
default: present
|
||||
choices: [ "present", "absent" ]
|
||||
notes:
|
||||
|
||||
@@ -36,7 +36,6 @@ options:
|
||||
description:
|
||||
- name of the user (role) to add or remove
|
||||
required: true
|
||||
default: null
|
||||
password:
|
||||
description:
|
||||
- set the user's password, before 1.4 this was required.
|
||||
@@ -45,16 +44,14 @@ options:
|
||||
C('str[\\"md5\\"] + md5[ password + username ]'), resulting in a total of 35 characters. An easy way to do this is:
|
||||
C(echo \\"md5`echo -n \\"verysecretpasswordJOE\\" | md5`\\"). Note that if the provided password string is already in
|
||||
MD5-hashed format, then it is used as-is, regardless of encrypted parameter.
|
||||
default: null
|
||||
db:
|
||||
description:
|
||||
- name of database where permissions will be granted
|
||||
default: null
|
||||
fail_on_user:
|
||||
description:
|
||||
- if C(yes), fail when user can't be removed. Otherwise just log and continue
|
||||
type: bool
|
||||
default: 'yes'
|
||||
choices: [ yes, no ]
|
||||
port:
|
||||
description:
|
||||
- Database port to connect to.
|
||||
@@ -66,7 +63,6 @@ options:
|
||||
login_password:
|
||||
description:
|
||||
- Password used to authenticate with PostgreSQL
|
||||
default: null
|
||||
login_host:
|
||||
description:
|
||||
- Host running PostgreSQL.
|
||||
@@ -74,11 +70,9 @@ options:
|
||||
login_unix_socket:
|
||||
description:
|
||||
- Path to a Unix domain socket for local connections
|
||||
default: null
|
||||
priv:
|
||||
description:
|
||||
- "PostgreSQL privileges string in the format: C(table:priv1,priv2)"
|
||||
default: null
|
||||
role_attr_flags:
|
||||
description:
|
||||
- "PostgreSQL role attributes string in the format: CREATEDB,CREATEROLE,SUPERUSER"
|
||||
@@ -94,21 +88,19 @@ options:
|
||||
description:
|
||||
- whether the password is stored hashed in the database. boolean. Passwords can be passed already hashed or unhashed, and postgresql ensures the
|
||||
stored password is hashed when encrypted is set.
|
||||
default: false
|
||||
version_added: '1.4'
|
||||
expires:
|
||||
description:
|
||||
- The date at which the user's password is to expire.
|
||||
- If set to C('infinity'), user's password never expire.
|
||||
- Note that this value should be a valid SQL date and time type.
|
||||
default: null
|
||||
version_added: '1.4'
|
||||
no_password_changes:
|
||||
description:
|
||||
- if C(yes), don't inspect database for password changes. Effective when C(pg_authid) is not accessible (such as AWS RDS). Otherwise, make
|
||||
password changes as necessary.
|
||||
type: bool
|
||||
default: 'no'
|
||||
choices: [ yes, no ]
|
||||
version_added: '2.0'
|
||||
ssl_mode:
|
||||
description:
|
||||
@@ -122,12 +114,10 @@ options:
|
||||
description:
|
||||
- Specifies the name of a file containing SSL certificate authority (CA) certificate(s). If the file exists, the server's certificate will be
|
||||
verified to be signed by one of these authorities.
|
||||
default: null
|
||||
version_added: '2.3'
|
||||
conn_limit:
|
||||
description:
|
||||
- Specifies the user connection limit.
|
||||
default: null
|
||||
version_added: '2.4'
|
||||
notes:
|
||||
- The default authentication assumes that you are either logging in as or
|
||||
|
||||
@@ -32,28 +32,21 @@ options:
|
||||
db:
|
||||
description:
|
||||
- Name of the Vertica database.
|
||||
required: false
|
||||
default: null
|
||||
cluster:
|
||||
description:
|
||||
- Name of the Vertica cluster.
|
||||
required: false
|
||||
default: localhost
|
||||
port:
|
||||
description:
|
||||
- Vertica cluster port to connect to.
|
||||
required: false
|
||||
default: 5433
|
||||
login_user:
|
||||
description:
|
||||
- The username used to authenticate with.
|
||||
required: false
|
||||
default: dbadmin
|
||||
login_password:
|
||||
description:
|
||||
- The password used to authenticate with.
|
||||
required: false
|
||||
default: null
|
||||
notes:
|
||||
- The default authentication assumes that you are either logging in as or sudo'ing
|
||||
to the C(dbadmin) account on the host.
|
||||
|
||||
@@ -24,28 +24,21 @@ options:
|
||||
cluster:
|
||||
description:
|
||||
- Name of the cluster running the schema.
|
||||
required: false
|
||||
default: localhost
|
||||
port:
|
||||
description:
|
||||
Database port to connect to.
|
||||
required: false
|
||||
default: 5433
|
||||
db:
|
||||
description:
|
||||
- Name of the database running the schema.
|
||||
required: false
|
||||
default: null
|
||||
login_user:
|
||||
description:
|
||||
- The username used to authenticate with.
|
||||
required: false
|
||||
default: dbadmin
|
||||
login_password:
|
||||
description:
|
||||
- The password used to authenticate with.
|
||||
required: false
|
||||
default: null
|
||||
notes:
|
||||
- The default authentication assumes that you are either logging in as or sudo'ing
|
||||
to the C(dbadmin) account on the host.
|
||||
|
||||
@@ -29,39 +29,29 @@ options:
|
||||
description:
|
||||
- Comma separated list of roles to assign to the role.
|
||||
aliases: ['assigned_role']
|
||||
required: false
|
||||
default: null
|
||||
state:
|
||||
description:
|
||||
- Whether to create C(present), drop C(absent) or lock C(locked) a role.
|
||||
required: false
|
||||
choices: ['present', 'absent']
|
||||
default: present
|
||||
db:
|
||||
description:
|
||||
- Name of the Vertica database.
|
||||
required: false
|
||||
default: null
|
||||
cluster:
|
||||
description:
|
||||
- Name of the Vertica cluster.
|
||||
required: false
|
||||
default: localhost
|
||||
port:
|
||||
description:
|
||||
- Vertica cluster port to connect to.
|
||||
required: false
|
||||
default: 5433
|
||||
login_user:
|
||||
description:
|
||||
- The username used to authenticate with.
|
||||
required: false
|
||||
default: dbadmin
|
||||
login_password:
|
||||
description:
|
||||
- The password used to authenticate with.
|
||||
required: false
|
||||
default: null
|
||||
notes:
|
||||
- The default authentication assumes that you are either logging in as or sudo'ing
|
||||
to the C(dbadmin) account on the host.
|
||||
|
||||
@@ -34,50 +34,36 @@ options:
|
||||
description:
|
||||
- Comma separated list of roles to create and grant usage access to the schema.
|
||||
aliases: ['usage_role']
|
||||
required: false
|
||||
default: null
|
||||
create_roles:
|
||||
description:
|
||||
- Comma separated list of roles to create and grant usage and create access to the schema.
|
||||
aliases: ['create_role']
|
||||
required: false
|
||||
default: null
|
||||
owner:
|
||||
description:
|
||||
- Name of the user to set as owner of the schema.
|
||||
required: false
|
||||
default: null
|
||||
state:
|
||||
description:
|
||||
- Whether to create C(present), or drop C(absent) a schema.
|
||||
required: false
|
||||
default: present
|
||||
choices: ['present', 'absent']
|
||||
db:
|
||||
description:
|
||||
- Name of the Vertica database.
|
||||
required: false
|
||||
default: null
|
||||
cluster:
|
||||
description:
|
||||
- Name of the Vertica cluster.
|
||||
required: false
|
||||
default: localhost
|
||||
port:
|
||||
description:
|
||||
- Vertica cluster port to connect to.
|
||||
required: false
|
||||
default: 5433
|
||||
login_user:
|
||||
description:
|
||||
- The username used to authenticate with.
|
||||
required: false
|
||||
default: dbadmin
|
||||
login_password:
|
||||
description:
|
||||
- The password used to authenticate with.
|
||||
required: false
|
||||
default: null
|
||||
notes:
|
||||
- The default authentication assumes that you are either logging in as or sudo'ing
|
||||
to the C(dbadmin) account on the host.
|
||||
|
||||
@@ -30,69 +30,49 @@ options:
|
||||
profile:
|
||||
description:
|
||||
- Sets the user's profile.
|
||||
required: false
|
||||
default: null
|
||||
resource_pool:
|
||||
description:
|
||||
- Sets the user's resource pool.
|
||||
required: false
|
||||
default: null
|
||||
password:
|
||||
description:
|
||||
- The user's password encrypted by the MD5 algorithm.
|
||||
- The password must be generated with the format C("md5" + md5[password + username]),
|
||||
resulting in a total of 35 characters. An easy way to do this is by querying
|
||||
the Vertica database with select 'md5'||md5('<user_password><user_name>').
|
||||
required: false
|
||||
default: null
|
||||
expired:
|
||||
description:
|
||||
- Sets the user's password expiration.
|
||||
required: false
|
||||
default: null
|
||||
ldap:
|
||||
description:
|
||||
- Set to true if users are authenticated via LDAP.
|
||||
- The user will be created with password expired and set to I($ldap$).
|
||||
required: false
|
||||
default: null
|
||||
roles:
|
||||
description:
|
||||
- Comma separated list of roles to assign to the user.
|
||||
aliases: ['role']
|
||||
required: false
|
||||
default: null
|
||||
state:
|
||||
description:
|
||||
- Whether to create C(present), drop C(absent) or lock C(locked) a user.
|
||||
required: false
|
||||
choices: ['present', 'absent', 'locked']
|
||||
default: present
|
||||
db:
|
||||
description:
|
||||
- Name of the Vertica database.
|
||||
required: false
|
||||
default: null
|
||||
cluster:
|
||||
description:
|
||||
- Name of the Vertica cluster.
|
||||
required: false
|
||||
default: localhost
|
||||
port:
|
||||
description:
|
||||
- Vertica cluster port to connect to.
|
||||
required: false
|
||||
default: 5433
|
||||
login_user:
|
||||
description:
|
||||
- The username used to authenticate with.
|
||||
required: false
|
||||
default: dbadmin
|
||||
login_password:
|
||||
description:
|
||||
- The password used to authenticate with.
|
||||
required: false
|
||||
default: null
|
||||
notes:
|
||||
- The default authentication assumes that you are either logging in as or sudo'ing
|
||||
to the C(dbadmin) account on the host.
|
||||
|
||||
Reference in New Issue
Block a user