mirror of
https://github.com/ansible-collections/community.general.git
synced 2025-07-22 12:50:22 -07: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:
parent
58eb2e849d
commit
cdd21e2170
624 changed files with 1458 additions and 9114 deletions
|
@ -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.
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue