1
0
Fork 0
mirror of https://github.com/ansible-collections/community.general.git synced 2024-09-14 20:13:21 +02:00

Add attributes to more modules (2/4) (#5966)

Add attributes to more modules.
This commit is contained in:
Felix Fontein 2023-02-20 17:29:41 +01:00 committed by GitHub
parent 0ef805699d
commit b4a500103a
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
32 changed files with 261 additions and 32 deletions

View file

@ -19,6 +19,13 @@ description:
- If waiting for migrations is not desired, simply just poll until - If waiting for migrations is not desired, simply just poll until
port 3000 if available or asinfo -v status returns ok port 3000 if available or asinfo -v status returns ok
author: "Albert Autin (@Alb0t)" author: "Albert Autin (@Alb0t)"
extends_documentation_fragment:
- community.general.attributes
attributes:
check_mode:
support: full
diff_mode:
support: none
options: options:
host: host:
description: description:

View file

@ -18,6 +18,13 @@ author:
short_description: Notify airbrake about app deployments short_description: Notify airbrake about app deployments
description: description:
- Notify airbrake about app deployments (see U(https://airbrake.io/docs/api/#deploys-v4)). - 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: options:
project_id: project_id:
description: description:

View file

@ -20,6 +20,13 @@ seealso:
- name: API documentation - name: API documentation
description: Documentation for Alerta API description: Documentation for Alerta API
link: https://docs.alerta.io/api/reference.html#customers 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: options:
customer: customer:
description: description:

View file

@ -18,6 +18,13 @@ description:
- This modules allows for enable/disable/activate of I(awall) policies. - This modules allows for enable/disable/activate of I(awall) policies.
- Alpine Wall (I(awall)) generates a firewall configuration from the enabled policy files - Alpine Wall (I(awall)) generates a firewall configuration from the enabled policy files
and activates the configuration on the system. and activates the configuration on the system.
extends_documentation_fragment:
- community.general.attributes
attributes:
check_mode:
support: full
diff_mode:
support: none
options: options:
name: name:
description: description:

View file

@ -14,6 +14,13 @@ description:
- The M(community.general.bearychat) module sends notifications to U(https://bearychat.com) - The M(community.general.bearychat) module sends notifications to U(https://bearychat.com)
via the Incoming Robot integration. via the Incoming Robot integration.
author: "Jiangge Zhang (@tonyseek)" author: "Jiangge Zhang (@tonyseek)"
extends_documentation_fragment:
- community.general.attributes
attributes:
check_mode:
support: none
diff_mode:
support: none
options: options:
url: url:
type: str type: str

View file

@ -15,6 +15,13 @@ author: "Hagai Kariti (@hkariti)"
short_description: Notify BigPanda about deployments short_description: Notify BigPanda about deployments
description: description:
- Notify BigPanda when deployments start and end (successfully or not). Returns a deployment object containing all the parameters for future module calls. - 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: options:
component: component:
type: str type: str

View file

@ -14,6 +14,13 @@ module: capabilities
short_description: Manage Linux capabilities short_description: Manage Linux capabilities
description: description:
- This module manipulates files privileges using the Linux capabilities(7) system. - 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: options:
path: path:
description: description:

View file

@ -16,7 +16,14 @@ DOCUMENTATION = '''
module: catapult module: catapult
short_description: Send a sms / mms using the catapult bandwidth api short_description: Send a sms / mms using the catapult bandwidth api
description: 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: options:
src: src:
type: str type: str

View file

@ -20,6 +20,13 @@ requirements:
- requests (either >= 2.0.0 for Python 3, or >= 1.0.0 for Python 2) - requests (either >= 2.0.0 for Python 3, or >= 1.0.0 for Python 2)
notes: notes:
- Check mode isn't supported. - Check mode isn't supported.
extends_documentation_fragment:
- community.general.attributes
attributes:
check_mode:
support: none
diff_mode:
support: none
options: options:
api_key: api_key:
type: str type: str

View file

@ -18,6 +18,13 @@ requirements:
short_description: Manage Cloudflare DNS records short_description: Manage Cloudflare DNS records
description: description:
- "Manages dns records via the Cloudflare API, see the docs: U(https://api.cloudflare.com/)." - "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: options:
api_token: api_token:
description: description:

View file

@ -17,6 +17,13 @@ short_description: Manages a Django application
description: description:
- Manages a Django application using the C(manage.py) application frontend to C(django-admin). With the - 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. 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: options:
command: command:
description: description:

View file

@ -16,6 +16,13 @@ module: dnsimple
short_description: Interface with dnsimple.com (a DNS hosting service) short_description: Interface with dnsimple.com (a DNS hosting service)
description: description:
- "Manages domains and records via the DNSimple API, see the docs: U(http://developer.dnsimple.com/)." - "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: options:
account_email: account_email:
description: description:

View file

@ -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 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/) 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: options:
account_key: account_key:
description: description:

View file

@ -18,6 +18,13 @@ requirements:
- ejabberd with mod_admin_extra - ejabberd with mod_admin_extra
description: description:
- This module provides user management for ejabberd servers - This module provides user management for ejabberd servers
extends_documentation_fragment:
- community.general.attributes
attributes:
check_mode:
support: full
diff_mode:
support: none
options: options:
username: username:
type: str type: str

View file

@ -18,6 +18,13 @@ description:
author: author:
- Mathew Davies (@ThePixelDeveloper) - Mathew Davies (@ThePixelDeveloper)
- Sam Doran (@samdoran) - Sam Doran (@samdoran)
extends_documentation_fragment:
- community.general.attributes
attributes:
check_mode:
support: full
diff_mode:
support: none
options: options:
name: name:
description: description:

View file

@ -23,8 +23,14 @@ description:
- "This module manages the members of an existing storage group." - "This module manages the members of an existing storage group."
extends_documentation_fragment: 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: options:
name: name:

View file

@ -16,6 +16,13 @@ description:
- Runs the C(facter) discovery program - Runs the C(facter) discovery program
(U(https://github.com/puppetlabs/facter)) on the remote system, returning (U(https://github.com/puppetlabs/facter)) on the remote system, returning
JSON data that can be useful for inventory purposes. 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: options:
arguments: arguments:
description: description:

View file

@ -15,7 +15,14 @@ module: flowdock
author: "Matt Coddington (@mcodd)" author: "Matt Coddington (@mcodd)"
short_description: Send a message to a flowdock short_description: Send a message to a flowdock
description: 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: options:
token: token:
type: str type: str

View file

@ -12,11 +12,18 @@ DOCUMENTATION = r'''
--- ---
module: gandi_livedns module: gandi_livedns
author: author:
- Gregory Thiemonge (@gthiemonge) - Gregory Thiemonge (@gthiemonge)
version_added: "2.3.0" version_added: "2.3.0"
short_description: Manage Gandi LiveDNS records short_description: Manage Gandi LiveDNS records
description: 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: options:
api_key: api_key:
description: description:
@ -55,8 +62,6 @@ options:
- The name of the Domain to work with (for example, "example.com"). - The name of the Domain to work with (for example, "example.com").
required: true required: true
type: str type: str
notes:
- Supports C(check_mode).
''' '''
EXAMPLES = r''' EXAMPLES = r'''

View file

@ -16,6 +16,13 @@ short_description: Sends a notification to a grove.io channel
description: description:
- The C(grove) module sends a message for a service to a Grove.io - The C(grove) module sends a message for a service to a Grove.io
channel. channel.
extends_documentation_fragment:
- community.general.attributes
attributes:
check_mode:
support: none
diff_mode:
support: none
options: options:
channel_token: channel_token:
type: str type: str

View file

@ -14,14 +14,21 @@ DOCUMENTATION = '''
module: gunicorn module: gunicorn
short_description: Run gunicorn with various settings short_description: Run gunicorn with various settings
description: description:
- Starts gunicorn with the parameters specified. Common settings for gunicorn - Starts gunicorn with the parameters specified. Common settings for gunicorn
configuration are supported. For additional configuration use a config file configuration are supported. For additional configuration use a config file
See U(https://gunicorn-docs.readthedocs.io/en/latest/settings.html) for more 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 options. It's recommended to always use the chdir option to avoid problems
with the location of the app. with the location of the app.
requirements: [gunicorn] requirements: [gunicorn]
author: author:
- "Alejandro Gomez (@agmezr)" - "Alejandro Gomez (@agmezr)"
extends_documentation_fragment:
- community.general.attributes
attributes:
check_mode:
support: none
diff_mode:
support: none
options: options:
app: app:
type: str type: str

View file

@ -13,7 +13,7 @@ DOCUMENTATION = r'''
module: haproxy module: haproxy
short_description: Enable, disable, and set weights for HAProxy backend servers using socket commands short_description: Enable, disable, and set weights for HAProxy backend servers using socket commands
author: author:
- Ravi Bhure (@ravibhure) - Ravi Bhure (@ravibhure)
description: description:
- Enable, disable, drain and set weights for HAProxy backend servers using socket commands. - Enable, disable, drain and set weights for HAProxy backend servers using socket commands.
notes: notes:
@ -23,6 +23,13 @@ notes:
haproxy.cfg. See U(http://haproxy.1wt.eu/download/1.5/doc/configuration.txt). 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 - Depends on netcat (C(nc)) being available; you need to install the appropriate
package for your operating system before this module can be used. 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: options:
backend: backend:
description: description:

View file

@ -15,6 +15,11 @@ short_description: Manage user files for basic authentication
description: description:
- Add and remove username/password entries in a password file using htpasswd. - 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. - This is used by web servers such as Apache and Nginx for basic authentication.
attributes:
check_mode:
support: full
diff_mode:
support: none
options: options:
path: path:
type: path type: path
@ -68,7 +73,9 @@ notes:
- "On RHEL or CentOS: Enable EPEL, then install I(python-passlib)." - "On RHEL or CentOS: Enable EPEL, then install I(python-passlib)."
requirements: [ passlib>=1.6 ] requirements: [ passlib>=1.6 ]
author: "Ansible Core Team" author: "Ansible Core Team"
extends_documentation_fragment: files extends_documentation_fragment:
- files
- community.general.attributes
''' '''
EXAMPLES = """ EXAMPLES = """

View file

@ -14,14 +14,23 @@ DOCUMENTATION = r'''
module: iso_create module: iso_create
short_description: Generate ISO file with specified files or folders short_description: Generate ISO file with specified files or folders
description: 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: author:
- Diane Wang (@Tomorrow9) <dianew@vmware.com> - Diane Wang (@Tomorrow9) <dianew@vmware.com>
requirements: requirements:
- "pycdlib" - "pycdlib"
- "python >= 2.7" - "python >= 2.7"
version_added: '0.2.0' version_added: '0.2.0'
extends_documentation_fragment:
- community.general.attributes
attributes:
check_mode:
support: full
diff_mode:
support: none
options: options:
src_files: src_files:
description: description:

View file

@ -23,6 +23,15 @@ requirements:
- "python >= 2.7" - "python >= 2.7"
version_added: '5.8.0' version_added: '5.8.0'
extends_documentation_fragment:
- community.general.attributes
attributes:
check_mode:
support: full
diff_mode:
support: none
options: options:
src_iso: src_iso:
description: description:

View file

@ -14,22 +14,29 @@ __metaclass__ = type
DOCUMENTATION = r''' DOCUMENTATION = r'''
--- ---
author: author:
- Jeroen Hoekx (@jhoekx) - Jeroen Hoekx (@jhoekx)
- Matt Robinson (@ribbons) - Matt Robinson (@ribbons)
- Dag Wieers (@dagwieers) - Dag Wieers (@dagwieers)
module: iso_extract module: iso_extract
short_description: Extract files from an ISO image short_description: Extract files from an ISO image
description: description:
- This module has two possible ways of operation. - This module has two possible ways of operation.
- If 7zip is installed on the system, this module extracts files from an ISO - 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, into a temporary directory and copies files to a given destination,
if needed. if needed.
- If the user has mount-capabilities (CAP_SYS_ADMIN on Linux) this module - 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 mounts the ISO image to a temporary location, and copies files to a given
destination, if needed. destination, if needed.
requirements: requirements:
- Either 7z (from C(7zip) or C(p7zip) package) - Either 7z (from C(7zip) or C(p7zip) package)
- Or mount capabilities (root-access, or CAP_SYS_ADMIN capability on Linux) - 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: options:
image: image:
description: description:

View file

@ -14,6 +14,13 @@ module: jboss
short_description: Deploy applications to JBoss short_description: Deploy applications to JBoss
description: description:
- Deploy applications to JBoss standalone using the filesystem. - Deploy applications to JBoss standalone using the filesystem.
extends_documentation_fragment:
- community.general.attributes
attributes:
check_mode:
support: full
diff_mode:
support: none
options: options:
deployment: deployment:
required: true required: true

View file

@ -20,6 +20,15 @@ short_description: Create and modify issues in a JIRA instance
description: description:
- Create and modify issues in a JIRA instance. - Create and modify issues in a JIRA instance.
extends_documentation_fragment:
- community.general.attributes
attributes:
check_mode:
support: none
diff_mode:
support: none
options: options:
uri: uri:
type: str type: str

View file

@ -18,6 +18,13 @@ short_description: Manage Kibana plugins
description: description:
- This module can be used to manage Kibana plugins. - This module can be used to manage Kibana plugins.
author: Thierno IB. BARRY (@barryib) author: Thierno IB. BARRY (@barryib)
extends_documentation_fragment:
- community.general.attributes
attributes:
check_mode:
support: full
diff_mode:
support: none
options: options:
name: name:
description: description:

View file

@ -17,7 +17,16 @@ short_description: Local Backup Utility for Alpine Linux
version_added: '0.2.0' version_added: '0.2.0'
description: 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: options:
commit: commit:
@ -36,7 +45,7 @@ options:
elements: str elements: str
author: author:
- Kaarle Ritvanen (@kunkku) - Kaarle Ritvanen (@kunkku)
''' '''
EXAMPLES = ''' EXAMPLES = '''

View file

@ -16,6 +16,13 @@ requirements: [ lldpctl ]
short_description: Get details reported by lldp short_description: Get details reported by lldp
description: description:
- Reads data out of lldpctl - Reads data out of lldpctl
extends_documentation_fragment:
- community.general.attributes
attributes:
check_mode:
support: none
diff_mode:
support: none
options: {} options: {}
author: "Andy Hill (@andyhky)" author: "Andy Hill (@andyhky)"
notes: notes:

View file

@ -15,6 +15,13 @@ short_description: Manage Logstash plugins
description: description:
- Manages Logstash plugins. - Manages Logstash plugins.
author: Loic Blot (@nerzhul) author: Loic Blot (@nerzhul)
extends_documentation_fragment:
- community.general.attributes
attributes:
check_mode:
support: full
diff_mode:
support: none
options: options:
name: name:
type: str type: str