mirror of
https://github.com/ansible-collections/community.general.git
synced 2024-09-14 20:13:21 +02:00
Update version_added, update docs (#3542)
k: v in docs now Minor tweaks after https://github.com/ansible/ansible-modules-extras/pull/1883
This commit is contained in:
parent
fb610b7d07
commit
7e6fe97f57
1 changed files with 17 additions and 13 deletions
|
@ -19,44 +19,44 @@
|
||||||
DOCUMENTATION = '''
|
DOCUMENTATION = '''
|
||||||
---
|
---
|
||||||
module: postgresql_schema
|
module: postgresql_schema
|
||||||
short_description: Add or remove PostgreSQL schema from a remote host.
|
short_description: Add or remove PostgreSQL schema from a remote host
|
||||||
description:
|
description:
|
||||||
- Add or remove PostgreSQL schema from a remote host.
|
- Add or remove PostgreSQL schema from a remote host.
|
||||||
version_added: "2.2"
|
version_added: "2.3"
|
||||||
options:
|
options:
|
||||||
name:
|
name:
|
||||||
description:
|
description:
|
||||||
- name of the schema to add or remove
|
- Name of the schema to add or remove.
|
||||||
required: true
|
required: true
|
||||||
default: null
|
default: null
|
||||||
database:
|
database:
|
||||||
description:
|
description:
|
||||||
- name of the database to connect to
|
- Name of the database to connect to.
|
||||||
required: false
|
required: false
|
||||||
default: postgres
|
default: postgres
|
||||||
login_user:
|
login_user:
|
||||||
description:
|
description:
|
||||||
- The username used to authenticate with
|
- The username used to authenticate with.
|
||||||
required: false
|
required: false
|
||||||
default: null
|
default: null
|
||||||
login_password:
|
login_password:
|
||||||
description:
|
description:
|
||||||
- The password used to authenticate with
|
- The password used to authenticate with.
|
||||||
required: false
|
required: false
|
||||||
default: null
|
default: null
|
||||||
login_host:
|
login_host:
|
||||||
description:
|
description:
|
||||||
- Host running the database
|
- Host running the database.
|
||||||
required: false
|
required: false
|
||||||
default: localhost
|
default: localhost
|
||||||
login_unix_socket:
|
login_unix_socket:
|
||||||
description:
|
description:
|
||||||
- Path to a Unix domain socket for local connections
|
- Path to a Unix domain socket for local connections.
|
||||||
required: false
|
required: false
|
||||||
default: null
|
default: null
|
||||||
owner:
|
owner:
|
||||||
description:
|
description:
|
||||||
- Name of the role to set as owner of the schema
|
- Name of the role to set as owner of the schema.
|
||||||
required: false
|
required: false
|
||||||
default: null
|
default: null
|
||||||
port:
|
port:
|
||||||
|
@ -66,7 +66,7 @@ options:
|
||||||
default: 5432
|
default: 5432
|
||||||
state:
|
state:
|
||||||
description:
|
description:
|
||||||
- The schema state
|
- The schema state.
|
||||||
required: false
|
required: false
|
||||||
default: present
|
default: present
|
||||||
choices: [ "present", "absent" ]
|
choices: [ "present", "absent" ]
|
||||||
|
@ -79,9 +79,13 @@ author: "Flavien Chantelot <contact@flavien.io>"
|
||||||
|
|
||||||
EXAMPLES = '''
|
EXAMPLES = '''
|
||||||
# Create a new schema with name "acme"
|
# Create a new schema with name "acme"
|
||||||
- postgresql_schema: name=acme
|
- postgresql_schema:
|
||||||
|
name: acme
|
||||||
|
|
||||||
# Create a new schema "acme" with a user "bob" who will own it
|
# Create a new schema "acme" with a user "bob" who will own it
|
||||||
- postgresql_schema: name=acme owner=bob
|
- postgresql_schema:
|
||||||
|
name: acme
|
||||||
|
owner: bob
|
||||||
|
|
||||||
'''
|
'''
|
||||||
|
|
||||||
|
@ -261,6 +265,6 @@ def main():
|
||||||
# import module snippets
|
# import module snippets
|
||||||
from ansible.module_utils.basic import *
|
from ansible.module_utils.basic import *
|
||||||
from ansible.module_utils.database import *
|
from ansible.module_utils.database import *
|
||||||
|
|
||||||
if __name__ == '__main__':
|
if __name__ == '__main__':
|
||||||
main()
|
main()
|
||||||
|
|
||||||
|
|
Loading…
Reference in a new issue