From 6b02eaa795730eb54ef485548c24681e71a8752d Mon Sep 17 00:00:00 2001
From: "patchback[bot]" <45432694+patchback[bot]@users.noreply.github.com>
Date: Sun, 29 Dec 2024 21:24:30 +0100
Subject: [PATCH] [PR #9449/0bbc3ecc backport][stable-10]
manageiq_alert_profiles: improve handling param requirements (#9464)
manageiq_alert_profiles: improve handling param requirements (#9449)
* manageiq_alert_profiles: improve handling param requirements
Basically two changes:
* `name` is already required when state is either present or absent, and there are no other states, so making it fully required and removing the conditional
* `alerts` is documented as required when state=present, this has been verified in the code, so added that parameter to the existing `required_if` spec.
* add changelog frag
(cherry picked from commit 0bbc3eccd9401e16367577f9c66bf547537c8f72)
Co-authored-by: Alexei Znamensky <103110+russoz@users.noreply.github.com>
---
.../fragments/9449-manageiq-alert-profiles-reqs.yml | 2 ++
plugins/modules/manageiq_alert_profiles.py | 13 +++++--------
2 files changed, 7 insertions(+), 8 deletions(-)
create mode 100644 changelogs/fragments/9449-manageiq-alert-profiles-reqs.yml
diff --git a/changelogs/fragments/9449-manageiq-alert-profiles-reqs.yml b/changelogs/fragments/9449-manageiq-alert-profiles-reqs.yml
new file mode 100644
index 0000000000..710cf672cc
--- /dev/null
+++ b/changelogs/fragments/9449-manageiq-alert-profiles-reqs.yml
@@ -0,0 +1,2 @@
+minor_changes:
+ - manageiq_alert_profiles - improve handling of parameter requirements (https://github.com/ansible-collections/community.general/pull/9449).
diff --git a/plugins/modules/manageiq_alert_profiles.py b/plugins/modules/manageiq_alert_profiles.py
index 33ca05df3b..fff9552a6c 100644
--- a/plugins/modules/manageiq_alert_profiles.py
+++ b/plugins/modules/manageiq_alert_profiles.py
@@ -37,7 +37,7 @@ options:
type: str
description:
- The unique alert profile name in ManageIQ.
- - Required when state is "absent" or "present".
+ required: true
resource_type:
type: str
description:
@@ -114,8 +114,7 @@ class ManageIQAlertProfiles(object):
"""
alerts = []
for alert_description in alert_descriptions:
- alert = self.manageiq.find_collection_resource_or_fail("alert_definitions",
- description=alert_description)
+ alert = self.manageiq.find_collection_resource_or_fail("alert_definitions", description=alert_description)
alerts.append(alert['href'])
return alerts
@@ -253,7 +252,7 @@ class ManageIQAlertProfiles(object):
def main():
argument_spec = dict(
- name=dict(type='str'),
+ name=dict(type='str', required=True),
resource_type=dict(type='str', choices=['Vm',
'ContainerNode',
'MiqServer',
@@ -270,8 +269,7 @@ def main():
argument_spec.update(manageiq_argument_spec())
module = AnsibleModule(argument_spec=argument_spec,
- required_if=[('state', 'present', ['name', 'resource_type']),
- ('state', 'absent', ['name'])])
+ required_if=[('state', 'present', ['resource_type', 'alerts'])])
state = module.params['state']
name = module.params['name']
@@ -279,8 +277,7 @@ def main():
manageiq = ManageIQ(module)
manageiq_alert_profiles = ManageIQAlertProfiles(manageiq)
- existing_profile = manageiq.find_collection_resource_by("alert_definition_profiles",
- name=name)
+ existing_profile = manageiq.find_collection_resource_by("alert_definition_profiles", name=name)
# we need to add or update the alert profile
if state == "present":