From ac6ac732764d16ed9a96f7b92c6ad68c15bbe655 Mon Sep 17 00:00:00 2001 From: Felix Fontein Date: Sun, 6 Nov 2022 21:16:43 +0100 Subject: [PATCH] Document attributes (_info and _facts modules for now) (#5481) * Add attributes docs fragment. * Use attributes for _info and _facts modules. --- plugins/doc_fragments/attributes.py | 89 +++++++++++++++++++ plugins/modules/ali_instance_info.py | 2 + plugins/modules/cloud_init_data_facts.py | 4 + plugins/modules/dnsimple_info.py | 4 + plugins/modules/gconftool2_info.py | 3 + plugins/modules/github_webhook_info.py | 3 + plugins/modules/hpilo_info.py | 3 + plugins/modules/idrac_redfish_info.py | 3 + plugins/modules/ilo_redfish_info.py | 3 + plugins/modules/ipify_facts.py | 4 + plugins/modules/ipinfoio_facts.py | 4 + plugins/modules/jenkins_job_info.py | 3 + plugins/modules/keycloak_realm_info.py | 4 + plugins/modules/keyring_info.py | 3 + plugins/modules/listen_ports_facts.py | 4 + plugins/modules/manageiq_policies_info.py | 2 + plugins/modules/manageiq_tags_info.py | 4 +- plugins/modules/memset_memstore_info.py | 3 + plugins/modules/memset_server_info.py | 3 + plugins/modules/nginx_status_info.py | 3 + plugins/modules/nomad_job_info.py | 2 + plugins/modules/one_image_info.py | 3 + plugins/modules/onepassword_info.py | 3 + plugins/modules/oneview_datacenter_info.py | 6 +- plugins/modules/oneview_enclosure_info.py | 6 +- .../modules/oneview_ethernet_network_info.py | 6 +- plugins/modules/oneview_fc_network_info.py | 6 +- plugins/modules/oneview_fcoe_network_info.py | 6 +- ...oneview_logical_interconnect_group_info.py | 6 +- plugins/modules/oneview_network_set_info.py | 6 +- plugins/modules/oneview_san_manager_info.py | 4 +- plugins/modules/online_server_info.py | 4 +- plugins/modules/online_user_info.py | 4 +- plugins/modules/pip_package_info.py | 5 +- plugins/modules/pipx_info.py | 3 + plugins/modules/pritunl_org_info.py | 2 + plugins/modules/pritunl_user_info.py | 2 + plugins/modules/proxmox_domain_info.py | 5 +- plugins/modules/proxmox_group_info.py | 5 +- plugins/modules/proxmox_storage_info.py | 5 +- plugins/modules/proxmox_tasks_info.py | 2 + plugins/modules/proxmox_user_info.py | 5 +- plugins/modules/python_requirements_info.py | 3 + plugins/modules/rax_facts.py | 7 +- plugins/modules/redfish_info.py | 3 + plugins/modules/redis_data_info.py | 2 + plugins/modules/redis_info.py | 3 + .../modules/rundeck_job_executions_info.py | 2 + .../scaleway_container_namespace_info.py | 3 +- .../scaleway_container_registry_info.py | 3 +- plugins/modules/scaleway_function_info.py | 3 +- .../scaleway_function_namespace_info.py | 3 +- plugins/modules/scaleway_image_info.py | 4 +- plugins/modules/scaleway_ip_info.py | 4 +- plugins/modules/scaleway_organization_info.py | 4 +- .../modules/scaleway_security_group_info.py | 4 +- plugins/modules/scaleway_server_info.py | 4 +- plugins/modules/scaleway_snapshot_info.py | 4 +- plugins/modules/scaleway_volume_info.py | 4 +- plugins/modules/smartos_image_info.py | 3 + plugins/modules/snmp_facts.py | 4 + plugins/modules/utm_aaa_group_info.py | 4 +- plugins/modules/utm_ca_host_key_cert_info.py | 5 +- .../utm_network_interface_address_info.py | 5 +- plugins/modules/utm_proxy_frontend_info.py | 5 +- plugins/modules/utm_proxy_location_info.py | 5 +- plugins/modules/vertica_info.py | 3 + plugins/modules/wdc_redfish_info.py | 3 + plugins/modules/xenserver_facts.py | 10 ++- plugins/modules/xenserver_guest_info.py | 3 +- plugins/modules/xfconf_info.py | 3 + plugins/modules/zfs_facts.py | 4 + plugins/modules/zpool_facts.py | 4 + 73 files changed, 319 insertions(+), 49 deletions(-) create mode 100644 plugins/doc_fragments/attributes.py diff --git a/plugins/doc_fragments/attributes.py b/plugins/doc_fragments/attributes.py new file mode 100644 index 0000000000..da089dff21 --- /dev/null +++ b/plugins/doc_fragments/attributes.py @@ -0,0 +1,89 @@ +# -*- coding: utf-8 -*- + +# Copyright (c) Ansible Project +# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt) +# SPDX-License-Identifier: GPL-3.0-or-later + +from __future__ import (absolute_import, division, print_function) +__metaclass__ = type + + +class ModuleDocFragment(object): + + # Standard documentation fragment + DOCUMENTATION = r''' +options: {} +attributes: + check_mode: + description: Can run in C(check_mode) and return changed status prediction without modifying target. + diff_mode: + description: Will return details on what has changed (or possibly needs changing in C(check_mode)), when in diff mode. +''' + +# platform: +# description: Target OS/families that can be operated against. +# support: N/A + + # Should be used together with the standard fragment + INFO_MODULE = r''' +options: {} +attributes: + check_mode: + support: full + details: + - This action does not modify state. + diff_mode: + support: N/A + details: + - This action does not modify state. +''' + + CONN = r''' +options: {} +attributes: + become: + description: Is usable alongside C(become) keywords. + connection: + description: Uses the target's configured connection information to execute code on it. + delegation: + description: Can be used in conjunction with C(delegate_to) and related keywords. +''' + + FACTS = r''' +options: {} +attributes: + facts: + description: Action returns an C(ansible_facts) dictionary that will update existing host facts. +''' + + # Should be used together with the standard fragment and the FACTS fragment + FACTS_MODULE = r''' +options: {} +attributes: + check_mode: + support: full + details: + - This action does not modify state. + diff_mode: + support: N/A + details: + - This action does not modify state. + facts: + support: full +''' + + FILES = r''' +options: {} +attributes: + safe_file_operations: + description: Uses Ansible's strict file operation functions to ensure proper permissions and avoid data corruption. +''' + + FLOW = r''' +options: {} +attributes: + action: + description: Indicates this has a corresponding action plugin so some parts of the options can be executed on the controller. + async: + description: Supports being used with the C(async) keyword. +''' diff --git a/plugins/modules/ali_instance_info.py b/plugins/modules/ali_instance_info.py index 4b758477a3..ea7bcc8d4a 100644 --- a/plugins/modules/ali_instance_info.py +++ b/plugins/modules/ali_instance_info.py @@ -60,6 +60,8 @@ requirements: - "footmark >= 1.13.0" extends_documentation_fragment: - community.general.alicloud + - community.general.attributes + - community.general.attributes.info_module ''' EXAMPLES = ''' diff --git a/plugins/modules/cloud_init_data_facts.py b/plugins/modules/cloud_init_data_facts.py index d02fd2301d..df2f77148e 100644 --- a/plugins/modules/cloud_init_data_facts.py +++ b/plugins/modules/cloud_init_data_facts.py @@ -15,6 +15,10 @@ short_description: Retrieve facts of cloud-init. description: - Gathers facts by reading the status.json and result.json of cloud-init. author: René Moser (@resmo) +extends_documentation_fragment: + - community.general.attributes + - community.general.attributes.facts + - community.general.attributes.facts_module options: filter: description: diff --git a/plugins/modules/dnsimple_info.py b/plugins/modules/dnsimple_info.py index f4a68f509d..959bacbbe8 100644 --- a/plugins/modules/dnsimple_info.py +++ b/plugins/modules/dnsimple_info.py @@ -19,6 +19,10 @@ version_added: "4.2.0" description: Retrieve existing records and domains from DNSimple API. +extends_documentation_fragment: + - community.general.attributes + - community.general.attributes.info_module + options: name: description: diff --git a/plugins/modules/gconftool2_info.py b/plugins/modules/gconftool2_info.py index acebb44013..f9231104d4 100644 --- a/plugins/modules/gconftool2_info.py +++ b/plugins/modules/gconftool2_info.py @@ -15,6 +15,9 @@ short_description: Retrieve GConf configurations version_added: 5.1.0 description: - This module allows retrieving application preferences from the GConf database, with the help of C(gconftool-2). +extends_documentation_fragment: + - community.general.attributes + - community.general.attributes.info_module options: key: description: diff --git a/plugins/modules/github_webhook_info.py b/plugins/modules/github_webhook_info.py index bc3d3c90fa..a6f7c3e52c 100644 --- a/plugins/modules/github_webhook_info.py +++ b/plugins/modules/github_webhook_info.py @@ -17,6 +17,9 @@ description: - This module was called C(github_webhook_facts) before Ansible 2.9. The usage did not change. requirements: - "PyGithub >= 1.3.5" +extends_documentation_fragment: + - community.general.attributes + - community.general.attributes.info_module options: repository: description: diff --git a/plugins/modules/hpilo_info.py b/plugins/modules/hpilo_info.py index 219885cf41..cef6597e48 100644 --- a/plugins/modules/hpilo_info.py +++ b/plugins/modules/hpilo_info.py @@ -21,6 +21,9 @@ description: - This module requires the C(hpilo) python module. - This module was called C(hpilo_facts) before Ansible 2.9, returning C(ansible_facts). Note that the M(community.general.hpilo_info) module no longer returns C(ansible_facts)! +extends_documentation_fragment: +- community.general.attributes +- community.general.attributes.info_module options: host: description: diff --git a/plugins/modules/idrac_redfish_info.py b/plugins/modules/idrac_redfish_info.py index 91e57de14d..cb44a75961 100644 --- a/plugins/modules/idrac_redfish_info.py +++ b/plugins/modules/idrac_redfish_info.py @@ -18,6 +18,9 @@ description: - For use with Dell EMC iDRAC operations that require Redfish OEM extensions. - This module was called C(idrac_redfish_facts) before Ansible 2.9, returning C(ansible_facts). Note that the M(community.general.idrac_redfish_info) module no longer returns C(ansible_facts)! +extends_documentation_fragment: + - community.general.attributes + - community.general.attributes.info_module options: category: required: true diff --git a/plugins/modules/ilo_redfish_info.py b/plugins/modules/ilo_redfish_info.py index 4611e620d5..90cafb8ec6 100644 --- a/plugins/modules/ilo_redfish_info.py +++ b/plugins/modules/ilo_redfish_info.py @@ -15,6 +15,9 @@ description: - Builds Redfish URIs locally and sends them to iLO to get information back. - For use with HPE iLO operations that require Redfish OEM extensions. +extends_documentation_fragment: + - community.general.attributes + - community.general.attributes.info_module options: category: required: true diff --git a/plugins/modules/ipify_facts.py b/plugins/modules/ipify_facts.py index 8953c02940..ab96d7e949 100644 --- a/plugins/modules/ipify_facts.py +++ b/plugins/modules/ipify_facts.py @@ -17,6 +17,10 @@ description: - If behind NAT and need to know the public IP of your internet gateway. author: - René Moser (@resmo) +extends_documentation_fragment: + - community.general.attributes + - community.general.attributes.facts + - community.general.attributes.facts_module options: api_url: description: diff --git a/plugins/modules/ipinfoio_facts.py b/plugins/modules/ipinfoio_facts.py index a10b54ecce..676e88d84d 100644 --- a/plugins/modules/ipinfoio_facts.py +++ b/plugins/modules/ipinfoio_facts.py @@ -16,6 +16,10 @@ short_description: "Retrieve IP geolocation facts of a host's IP address" description: - "Gather IP geolocation facts of a host's IP address using ipinfo.io API" author: "Aleksei Kostiuk (@akostyuk)" +extends_documentation_fragment: + - community.general.attributes + - community.general.attributes.facts + - community.general.attributes.facts_module options: timeout: description: diff --git a/plugins/modules/jenkins_job_info.py b/plugins/modules/jenkins_job_info.py index 1195a3e03d..ba6a531179 100644 --- a/plugins/modules/jenkins_job_info.py +++ b/plugins/modules/jenkins_job_info.py @@ -18,6 +18,9 @@ description: - This module was called C(jenkins_job_info) before Ansible 2.9. The usage did not change. requirements: - "python-jenkins >= 0.4.12" +extends_documentation_fragment: + - community.general.attributes + - community.general.attributes.info_module options: name: type: str diff --git a/plugins/modules/keycloak_realm_info.py b/plugins/modules/keycloak_realm_info.py index 0956f1b525..5c2ebb4c9e 100644 --- a/plugins/modules/keycloak_realm_info.py +++ b/plugins/modules/keycloak_realm_info.py @@ -26,6 +26,10 @@ description: be returned that way by this module. You may pass single values for attributes when calling the module, and this will be translated into a list suitable for the API. +extends_documentation_fragment: + - community.general.attributes + - community.general.attributes.info_module + options: auth_keycloak_url: description: diff --git a/plugins/modules/keyring_info.py b/plugins/modules/keyring_info.py index e0c33ce724..5c41ecc4d0 100644 --- a/plugins/modules/keyring_info.py +++ b/plugins/modules/keyring_info.py @@ -26,6 +26,9 @@ requirements: - keyring (Python library) - gnome-keyring (application - required for headless Linux keyring access) - dbus-run-session (application - required for headless Linux keyring access) +extends_documentation_fragment: + - community.general.attributes + - community.general.attributes.info_module options: service: description: The name of the service. diff --git a/plugins/modules/listen_ports_facts.py b/plugins/modules/listen_ports_facts.py index fc4afa6d7b..eb1ba09237 100644 --- a/plugins/modules/listen_ports_facts.py +++ b/plugins/modules/listen_ports_facts.py @@ -23,6 +23,10 @@ notes: - | C(ss) returns all processes for each listen address and port. This plugin will return each of them, so multiple entries for the same listen address and port are likely in results. +extends_documentation_fragment: + - community.general.attributes + - community.general.attributes.facts + - community.general.attributes.facts_module options: command: description: diff --git a/plugins/modules/manageiq_policies_info.py b/plugins/modules/manageiq_policies_info.py index cdf4cafdaf..c10ee95327 100644 --- a/plugins/modules/manageiq_policies_info.py +++ b/plugins/modules/manageiq_policies_info.py @@ -18,6 +18,8 @@ version_added: 5.8.0 short_description: Listing of resource policy_profiles in ManageIQ extends_documentation_fragment: - community.general.manageiq + - community.general.attributes + - community.general.attributes.info_module author: Alexei Znamensky (@russoz) description: diff --git a/plugins/modules/manageiq_tags_info.py b/plugins/modules/manageiq_tags_info.py index 0cdcd5184d..af71e150cb 100644 --- a/plugins/modules/manageiq_tags_info.py +++ b/plugins/modules/manageiq_tags_info.py @@ -15,7 +15,9 @@ module: manageiq_tags_info version_added: 5.8.0 short_description: Retrieve resource tags in ManageIQ extends_documentation_fragment: -- community.general.manageiq + - community.general.manageiq + - community.general.attributes + - community.general.attributes.info_module author: Alexei Znamensky (@russoz) description: diff --git a/plugins/modules/memset_memstore_info.py b/plugins/modules/memset_memstore_info.py index 1247085ab9..4de803f991 100644 --- a/plugins/modules/memset_memstore_info.py +++ b/plugins/modules/memset_memstore_info.py @@ -19,6 +19,9 @@ notes: description: - Retrieve Memstore product usage information. - This module was called C(memset_memstore_facts) before Ansible 2.9. The usage did not change. +extends_documentation_fragment: + - community.general.attributes + - community.general.attributes.info_module options: api_key: required: true diff --git a/plugins/modules/memset_server_info.py b/plugins/modules/memset_server_info.py index b756a8338e..44aa0d8442 100644 --- a/plugins/modules/memset_server_info.py +++ b/plugins/modules/memset_server_info.py @@ -19,6 +19,9 @@ notes: description: - Retrieve server information. - This module was called C(memset_server_facts) before Ansible 2.9. The usage did not change. +extends_documentation_fragment: + - community.general.attributes + - community.general.attributes.info_module options: api_key: required: true diff --git a/plugins/modules/nginx_status_info.py b/plugins/modules/nginx_status_info.py index 1c99fb2370..1e1bb10495 100644 --- a/plugins/modules/nginx_status_info.py +++ b/plugins/modules/nginx_status_info.py @@ -16,6 +16,9 @@ short_description: Retrieve information on nginx status. description: - Gathers information from nginx from an URL having C(stub_status) enabled. author: "René Moser (@resmo)" +extends_documentation_fragment: + - community.general.attributes + - community.general.attributes.info_module options: url: type: str diff --git a/plugins/modules/nomad_job_info.py b/plugins/modules/nomad_job_info.py index 5130fd1b60..5ee25a57a4 100644 --- a/plugins/modules/nomad_job_info.py +++ b/plugins/modules/nomad_job_info.py @@ -21,6 +21,8 @@ requirements: - python-nomad extends_documentation_fragment: - community.general.nomad + - community.general.attributes + - community.general.attributes.info_module options: name: description: diff --git a/plugins/modules/one_image_info.py b/plugins/modules/one_image_info.py index a908b46776..938f0ef2a4 100644 --- a/plugins/modules/one_image_info.py +++ b/plugins/modules/one_image_info.py @@ -17,6 +17,9 @@ description: - This module was called C(one_image_facts) before Ansible 2.9. The usage did not change. requirements: - pyone +extends_documentation_fragment: + - community.general.attributes + - community.general.attributes.info_module options: api_url: description: diff --git a/plugins/modules/onepassword_info.py b/plugins/modules/onepassword_info.py index ddf8579cb1..bb814c4439 100644 --- a/plugins/modules/onepassword_info.py +++ b/plugins/modules/onepassword_info.py @@ -29,6 +29,9 @@ description: - This module was called C(onepassword_facts) before Ansible 2.9, returning C(ansible_facts). Note that the M(community.general.onepassword_info) module no longer returns C(ansible_facts)! You must now use the C(register) option to use the facts in other tasks. +extends_documentation_fragment: + - community.general.attributes + - community.general.attributes.info_module options: search_terms: type: list diff --git a/plugins/modules/oneview_datacenter_info.py b/plugins/modules/oneview_datacenter_info.py index 0d78c2483a..76e752f399 100644 --- a/plugins/modules/oneview_datacenter_info.py +++ b/plugins/modules/oneview_datacenter_info.py @@ -34,8 +34,10 @@ options: elements: str extends_documentation_fragment: -- community.general.oneview -- community.general.oneview.factsparams + - community.general.oneview + - community.general.oneview.factsparams + - community.general.attributes + - community.general.attributes.info_module ''' diff --git a/plugins/modules/oneview_enclosure_info.py b/plugins/modules/oneview_enclosure_info.py index 1c19d36860..dfef893542 100644 --- a/plugins/modules/oneview_enclosure_info.py +++ b/plugins/modules/oneview_enclosure_info.py @@ -36,8 +36,10 @@ options: elements: raw extends_documentation_fragment: -- community.general.oneview -- community.general.oneview.factsparams + - community.general.oneview + - community.general.oneview.factsparams + - community.general.attributes + - community.general.attributes.info_module ''' diff --git a/plugins/modules/oneview_ethernet_network_info.py b/plugins/modules/oneview_ethernet_network_info.py index 94b87ff24b..cb58575a3b 100644 --- a/plugins/modules/oneview_ethernet_network_info.py +++ b/plugins/modules/oneview_ethernet_network_info.py @@ -33,8 +33,10 @@ options: type: list elements: str extends_documentation_fragment: -- community.general.oneview -- community.general.oneview.factsparams + - community.general.oneview + - community.general.oneview.factsparams + - community.general.attributes + - community.general.attributes.info_module ''' diff --git a/plugins/modules/oneview_fc_network_info.py b/plugins/modules/oneview_fc_network_info.py index 2b6377fb35..6927ba438c 100644 --- a/plugins/modules/oneview_fc_network_info.py +++ b/plugins/modules/oneview_fc_network_info.py @@ -28,8 +28,10 @@ options: type: str extends_documentation_fragment: -- community.general.oneview -- community.general.oneview.factsparams + - community.general.oneview + - community.general.oneview.factsparams + - community.general.attributes + - community.general.attributes.info_module ''' diff --git a/plugins/modules/oneview_fcoe_network_info.py b/plugins/modules/oneview_fcoe_network_info.py index db5c5a59b0..52bcb12c89 100644 --- a/plugins/modules/oneview_fcoe_network_info.py +++ b/plugins/modules/oneview_fcoe_network_info.py @@ -27,8 +27,10 @@ options: - FCoE Network name. type: str extends_documentation_fragment: -- community.general.oneview -- community.general.oneview.factsparams + - community.general.oneview + - community.general.oneview.factsparams + - community.general.attributes + - community.general.attributes.info_module ''' diff --git a/plugins/modules/oneview_logical_interconnect_group_info.py b/plugins/modules/oneview_logical_interconnect_group_info.py index f0962a996a..8d355cdaa0 100644 --- a/plugins/modules/oneview_logical_interconnect_group_info.py +++ b/plugins/modules/oneview_logical_interconnect_group_info.py @@ -28,8 +28,10 @@ options: - Logical Interconnect Group name. type: str extends_documentation_fragment: -- community.general.oneview -- community.general.oneview.factsparams + - community.general.oneview + - community.general.oneview.factsparams + - community.general.attributes + - community.general.attributes.info_module ''' diff --git a/plugins/modules/oneview_network_set_info.py b/plugins/modules/oneview_network_set_info.py index caff260220..1c793dbfb5 100644 --- a/plugins/modules/oneview_network_set_info.py +++ b/plugins/modules/oneview_network_set_info.py @@ -36,8 +36,10 @@ options: elements: str extends_documentation_fragment: -- community.general.oneview -- community.general.oneview.factsparams + - community.general.oneview + - community.general.oneview.factsparams + - community.general.attributes + - community.general.attributes.info_module ''' diff --git a/plugins/modules/oneview_san_manager_info.py b/plugins/modules/oneview_san_manager_info.py index 95497ed8aa..87b3c0534f 100644 --- a/plugins/modules/oneview_san_manager_info.py +++ b/plugins/modules/oneview_san_manager_info.py @@ -36,7 +36,9 @@ options: - C(sort): The sort order of the returned data set." type: dict extends_documentation_fragment: -- community.general.oneview + - community.general.oneview + - community.general.attributes + - community.general.attributes.info_module ''' diff --git a/plugins/modules/online_server_info.py b/plugins/modules/online_server_info.py index 6ba3e4aa4f..533e0453f9 100644 --- a/plugins/modules/online_server_info.py +++ b/plugins/modules/online_server_info.py @@ -18,7 +18,9 @@ description: author: - "Remy Leone (@remyleone)" extends_documentation_fragment: -- community.general.online + - community.general.online + - community.general.attributes + - community.general.attributes.info_module ''' diff --git a/plugins/modules/online_user_info.py b/plugins/modules/online_user_info.py index 1086502040..17cbc7d662 100644 --- a/plugins/modules/online_user_info.py +++ b/plugins/modules/online_user_info.py @@ -15,7 +15,9 @@ description: author: - "Remy Leone (@remyleone)" extends_documentation_fragment: -- community.general.online + - community.general.online + - community.general.attributes + - community.general.attributes.info_module ''' EXAMPLES = r''' diff --git a/plugins/modules/pip_package_info.py b/plugins/modules/pip_package_info.py index 6931366c87..c89e47014e 100644 --- a/plugins/modules/pip_package_info.py +++ b/plugins/modules/pip_package_info.py @@ -14,6 +14,9 @@ module: pip_package_info short_description: pip package information description: - Return information about installed pip packages +extends_documentation_fragment: + - community.general.attributes + - community.general.attributes.info_module options: clients: description: @@ -24,7 +27,7 @@ options: type: list elements: path requirements: - - The requested pip executables must be installed on the target. + - The requested pip executables must be installed on the target. author: - Matthew Jones (@matburt) - Brian Coca (@bcoca) diff --git a/plugins/modules/pipx_info.py b/plugins/modules/pipx_info.py index 05b9db1b2d..ff9698e31d 100644 --- a/plugins/modules/pipx_info.py +++ b/plugins/modules/pipx_info.py @@ -16,6 +16,9 @@ short_description: Rretrieves information about applications installed with pipx version_added: 5.6.0 description: - Retrieve details about Python applications installed in isolated virtualenvs using pipx. +extends_documentation_fragment: + - community.general.attributes + - community.general.attributes.info_module options: name: description: diff --git a/plugins/modules/pritunl_org_info.py b/plugins/modules/pritunl_org_info.py index 1529239ad9..7f3974e0e5 100644 --- a/plugins/modules/pritunl_org_info.py +++ b/plugins/modules/pritunl_org_info.py @@ -18,6 +18,8 @@ description: - A module to list Pritunl organizations using the Pritunl API. extends_documentation_fragment: - community.general.pritunl + - community.general.attributes + - community.general.attributes.info_module options: organization: type: str diff --git a/plugins/modules/pritunl_user_info.py b/plugins/modules/pritunl_user_info.py index 3a5343f6b6..d4c68ca6e0 100644 --- a/plugins/modules/pritunl_user_info.py +++ b/plugins/modules/pritunl_user_info.py @@ -18,6 +18,8 @@ description: - A module to list Pritunl users using the Pritunl API. extends_documentation_fragment: - community.general.pritunl + - community.general.attributes + - community.general.attributes.info_module options: organization: type: str diff --git a/plugins/modules/proxmox_domain_info.py b/plugins/modules/proxmox_domain_info.py index 2cabf5b3c7..7435695a91 100644 --- a/plugins/modules/proxmox_domain_info.py +++ b/plugins/modules/proxmox_domain_info.py @@ -23,7 +23,10 @@ options: aliases: ['realm', 'name'] type: str author: Tristan Le Guern (@tleguern) -extends_documentation_fragment: community.general.proxmox.documentation +extends_documentation_fragment: + - community.general.proxmox.documentation + - community.general.attributes + - community.general.attributes.info_module ''' diff --git a/plugins/modules/proxmox_group_info.py b/plugins/modules/proxmox_group_info.py index d2d4491ce2..531a9dae7a 100644 --- a/plugins/modules/proxmox_group_info.py +++ b/plugins/modules/proxmox_group_info.py @@ -23,7 +23,10 @@ options: aliases: ['groupid', 'name'] type: str author: Tristan Le Guern (@tleguern) -extends_documentation_fragment: community.general.proxmox.documentation +extends_documentation_fragment: + - community.general.proxmox.documentation + - community.general.attributes + - community.general.attributes.info_module ''' diff --git a/plugins/modules/proxmox_storage_info.py b/plugins/modules/proxmox_storage_info.py index a98d3794a9..fd3759364b 100644 --- a/plugins/modules/proxmox_storage_info.py +++ b/plugins/modules/proxmox_storage_info.py @@ -27,7 +27,10 @@ options: - Filter on a specifc storage type. type: str author: Tristan Le Guern (@tleguern) -extends_documentation_fragment: community.general.proxmox.documentation +extends_documentation_fragment: + - community.general.proxmox.documentation + - community.general.attributes + - community.general.attributes.info_module notes: - Storage specific options can be returned by this module, please look at the documentation at U(https://pve.proxmox.com/wiki/Storage). ''' diff --git a/plugins/modules/proxmox_tasks_info.py b/plugins/modules/proxmox_tasks_info.py index c0a3dc6886..183fb3bf0f 100644 --- a/plugins/modules/proxmox_tasks_info.py +++ b/plugins/modules/proxmox_tasks_info.py @@ -30,6 +30,8 @@ options: type: str extends_documentation_fragment: - community.general.proxmox.documentation + - community.general.attributes + - community.general.attributes.info_module ''' diff --git a/plugins/modules/proxmox_user_info.py b/plugins/modules/proxmox_user_info.py index f1b3b881c9..a515f2b453 100644 --- a/plugins/modules/proxmox_user_info.py +++ b/plugins/modules/proxmox_user_info.py @@ -32,7 +32,10 @@ options: - Restrict results to a specific user ID, which is a concatenation of a user and domain parts. type: str author: Tristan Le Guern (@tleguern) -extends_documentation_fragment: community.general.proxmox.documentation +extends_documentation_fragment: + - community.general.proxmox.documentation + - community.general.attributes + - community.general.attributes.info_module ''' EXAMPLES = ''' diff --git a/plugins/modules/python_requirements_info.py b/plugins/modules/python_requirements_info.py index d96787c7d0..231114a1db 100644 --- a/plugins/modules/python_requirements_info.py +++ b/plugins/modules/python_requirements_info.py @@ -13,6 +13,9 @@ short_description: Show python path and assert dependency versions description: - Get info about available Python requirements on the target host, including listing required libraries and gathering versions. - This module was called C(python_requirements_facts) before Ansible 2.9. The usage did not change. +extends_documentation_fragment: + - community.general.attributes + - community.general.attributes.info_module options: dependencies: type: list diff --git a/plugins/modules/rax_facts.py b/plugins/modules/rax_facts.py index 560f05e56a..53657f3c9a 100644 --- a/plugins/modules/rax_facts.py +++ b/plugins/modules/rax_facts.py @@ -13,7 +13,7 @@ DOCUMENTATION = ''' module: rax_facts short_description: Gather facts for Rackspace Cloud Servers description: - - Gather facts for Rackspace Cloud Servers. + - Gather facts for Rackspace Cloud Servers. options: address: type: str @@ -30,7 +30,10 @@ options: - Server name to retrieve facts for author: "Matt Martz (@sivel)" extends_documentation_fragment: -- community.general.rackspace.openstack + - community.general.rackspace.openstack + - community.general.attributes + - community.general.attributes.facts + - community.general.attributes.facts_module ''' diff --git a/plugins/modules/redfish_info.py b/plugins/modules/redfish_info.py index 4cb42711ad..fd81695368 100644 --- a/plugins/modules/redfish_info.py +++ b/plugins/modules/redfish_info.py @@ -18,6 +18,9 @@ description: - Information retrieved is placed in a location specified by the user. - This module was called C(redfish_facts) before Ansible 2.9, returning C(ansible_facts). Note that the M(community.general.redfish_info) module no longer returns C(ansible_facts)! +extends_documentation_fragment: + - community.general.attributes + - community.general.attributes.info_module options: category: required: false diff --git a/plugins/modules/redis_data_info.py b/plugins/modules/redis_data_info.py index c4186ff358..c0af619057 100644 --- a/plugins/modules/redis_data_info.py +++ b/plugins/modules/redis_data_info.py @@ -25,6 +25,8 @@ options: extends_documentation_fragment: - community.general.redis + - community.general.attributes + - community.general.attributes.info_module seealso: - module: community.general.redis_data diff --git a/plugins/modules/redis_info.py b/plugins/modules/redis_info.py index 25b1d80035..b9900a7caf 100644 --- a/plugins/modules/redis_info.py +++ b/plugins/modules/redis_info.py @@ -16,6 +16,9 @@ short_description: Gather information about Redis servers version_added: '0.2.0' description: - Gathers information and statistics about Redis servers. +extends_documentation_fragment: +- community.general.attributes +- community.general.attributes.info_module options: login_host: description: diff --git a/plugins/modules/rundeck_job_executions_info.py b/plugins/modules/rundeck_job_executions_info.py index 2af6eb1d5f..818bde83c0 100644 --- a/plugins/modules/rundeck_job_executions_info.py +++ b/plugins/modules/rundeck_job_executions_info.py @@ -41,6 +41,8 @@ options: extends_documentation_fragment: - community.general.rundeck - url + - community.general.attributes + - community.general.attributes.info_module ''' EXAMPLES = ''' diff --git a/plugins/modules/scaleway_container_namespace_info.py b/plugins/modules/scaleway_container_namespace_info.py index daf5d7b1d6..20ec25d96a 100644 --- a/plugins/modules/scaleway_container_namespace_info.py +++ b/plugins/modules/scaleway_container_namespace_info.py @@ -21,7 +21,8 @@ description: - This module return information about a container namespace on Scaleway account. extends_documentation_fragment: - community.general.scaleway - + - community.general.attributes + - community.general.attributes.info_module options: project_id: diff --git a/plugins/modules/scaleway_container_registry_info.py b/plugins/modules/scaleway_container_registry_info.py index c53e405780..d2a5e61e93 100644 --- a/plugins/modules/scaleway_container_registry_info.py +++ b/plugins/modules/scaleway_container_registry_info.py @@ -21,7 +21,8 @@ description: - This module return information about a container registry on Scaleway account. extends_documentation_fragment: - community.general.scaleway - + - community.general.attributes + - community.general.attributes.info_module options: project_id: diff --git a/plugins/modules/scaleway_function_info.py b/plugins/modules/scaleway_function_info.py index b6f2eefa71..47eca48614 100644 --- a/plugins/modules/scaleway_function_info.py +++ b/plugins/modules/scaleway_function_info.py @@ -21,7 +21,8 @@ description: - This module return information about a function on Scaleway account. extends_documentation_fragment: - community.general.scaleway - + - community.general.attributes + - community.general.attributes.info_module options: namespace_id: diff --git a/plugins/modules/scaleway_function_namespace_info.py b/plugins/modules/scaleway_function_namespace_info.py index 7e02e8e42d..bb0b7fa9df 100644 --- a/plugins/modules/scaleway_function_namespace_info.py +++ b/plugins/modules/scaleway_function_namespace_info.py @@ -21,7 +21,8 @@ description: - This module return information about a function namespace on Scaleway account. extends_documentation_fragment: - community.general.scaleway - + - community.general.attributes + - community.general.attributes.info_module options: project_id: diff --git a/plugins/modules/scaleway_image_info.py b/plugins/modules/scaleway_image_info.py index c68cc99684..ee0134a52a 100644 --- a/plugins/modules/scaleway_image_info.py +++ b/plugins/modules/scaleway_image_info.py @@ -18,7 +18,9 @@ author: - "Yanis Guenane (@Spredzy)" - "Remy Leone (@remyleone)" extends_documentation_fragment: -- community.general.scaleway + - community.general.scaleway + - community.general.attributes + - community.general.attributes.info_module options: region: diff --git a/plugins/modules/scaleway_ip_info.py b/plugins/modules/scaleway_ip_info.py index c65c7e6ab9..d8725894e6 100644 --- a/plugins/modules/scaleway_ip_info.py +++ b/plugins/modules/scaleway_ip_info.py @@ -18,7 +18,9 @@ author: - "Yanis Guenane (@Spredzy)" - "Remy Leone (@remyleone)" extends_documentation_fragment: -- community.general.scaleway + - community.general.scaleway + - community.general.attributes + - community.general.attributes.info_module options: region: diff --git a/plugins/modules/scaleway_organization_info.py b/plugins/modules/scaleway_organization_info.py index 542b8d4603..aca8a0c43f 100644 --- a/plugins/modules/scaleway_organization_info.py +++ b/plugins/modules/scaleway_organization_info.py @@ -24,7 +24,9 @@ options: default: 'https://account.scaleway.com' aliases: ['base_url'] extends_documentation_fragment: -- community.general.scaleway + - community.general.scaleway + - community.general.attributes + - community.general.attributes.info_module ''' diff --git a/plugins/modules/scaleway_security_group_info.py b/plugins/modules/scaleway_security_group_info.py index 5e2cc95a1c..7fd96fd067 100644 --- a/plugins/modules/scaleway_security_group_info.py +++ b/plugins/modules/scaleway_security_group_info.py @@ -33,7 +33,9 @@ options: - waw1 - EMEA-PL-WAW1 extends_documentation_fragment: -- community.general.scaleway + - community.general.scaleway + - community.general.attributes + - community.general.attributes.info_module ''' diff --git a/plugins/modules/scaleway_server_info.py b/plugins/modules/scaleway_server_info.py index 087be54d24..7a31882ef7 100644 --- a/plugins/modules/scaleway_server_info.py +++ b/plugins/modules/scaleway_server_info.py @@ -18,7 +18,9 @@ author: - "Yanis Guenane (@Spredzy)" - "Remy Leone (@remyleone)" extends_documentation_fragment: -- community.general.scaleway + - community.general.scaleway + - community.general.attributes + - community.general.attributes.info_module options: region: diff --git a/plugins/modules/scaleway_snapshot_info.py b/plugins/modules/scaleway_snapshot_info.py index bebf27395c..47cd14cee8 100644 --- a/plugins/modules/scaleway_snapshot_info.py +++ b/plugins/modules/scaleway_snapshot_info.py @@ -18,7 +18,9 @@ author: - "Yanis Guenane (@Spredzy)" - "Remy Leone (@remyleone)" extends_documentation_fragment: -- community.general.scaleway + - community.general.scaleway + - community.general.attributes + - community.general.attributes.info_module options: region: diff --git a/plugins/modules/scaleway_volume_info.py b/plugins/modules/scaleway_volume_info.py index 14a8c96884..369fadbe64 100644 --- a/plugins/modules/scaleway_volume_info.py +++ b/plugins/modules/scaleway_volume_info.py @@ -18,7 +18,9 @@ author: - "Yanis Guenane (@Spredzy)" - "Remy Leone (@remyleone)" extends_documentation_fragment: -- community.general.scaleway + - community.general.scaleway + - community.general.attributes + - community.general.attributes.info_module options: region: diff --git a/plugins/modules/smartos_image_info.py b/plugins/modules/smartos_image_info.py index fb8c782317..0b5117fc45 100644 --- a/plugins/modules/smartos_image_info.py +++ b/plugins/modules/smartos_image_info.py @@ -18,6 +18,9 @@ description: - This module was called C(smartos_image_facts) before Ansible 2.9, returning C(ansible_facts). Note that the M(community.general.smartos_image_info) module no longer returns C(ansible_facts)! author: Adam Števko (@xen0l) +extends_documentation_fragment: + - community.general.attributes + - community.general.attributes.info_module options: filters: description: diff --git a/plugins/modules/snmp_facts.py b/plugins/modules/snmp_facts.py index 7683d7308b..71821faaa8 100644 --- a/plugins/modules/snmp_facts.py +++ b/plugins/modules/snmp_facts.py @@ -20,6 +20,10 @@ description: inserted to the ansible_facts key. requirements: - pysnmp +extends_documentation_fragment: + - community.general.attributes + - community.general.attributes.facts + - community.general.attributes.facts_module options: host: description: diff --git a/plugins/modules/utm_aaa_group_info.py b/plugins/modules/utm_aaa_group_info.py index 26d06cebfe..a01dad92ac 100644 --- a/plugins/modules/utm_aaa_group_info.py +++ b/plugins/modules/utm_aaa_group_info.py @@ -31,7 +31,9 @@ options: required: true extends_documentation_fragment: -- community.general.utm + - community.general.utm + - community.general.attributes + - community.general.attributes.info_module ''' diff --git a/plugins/modules/utm_ca_host_key_cert_info.py b/plugins/modules/utm_ca_host_key_cert_info.py index f67960eeef..e5de74cd4c 100644 --- a/plugins/modules/utm_ca_host_key_cert_info.py +++ b/plugins/modules/utm_ca_host_key_cert_info.py @@ -30,8 +30,9 @@ options: required: true extends_documentation_fragment: -- community.general.utm - + - community.general.utm + - community.general.attributes + - community.general.attributes.info_module ''' EXAMPLES = """ diff --git a/plugins/modules/utm_network_interface_address_info.py b/plugins/modules/utm_network_interface_address_info.py index d7910e73e4..736ea501ef 100644 --- a/plugins/modules/utm_network_interface_address_info.py +++ b/plugins/modules/utm_network_interface_address_info.py @@ -29,8 +29,9 @@ options: required: true extends_documentation_fragment: -- community.general.utm - + - community.general.utm + - community.general.attributes + - community.general.attributes.info_module ''' EXAMPLES = """ diff --git a/plugins/modules/utm_proxy_frontend_info.py b/plugins/modules/utm_proxy_frontend_info.py index 27a71a013e..0b8e124379 100644 --- a/plugins/modules/utm_proxy_frontend_info.py +++ b/plugins/modules/utm_proxy_frontend_info.py @@ -31,8 +31,9 @@ options: required: true extends_documentation_fragment: -- community.general.utm - + - community.general.utm + - community.general.attributes + - community.general.attributes.info_module ''' EXAMPLES = """ diff --git a/plugins/modules/utm_proxy_location_info.py b/plugins/modules/utm_proxy_location_info.py index b46603f8f1..0e7b165903 100644 --- a/plugins/modules/utm_proxy_location_info.py +++ b/plugins/modules/utm_proxy_location_info.py @@ -31,8 +31,9 @@ options: required: true extends_documentation_fragment: -- community.general.utm - + - community.general.utm + - community.general.attributes + - community.general.attributes.info_module ''' EXAMPLES = """ diff --git a/plugins/modules/vertica_info.py b/plugins/modules/vertica_info.py index 825006ad71..a51187de1d 100644 --- a/plugins/modules/vertica_info.py +++ b/plugins/modules/vertica_info.py @@ -17,6 +17,9 @@ description: - Gathers Vertica database information. - This module was called C(vertica_facts) before Ansible 2.9, returning C(ansible_facts). Note that the M(community.general.vertica_info) module no longer returns C(ansible_facts)! +extends_documentation_fragment: + - community.general.attributes + - community.general.attributes.info_module options: cluster: description: diff --git a/plugins/modules/wdc_redfish_info.py b/plugins/modules/wdc_redfish_info.py index 7ba9263b55..038e1a72db 100644 --- a/plugins/modules/wdc_redfish_info.py +++ b/plugins/modules/wdc_redfish_info.py @@ -16,6 +16,9 @@ version_added: 5.4.0 description: - Builds Redfish URIs locally and sends them to remote OOB controllers to get information back. +extends_documentation_fragment: + - community.general.attributes + - community.general.attributes.info_module options: category: required: true diff --git a/plugins/modules/xenserver_facts.py b/plugins/modules/xenserver_facts.py index 567aa07adb..10ec3cd50f 100644 --- a/plugins/modules/xenserver_facts.py +++ b/plugins/modules/xenserver_facts.py @@ -16,9 +16,13 @@ short_description: get facts reported on xenserver description: - Reads data out of XenAPI, can be used instead of multiple xe commands. author: - - Andy Hill (@andyhky) - - Tim Rupp (@caphrim007) - - Robin Lee (@cheese) + - Andy Hill (@andyhky) + - Tim Rupp (@caphrim007) + - Robin Lee (@cheese) +extends_documentation_fragment: + - community.general.attributes + - community.general.attributes.facts + - community.general.attributes.facts_module options: {} ''' diff --git a/plugins/modules/xenserver_guest_info.py b/plugins/modules/xenserver_guest_info.py index 750cc3a84f..5cdd52fc56 100644 --- a/plugins/modules/xenserver_guest_info.py +++ b/plugins/modules/xenserver_guest_info.py @@ -47,7 +47,8 @@ options: type: str extends_documentation_fragment: - community.general.xenserver.documentation - +- community.general.attributes +- community.general.attributes.info_module ''' EXAMPLES = r''' diff --git a/plugins/modules/xfconf_info.py b/plugins/modules/xfconf_info.py index 2bdb745393..149325ebac 100644 --- a/plugins/modules/xfconf_info.py +++ b/plugins/modules/xfconf_info.py @@ -15,6 +15,9 @@ short_description: Retrieve XFCE4 configurations version_added: 3.5.0 description: - This module allows retrieving Xfce 4 configurations with the help of C(xfconf-query). +extends_documentation_fragment: + - community.general.attributes + - community.general.attributes.info_module options: channel: description: diff --git a/plugins/modules/zfs_facts.py b/plugins/modules/zfs_facts.py index 15eef706e5..734659a7ea 100644 --- a/plugins/modules/zfs_facts.py +++ b/plugins/modules/zfs_facts.py @@ -16,6 +16,10 @@ short_description: Gather facts about ZFS datasets. description: - Gather facts from ZFS dataset properties. author: Adam Števko (@xen0l) +extends_documentation_fragment: + - community.general.attributes + - community.general.attributes.facts + - community.general.attributes.facts_module options: name: description: diff --git a/plugins/modules/zpool_facts.py b/plugins/modules/zpool_facts.py index a749438659..ec5fdc4442 100644 --- a/plugins/modules/zpool_facts.py +++ b/plugins/modules/zpool_facts.py @@ -16,6 +16,10 @@ short_description: Gather facts about ZFS pools. description: - Gather facts from ZFS pool properties. author: Adam Števko (@xen0l) +extends_documentation_fragment: + - community.general.attributes + - community.general.attributes.facts + - community.general.attributes.facts_module options: name: description: