Move endpoints to routes & preparations to use a database.

gns3server/api/routes/compute/vmware_nodes.py

@@ -0,0 +1,298 @@
+# -*- coding: utf-8 -*-
+#
+# Copyright (C) 2020 GNS3 Technologies Inc.
+#
+# This program 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.
+#
+# This program 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 this program.  If not, see <http://www.gnu.org/licenses/>.
+
+"""
+API routes for VMware nodes.
+"""
+
+import os
+
+from fastapi import APIRouter, WebSocket, Depends, status
+from fastapi.encoders import jsonable_encoder
+from fastapi.responses import StreamingResponse
+from uuid import UUID
+
+from gns3server import schemas
+from gns3server.compute.vmware import VMware
+from gns3server.compute.project_manager import ProjectManager
+from gns3server.compute.vmware.vmware_vm import VMwareVM
+
+router = APIRouter()
+
+responses = {
+    404: {"model": schemas.ErrorMessage, "description": "Could not find project or VMware node"}
+}
+
+
+def dep_node(project_id: UUID, node_id: UUID):
+    """
+    Dependency to retrieve a node.
+    """
+
+    vmware_manager = VMware.instance()
+    node = vmware_manager.get_node(str(node_id), project_id=str(project_id))
+    return node
+
+
+@router.post("",
+             response_model=schemas.VMware,
+             status_code=status.HTTP_201_CREATED,
+             responses={409: {"model": schemas.ErrorMessage, "description": "Could not create VMware node"}})
+async def create_vmware_node(project_id: UUID, node_data: schemas.VMwareCreate):
+    """
+    Create a new VMware node.
+    """
+
+    vmware_manager = VMware.instance()
+    node_data = jsonable_encoder(node_data, exclude_unset=True)
+    vm = await vmware_manager.create_node(node_data.pop("name"),
+                                          str(project_id),
+                                          node_data.get("node_id"),
+                                          node_data.pop("vmx_path"),
+                                          linked_clone=node_data.pop("linked_clone"),
+                                          console=node_data.get("console", None),
+                                          console_type=node_data.get("console_type", "telnet"))
+
+    for name, value in node_data.items():
+        if name != "node_id":
+            if hasattr(vm, name) and getattr(vm, name) != value:
+                setattr(vm, name, value)
+
+    return vm.__json__()
+
+
+@router.get("/{node_id}",
+            response_model=schemas.VMware,
+            responses=responses)
+def get_vmware_node(node: VMwareVM = Depends(dep_node)):
+    """
+    Return a VMware node.
+    """
+
+    return node.__json__()
+
+
+@router.put("/{node_id}",
+            response_model=schemas.VMware,
+            responses=responses)
+def update_vmware_node(node_data: schemas.VMwareUpdate, node: VMwareVM = Depends(dep_node)):
+    """
+    Update a VMware node.
+    """
+
+    node_data = jsonable_encoder(node_data, exclude_unset=True)
+    # update the console first to avoid issue if updating console type
+    node.console = node_data.pop("console", node.console)
+    for name, value in node_data.items():
+        if hasattr(node, name) and getattr(node, name) != value:
+            setattr(node, name, value)
+
+    node.updated()
+    return node.__json__()
+
+
+@router.delete("/{node_id}",
+               status_code=status.HTTP_204_NO_CONTENT,
+               responses=responses)
+async def delete_vmware_node(node: VMwareVM = Depends(dep_node)):
+    """
+    Delete a VMware node.
+    """
+
+    await VMware.instance().delete_node(node.id)
+
+
+@router.post("/{node_id}/start",
+             status_code=status.HTTP_204_NO_CONTENT,
+             responses=responses)
+async def start_vmware_node(node: VMwareVM = Depends(dep_node)):
+    """
+    Start a VMware node.
+    """
+
+    if node.check_hw_virtualization():
+        pm = ProjectManager.instance()
+        if pm.check_hardware_virtualization(node) is False:
+            pass # FIXME: check this
+            #raise ComputeError("Cannot start VM with hardware acceleration (KVM/HAX) enabled because hardware virtualization (VT-x/AMD-V) is already used by another software like VMware or VirtualBox")
+    await node.start()
+
+
+@router.post("/{node_id}/stop",
+             status_code=status.HTTP_204_NO_CONTENT,
+             responses=responses)
+async def stop_vmware_node(node: VMwareVM = Depends(dep_node)):
+    """
+    Stop a VMware node.
+    """
+
+    await node.stop()
+
+
+@router.post("/{node_id}/suspend",
+             status_code=status.HTTP_204_NO_CONTENT,
+             responses=responses)
+async def suspend_vmware_node(node: VMwareVM = Depends(dep_node)):
+    """
+    Suspend a VMware node.
+    """
+
+    await node.suspend()
+
+
+@router.post("/{node_id}/resume",
+             status_code=status.HTTP_204_NO_CONTENT,
+             responses=responses)
+async def resume_vmware_node(node: VMwareVM = Depends(dep_node)):
+    """
+    Resume a VMware node.
+    """
+
+    await node.resume()
+
+
+@router.post("/{node_id}/reload",
+             status_code=status.HTTP_204_NO_CONTENT,
+             responses=responses)
+async def reload_vmware_node(node: VMwareVM = Depends(dep_node)):
+    """
+    Reload a VMware node.
+    """
+
+    await node.reload()
+
+
+@router.post("/{node_id}/adapters/{adapter_number}/ports/{port_number}/nio",
+             status_code=status.HTTP_201_CREATED,
+             response_model=schemas.UDPNIO,
+             responses=responses)
+async def create_nio(adapter_number: int,
+                     port_number: int,
+                     nio_data: schemas.UDPNIO,
+                     node: VMwareVM = Depends(dep_node)):
+    """
+    Add a NIO (Network Input/Output) to the node.
+    The port number on the VMware node is always 0.
+    """
+
+    nio = VMware.instance().create_nio(jsonable_encoder(nio_data, exclude_unset=True))
+    await node.adapter_add_nio_binding(adapter_number, nio)
+    return nio.__json__()
+
+
+@router.put("/{node_id}/adapters/{adapter_number}/ports/{port_number}/nio",
+            status_code=status.HTTP_201_CREATED,
+            response_model=schemas.UDPNIO,
+            responses=responses)
+async def update_nio(adapter_number: int,
+                     port_number: int,
+                     nio_data: schemas.UDPNIO, node: VMwareVM = Depends(dep_node)):
+    """
+    Update a NIO (Network Input/Output) on the node.
+    The port number on the VMware node is always 0.
+    """
+
+    nio = node.get_nio(adapter_number)
+    if nio_data.filters:
+        nio.filters = nio_data.filters
+    await node.adapter_update_nio_binding(adapter_number, nio)
+    return nio.__json__()
+
+
+@router.delete("/{node_id}/adapters/{adapter_number}/ports/{port_number}/nio",
+               status_code=status.HTTP_204_NO_CONTENT,
+               responses=responses)
+async def delete_nio(adapter_number: int, port_number: int, node: VMwareVM = Depends(dep_node)):
+    """
+    Delete a NIO (Network Input/Output) from the node.
+    The port number on the VMware node is always 0.
+    """
+
+    await node.adapter_remove_nio_binding(adapter_number)
+
+
+@router.post("/{node_id}/adapters/{adapter_number}/ports/{port_number}/capture/start",
+             responses=responses)
+async def start_capture(adapter_number: int,
+                        port_number: int,
+                        node_capture_data: schemas.NodeCapture,
+                        node: VMwareVM = Depends(dep_node)):
+    """
+    Start a packet capture on the node.
+    The port number on the VMware node is always 0.
+    """
+
+    pcap_file_path = os.path.join(node.project.capture_working_directory(), node_capture_data.capture_file_name)
+    await node.start_capture(adapter_number, pcap_file_path)
+    return {"pcap_file_path": pcap_file_path}
+
+
+@router.post("/{node_id}/adapters/{adapter_number}/ports/{port_number}/capture/stop",
+             status_code=status.HTTP_204_NO_CONTENT,
+             responses=responses)
+async def stop_capture(adapter_number: int, port_number: int, node: VMwareVM = Depends(dep_node)):
+    """
+    Stop a packet capture on the node.
+    The port number on the VMware node is always 0.
+    """
+
+    await node.stop_capture(adapter_number)
+
+
+@router.get("/{node_id}/adapters/{adapter_number}/ports/{port_number}/capture/stream",
+            responses=responses)
+async def stream_pcap_file(adapter_number: int, port_number: int, node: VMwareVM = Depends(dep_node)):
+    """
+    Stream the pcap capture file.
+    The port number on the VMware node is always 0.
+    """
+
+    nio = node.get_nio(adapter_number)
+    stream = VMware.instance().stream_pcap_file(nio, node.project.id)
+    return StreamingResponse(stream, media_type="application/vnd.tcpdump.pcap")
+
+
+@router.post("/{node_id}/interfaces/vmnet",
+             status_code=status.HTTP_201_CREATED,
+             responses=responses)
+def allocate_vmnet(node: VMwareVM = Depends(dep_node)) -> dict:
+    """
+    Allocate a VMware VMnet interface on the server.
+    """
+
+    vmware_manager = VMware.instance()
+    vmware_manager.refresh_vmnet_list(ubridge=False)
+    vmnet = vmware_manager.allocate_vmnet()
+    node.vmnets.append(vmnet)
+    return {"vmnet": vmnet}
+
+
+@router.websocket("/{node_id}/console/ws")
+async def console_ws(websocket: WebSocket, node: VMwareVM = Depends(dep_node)):
+    """
+    Console WebSocket.
+    """
+
+    await node.start_websocket_console(websocket)
+
+
+@router.post("/{node_id}/console/reset",
+             status_code=status.HTTP_204_NO_CONTENT,
+             responses=responses)
+async def reset_console(node: VMwareVM = Depends(dep_node)):
+
+    await node.reset_console()