From 9350954aa3db064ec10676e75eb2524ac2ba8131 Mon Sep 17 00:00:00 2001 From: "patchback[bot]" <45432694+patchback[bot]@users.noreply.github.com> Date: Mon, 20 Feb 2023 17:42:08 +0100 Subject: [PATCH] [PR #5958/ed79a685 backport][stable-6] Add attributes to atomic, memset, one, oneview, packet, proxmox, and xenserver modules (#6019) Add attributes to atomic, memset, one, oneview, packet, proxmox, and xenserver modules (#5958) Add attributes to atomic, memset, one, oneview, packet, proxmox, and xenserver modules. (cherry picked from commit ed79a685533b2940abcf5af64fbce8fa31de1ca3) Co-authored-by: Felix Fontein --- plugins/modules/atomic_container.py | 7 +++++++ plugins/modules/atomic_host.py | 7 +++++++ plugins/modules/atomic_image.py | 7 +++++++ plugins/modules/memset_dns_reload.py | 9 ++++++++- plugins/modules/memset_zone.py | 9 ++++++++- plugins/modules/memset_zone_domain.py | 9 ++++++++- plugins/modules/memset_zone_record.py | 9 ++++++++- plugins/modules/one_host.py | 10 ++++++++-- plugins/modules/one_image.py | 7 +++++++ plugins/modules/one_service.py | 7 +++++++ plugins/modules/one_template.py | 12 +++++++++--- plugins/modules/one_vm.py | 7 +++++++ plugins/modules/oneview_ethernet_network.py | 10 ++++++++-- plugins/modules/oneview_fc_network.py | 10 ++++++++-- plugins/modules/oneview_fcoe_network.py | 10 ++++++++-- .../modules/oneview_logical_interconnect_group.py | 10 ++++++++-- plugins/modules/oneview_network_set.py | 10 ++++++++-- plugins/modules/oneview_san_manager.py | 10 ++++++++-- plugins/modules/packet_device.py | 12 +++++++++--- plugins/modules/packet_ip_subnet.py | 9 +++++++++ plugins/modules/packet_project.py | 9 +++++++++ plugins/modules/packet_sshkey.py | 7 +++++++ plugins/modules/packet_volume.py | 9 +++++++++ plugins/modules/packet_volume_attachment.py | 9 +++++++++ plugins/modules/proxmox.py | 6 ++++++ plugins/modules/proxmox_disk.py | 6 ++++++ plugins/modules/proxmox_kvm.py | 6 ++++++ plugins/modules/proxmox_nic.py | 6 ++++++ plugins/modules/proxmox_snap.py | 7 ++++++- plugins/modules/proxmox_template.py | 9 ++++++++- plugins/modules/xenserver_guest.py | 6 ++++++ plugins/modules/xenserver_guest_powerstate.py | 6 ++++++ 32 files changed, 241 insertions(+), 26 deletions(-) diff --git a/plugins/modules/atomic_container.py b/plugins/modules/atomic_container.py index c32e617a22..c265102960 100644 --- a/plugins/modules/atomic_container.py +++ b/plugins/modules/atomic_container.py @@ -22,6 +22,13 @@ notes: requirements: - atomic - "python >= 2.6" +extends_documentation_fragment: + - community.general.attributes +attributes: + check_mode: + support: none + diff_mode: + support: none options: backend: description: diff --git a/plugins/modules/atomic_host.py b/plugins/modules/atomic_host.py index 5aa389e174..bb44c44896 100644 --- a/plugins/modules/atomic_host.py +++ b/plugins/modules/atomic_host.py @@ -22,6 +22,13 @@ notes: requirements: - atomic - python >= 2.6 +extends_documentation_fragment: + - community.general.attributes +attributes: + check_mode: + support: none + diff_mode: + support: none options: revision: description: diff --git a/plugins/modules/atomic_image.py b/plugins/modules/atomic_image.py index 2705304f01..65aec1e9d5 100644 --- a/plugins/modules/atomic_image.py +++ b/plugins/modules/atomic_image.py @@ -22,6 +22,13 @@ notes: requirements: - atomic - python >= 2.6 +extends_documentation_fragment: + - community.general.attributes +attributes: + check_mode: + support: none + diff_mode: + support: none options: backend: description: diff --git a/plugins/modules/memset_dns_reload.py b/plugins/modules/memset_dns_reload.py index 580740d1a3..c69df6d783 100644 --- a/plugins/modules/memset_dns_reload.py +++ b/plugins/modules/memset_dns_reload.py @@ -21,7 +21,14 @@ notes: I(dns.reload). If you wish to poll the job status to wait until the reload has completed, then I(job.status) is also required. description: - - Request a reload of Memset's DNS infrastructure, and optionally poll until it finishes. + - Request a reload of Memset's DNS infrastructure, and optionally poll until it finishes. +extends_documentation_fragment: + - community.general.attributes +attributes: + check_mode: + support: none + diff_mode: + support: none options: api_key: required: true diff --git a/plugins/modules/memset_zone.py b/plugins/modules/memset_zone.py index 02b5fd28f0..738d9e16ba 100644 --- a/plugins/modules/memset_zone.py +++ b/plugins/modules/memset_zone.py @@ -19,7 +19,14 @@ notes: Memset customer control panel is needed with the following minimum scope - I(dns.zone_create), I(dns.zone_delete), I(dns.zone_list). description: - - Manage DNS zones in a Memset account. + - Manage DNS zones in a Memset account. +extends_documentation_fragment: + - community.general.attributes +attributes: + check_mode: + support: full + diff_mode: + support: none options: state: required: true diff --git a/plugins/modules/memset_zone_domain.py b/plugins/modules/memset_zone_domain.py index 1e18a984b6..26276f68a5 100644 --- a/plugins/modules/memset_zone_domain.py +++ b/plugins/modules/memset_zone_domain.py @@ -21,7 +21,14 @@ notes: - Currently this module can only create one domain at a time. Multiple domains should be created using C(with_items). description: - - Manage DNS zone domains in a Memset account. + - Manage DNS zone domains in a Memset account. +extends_documentation_fragment: + - community.general.attributes +attributes: + check_mode: + support: full + diff_mode: + support: none options: state: default: present diff --git a/plugins/modules/memset_zone_record.py b/plugins/modules/memset_zone_record.py index 16a1c3a742..021ad461d2 100644 --- a/plugins/modules/memset_zone_record.py +++ b/plugins/modules/memset_zone_record.py @@ -21,7 +21,14 @@ notes: - Currently this module can only create one DNS record at a time. Multiple records should be created using C(with_items). description: - - Manage DNS records in a Memset account. + - Manage DNS records in a Memset account. +extends_documentation_fragment: + - community.general.attributes +attributes: + check_mode: + support: full + diff_mode: + support: none options: state: default: present diff --git a/plugins/modules/one_host.py b/plugins/modules/one_host.py index 20bdaa4088..c4578f9501 100644 --- a/plugins/modules/one_host.py +++ b/plugins/modules/one_host.py @@ -23,6 +23,12 @@ requirements: description: - "Manages OpenNebula Hosts" +attributes: + check_mode: + support: none + diff_mode: + support: none + options: name: description: @@ -77,8 +83,8 @@ options: type: dict extends_documentation_fragment: -- community.general.opennebula - + - community.general.opennebula + - community.general.attributes author: - Rafael del Valle (@rvalle) diff --git a/plugins/modules/one_image.py b/plugins/modules/one_image.py index fb255dc590..a50b33e93e 100644 --- a/plugins/modules/one_image.py +++ b/plugins/modules/one_image.py @@ -16,6 +16,13 @@ description: - Manages OpenNebula images requirements: - pyone +extends_documentation_fragment: + - community.general.attributes +attributes: + check_mode: + support: full + diff_mode: + support: none options: api_url: description: diff --git a/plugins/modules/one_service.py b/plugins/modules/one_service.py index 6bc3137cc3..4f51438870 100644 --- a/plugins/modules/one_service.py +++ b/plugins/modules/one_service.py @@ -14,6 +14,13 @@ module: one_service short_description: Deploy and manage OpenNebula services description: - Manage OpenNebula services +extends_documentation_fragment: + - community.general.attributes +attributes: + check_mode: + support: full + diff_mode: + support: none options: api_url: description: diff --git a/plugins/modules/one_template.py b/plugins/modules/one_template.py index 8cfac6baf0..97d0f856ed 100644 --- a/plugins/modules/one_template.py +++ b/plugins/modules/one_template.py @@ -23,6 +23,14 @@ requirements: description: - "Manages OpenNebula templates." +attributes: + check_mode: + support: partial + details: + - Note that check mode always returns C(changed=true) for existing templates, even if the template would not actually change. + diff_mode: + support: none + options: id: description: @@ -47,11 +55,9 @@ options: default: present type: str -notes: - - Supports C(check_mode). Note that check mode always returns C(changed=true) for existing templates, even if the template would not actually change. - extends_documentation_fragment: - community.general.opennebula + - community.general.attributes author: - "Georg Gadinger (@nilsding)" diff --git a/plugins/modules/one_vm.py b/plugins/modules/one_vm.py index 3724d9433d..1bbf474661 100644 --- a/plugins/modules/one_vm.py +++ b/plugins/modules/one_vm.py @@ -17,6 +17,13 @@ description: - Manages OpenNebula instances requirements: - pyone +extends_documentation_fragment: + - community.general.attributes +attributes: + check_mode: + support: full + diff_mode: + support: none options: api_url: description: diff --git a/plugins/modules/oneview_ethernet_network.py b/plugins/modules/oneview_ethernet_network.py index 3c8711fe05..8eb63db5aa 100644 --- a/plugins/modules/oneview_ethernet_network.py +++ b/plugins/modules/oneview_ethernet_network.py @@ -19,6 +19,11 @@ author: - Felipe Bulsoni (@fgbulsoni) - Thiago Miotto (@tmiotto) - Adriane Cardozo (@adriane-cardozo) +attributes: + check_mode: + support: none + diff_mode: + support: none options: state: description: @@ -35,8 +40,9 @@ options: type: dict required: true extends_documentation_fragment: -- community.general.oneview -- community.general.oneview.validateetag + - community.general.oneview + - community.general.oneview.validateetag + - community.general.attributes ''' diff --git a/plugins/modules/oneview_fc_network.py b/plugins/modules/oneview_fc_network.py index 2898447c0b..4c5f867e23 100644 --- a/plugins/modules/oneview_fc_network.py +++ b/plugins/modules/oneview_fc_network.py @@ -16,6 +16,11 @@ description: requirements: - "hpOneView >= 4.0.0" author: "Felipe Bulsoni (@fgbulsoni)" +attributes: + check_mode: + support: none + diff_mode: + support: none options: state: description: @@ -32,8 +37,9 @@ options: required: true extends_documentation_fragment: -- community.general.oneview -- community.general.oneview.validateetag + - community.general.oneview + - community.general.oneview.validateetag + - community.general.attributes ''' diff --git a/plugins/modules/oneview_fcoe_network.py b/plugins/modules/oneview_fcoe_network.py index 61102dff15..73eef5af08 100644 --- a/plugins/modules/oneview_fcoe_network.py +++ b/plugins/modules/oneview_fcoe_network.py @@ -17,6 +17,11 @@ requirements: - "python >= 2.7.9" - "hpOneView >= 4.0.0" author: "Felipe Bulsoni (@fgbulsoni)" +attributes: + check_mode: + support: none + diff_mode: + support: none options: state: description: @@ -33,8 +38,9 @@ options: required: true extends_documentation_fragment: -- community.general.oneview -- community.general.oneview.validateetag + - community.general.oneview + - community.general.oneview.validateetag + - community.general.attributes ''' diff --git a/plugins/modules/oneview_logical_interconnect_group.py b/plugins/modules/oneview_logical_interconnect_group.py index ed51722672..cd8e875285 100644 --- a/plugins/modules/oneview_logical_interconnect_group.py +++ b/plugins/modules/oneview_logical_interconnect_group.py @@ -20,6 +20,11 @@ author: - Felipe Bulsoni (@fgbulsoni) - Thiago Miotto (@tmiotto) - Adriane Cardozo (@adriane-cardozo) +attributes: + check_mode: + support: none + diff_mode: + support: none options: state: description: @@ -35,8 +40,9 @@ options: type: dict required: true extends_documentation_fragment: -- community.general.oneview -- community.general.oneview.validateetag + - community.general.oneview + - community.general.oneview.validateetag + - community.general.attributes ''' diff --git a/plugins/modules/oneview_network_set.py b/plugins/modules/oneview_network_set.py index 6dac04c5ca..a6a62a05c2 100644 --- a/plugins/modules/oneview_network_set.py +++ b/plugins/modules/oneview_network_set.py @@ -19,6 +19,11 @@ author: - Felipe Bulsoni (@fgbulsoni) - Thiago Miotto (@tmiotto) - Adriane Cardozo (@adriane-cardozo) +attributes: + check_mode: + support: none + diff_mode: + support: none options: state: description: @@ -35,8 +40,9 @@ options: required: true extends_documentation_fragment: -- community.general.oneview -- community.general.oneview.validateetag + - community.general.oneview + - community.general.oneview.validateetag + - community.general.attributes ''' diff --git a/plugins/modules/oneview_san_manager.py b/plugins/modules/oneview_san_manager.py index a22398074a..65a016b1c2 100644 --- a/plugins/modules/oneview_san_manager.py +++ b/plugins/modules/oneview_san_manager.py @@ -19,6 +19,11 @@ author: - Felipe Bulsoni (@fgbulsoni) - Thiago Miotto (@tmiotto) - Adriane Cardozo (@adriane-cardozo) +attributes: + check_mode: + support: none + diff_mode: + support: none options: state: description: @@ -36,8 +41,9 @@ options: required: true extends_documentation_fragment: -- community.general.oneview -- community.general.oneview.validateetag + - community.general.oneview + - community.general.oneview.validateetag + - community.general.attributes ''' diff --git a/plugins/modules/packet_device.py b/plugins/modules/packet_device.py index a2c2d1d653..d220c5f8f7 100644 --- a/plugins/modules/packet_device.py +++ b/plugins/modules/packet_device.py @@ -28,6 +28,15 @@ author: - Matt Baldwin (@baldwinSPC) - Thibaud Morel l'Horset (@teebes) +extends_documentation_fragment: + - community.general.attributes + +attributes: + check_mode: + support: none + diff_mode: + support: none + options: auth_token: description: @@ -149,9 +158,6 @@ options: requirements: - "packet-python >= 1.35" -notes: - - Doesn't support check mode. - ''' EXAMPLES = ''' diff --git a/plugins/modules/packet_ip_subnet.py b/plugins/modules/packet_ip_subnet.py index 63790e1c6a..afeb7ea04c 100644 --- a/plugins/modules/packet_ip_subnet.py +++ b/plugins/modules/packet_ip_subnet.py @@ -28,6 +28,15 @@ author: - Tomas Karasek (@t0mk) - Nurfet Becirevic (@nurfet-becirevic) +extends_documentation_fragment: + - community.general.attributes + +attributes: + check_mode: + support: full + diff_mode: + support: none + options: auth_token: description: diff --git a/plugins/modules/packet_project.py b/plugins/modules/packet_project.py index 9a82c2ec72..da4a2bb89f 100644 --- a/plugins/modules/packet_project.py +++ b/plugins/modules/packet_project.py @@ -26,6 +26,15 @@ author: - Tomas Karasek (@t0mk) - Nurfet Becirevic (@nurfet-becirevic) +extends_documentation_fragment: + - community.general.attributes + +attributes: + check_mode: + support: full + diff_mode: + support: none + options: state: description: diff --git a/plugins/modules/packet_sshkey.py b/plugins/modules/packet_sshkey.py index 87beb01aa8..97f55ba23b 100644 --- a/plugins/modules/packet_sshkey.py +++ b/plugins/modules/packet_sshkey.py @@ -16,6 +16,13 @@ description: - Create/delete an SSH key in Packet host. - API is documented at U(https://www.packet.net/help/api/#page:ssh-keys,header:ssh-keys-ssh-keys-post). author: "Tomas Karasek (@t0mk) " +extends_documentation_fragment: + - community.general.attributes +attributes: + check_mode: + support: none + diff_mode: + support: none options: state: description: diff --git a/plugins/modules/packet_volume.py b/plugins/modules/packet_volume.py index b06e57b56c..910d64b55b 100644 --- a/plugins/modules/packet_volume.py +++ b/plugins/modules/packet_volume.py @@ -25,6 +25,15 @@ author: - Tomas Karasek (@t0mk) - Nurfet Becirevic (@nurfet-becirevic) +extends_documentation_fragment: + - community.general.attributes + +attributes: + check_mode: + support: full + diff_mode: + support: none + options: state: description: diff --git a/plugins/modules/packet_volume_attachment.py b/plugins/modules/packet_volume_attachment.py index 74b42ab479..7f6c68e054 100644 --- a/plugins/modules/packet_volume_attachment.py +++ b/plugins/modules/packet_volume_attachment.py @@ -29,6 +29,15 @@ author: - Tomas Karasek (@t0mk) - Nurfet Becirevic (@nurfet-becirevic) +extends_documentation_fragment: + - community.general.attributes + +attributes: + check_mode: + support: full + diff_mode: + support: none + options: state: description: diff --git a/plugins/modules/proxmox.py b/plugins/modules/proxmox.py index 640f9b4114..315ee601ad 100644 --- a/plugins/modules/proxmox.py +++ b/plugins/modules/proxmox.py @@ -16,6 +16,11 @@ description: - allows you to create/delete/stop instances in Proxmox VE cluster - Starting in Ansible 2.1, it automatically detects containerization type (lxc for PVE 4, openvz for older) - Since community.general 4.0.0 on, there are no more default values, see I(proxmox_default_behavior). +attributes: + check_mode: + support: none + diff_mode: + support: none options: password: description: @@ -202,6 +207,7 @@ author: Sergei Antipov (@UnderGreen) extends_documentation_fragment: - community.general.proxmox.documentation - community.general.proxmox.selection + - community.general.attributes ''' EXAMPLES = r''' diff --git a/plugins/modules/proxmox_disk.py b/plugins/modules/proxmox_disk.py index 8292b1de50..df6735cc0c 100644 --- a/plugins/modules/proxmox_disk.py +++ b/plugins/modules/proxmox_disk.py @@ -16,6 +16,11 @@ version_added: 5.7.0 description: - Allows you to perform some supported operations on a disk in Qemu(KVM) Virtual Machines in a Proxmox VE cluster. author: "Castor Sky (@castorsky) " +attributes: + check_mode: + support: none + diff_mode: + support: none options: name: description: @@ -311,6 +316,7 @@ options: type: str extends_documentation_fragment: - community.general.proxmox.documentation + - community.general.attributes ''' EXAMPLES = ''' diff --git a/plugins/modules/proxmox_kvm.py b/plugins/modules/proxmox_kvm.py index 25e252bee9..852f6333b7 100644 --- a/plugins/modules/proxmox_kvm.py +++ b/plugins/modules/proxmox_kvm.py @@ -16,6 +16,11 @@ description: - Allows you to create/delete/stop Qemu(KVM) Virtual Machines in Proxmox VE cluster. - Since community.general 4.0.0 on, there are no more default values, see I(proxmox_default_behavior). author: "Abdoul Bah (@helldorado) " +attributes: + check_mode: + support: none + diff_mode: + support: none options: acpi: description: @@ -519,6 +524,7 @@ options: extends_documentation_fragment: - community.general.proxmox.documentation - community.general.proxmox.selection + - community.general.attributes ''' EXAMPLES = ''' diff --git a/plugins/modules/proxmox_nic.py b/plugins/modules/proxmox_nic.py index 5c8c3f47df..26d07c7ecc 100644 --- a/plugins/modules/proxmox_nic.py +++ b/plugins/modules/proxmox_nic.py @@ -16,6 +16,11 @@ version_added: 3.1.0 description: - Allows you to create/update/delete a NIC on Qemu(KVM) Virtual Machines in a Proxmox VE cluster. author: "Lammert Hellinga (@Kogelvis) " +attributes: + check_mode: + support: full + diff_mode: + support: none options: bridge: description: @@ -90,6 +95,7 @@ options: type: int extends_documentation_fragment: - community.general.proxmox.documentation + - community.general.attributes ''' EXAMPLES = ''' diff --git a/plugins/modules/proxmox_snap.py b/plugins/modules/proxmox_snap.py index 3bd7c4ee32..0c17f83763 100644 --- a/plugins/modules/proxmox_snap.py +++ b/plugins/modules/proxmox_snap.py @@ -16,6 +16,11 @@ version_added: 2.0.0 description: - Allows you to create/delete/restore snapshots from instances in Proxmox VE cluster. - Supports both KVM and LXC, OpenVZ has not been tested, as it is no longer supported on Proxmox VE. +attributes: + check_mode: + support: full + diff_mode: + support: none options: hostname: description: @@ -72,11 +77,11 @@ options: notes: - Requires proxmoxer and requests modules on host. These modules can be installed with pip. - - Supports C(check_mode). requirements: [ "proxmoxer", "python >= 2.7", "requests" ] author: Jeffrey van Pelt (@Thulium-Drake) extends_documentation_fragment: - community.general.proxmox.documentation + - community.general.attributes ''' EXAMPLES = r''' diff --git a/plugins/modules/proxmox_template.py b/plugins/modules/proxmox_template.py index a09af2f2a3..2bf24ff845 100644 --- a/plugins/modules/proxmox_template.py +++ b/plugins/modules/proxmox_template.py @@ -15,6 +15,11 @@ module: proxmox_template short_description: Management of OS templates in Proxmox VE cluster description: - allows you to upload/delete templates in Proxmox VE cluster +attributes: + check_mode: + support: none + diff_mode: + support: none options: node: description: @@ -62,7 +67,9 @@ options: notes: - Requires C(proxmoxer) and C(requests) modules on host. This modules can be installed with M(ansible.builtin.pip). author: Sergei Antipov (@UnderGreen) -extends_documentation_fragment: community.general.proxmox.documentation +extends_documentation_fragment: + - community.general.proxmox.documentation + - community.general.attributes ''' EXAMPLES = ''' diff --git a/plugins/modules/xenserver_guest.py b/plugins/modules/xenserver_guest.py index 95b25174cf..7659ee2aed 100644 --- a/plugins/modules/xenserver_guest.py +++ b/plugins/modules/xenserver_guest.py @@ -46,6 +46,11 @@ notes: requirements: - python >= 2.6 - XenAPI +attributes: + check_mode: + support: full + diff_mode: + support: none options: state: description: @@ -286,6 +291,7 @@ options: default: false extends_documentation_fragment: - community.general.xenserver.documentation +- community.general.attributes ''' diff --git a/plugins/modules/xenserver_guest_powerstate.py b/plugins/modules/xenserver_guest_powerstate.py index 2bb7264875..ba88bbf1de 100644 --- a/plugins/modules/xenserver_guest_powerstate.py +++ b/plugins/modules/xenserver_guest_powerstate.py @@ -30,6 +30,11 @@ notes: requirements: - python >= 2.6 - XenAPI +attributes: + check_mode: + support: full + diff_mode: + support: none options: state: description: @@ -67,6 +72,7 @@ options: default: 0 extends_documentation_fragment: - community.general.xenserver.documentation +- community.general.attributes '''