cloud: ovirt: add ovirt_scheduling_policies_facts module (#25055)

lib/ansible/modules/cloud/ovirt/ovirt_scheduling_policies_facts.py

@@ -0,0 +1,127 @@
+#!/usr/bin/python
+# -*- coding: utf-8 -*-
+#
+# Copyright (c) 2017 Red Hat, Inc.
+#
+# This file is part of Ansible
+#
+# Ansible is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# Ansible is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with Ansible.  If not, see <http://www.gnu.org/licenses/>.
+#
+
+ANSIBLE_METADATA = {'metadata_version': '1.0',
+                    'status': ['preview'],
+                    'supported_by': 'community'}
+
+
+DOCUMENTATION = '''
+---
+module: ovirt_scheduling_policies_facts
+short_description: Retrieve facts about one or more oVirt scheduling policies
+author: "Ondra Machacek (@machacekondra)"
+version_added: "2.4"
+description:
+    - "Retrieve facts about one or more oVirt scheduling policies."
+notes:
+    - "This module creates a new top-level C(ovirt_scheduling_policies) fact,
+       which contains a list of scheduling policies."
+options:
+    id:
+        description:
+            - "ID of the scheduling policy."
+        required: true
+    name:
+        description:
+            - "Name of the scheduling policy, can be used as glob expression."
+extends_documentation_fragment: ovirt_facts
+'''
+
+EXAMPLES = '''
+# Examples don't contain auth parameter for simplicity,
+# look at ovirt_auth module to see how to reuse authentication:
+
+# Gather facts about all scheduling policies with name InClusterUpgrade:
+- ovirt_scheduling_policies_facts:
+    name: InClusterUpgrade
+- debug:
+    var: ovirt_scheduling_policies
+'''
+
+RETURN = '''
+ovirt_scheduling_policies:
+    description: "List of dictionaries describing the scheduling policies.
+                  Scheduling policies attribues are mapped to dictionary keys,
+                  all scheduling policies attributes can be found at following
+                  url: https://ovirt.example.com/ovirt-engine/api/model#types/scheduling_policy."
+    returned: On success.
+    type: list
+'''
+
+import fnmatch
+import traceback
+
+from ansible.module_utils.basic import AnsibleModule
+from ansible.module_utils.ovirt import (
+    check_sdk,
+    create_connection,
+    get_dict_of_struct,
+    ovirt_facts_full_argument_spec,
+)
+
+
+def main():
+    argument_spec = ovirt_facts_full_argument_spec(
+        id=dict(default=None),
+        name=dict(default=None),
+    )
+    module = AnsibleModule(argument_spec)
+    check_sdk(module)
+
+    try:
+        auth = module.params.pop('auth')
+        connection = create_connection(auth)
+        system_service = connection.system_service()
+        sched_policies_service = system_service.scheduling_policies_service()
+        if module.params['name']:
+            sched_policies = [
+                e for e in sched_policies_service.list()
+                if fnmatch.fnmatch(e.name, module.params['name'])
+            ]
+        elif module.params['id']:
+            sched_policies = [
+                sched_policies_service.service(module.params['id']).get()
+            ]
+        else:
+            sched_policies = sched_policies_service.list()
+
+        module.exit_json(
+            changed=False,
+            ansible_facts=dict(
+                ovirt_scheduling_policies=[
+                    get_dict_of_struct(
+                        struct=c,
+                        connection=connection,
+                        fetch_nested=module.params.get('fetch_nested'),
+                        attributes=module.params.get('nested_attributes'),
+                    ) for c in sched_policies
+                ],
+            ),
+        )
+    except Exception as e:
+        module.fail_json(msg=str(e), exception=traceback.format_exc())
+    finally:
+        connection.close(logout=auth.get('token') is None)
+
+
+if __name__ == '__main__':
+    main()