mirror of
https://github.com/ansible-collections/community.general.git
synced 2024-09-14 20:13:21 +02:00
[PR #5966/b4a50010 backport][stable-6] Add attributes to more modules (2/4) (#6023)
Add attributes to more modules (2/4) (#5966)
Add attributes to more modules.
(cherry picked from commit b4a500103a
)
Co-authored-by: Felix Fontein <felix@fontein.de>
This commit is contained in:
parent
1bfdee0830
commit
94b4034fd2
32 changed files with 261 additions and 32 deletions
|
@ -19,6 +19,13 @@ description:
|
|||
- If waiting for migrations is not desired, simply just poll until
|
||||
port 3000 if available or asinfo -v status returns ok
|
||||
author: "Albert Autin (@Alb0t)"
|
||||
extends_documentation_fragment:
|
||||
- community.general.attributes
|
||||
attributes:
|
||||
check_mode:
|
||||
support: full
|
||||
diff_mode:
|
||||
support: none
|
||||
options:
|
||||
host:
|
||||
description:
|
||||
|
|
|
@ -18,6 +18,13 @@ author:
|
|||
short_description: Notify airbrake about app deployments
|
||||
description:
|
||||
- Notify airbrake about app deployments (see U(https://airbrake.io/docs/api/#deploys-v4)).
|
||||
extends_documentation_fragment:
|
||||
- community.general.attributes
|
||||
attributes:
|
||||
check_mode:
|
||||
support: full
|
||||
diff_mode:
|
||||
support: none
|
||||
options:
|
||||
project_id:
|
||||
description:
|
||||
|
|
|
@ -20,6 +20,13 @@ seealso:
|
|||
- name: API documentation
|
||||
description: Documentation for Alerta API
|
||||
link: https://docs.alerta.io/api/reference.html#customers
|
||||
extends_documentation_fragment:
|
||||
- community.general.attributes
|
||||
attributes:
|
||||
check_mode:
|
||||
support: full
|
||||
diff_mode:
|
||||
support: none
|
||||
options:
|
||||
customer:
|
||||
description:
|
||||
|
|
|
@ -18,6 +18,13 @@ description:
|
|||
- This modules allows for enable/disable/activate of I(awall) policies.
|
||||
- Alpine Wall (I(awall)) generates a firewall configuration from the enabled policy files
|
||||
and activates the configuration on the system.
|
||||
extends_documentation_fragment:
|
||||
- community.general.attributes
|
||||
attributes:
|
||||
check_mode:
|
||||
support: full
|
||||
diff_mode:
|
||||
support: none
|
||||
options:
|
||||
name:
|
||||
description:
|
||||
|
|
|
@ -14,6 +14,13 @@ description:
|
|||
- The M(community.general.bearychat) module sends notifications to U(https://bearychat.com)
|
||||
via the Incoming Robot integration.
|
||||
author: "Jiangge Zhang (@tonyseek)"
|
||||
extends_documentation_fragment:
|
||||
- community.general.attributes
|
||||
attributes:
|
||||
check_mode:
|
||||
support: none
|
||||
diff_mode:
|
||||
support: none
|
||||
options:
|
||||
url:
|
||||
type: str
|
||||
|
|
|
@ -15,6 +15,13 @@ author: "Hagai Kariti (@hkariti)"
|
|||
short_description: Notify BigPanda about deployments
|
||||
description:
|
||||
- Notify BigPanda when deployments start and end (successfully or not). Returns a deployment object containing all the parameters for future module calls.
|
||||
extends_documentation_fragment:
|
||||
- community.general.attributes
|
||||
attributes:
|
||||
check_mode:
|
||||
support: full
|
||||
diff_mode:
|
||||
support: none
|
||||
options:
|
||||
component:
|
||||
type: str
|
||||
|
|
|
@ -14,6 +14,13 @@ module: capabilities
|
|||
short_description: Manage Linux capabilities
|
||||
description:
|
||||
- This module manipulates files privileges using the Linux capabilities(7) system.
|
||||
extends_documentation_fragment:
|
||||
- community.general.attributes
|
||||
attributes:
|
||||
check_mode:
|
||||
support: full
|
||||
diff_mode:
|
||||
support: none
|
||||
options:
|
||||
path:
|
||||
description:
|
||||
|
|
|
@ -16,7 +16,14 @@ DOCUMENTATION = '''
|
|||
module: catapult
|
||||
short_description: Send a sms / mms using the catapult bandwidth api
|
||||
description:
|
||||
- Allows notifications to be sent using sms / mms via the catapult bandwidth api.
|
||||
- Allows notifications to be sent using sms / mms via the catapult bandwidth api.
|
||||
extends_documentation_fragment:
|
||||
- community.general.attributes
|
||||
attributes:
|
||||
check_mode:
|
||||
support: none
|
||||
diff_mode:
|
||||
support: none
|
||||
options:
|
||||
src:
|
||||
type: str
|
||||
|
|
|
@ -20,6 +20,13 @@ requirements:
|
|||
- requests (either >= 2.0.0 for Python 3, or >= 1.0.0 for Python 2)
|
||||
notes:
|
||||
- Check mode isn't supported.
|
||||
extends_documentation_fragment:
|
||||
- community.general.attributes
|
||||
attributes:
|
||||
check_mode:
|
||||
support: none
|
||||
diff_mode:
|
||||
support: none
|
||||
options:
|
||||
api_key:
|
||||
type: str
|
||||
|
|
|
@ -18,6 +18,13 @@ requirements:
|
|||
short_description: Manage Cloudflare DNS records
|
||||
description:
|
||||
- "Manages dns records via the Cloudflare API, see the docs: U(https://api.cloudflare.com/)."
|
||||
extends_documentation_fragment:
|
||||
- community.general.attributes
|
||||
attributes:
|
||||
check_mode:
|
||||
support: full
|
||||
diff_mode:
|
||||
support: none
|
||||
options:
|
||||
api_token:
|
||||
description:
|
||||
|
|
|
@ -17,6 +17,13 @@ short_description: Manages a Django application
|
|||
description:
|
||||
- Manages a Django application using the C(manage.py) application frontend to C(django-admin). With the
|
||||
I(virtualenv) parameter, all management commands will be executed by the given C(virtualenv) installation.
|
||||
extends_documentation_fragment:
|
||||
- community.general.attributes
|
||||
attributes:
|
||||
check_mode:
|
||||
support: none
|
||||
diff_mode:
|
||||
support: none
|
||||
options:
|
||||
command:
|
||||
description:
|
||||
|
|
|
@ -16,6 +16,13 @@ module: dnsimple
|
|||
short_description: Interface with dnsimple.com (a DNS hosting service)
|
||||
description:
|
||||
- "Manages domains and records via the DNSimple API, see the docs: U(http://developer.dnsimple.com/)."
|
||||
extends_documentation_fragment:
|
||||
- community.general.attributes
|
||||
attributes:
|
||||
check_mode:
|
||||
support: full
|
||||
diff_mode:
|
||||
support: none
|
||||
options:
|
||||
account_email:
|
||||
description:
|
||||
|
|
|
@ -17,6 +17,13 @@ description:
|
|||
- >
|
||||
Manages DNS records via the v2 REST API of the DNS Made Easy service. It handles records only; there is no manipulation of domains or
|
||||
monitor/account support yet. See: U(https://www.dnsmadeeasy.com/integration/restapi/)
|
||||
extends_documentation_fragment:
|
||||
- community.general.attributes
|
||||
attributes:
|
||||
check_mode:
|
||||
support: none
|
||||
diff_mode:
|
||||
support: none
|
||||
options:
|
||||
account_key:
|
||||
description:
|
||||
|
|
|
@ -18,6 +18,13 @@ requirements:
|
|||
- ejabberd with mod_admin_extra
|
||||
description:
|
||||
- This module provides user management for ejabberd servers
|
||||
extends_documentation_fragment:
|
||||
- community.general.attributes
|
||||
attributes:
|
||||
check_mode:
|
||||
support: full
|
||||
diff_mode:
|
||||
support: none
|
||||
options:
|
||||
username:
|
||||
type: str
|
||||
|
|
|
@ -18,6 +18,13 @@ description:
|
|||
author:
|
||||
- Mathew Davies (@ThePixelDeveloper)
|
||||
- Sam Doran (@samdoran)
|
||||
extends_documentation_fragment:
|
||||
- community.general.attributes
|
||||
attributes:
|
||||
check_mode:
|
||||
support: full
|
||||
diff_mode:
|
||||
support: none
|
||||
options:
|
||||
name:
|
||||
description:
|
||||
|
|
|
@ -23,8 +23,14 @@ description:
|
|||
- "This module manages the members of an existing storage group."
|
||||
|
||||
extends_documentation_fragment:
|
||||
- community.general.emc.emc_vnx
|
||||
- community.general.emc.emc_vnx
|
||||
- community.general.attributes
|
||||
|
||||
attributes:
|
||||
check_mode:
|
||||
support: full
|
||||
diff_mode:
|
||||
support: none
|
||||
|
||||
options:
|
||||
name:
|
||||
|
|
|
@ -16,6 +16,13 @@ description:
|
|||
- Runs the C(facter) discovery program
|
||||
(U(https://github.com/puppetlabs/facter)) on the remote system, returning
|
||||
JSON data that can be useful for inventory purposes.
|
||||
extends_documentation_fragment:
|
||||
- community.general.attributes
|
||||
attributes:
|
||||
check_mode:
|
||||
support: none
|
||||
diff_mode:
|
||||
support: none
|
||||
options:
|
||||
arguments:
|
||||
description:
|
||||
|
|
|
@ -15,7 +15,14 @@ module: flowdock
|
|||
author: "Matt Coddington (@mcodd)"
|
||||
short_description: Send a message to a flowdock
|
||||
description:
|
||||
- Send a message to a flowdock team inbox or chat using the push API (see https://www.flowdock.com/api/team-inbox and https://www.flowdock.com/api/chat)
|
||||
- Send a message to a flowdock team inbox or chat using the push API (see https://www.flowdock.com/api/team-inbox and https://www.flowdock.com/api/chat)
|
||||
extends_documentation_fragment:
|
||||
- community.general.attributes
|
||||
attributes:
|
||||
check_mode:
|
||||
support: full
|
||||
diff_mode:
|
||||
support: none
|
||||
options:
|
||||
token:
|
||||
type: str
|
||||
|
|
|
@ -12,11 +12,18 @@ DOCUMENTATION = r'''
|
|||
---
|
||||
module: gandi_livedns
|
||||
author:
|
||||
- Gregory Thiemonge (@gthiemonge)
|
||||
- Gregory Thiemonge (@gthiemonge)
|
||||
version_added: "2.3.0"
|
||||
short_description: Manage Gandi LiveDNS records
|
||||
description:
|
||||
- "Manages DNS records by the Gandi LiveDNS API, see the docs: U(https://doc.livedns.gandi.net/)."
|
||||
- "Manages DNS records by the Gandi LiveDNS API, see the docs: U(https://doc.livedns.gandi.net/)."
|
||||
extends_documentation_fragment:
|
||||
- community.general.attributes
|
||||
attributes:
|
||||
check_mode:
|
||||
support: full
|
||||
diff_mode:
|
||||
support: none
|
||||
options:
|
||||
api_key:
|
||||
description:
|
||||
|
@ -55,8 +62,6 @@ options:
|
|||
- The name of the Domain to work with (for example, "example.com").
|
||||
required: true
|
||||
type: str
|
||||
notes:
|
||||
- Supports C(check_mode).
|
||||
'''
|
||||
|
||||
EXAMPLES = r'''
|
||||
|
|
|
@ -16,6 +16,13 @@ short_description: Sends a notification to a grove.io channel
|
|||
description:
|
||||
- The C(grove) module sends a message for a service to a Grove.io
|
||||
channel.
|
||||
extends_documentation_fragment:
|
||||
- community.general.attributes
|
||||
attributes:
|
||||
check_mode:
|
||||
support: none
|
||||
diff_mode:
|
||||
support: none
|
||||
options:
|
||||
channel_token:
|
||||
type: str
|
||||
|
|
|
@ -14,14 +14,21 @@ DOCUMENTATION = '''
|
|||
module: gunicorn
|
||||
short_description: Run gunicorn with various settings
|
||||
description:
|
||||
- Starts gunicorn with the parameters specified. Common settings for gunicorn
|
||||
configuration are supported. For additional configuration use a config file
|
||||
See U(https://gunicorn-docs.readthedocs.io/en/latest/settings.html) for more
|
||||
options. It's recommended to always use the chdir option to avoid problems
|
||||
with the location of the app.
|
||||
- Starts gunicorn with the parameters specified. Common settings for gunicorn
|
||||
configuration are supported. For additional configuration use a config file
|
||||
See U(https://gunicorn-docs.readthedocs.io/en/latest/settings.html) for more
|
||||
options. It's recommended to always use the chdir option to avoid problems
|
||||
with the location of the app.
|
||||
requirements: [gunicorn]
|
||||
author:
|
||||
- "Alejandro Gomez (@agmezr)"
|
||||
extends_documentation_fragment:
|
||||
- community.general.attributes
|
||||
attributes:
|
||||
check_mode:
|
||||
support: none
|
||||
diff_mode:
|
||||
support: none
|
||||
options:
|
||||
app:
|
||||
type: str
|
||||
|
|
|
@ -13,7 +13,7 @@ DOCUMENTATION = r'''
|
|||
module: haproxy
|
||||
short_description: Enable, disable, and set weights for HAProxy backend servers using socket commands
|
||||
author:
|
||||
- Ravi Bhure (@ravibhure)
|
||||
- Ravi Bhure (@ravibhure)
|
||||
description:
|
||||
- Enable, disable, drain and set weights for HAProxy backend servers using socket commands.
|
||||
notes:
|
||||
|
@ -23,6 +23,13 @@ notes:
|
|||
haproxy.cfg. See U(http://haproxy.1wt.eu/download/1.5/doc/configuration.txt).
|
||||
- Depends on netcat (C(nc)) being available; you need to install the appropriate
|
||||
package for your operating system before this module can be used.
|
||||
extends_documentation_fragment:
|
||||
- community.general.attributes
|
||||
attributes:
|
||||
check_mode:
|
||||
support: none
|
||||
diff_mode:
|
||||
support: none
|
||||
options:
|
||||
backend:
|
||||
description:
|
||||
|
|
|
@ -15,6 +15,11 @@ short_description: Manage user files for basic authentication
|
|||
description:
|
||||
- Add and remove username/password entries in a password file using htpasswd.
|
||||
- This is used by web servers such as Apache and Nginx for basic authentication.
|
||||
attributes:
|
||||
check_mode:
|
||||
support: full
|
||||
diff_mode:
|
||||
support: none
|
||||
options:
|
||||
path:
|
||||
type: path
|
||||
|
@ -68,7 +73,9 @@ notes:
|
|||
- "On RHEL or CentOS: Enable EPEL, then install I(python-passlib)."
|
||||
requirements: [ passlib>=1.6 ]
|
||||
author: "Ansible Core Team"
|
||||
extends_documentation_fragment: files
|
||||
extends_documentation_fragment:
|
||||
- files
|
||||
- community.general.attributes
|
||||
'''
|
||||
|
||||
EXAMPLES = """
|
||||
|
|
|
@ -14,14 +14,23 @@ DOCUMENTATION = r'''
|
|||
module: iso_create
|
||||
short_description: Generate ISO file with specified files or folders
|
||||
description:
|
||||
- This module is used to generate ISO file with specified path of files.
|
||||
- This module is used to generate ISO file with specified path of files.
|
||||
author:
|
||||
- Diane Wang (@Tomorrow9) <dianew@vmware.com>
|
||||
- Diane Wang (@Tomorrow9) <dianew@vmware.com>
|
||||
requirements:
|
||||
- "pycdlib"
|
||||
- "python >= 2.7"
|
||||
- "pycdlib"
|
||||
- "python >= 2.7"
|
||||
version_added: '0.2.0'
|
||||
|
||||
extends_documentation_fragment:
|
||||
- community.general.attributes
|
||||
|
||||
attributes:
|
||||
check_mode:
|
||||
support: full
|
||||
diff_mode:
|
||||
support: none
|
||||
|
||||
options:
|
||||
src_files:
|
||||
description:
|
||||
|
|
|
@ -23,6 +23,15 @@ requirements:
|
|||
- "python >= 2.7"
|
||||
version_added: '5.8.0'
|
||||
|
||||
extends_documentation_fragment:
|
||||
- community.general.attributes
|
||||
|
||||
attributes:
|
||||
check_mode:
|
||||
support: full
|
||||
diff_mode:
|
||||
support: none
|
||||
|
||||
options:
|
||||
src_iso:
|
||||
description:
|
||||
|
|
|
@ -14,22 +14,29 @@ __metaclass__ = type
|
|||
DOCUMENTATION = r'''
|
||||
---
|
||||
author:
|
||||
- Jeroen Hoekx (@jhoekx)
|
||||
- Matt Robinson (@ribbons)
|
||||
- Dag Wieers (@dagwieers)
|
||||
- Jeroen Hoekx (@jhoekx)
|
||||
- Matt Robinson (@ribbons)
|
||||
- Dag Wieers (@dagwieers)
|
||||
module: iso_extract
|
||||
short_description: Extract files from an ISO image
|
||||
description:
|
||||
- This module has two possible ways of operation.
|
||||
- If 7zip is installed on the system, this module extracts files from an ISO
|
||||
into a temporary directory and copies files to a given destination,
|
||||
if needed.
|
||||
- If the user has mount-capabilities (CAP_SYS_ADMIN on Linux) this module
|
||||
mounts the ISO image to a temporary location, and copies files to a given
|
||||
destination, if needed.
|
||||
- This module has two possible ways of operation.
|
||||
- If 7zip is installed on the system, this module extracts files from an ISO
|
||||
into a temporary directory and copies files to a given destination,
|
||||
if needed.
|
||||
- If the user has mount-capabilities (CAP_SYS_ADMIN on Linux) this module
|
||||
mounts the ISO image to a temporary location, and copies files to a given
|
||||
destination, if needed.
|
||||
requirements:
|
||||
- Either 7z (from C(7zip) or C(p7zip) package)
|
||||
- Or mount capabilities (root-access, or CAP_SYS_ADMIN capability on Linux)
|
||||
- Either 7z (from C(7zip) or C(p7zip) package)
|
||||
- Or mount capabilities (root-access, or CAP_SYS_ADMIN capability on Linux)
|
||||
extends_documentation_fragment:
|
||||
- community.general.attributes
|
||||
attributes:
|
||||
check_mode:
|
||||
support: full
|
||||
diff_mode:
|
||||
support: none
|
||||
options:
|
||||
image:
|
||||
description:
|
||||
|
|
|
@ -14,6 +14,13 @@ module: jboss
|
|||
short_description: Deploy applications to JBoss
|
||||
description:
|
||||
- Deploy applications to JBoss standalone using the filesystem.
|
||||
extends_documentation_fragment:
|
||||
- community.general.attributes
|
||||
attributes:
|
||||
check_mode:
|
||||
support: full
|
||||
diff_mode:
|
||||
support: none
|
||||
options:
|
||||
deployment:
|
||||
required: true
|
||||
|
|
|
@ -20,6 +20,15 @@ short_description: Create and modify issues in a JIRA instance
|
|||
description:
|
||||
- Create and modify issues in a JIRA instance.
|
||||
|
||||
extends_documentation_fragment:
|
||||
- community.general.attributes
|
||||
|
||||
attributes:
|
||||
check_mode:
|
||||
support: none
|
||||
diff_mode:
|
||||
support: none
|
||||
|
||||
options:
|
||||
uri:
|
||||
type: str
|
||||
|
|
|
@ -18,6 +18,13 @@ short_description: Manage Kibana plugins
|
|||
description:
|
||||
- This module can be used to manage Kibana plugins.
|
||||
author: Thierno IB. BARRY (@barryib)
|
||||
extends_documentation_fragment:
|
||||
- community.general.attributes
|
||||
attributes:
|
||||
check_mode:
|
||||
support: full
|
||||
diff_mode:
|
||||
support: none
|
||||
options:
|
||||
name:
|
||||
description:
|
||||
|
|
|
@ -17,7 +17,16 @@ short_description: Local Backup Utility for Alpine Linux
|
|||
version_added: '0.2.0'
|
||||
|
||||
description:
|
||||
- Manage Local Backup Utility of Alpine Linux in run-from-RAM mode
|
||||
- Manage Local Backup Utility of Alpine Linux in run-from-RAM mode
|
||||
|
||||
extends_documentation_fragment:
|
||||
- community.general.attributes
|
||||
|
||||
attributes:
|
||||
check_mode:
|
||||
support: full
|
||||
diff_mode:
|
||||
support: none
|
||||
|
||||
options:
|
||||
commit:
|
||||
|
@ -36,7 +45,7 @@ options:
|
|||
elements: str
|
||||
|
||||
author:
|
||||
- Kaarle Ritvanen (@kunkku)
|
||||
- Kaarle Ritvanen (@kunkku)
|
||||
'''
|
||||
|
||||
EXAMPLES = '''
|
||||
|
|
|
@ -16,6 +16,13 @@ requirements: [ lldpctl ]
|
|||
short_description: Get details reported by lldp
|
||||
description:
|
||||
- Reads data out of lldpctl
|
||||
extends_documentation_fragment:
|
||||
- community.general.attributes
|
||||
attributes:
|
||||
check_mode:
|
||||
support: none
|
||||
diff_mode:
|
||||
support: none
|
||||
options: {}
|
||||
author: "Andy Hill (@andyhky)"
|
||||
notes:
|
||||
|
|
|
@ -15,6 +15,13 @@ short_description: Manage Logstash plugins
|
|||
description:
|
||||
- Manages Logstash plugins.
|
||||
author: Loic Blot (@nerzhul)
|
||||
extends_documentation_fragment:
|
||||
- community.general.attributes
|
||||
attributes:
|
||||
check_mode:
|
||||
support: full
|
||||
diff_mode:
|
||||
support: none
|
||||
options:
|
||||
name:
|
||||
type: str
|
||||
|
|
Loading…
Reference in a new issue