FileMgr

✏️ /usr/lib/python3.9/site-packages/ansible_collections/ovirt/ovirt/plugins/modules/ovirt_network.py

✕ Tutup

# -*- 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/>.
#

from __future__ import (absolute_import, division, print_function)
__metaclass__ = type

DOCUMENTATION = '''
---
module: ovirt_network
short_description: Module to manage logical networks in oVirt/RHV
version_added: "1.0.0"
author:
- "Ondra Machacek (@machacekondra)"
- "Martin Necas (@mnecas)"
description:
    - "Module to manage logical networks in oVirt/RHV"
options:
    id:
        description:
            - "ID of the network to manage."
        type: str
    name:
        description:
            - "Name of the network to manage."
        required: true
        type: str
    state:
        description:
            - "Should the network be present or absent"
        choices: ['present', 'absent']
        default: present
        type: str
    data_center:
        description:
            - "Datacenter name where network reside."
        type: str
        required: true
    description:
        description:
            - "Description of the network."
        type: str
    comment:
        description:
            - "Comment of the network."
        type: str
    vlan_tag:
        description:
            - "Specify VLAN tag."
            - "NOTE - To remove the vlan_tag use -1."
        type: int
    external_provider:
        description:
            - "Name of external network provider."
            - "At first it tries to import the network when not found it will create network in external provider."
        type: str
    vm_network:
        description:
            - "If I(True) network will be marked as network for VM."
            - "VM network carries traffic relevant to the virtual machine."
        type: bool
    mtu:
        description:
            - "Maximum transmission unit (MTU) of the network."
        type: int
    clusters:
        description:
            - "List of dictionaries describing how the network is managed in specific cluster."
        type: list
        elements: dict
        suboptions:
            name:
                description:
                    - Cluster name.
            assigned:
                description:
                    - I(true) if the network should be assigned to cluster. Default is I(true).
                type: bool
            required:
                description:
                    - I(true) if the network must remain operational for all hosts associated with this network.
                type: bool
            display:
                description:
                    - I(true) if the network should marked as display network.
                type: bool
            migration:
                description:
                    - I(true) if the network should marked as migration network.
                type: bool
            gluster:
                description:
                    - I(true) if the network should marked as gluster network.
                type: bool
    label:
        description:
            - "Name of the label to assign to the network."
        type: str
extends_documentation_fragment: ovirt.ovirt.ovirt
'''

EXAMPLES = '''
# Examples don't contain auth parameter for simplicity,
# look at ovirt_auth module to see how to reuse authentication:

# Create network
- ovirt.ovirt.ovirt_network:
    data_center: mydatacenter
    name: mynetwork
    vlan_tag: 10
    vm_network: true

# Remove network
- ovirt.ovirt.ovirt_network:
    state: absent
    name: mynetwork

# Change Network Name
- ovirt.ovirt.ovirt_network:
    id: 00000000-0000-0000-0000-000000000000
    name: "new_network_name"
    data_center: mydatacenter

# Add network from external provider
- ovirt.ovirt.ovirt_network:
    data_center: mydatacenter
    name: mynetwork
    external_provider: ovirt-provider-ovn

# Remove vlan_tag
- ovirt.ovirt.ovirt_network:
    data_center: mydatacenter
    name: mynetwork
    vlan_tag: -1
'''

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/RHV instance
                  at following url: http://ovirt.github.io/ovirt-engine-api-model/master/#types/network."
    returned: "On success if network is found."
    type: dict
'''

import traceback

try:
    import ovirtsdk4.types as otypes
except ImportError:
    pass

from ansible.module_utils.basic import AnsibleModule
from ansible_collections.ovirt.ovirt.plugins.module_utils.ovirt import (
    BaseModule,
    check_sdk,
    check_params,
    create_connection,
    equal,
    ovirt_full_argument_spec,
    search_by_name,
    get_id_by_name,
    get_dict_of_struct,
    get_entity
)

class NetworksModule(BaseModule):
    def build_entity(self):
        if self.param('external_provider'):
            ons_service = self._connection.system_service().openstack_network_providers_service()
            on_service = ons_service.provider_service(get_id_by_name(ons_service, self.param('external_provider')))
        return otypes.Network(
            name=self._module.params['name'],
            comment=self._module.params['comment'],
            description=self._module.params['description'],
            id=self._module.params['id'],
            data_center=otypes.DataCenter(
                name=self._module.params['data_center'],
            ) if self._module.params['data_center'] else None,
            vlan=otypes.Vlan(
                self._module.params['vlan_tag'] if self._module.params['vlan_tag'] != -1 else None,
            ) if self._module.params['vlan_tag'] is not None 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'],
            external_provider=otypes.OpenStackNetworkProvider(id=on_service.get().id)
            if self.param('external_provider') else None,
        )

def post_create(self, entity):
        self._update_label_assignments(entity)

def _update_label_assignments(self, entity):
        if self.param('label') is None:
            return

labels_service = self._service.service(entity.id).network_labels_service()
        labels = [lbl.id for lbl in labels_service.list()]
        if not self.param('label') in labels:
            if not self._module.check_mode:
                if labels:
                    labels_service.label_service(labels[0]).remove()
                labels_service.add(
                    label=otypes.NetworkLabel(id=self.param('label'))
                )
            self.changed = True

def update_check(self, entity):
        self._update_label_assignments(entity)
        vlan_tag_changed = equal(self._module.params.get('vlan_tag'), getattr(entity.vlan, 'id', None))
        if self._module.params.get('vlan_tag') == -1:
            vlan_tag_changed = getattr(entity.vlan, 'id', None) is None
        return (
            vlan_tag_changed and
            equal(self._module.params.get('comment'), entity.comment) and
            equal(self._module.params.get('name'), entity.name) and
            equal(self._module.params.get('description'), entity.description) 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
        self._old_usages = []
        self._cluster_network_entity = get_entity(self._service.network_service(network_id))
        if self._cluster_network_entity is not None:
            self._old_usages = self._cluster_network_entity.usages

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=list(set([
                otypes.NetworkUsage(usage)
                for usage in ['display', 'gluster', 'migration']
                if self._cluster_network.get(usage, False)
            ] + self._old_usages))
            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
            all(
                x in [
                    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
                ]
                for x in [
                    usage
                    for usage in ['display', 'gluster', 'migration']
                    if self._cluster_network.get(usage, False)
                ]
            )
        )

def main():
    argument_spec = ovirt_full_argument_spec(
        state=dict(
            choices=['present', 'absent'],
            default='present',
        ),
        data_center=dict(required=True),
        id=dict(default=None),
        name=dict(required=True),
        description=dict(default=None),
        comment=dict(default=None),
        external_provider=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', elements='dict'),
        label=dict(default=None),
    )
    module = AnsibleModule(
        argument_spec=argument_spec,
        supports_check_mode=True,
    )

check_sdk(module)
    check_params(module)

try:
        auth = module.params.pop('auth')
        connection = create_connection(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']
        search_params = {
            'name': module.params['name'],
            'datacenter': module.params['data_center'],
        }
        if state == 'present':
            imported = False
            if module.params.get('external_provider') and module.params.get('name') not in [net.name for net in networks_service.list()]:
                # Try to import network
                ons_service = connection.system_service().openstack_network_providers_service()
                on_service = ons_service.provider_service(get_id_by_name(ons_service, module.params.get('external_provider')))
                on_networks_service = on_service.networks_service()
                if module.params.get('name') in [net.name for net in on_networks_service.list()]:
                    network_service = on_networks_service.network_service(get_id_by_name(on_networks_service, module.params.get('name')))
                    network_service.import_(data_center=otypes.DataCenter(name=module.params.get('data_center')))
                    imported = True

ret = networks_module.create(search_params=search_params)
            ret['changed'] = ret['changed'] or imported
            # Update clusters networks:
            if module.params.get('clusters') is not None:
                for param_cluster in module.params.get('clusters'):
                    cluster = search_by_name(clusters_service, param_cluster.get('name'))
                    if cluster is None:
                        raise Exception("Cluster '%s' was not found." % param_cluster.get('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(search_params=search_params)

module.exit_json(**ret)
    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()

Batal

⬅ plugins 60 item

Nama	Tipe	Ukuran	Diubah	Perm	Aksi
📁 __pycache__	dir	—	16/09/24 06:47	0755	📂
🐍 __init__.py	py	0 B	08/11/23 12:12	0644	✏️ ⬇
🐍 ovirt_affinity_group.py	py	13.4 KB	08/11/23 12:12	0644	✏️ ⬇
🐍 ovirt_affinity_label.py	py	6.9 KB	08/11/23 12:12	0644	✏️ ⬇
🐍 ovirt_affinity_label_info.py	py	6.9 KB	08/11/23 12:12	0644	✏️ ⬇
🐍 ovirt_api_info.py	py	3 KB	08/11/23 12:12	0644	✏️ ⬇
🐍 ovirt_auth.py	py	11.3 KB	08/11/23 12:12	0644	✏️ ⬇
🐍 ovirt_cluster.py	py	35.3 KB	08/11/23 12:12	0644	✏️ ⬇
🐍 ovirt_cluster_info.py	py	4.6 KB	08/11/23 12:12	0644	✏️ ⬇
🐍 ovirt_datacenter.py	py	11.4 KB	08/11/23 12:12	0644	✏️ ⬇
🐍 ovirt_datacenter_info.py	py	4.1 KB	08/11/23 12:12	0644	✏️ ⬇
🐍 ovirt_disk.py	py	41.3 KB	08/11/23 12:12	0644	✏️ ⬇
🐍 ovirt_disk_info.py	py	4.5 KB	08/11/23 12:12	0644	✏️ ⬇
🐍 ovirt_disk_profile.py	py	6.6 KB	08/11/23 12:12	0644	✏️ ⬇
🐍 ovirt_event.py	py	7.7 KB	08/11/23 12:12	0644	✏️ ⬇
🐍 ovirt_event_info.py	py	5.8 KB	08/11/23 12:12	0644	✏️ ⬇
🐍 ovirt_external_provider.py	py	14.8 KB	08/11/23 12:12	0644	✏️ ⬇
🐍 ovirt_external_provider_info.py	py	7.1 KB	08/11/23 12:12	0644	✏️ ⬇
🐍 ovirt_group.py	py	5.3 KB	08/11/23 12:12	0644	✏️ ⬇
🐍 ovirt_group_info.py	py	4.4 KB	08/11/23 12:12	0644	✏️ ⬇
🐍 ovirt_host.py	py	29 KB	08/11/23 12:12	0644	✏️ ⬇
🐍 ovirt_host_info.py	py	5.3 KB	08/11/23 12:12	0644	✏️ ⬇
🐍 ovirt_host_network.py	py	21.8 KB	08/11/23 12:12	0644	✏️ ⬇
🐍 ovirt_host_pm.py	py	8.3 KB	08/11/23 12:12	0644	✏️ ⬇
🐍 ovirt_host_storage_info.py	py	6.6 KB	08/11/23 12:12	0644	✏️ ⬇
🐍 ovirt_instance_type.py	py	25.5 KB	08/11/23 12:12	0644	✏️ ⬇
🐍 ovirt_job.py	py	7.5 KB	08/11/23 12:12	0644	✏️ ⬇
🐍 ovirt_mac_pool.py	py	5.3 KB	08/11/23 12:12	0644	✏️ ⬇
🐍 ovirt_network.py	py	13.6 KB	08/11/23 12:12	0644	✏️ ⬇
🐍 ovirt_network_info.py	py	4.5 KB	08/11/23 12:12	0644	✏️ ⬇
🐍 ovirt_nic.py	py	11.6 KB	08/11/23 12:12	0644	✏️ ⬇
🐍 ovirt_nic_info.py	py	5.7 KB	08/11/23 12:12	0644	✏️ ⬇
🐍 ovirt_permission.py	py	10.7 KB	08/11/23 12:12	0644	✏️ ⬇
🐍 ovirt_permission_info.py	py	5.9 KB	08/11/23 12:12	0644	✏️ ⬇
🐍 ovirt_qos.py	py	14 KB	08/11/23 12:12	0644	✏️ ⬇
🐍 ovirt_quota.py	py	11 KB	08/11/23 12:12	0644	✏️ ⬇
🐍 ovirt_quota_info.py	py	5 KB	08/11/23 12:12	0644	✏️ ⬇
🐍 ovirt_role.py	py	5.9 KB	08/11/23 12:12	0644	✏️ ⬇
🐍 ovirt_scheduling_policy_info.py	py	5.2 KB	08/11/23 12:12	0644	✏️ ⬇
🐍 ovirt_snapshot.py	py	19.1 KB	08/11/23 12:12	0644	✏️ ⬇
🐍 ovirt_snapshot_info.py	py	4.9 KB	08/11/23 12:12	0644	✏️ ⬇
🐍 ovirt_storage_connection.py	py	10 KB	08/11/23 12:12	0644	✏️ ⬇
🐍 ovirt_storage_domain.py	py	31.1 KB	08/11/23 12:12	0644	✏️ ⬇
🐍 ovirt_storage_domain_info.py	py	4.8 KB	08/11/23 12:12	0644	✏️ ⬇
🐍 ovirt_storage_template_info.py	py	5.7 KB	08/11/23 12:12	0644	✏️ ⬇
🐍 ovirt_storage_vm_info.py	py	5.5 KB	08/11/23 12:12	0644	✏️ ⬇
🐍 ovirt_system_option_info.py	py	4.5 KB	08/11/23 12:12	0644	✏️ ⬇
🐍 ovirt_tag.py	py	8.2 KB	08/11/23 12:12	0644	✏️ ⬇
🐍 ovirt_tag_info.py	py	6.1 KB	08/11/23 12:12	0644	✏️ ⬇
🐍 ovirt_template.py	py	47 KB	08/11/23 12:12	0644	✏️ ⬇
🐍 ovirt_template_info.py	py	4.6 KB	08/11/23 12:12	0644	✏️ ⬇
🐍 ovirt_user.py	py	6.3 KB	08/11/23 12:12	0644	✏️ ⬇
🐍 ovirt_user_info.py	py	4.4 KB	08/11/23 12:12	0644	✏️ ⬇
🐍 ovirt_vm.py	py	124.2 KB	08/11/23 12:12	0644	✏️ ⬇
🐍 ovirt_vm_info.py	py	7.1 KB	08/11/23 12:12	0644	✏️ ⬇
🐍 ovirt_vm_os_info.py	py	4.8 KB	08/11/23 12:12	0644	✏️ ⬇
🐍 ovirt_vmpool.py	py	19.2 KB	08/11/23 12:12	0644	✏️ ⬇
🐍 ovirt_vmpool_info.py	py	4.5 KB	08/11/23 12:12	0644	✏️ ⬇
🐍 ovirt_vnic_profile.py	py	11.9 KB	08/11/23 12:12	0644	✏️ ⬇
🐍 ovirt_vnic_profile_info.py	py	4.5 KB	08/11/23 12:12	0644	✏️ ⬇

✏️ Rename

🔑 Ubah Permission