From 94b4034fd285d8fb89db7b886f51027a9e2277aa Mon Sep 17 00:00:00 2001 From: "patchback[bot]" <45432694+patchback[bot]@users.noreply.github.com> Date: Mon, 20 Feb 2023 17:46:37 +0100 Subject: [PATCH] [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 b4a500103a4f617cfa0e92da6faf9d3d726b2f41) Co-authored-by: Felix Fontein --- plugins/modules/aerospike_migrations.py | 7 ++++++ plugins/modules/airbrake_deployment.py | 7 ++++++ plugins/modules/alerta_customer.py | 7 ++++++ plugins/modules/awall.py | 7 ++++++ plugins/modules/bearychat.py | 7 ++++++ plugins/modules/bigpanda.py | 7 ++++++ plugins/modules/capabilities.py | 7 ++++++ plugins/modules/catapult.py | 9 ++++++- plugins/modules/circonus_annotation.py | 7 ++++++ plugins/modules/cloudflare_dns.py | 7 ++++++ plugins/modules/django_manage.py | 7 ++++++ plugins/modules/dnsimple.py | 7 ++++++ plugins/modules/dnsmadeeasy.py | 7 ++++++ plugins/modules/ejabberd_user.py | 7 ++++++ plugins/modules/elasticsearch_plugin.py | 7 ++++++ plugins/modules/emc_vnx_sg_member.py | 8 ++++++- plugins/modules/facter.py | 7 ++++++ plugins/modules/flowdock.py | 9 ++++++- plugins/modules/gandi_livedns.py | 13 +++++++---- plugins/modules/grove.py | 7 ++++++ plugins/modules/gunicorn.py | 17 ++++++++++---- plugins/modules/haproxy.py | 9 ++++++- plugins/modules/htpasswd.py | 9 ++++++- plugins/modules/iso_create.py | 17 ++++++++++---- plugins/modules/iso_customize.py | 9 +++++++ plugins/modules/iso_extract.py | 31 +++++++++++++++---------- plugins/modules/jboss.py | 7 ++++++ plugins/modules/jira.py | 9 +++++++ plugins/modules/kibana_plugin.py | 7 ++++++ plugins/modules/lbu.py | 13 +++++++++-- plugins/modules/lldp.py | 7 ++++++ plugins/modules/logstash_plugin.py | 7 ++++++ 32 files changed, 261 insertions(+), 32 deletions(-) diff --git a/plugins/modules/aerospike_migrations.py b/plugins/modules/aerospike_migrations.py index 32ab06a853..1eee5b1a2f 100644 --- a/plugins/modules/aerospike_migrations.py +++ b/plugins/modules/aerospike_migrations.py @@ -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: diff --git a/plugins/modules/airbrake_deployment.py b/plugins/modules/airbrake_deployment.py index 2fb5b58737..42ac037e1e 100644 --- a/plugins/modules/airbrake_deployment.py +++ b/plugins/modules/airbrake_deployment.py @@ -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: diff --git a/plugins/modules/alerta_customer.py b/plugins/modules/alerta_customer.py index b9bfd4b265..120d989328 100644 --- a/plugins/modules/alerta_customer.py +++ b/plugins/modules/alerta_customer.py @@ -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: diff --git a/plugins/modules/awall.py b/plugins/modules/awall.py index dc13d46789..856cf782d4 100644 --- a/plugins/modules/awall.py +++ b/plugins/modules/awall.py @@ -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: diff --git a/plugins/modules/bearychat.py b/plugins/modules/bearychat.py index 48d5c994fc..28f1f8fcd9 100644 --- a/plugins/modules/bearychat.py +++ b/plugins/modules/bearychat.py @@ -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 diff --git a/plugins/modules/bigpanda.py b/plugins/modules/bigpanda.py index 4e653aadb7..bab200bc44 100644 --- a/plugins/modules/bigpanda.py +++ b/plugins/modules/bigpanda.py @@ -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 diff --git a/plugins/modules/capabilities.py b/plugins/modules/capabilities.py index 9309958eca..9b72ac6ea1 100644 --- a/plugins/modules/capabilities.py +++ b/plugins/modules/capabilities.py @@ -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: diff --git a/plugins/modules/catapult.py b/plugins/modules/catapult.py index 8b8c72974d..a3bbef6c42 100644 --- a/plugins/modules/catapult.py +++ b/plugins/modules/catapult.py @@ -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 diff --git a/plugins/modules/circonus_annotation.py b/plugins/modules/circonus_annotation.py index 661c854e6d..9376107761 100644 --- a/plugins/modules/circonus_annotation.py +++ b/plugins/modules/circonus_annotation.py @@ -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 diff --git a/plugins/modules/cloudflare_dns.py b/plugins/modules/cloudflare_dns.py index 92132c0f6f..a0fa8a38b2 100644 --- a/plugins/modules/cloudflare_dns.py +++ b/plugins/modules/cloudflare_dns.py @@ -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: diff --git a/plugins/modules/django_manage.py b/plugins/modules/django_manage.py index 188ff2d3df..537cf0fa74 100644 --- a/plugins/modules/django_manage.py +++ b/plugins/modules/django_manage.py @@ -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: diff --git a/plugins/modules/dnsimple.py b/plugins/modules/dnsimple.py index ddd3ba0bab..df41f73a69 100644 --- a/plugins/modules/dnsimple.py +++ b/plugins/modules/dnsimple.py @@ -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: diff --git a/plugins/modules/dnsmadeeasy.py b/plugins/modules/dnsmadeeasy.py index b775f24ab0..44587ca39c 100644 --- a/plugins/modules/dnsmadeeasy.py +++ b/plugins/modules/dnsmadeeasy.py @@ -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: diff --git a/plugins/modules/ejabberd_user.py b/plugins/modules/ejabberd_user.py index f7189fa08e..397207ae61 100644 --- a/plugins/modules/ejabberd_user.py +++ b/plugins/modules/ejabberd_user.py @@ -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 diff --git a/plugins/modules/elasticsearch_plugin.py b/plugins/modules/elasticsearch_plugin.py index a68ff086c3..cd4bb45de7 100644 --- a/plugins/modules/elasticsearch_plugin.py +++ b/plugins/modules/elasticsearch_plugin.py @@ -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: diff --git a/plugins/modules/emc_vnx_sg_member.py b/plugins/modules/emc_vnx_sg_member.py index 39c0ab3a99..487b6feefa 100644 --- a/plugins/modules/emc_vnx_sg_member.py +++ b/plugins/modules/emc_vnx_sg_member.py @@ -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: diff --git a/plugins/modules/facter.py b/plugins/modules/facter.py index be45e3ce14..e7cf52e203 100644 --- a/plugins/modules/facter.py +++ b/plugins/modules/facter.py @@ -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: diff --git a/plugins/modules/flowdock.py b/plugins/modules/flowdock.py index 965ae62d7a..c78716ba40 100644 --- a/plugins/modules/flowdock.py +++ b/plugins/modules/flowdock.py @@ -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 diff --git a/plugins/modules/gandi_livedns.py b/plugins/modules/gandi_livedns.py index 9566661f41..cc9dd630b4 100644 --- a/plugins/modules/gandi_livedns.py +++ b/plugins/modules/gandi_livedns.py @@ -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''' diff --git a/plugins/modules/grove.py b/plugins/modules/grove.py index d3ad6bb019..b3e0508ffa 100644 --- a/plugins/modules/grove.py +++ b/plugins/modules/grove.py @@ -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 diff --git a/plugins/modules/gunicorn.py b/plugins/modules/gunicorn.py index ff88cead7c..2b2abcf8e6 100644 --- a/plugins/modules/gunicorn.py +++ b/plugins/modules/gunicorn.py @@ -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 diff --git a/plugins/modules/haproxy.py b/plugins/modules/haproxy.py index 38033bc81a..56f987d80f 100644 --- a/plugins/modules/haproxy.py +++ b/plugins/modules/haproxy.py @@ -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: diff --git a/plugins/modules/htpasswd.py b/plugins/modules/htpasswd.py index 231506984a..180b020733 100644 --- a/plugins/modules/htpasswd.py +++ b/plugins/modules/htpasswd.py @@ -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 = """ diff --git a/plugins/modules/iso_create.py b/plugins/modules/iso_create.py index c457f5a412..4b51be96d2 100644 --- a/plugins/modules/iso_create.py +++ b/plugins/modules/iso_create.py @@ -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) + - Diane Wang (@Tomorrow9) 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: diff --git a/plugins/modules/iso_customize.py b/plugins/modules/iso_customize.py index 4f902f47e4..9add080b11 100644 --- a/plugins/modules/iso_customize.py +++ b/plugins/modules/iso_customize.py @@ -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: diff --git a/plugins/modules/iso_extract.py b/plugins/modules/iso_extract.py index 6693fc3884..599cbe4de5 100644 --- a/plugins/modules/iso_extract.py +++ b/plugins/modules/iso_extract.py @@ -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: diff --git a/plugins/modules/jboss.py b/plugins/modules/jboss.py index 2dc82f5594..b389e7e662 100644 --- a/plugins/modules/jboss.py +++ b/plugins/modules/jboss.py @@ -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 diff --git a/plugins/modules/jira.py b/plugins/modules/jira.py index 5e0a55119c..91aeb67037 100644 --- a/plugins/modules/jira.py +++ b/plugins/modules/jira.py @@ -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 diff --git a/plugins/modules/kibana_plugin.py b/plugins/modules/kibana_plugin.py index 94838e22b6..a52eda2fdd 100644 --- a/plugins/modules/kibana_plugin.py +++ b/plugins/modules/kibana_plugin.py @@ -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: diff --git a/plugins/modules/lbu.py b/plugins/modules/lbu.py index 86f01f62af..c961b6060d 100644 --- a/plugins/modules/lbu.py +++ b/plugins/modules/lbu.py @@ -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 = ''' diff --git a/plugins/modules/lldp.py b/plugins/modules/lldp.py index 3a050ae29e..fb608ff138 100644 --- a/plugins/modules/lldp.py +++ b/plugins/modules/lldp.py @@ -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: diff --git a/plugins/modules/logstash_plugin.py b/plugins/modules/logstash_plugin.py index a4979646dd..7ee118ff28 100644 --- a/plugins/modules/logstash_plugin.py +++ b/plugins/modules/logstash_plugin.py @@ -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