Add ovirt_networks and ovirt_networks_facts modules (#3148)

2 files changed, 364 insertions, 0 deletions

diff --git a/cloud/ovirt/ovirt_networks.py b/cloud/ovirt/ovirt_networks.py
new file mode 100644
index 00000000..44b7fefe
--- /dev/null
+++ b/cloud/ovirt/ovirt_networks.py
@@ -0,0 +1,264 @@
+#!/usr/bin/python
+# -*- coding: utf-8 -*-
+#
+# Copyright (c) 2016 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/>.
+#
+
+import traceback
+
+try:
+    import ovirtsdk4.types as otypes
+except ImportError:
+    pass
+
+from ansible.module_utils.basic import AnsibleModule
+from ansible.module_utils.ovirt import (
+    BaseModule,
+    check_sdk,
+    check_params,
+    create_connection,
+    equal,
+    ovirt_full_argument_spec,
+    search_by_name,
+)
+
+
+DOCUMENTATION = '''
+---
+module: ovirt_networks
+short_description: Module to manage logical networks in oVirt
+version_added: "2.3"
+author: "Ondra Machacek (@machacekondra)"
+description:
+    - "Module to manage logical networks in oVirt"
+options:
+    name:
+        description:
+            - "Name of the the network to manage."
+        required: true
+    state:
+        description:
+            - "Should the network be present or absent"
+        choices: ['present', 'absent']
+        default: present
+    datacenter:
+        description:
+            - "Datacenter name where network reside."
+    description:
+        description:
+            - "Description of the network."
+    comment:
+        description:
+            - "Comment of the network."
+    vlan_tag:
+        description:
+            - "Specify VLAN tag."
+    vm_network:
+        description:
+            - "If I(True) network will be marked as network for VM."
+            - "VM network carries traffic relevant to the virtual machine."
+    mtu:
+        description:
+            - "Maximum transmission unit (MTU) of the network."
+    clusters:
+        description:
+            - "List of dictionaries describing how the network is managed in specific cluster."
+            - "C(name) - Cluster name."
+            - "C(assigned) - I(true) if the network should be assigned to cluster. Default is I(true)."
+            - "C(required) - I(true) if the network must remain operational for all hosts associated with this network."
+            - "C(display) - I(true) if the network should marked as display network."
+            - "C(migration) - I(true) if the network should marked as migration network."
+            - "C(gluster) - I(true) if the network should marked as gluster network."
+
+extends_documentation_fragment: ovirt
+'''
+
+EXAMPLES = '''
+# Examples don't contain auth parameter for simplicity,
+# look at ovirt_auth module to see how to reuse authentication:
+
+# Create network
+- ovirt_networks:
+    datacenter: mydatacenter
+    name: mynetwork
+    vlan_tag: 1
+    vm_network: true
+
+# Remove network
+- ovirt_networks:
+    state: absent
+    name: mynetwork
+'''
+
+RETURN = '''
+id:
+    description: "ID of the managed network"
+    returned: "On success if network is found."
+    type: str
+    sample: 7de90f31-222c-436c-a1ca-7e655bd5b60c
+network:
+    description: "Dictionary of all the network attributes. Network attributes can be found on your oVirt instance
+                  at following url: https://ovirt.example.com/ovirt-engine/api/model#types/network."
+    returned: "On success if network is found."
+'''
+
+
+class NetworksModule(BaseModule):
+
+    def build_entity(self):
+        return otypes.Network(
+            name=self._module.params['name'],
+            comment=self._module.params['comment'],
+            description=self._module.params['description'],
+            data_center=otypes.DataCenter(
+                name=self._module.params['datacenter'],
+            ) if self._module.params['datacenter'] else None,
+            vlan=otypes.Vlan(
+                self._module.params['vlan_tag'],
+            ) if self._module.params['vlan_tag'] else None,
+            usages=[
+                otypes.NetworkUsage.VM if self._module.params['vm_network'] else None
+            ] if self._module.params['vm_network'] is not None else None,
+            mtu=self._module.params['mtu'],
+        )
+
+    def update_check(self, entity):
+        return (
+            equal(self._module.params.get('comment'), entity.comment) and
+            equal(self._module.params.get('description'), entity.description) and
+            equal(self._module.params.get('vlan_tag'), getattr(entity.vlan, 'id', None)) and
+            equal(self._module.params.get('vm_network'), True if entity.usages else False) and
+            equal(self._module.params.get('mtu'), entity.mtu)
+        )
+
+
+class ClusterNetworksModule(BaseModule):
+
+    def __init__(self, network_id, cluster_network, *args, **kwargs):
+        super(ClusterNetworksModule, self).__init__(*args, **kwargs)
+        self._network_id = network_id
+        self._cluster_network = cluster_network
+
+    def build_entity(self):
+        return otypes.Network(
+            id=self._network_id,
+            name=self._module.params['name'],
+            required=self._cluster_network.get('required'),
+            display=self._cluster_network.get('display'),
+            usages=[
+                otypes.NetworkUsage(usage)
+                for usage in ['display', 'gluster', 'migration']
+                if self._cluster_network.get(usage, False)
+            ] if (
+                self._cluster_network.get('display') is not None or
+                self._cluster_network.get('gluster') is not None or
+                self._cluster_network.get('migration') is not None
+            ) else None,
+        )
+
+    def update_check(self, entity):
+        return (
+            equal(self._cluster_network.get('required'), entity.required) and
+            equal(self._cluster_network.get('display'), entity.display) and
+            equal(
+                sorted([
+                    usage
+                    for usage in ['display', 'gluster', 'migration']
+                    if self._cluster_network.get(usage, False)
+                ]),
+                sorted([
+                    str(usage)
+                    for usage in getattr(entity, 'usages', [])
+                    # VM + MANAGEMENT is part of root network
+                    if usage != otypes.NetworkUsage.VM and usage != otypes.NetworkUsage.MANAGEMENT
+                ]),
+            )
+        )
+
+
+def main():
+    argument_spec = ovirt_full_argument_spec(
+        state=dict(
+            choices=['present', 'absent'],
+            default='present',
+        ),
+        datacenter=dict(default=None, required=True),
+        name=dict(default=None, required=True),
+        description=dict(default=None),
+        comment=dict(default=None),
+        vlan_tag=dict(default=None, type='int'),
+        vm_network=dict(default=None, type='bool'),
+        mtu=dict(default=None, type='int'),
+        clusters=dict(default=None, type='list'),
+    )
+    module = AnsibleModule(
+        argument_spec=argument_spec,
+        supports_check_mode=True,
+    )
+    check_sdk(module)
+    check_params(module)
+
+    try:
+        connection = create_connection(module.params.pop('auth'))
+        clusters_service = connection.system_service().clusters_service()
+        networks_service = connection.system_service().networks_service()
+        networks_module = NetworksModule(
+            connection=connection,
+            module=module,
+            service=networks_service,
+        )
+        state = module.params['state']
+        network = networks_module.search_entity(
+            search_params={
+                'name': module.params['name'],
+                'datacenter': module.params['datacenter'],
+            },
+        )
+        if state == 'present':
+            ret = networks_module.create(entity=network)
+
+            # Update clusters networks:
+            for param_cluster in module.params.get('clusters', []):
+                cluster = search_by_name(clusters_service, param_cluster.get('name', None))
+                if cluster is None:
+                    raise Exception("Cluster '%s' was not found." % cluster_name)
+                cluster_networks_service = clusters_service.service(cluster.id).networks_service()
+                cluster_networks_module = ClusterNetworksModule(
+                    network_id=ret['id'],
+                    cluster_network=param_cluster,
+                    connection=connection,
+                    module=module,
+                    service=cluster_networks_service,
+                )
+                if param_cluster.get('assigned', True):
+                    ret = cluster_networks_module.create()
+                else:
+                    ret = cluster_networks_module.remove()
+
+        elif state == 'absent':
+            ret = networks_module.remove(entity=network)
+
+        module.exit_json(**ret)
+    except Exception as e:
+        module.fail_json(msg=str(e), exception=traceback.format_exc())
+    finally:
+        connection.close(logout=False)
+
+
+if __name__ == "__main__":
+    main()
diff --git a/cloud/ovirt/ovirt_networks_facts.py b/cloud/ovirt/ovirt_networks_facts.py
new file mode 100644
index 00000000..9c42244c
--- /dev/null
+++ b/cloud/ovirt/ovirt_networks_facts.py
@@ -0,0 +1,100 @@
+#!/usr/bin/python
+# -*- coding: utf-8 -*-
+#
+# Copyright (c) 2016 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/>.
+#
+
+import traceback
+
+from ansible.module_utils.basic import AnsibleModule
+from ansible.module_utils.ovirt import (
+    check_sdk,
+    create_connection,
+    get_dict_of_struct,
+    ovirt_full_argument_spec,
+)
+
+
+DOCUMENTATION = '''
+---
+module: ovirt_networks_facts
+short_description: Retrieve facts about one or more oVirt networks
+author: "Ondra Machacek (@machacekondra)"
+version_added: "2.3"
+description:
+    - "Retrieve facts about one or more oVirt networks."
+notes:
+    - "This module creates a new top-level C(ovirt_networks) fact, which
+       contains a list of networks."
+options:
+    pattern:
+      description:
+        - "Search term which is accepted by oVirt search backend."
+        - "For example to search network starting with string vlan1 use: name=vlan1*"
+extends_documentation_fragment: ovirt
+'''
+
+
+EXAMPLES = '''
+# Examples don't contain auth parameter for simplicity,
+# look at ovirt_auth module to see how to reuse authentication:
+
+# Gather facts about all networks which names start with C(vlan1):
+- ovirt_networks_facts:
+    pattern: name=vlan1*
+- debug:
+    var: ovirt_networks
+'''
+
+
+RETURN = '''
+ovirt_networks:
+    description: "List of dictionaries describing the networks. Network attribues are mapped to dictionary keys,
+                  all networks attributes can be found at following url: https://ovirt.example.com/ovirt-engine/api/model#types/network."
+    returned: On success.
+    type: list
+'''
+
+
+def main():
+    argument_spec = ovirt_full_argument_spec(
+        pattern=dict(default='', required=False),
+    )
+    module = AnsibleModule(argument_spec)
+    check_sdk(module)
+
+    try:
+        connection = create_connection(module.params.pop('auth'))
+        networks_service = connection.system_service().networks_service()
+        networks = networks_service.list(search=module.params['pattern'])
+        module.exit_json(
+            changed=False,
+            ansible_facts=dict(
+                ovirt_networks=[
+                    get_dict_of_struct(c) for c in networks
+                ],
+            ),
+        )
+    except Exception as e:
+        module.fail_json(msg=str(e), exception=traceback.format_exc())
+    finally:
+        connection.close(logout=False)
+
+
+if __name__ == '__main__':
+    main()