From e944a67c182df970f407e272741d46ea0724912f Mon Sep 17 00:00:00 2001 From: Felix Fontein Date: Fri, 24 Feb 2023 09:23:28 +0100 Subject: [PATCH] Add attributes to manageiq, udm, utm, and webfaction modules (#5955) Add attributes to manageiq, udm, utm, and webfaction modules. --- plugins/modules/manageiq_alert_profiles.py | 9 ++++++++- plugins/modules/manageiq_alerts.py | 9 ++++++++- plugins/modules/manageiq_group.py | 11 +++++++++-- plugins/modules/manageiq_policies.py | 9 ++++++++- plugins/modules/manageiq_provider.py | 9 ++++++++- plugins/modules/manageiq_tags.py | 9 ++++++++- plugins/modules/manageiq_tenant.py | 10 ++++++++-- plugins/modules/manageiq_user.py | 9 ++++++++- plugins/modules/udm_dns_record.py | 10 ++++++++-- plugins/modules/udm_dns_zone.py | 11 ++++++++--- plugins/modules/udm_group.py | 11 ++++++++--- plugins/modules/udm_share.py | 11 ++++++++--- plugins/modules/udm_user.py | 11 ++++++++--- plugins/modules/utm_aaa_group.py | 6 ++++++ plugins/modules/utm_ca_host_key_cert.py | 6 ++++++ plugins/modules/utm_dns_host.py | 6 ++++++ plugins/modules/utm_network_interface_address.py | 6 ++++++ plugins/modules/utm_proxy_auth_profile.py | 6 ++++++ plugins/modules/utm_proxy_exception.py | 6 ++++++ plugins/modules/utm_proxy_frontend.py | 6 ++++++ plugins/modules/utm_proxy_location.py | 6 ++++++ plugins/modules/webfaction_app.py | 9 +++++++++ plugins/modules/webfaction_db.py | 7 +++++++ plugins/modules/webfaction_domain.py | 9 +++++++++ plugins/modules/webfaction_mailbox.py | 10 ++++++++++ plugins/modules/webfaction_site.py | 9 +++++++++ 26 files changed, 197 insertions(+), 24 deletions(-) diff --git a/plugins/modules/manageiq_alert_profiles.py b/plugins/modules/manageiq_alert_profiles.py index 1ea5c57b09..c6cefad6a8 100644 --- a/plugins/modules/manageiq_alert_profiles.py +++ b/plugins/modules/manageiq_alert_profiles.py @@ -14,12 +14,19 @@ module: manageiq_alert_profiles short_description: Configuration of alert profiles for ManageIQ extends_documentation_fragment: -- community.general.manageiq + - community.general.manageiq + - community.general.attributes author: Elad Alfassa (@elad661) description: - The manageiq_alert_profiles module supports adding, updating and deleting alert profiles in ManageIQ. +attributes: + check_mode: + support: none + diff_mode: + support: none + options: state: type: str diff --git a/plugins/modules/manageiq_alerts.py b/plugins/modules/manageiq_alerts.py index d12ebd6ea6..518b29f1f3 100644 --- a/plugins/modules/manageiq_alerts.py +++ b/plugins/modules/manageiq_alerts.py @@ -14,12 +14,19 @@ module: manageiq_alerts short_description: Configuration of alerts in ManageIQ extends_documentation_fragment: -- community.general.manageiq + - community.general.manageiq + - community.general.attributes author: Elad Alfassa (@elad661) description: - The manageiq_alerts module supports adding, updating and deleting alerts in ManageIQ. +attributes: + check_mode: + support: none + diff_mode: + support: none + options: state: type: str diff --git a/plugins/modules/manageiq_group.py b/plugins/modules/manageiq_group.py index 5772c19a7e..a142a939fe 100644 --- a/plugins/modules/manageiq_group.py +++ b/plugins/modules/manageiq_group.py @@ -14,13 +14,20 @@ module: manageiq_group short_description: Management of groups in ManageIQ extends_documentation_fragment: -- community.general.manageiq + - community.general.manageiq + - community.general.attributes author: Evert Mulder (@evertmulder) description: - The manageiq_group module supports adding, updating and deleting groups in ManageIQ. requirements: -- manageiq-client + - manageiq-client + +attributes: + check_mode: + support: none + diff_mode: + support: none options: state: diff --git a/plugins/modules/manageiq_policies.py b/plugins/modules/manageiq_policies.py index fa96fc950f..7d05f2dfad 100644 --- a/plugins/modules/manageiq_policies.py +++ b/plugins/modules/manageiq_policies.py @@ -15,12 +15,19 @@ module: manageiq_policies short_description: Management of resource policy_profiles in ManageIQ extends_documentation_fragment: -- community.general.manageiq + - community.general.manageiq + - community.general.attributes author: Daniel Korn (@dkorn) description: - The manageiq_policies module supports adding and deleting policy_profiles in ManageIQ. +attributes: + check_mode: + support: none + diff_mode: + support: none + options: state: type: str diff --git a/plugins/modules/manageiq_provider.py b/plugins/modules/manageiq_provider.py index 5eb6d779ac..bbc27214b7 100644 --- a/plugins/modules/manageiq_provider.py +++ b/plugins/modules/manageiq_provider.py @@ -13,12 +13,19 @@ DOCUMENTATION = ''' module: manageiq_provider short_description: Management of provider in ManageIQ extends_documentation_fragment: -- community.general.manageiq + - community.general.manageiq + - community.general.attributes author: Daniel Korn (@dkorn) description: - The manageiq_provider module supports adding, updating, and deleting provider in ManageIQ. +attributes: + check_mode: + support: none + diff_mode: + support: none + options: state: type: str diff --git a/plugins/modules/manageiq_tags.py b/plugins/modules/manageiq_tags.py index 5e6b944533..8631ac46a4 100644 --- a/plugins/modules/manageiq_tags.py +++ b/plugins/modules/manageiq_tags.py @@ -15,12 +15,19 @@ module: manageiq_tags short_description: Management of resource tags in ManageIQ extends_documentation_fragment: -- community.general.manageiq + - community.general.manageiq + - community.general.attributes author: Daniel Korn (@dkorn) description: - The manageiq_tags module supports adding, updating and deleting tags in ManageIQ. +attributes: + check_mode: + support: none + diff_mode: + support: none + options: state: type: str diff --git a/plugins/modules/manageiq_tenant.py b/plugins/modules/manageiq_tenant.py index f3700d2492..d68e26a735 100644 --- a/plugins/modules/manageiq_tenant.py +++ b/plugins/modules/manageiq_tenant.py @@ -14,13 +14,19 @@ module: manageiq_tenant short_description: Management of tenants in ManageIQ extends_documentation_fragment: -- community.general.manageiq + - community.general.manageiq + - community.general.attributes author: Evert Mulder (@evertmulder) description: - The manageiq_tenant module supports adding, updating and deleting tenants in ManageIQ. requirements: -- manageiq-client + - manageiq-client +attributes: + check_mode: + support: none + diff_mode: + support: none options: state: type: str diff --git a/plugins/modules/manageiq_user.py b/plugins/modules/manageiq_user.py index 9910e092e0..0d3d8718b4 100644 --- a/plugins/modules/manageiq_user.py +++ b/plugins/modules/manageiq_user.py @@ -14,12 +14,19 @@ module: manageiq_user short_description: Management of users in ManageIQ extends_documentation_fragment: -- community.general.manageiq + - community.general.manageiq + - community.general.attributes author: Daniel Korn (@dkorn) description: - The manageiq_user module supports adding, updating and deleting users in ManageIQ. +attributes: + check_mode: + support: none + diff_mode: + support: none + options: state: type: str diff --git a/plugins/modules/udm_dns_record.py b/plugins/modules/udm_dns_record.py index 13eb4feed4..458a8e4ba5 100644 --- a/plugins/modules/udm_dns_record.py +++ b/plugins/modules/udm_dns_record.py @@ -14,15 +14,21 @@ DOCUMENTATION = ''' --- module: udm_dns_record author: -- Tobias Rüetschi (@keachi) + - Tobias Rüetschi (@keachi) short_description: Manage dns entries on a univention corporate server description: - "This module allows to manage dns records on a univention corporate server (UCS). It uses the python API of the UCS to create a new object or edit it." requirements: - - Python >= 2.6 - Univention - ipaddress (for I(type=ptr_record)) +extends_documentation_fragment: + - community.general.attributes +attributes: + check_mode: + support: full + diff_mode: + support: partial options: state: type: str diff --git a/plugins/modules/udm_dns_zone.py b/plugins/modules/udm_dns_zone.py index b75cbe95ac..19f24fa1c2 100644 --- a/plugins/modules/udm_dns_zone.py +++ b/plugins/modules/udm_dns_zone.py @@ -14,13 +14,18 @@ DOCUMENTATION = ''' --- module: udm_dns_zone author: -- Tobias Rüetschi (@keachi) + - Tobias Rüetschi (@keachi) short_description: Manage dns zones on a univention corporate server description: - "This module allows to manage dns zones on a univention corporate server (UCS). It uses the python API of the UCS to create a new object or edit it." -requirements: - - Python >= 2.6 +extends_documentation_fragment: + - community.general.attributes +attributes: + check_mode: + support: full + diff_mode: + support: partial options: state: type: str diff --git a/plugins/modules/udm_group.py b/plugins/modules/udm_group.py index 74916cfee2..5fe2422f8b 100644 --- a/plugins/modules/udm_group.py +++ b/plugins/modules/udm_group.py @@ -14,13 +14,18 @@ DOCUMENTATION = ''' --- module: udm_group author: -- Tobias Rüetschi (@keachi) + - Tobias Rüetschi (@keachi) short_description: Manage of the posix group description: - "This module allows to manage user groups on a univention corporate server (UCS). It uses the python API of the UCS to create a new object or edit it." -requirements: - - Python >= 2.6 +extends_documentation_fragment: + - community.general.attributes +attributes: + check_mode: + support: full + diff_mode: + support: partial options: state: required: false diff --git a/plugins/modules/udm_share.py b/plugins/modules/udm_share.py index 8120df1b00..2743913351 100644 --- a/plugins/modules/udm_share.py +++ b/plugins/modules/udm_share.py @@ -14,14 +14,19 @@ DOCUMENTATION = ''' --- module: udm_share author: -- Tobias Rüetschi (@keachi) + - Tobias Rüetschi (@keachi) short_description: Manage samba shares on a univention corporate server description: - "This module allows to manage samba shares on a univention corporate server (UCS). It uses the python API of the UCS to create a new object or edit it." -requirements: - - Python >= 2.6 +extends_documentation_fragment: + - community.general.attributes +attributes: + check_mode: + support: full + diff_mode: + support: partial options: state: default: "present" diff --git a/plugins/modules/udm_user.py b/plugins/modules/udm_user.py index 96bbdfbc10..05c5ad359d 100644 --- a/plugins/modules/udm_user.py +++ b/plugins/modules/udm_user.py @@ -14,14 +14,19 @@ DOCUMENTATION = r''' --- module: udm_user author: -- Tobias Rüetschi (@keachi) + - Tobias Rüetschi (@keachi) short_description: Manage posix users on a univention corporate server description: - "This module allows to manage posix users on a univention corporate server (UCS). It uses the python API of the UCS to create a new object or edit it." -requirements: - - Python >= 2.6 +extends_documentation_fragment: + - community.general.attributes +attributes: + check_mode: + support: full + diff_mode: + support: partial options: state: default: "present" diff --git a/plugins/modules/utm_aaa_group.py b/plugins/modules/utm_aaa_group.py index 3d5cbc2007..9c595284da 100644 --- a/plugins/modules/utm_aaa_group.py +++ b/plugins/modules/utm_aaa_group.py @@ -21,6 +21,11 @@ description: - Create, update or destroy an aaa group object in Sophos UTM. - This module needs to have the REST Ability of the UTM to be activated. +attributes: + check_mode: + support: none + diff_mode: + support: none options: name: @@ -112,6 +117,7 @@ options: extends_documentation_fragment: - community.general.utm +- community.general.attributes ''' diff --git a/plugins/modules/utm_ca_host_key_cert.py b/plugins/modules/utm_ca_host_key_cert.py index 318bc1fd31..b944e83124 100644 --- a/plugins/modules/utm_ca_host_key_cert.py +++ b/plugins/modules/utm_ca_host_key_cert.py @@ -22,6 +22,11 @@ description: - Create, update or destroy a ca host_key_cert entry in SOPHOS UTM. - This module needs to have the REST Ability of the UTM to be activated. +attributes: + check_mode: + support: none + diff_mode: + support: none options: name: @@ -60,6 +65,7 @@ options: extends_documentation_fragment: - community.general.utm +- community.general.attributes ''' diff --git a/plugins/modules/utm_dns_host.py b/plugins/modules/utm_dns_host.py index 3a1744651a..6b3725557b 100644 --- a/plugins/modules/utm_dns_host.py +++ b/plugins/modules/utm_dns_host.py @@ -21,6 +21,11 @@ description: - Create, update or destroy a dns entry in SOPHOS UTM. - This module needs to have the REST Ability of the UTM to be activated. +attributes: + check_mode: + support: none + diff_mode: + support: none options: name: @@ -70,6 +75,7 @@ options: extends_documentation_fragment: - community.general.utm +- community.general.attributes ''' diff --git a/plugins/modules/utm_network_interface_address.py b/plugins/modules/utm_network_interface_address.py index e980a0221b..a85a46aeab 100644 --- a/plugins/modules/utm_network_interface_address.py +++ b/plugins/modules/utm_network_interface_address.py @@ -21,6 +21,11 @@ description: - Create, update or destroy a network/interface_address object in SOPHOS UTM. - This module needs to have the REST Ability of the UTM to be activated. +attributes: + check_mode: + support: none + diff_mode: + support: none options: name: @@ -54,6 +59,7 @@ options: extends_documentation_fragment: - community.general.utm +- community.general.attributes ''' diff --git a/plugins/modules/utm_proxy_auth_profile.py b/plugins/modules/utm_proxy_auth_profile.py index 0c53a92380..ef3fc341a3 100644 --- a/plugins/modules/utm_proxy_auth_profile.py +++ b/plugins/modules/utm_proxy_auth_profile.py @@ -22,6 +22,11 @@ description: - Create, update or destroy a reverse_proxy auth_profile entry in SOPHOS UTM. - This module needs to have the REST Ability of the UTM to be activated. +attributes: + check_mode: + support: none + diff_mode: + support: none options: name: @@ -185,6 +190,7 @@ options: extends_documentation_fragment: - community.general.utm +- community.general.attributes ''' diff --git a/plugins/modules/utm_proxy_exception.py b/plugins/modules/utm_proxy_exception.py index f322bc8216..a0a3f85b5b 100644 --- a/plugins/modules/utm_proxy_exception.py +++ b/plugins/modules/utm_proxy_exception.py @@ -22,6 +22,11 @@ description: - Create, update or destroy a reverse_proxy exception entry in SOPHOS UTM. - This module needs to have the REST Ability of the UTM to be activated. +attributes: + check_mode: + support: none + diff_mode: + support: none options: name: @@ -123,6 +128,7 @@ options: extends_documentation_fragment: - community.general.utm +- community.general.attributes ''' diff --git a/plugins/modules/utm_proxy_frontend.py b/plugins/modules/utm_proxy_frontend.py index 127c7d4d43..22a773fef8 100644 --- a/plugins/modules/utm_proxy_frontend.py +++ b/plugins/modules/utm_proxy_frontend.py @@ -22,6 +22,11 @@ description: - Create, update or destroy a reverse_proxy frontend entry in Sophos UTM. - This module needs to have the REST Ability of the UTM to be activated. +attributes: + check_mode: + support: none + diff_mode: + support: none options: name: @@ -138,6 +143,7 @@ options: extends_documentation_fragment: - community.general.utm +- community.general.attributes ''' diff --git a/plugins/modules/utm_proxy_location.py b/plugins/modules/utm_proxy_location.py index 0efeea5a27..c22de7b927 100644 --- a/plugins/modules/utm_proxy_location.py +++ b/plugins/modules/utm_proxy_location.py @@ -22,6 +22,11 @@ description: - Create, update or destroy a reverse_proxy location entry in SOPHOS UTM. - This module needs to have the REST Ability of the UTM to be activated. +attributes: + check_mode: + support: none + diff_mode: + support: none options: name: @@ -104,6 +109,7 @@ options: extends_documentation_fragment: - community.general.utm +- community.general.attributes ''' diff --git a/plugins/modules/webfaction_app.py b/plugins/modules/webfaction_app.py index b2fe7f892d..7a47026755 100644 --- a/plugins/modules/webfaction_app.py +++ b/plugins/modules/webfaction_app.py @@ -31,6 +31,15 @@ notes: your host, you may want to add C(serial: 1) to the plays. - See `the webfaction API `_ for more info. +extends_documentation_fragment: + - community.general.attributes + +attributes: + check_mode: + support: full + diff_mode: + support: none + options: name: description: diff --git a/plugins/modules/webfaction_db.py b/plugins/modules/webfaction_db.py index 868f1f66a2..c4742cb217 100644 --- a/plugins/modules/webfaction_db.py +++ b/plugins/modules/webfaction_db.py @@ -27,6 +27,13 @@ notes: The location is not important. However, running them on multiple hosts I(simultaneously) is best avoided. If you don't specify I(localhost) as your host, you may want to add C(serial: 1) to the plays. - See `the webfaction API `_ for more info. +extends_documentation_fragment: + - community.general.attributes +attributes: + check_mode: + support: full + diff_mode: + support: none options: name: diff --git a/plugins/modules/webfaction_domain.py b/plugins/modules/webfaction_domain.py index 79485d629c..9bffec3cd1 100644 --- a/plugins/modules/webfaction_domain.py +++ b/plugins/modules/webfaction_domain.py @@ -27,6 +27,15 @@ notes: your host, you may want to add C(serial: 1) to the plays. - See `the webfaction API `_ for more info. +extends_documentation_fragment: + - community.general.attributes + +attributes: + check_mode: + support: full + diff_mode: + support: none + options: name: diff --git a/plugins/modules/webfaction_mailbox.py b/plugins/modules/webfaction_mailbox.py index 0df4e8ced0..2b543c5b1d 100644 --- a/plugins/modules/webfaction_mailbox.py +++ b/plugins/modules/webfaction_mailbox.py @@ -24,6 +24,16 @@ notes: The location is not important. However, running them on multiple hosts I(simultaneously) is best avoided. If you don't specify I(localhost) as your host, you may want to add C(serial: 1) to the plays. - See `the webfaction API `_ for more info. + +extends_documentation_fragment: + - community.general.attributes + +attributes: + check_mode: + support: full + diff_mode: + support: none + options: mailbox_name: diff --git a/plugins/modules/webfaction_site.py b/plugins/modules/webfaction_site.py index 4e6f317e87..385f552115 100644 --- a/plugins/modules/webfaction_site.py +++ b/plugins/modules/webfaction_site.py @@ -28,6 +28,15 @@ notes: your host, you may want to add C(serial: 1) to the plays. - See `the webfaction API `_ for more info. +extends_documentation_fragment: + - community.general.attributes + +attributes: + check_mode: + support: full + diff_mode: + support: none + options: name: