# # 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 . """ API routes for VMware nodes. """ import os from fastapi import APIRouter, WebSocket, Depends, Path, Response, 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 responses = {404: {"model": schemas.ErrorMessage, "description": "Could not find project or VMware node"}} router = APIRouter(responses=responses) def dep_node(project_id: UUID, node_id: UUID) -> VMwareVM: """ 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) -> schemas.VMware: """ 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.asdict() @router.get("/{node_id}", response_model=schemas.VMware) def get_vmware_node(node: VMwareVM = Depends(dep_node)) -> schemas.VMware: """ Return a VMware node. """ return node.asdict() @router.put("/{node_id}", response_model=schemas.VMware) def update_vmware_node(node_data: schemas.VMwareUpdate, node: VMwareVM = Depends(dep_node)) -> schemas.VMware: """ 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.asdict() @router.delete("/{node_id}", status_code=status.HTTP_204_NO_CONTENT) async def delete_vmware_node(node: VMwareVM = Depends(dep_node)) -> Response: """ Delete a VMware node. """ await VMware.instance().delete_node(node.id) return Response(status_code=status.HTTP_204_NO_CONTENT) @router.post("/{node_id}/start", status_code=status.HTTP_204_NO_CONTENT) async def start_vmware_node(node: VMwareVM = Depends(dep_node)) -> Response: """ Start a VMware node. """ await node.start() return Response(status_code=status.HTTP_204_NO_CONTENT) @router.post("/{node_id}/stop", status_code=status.HTTP_204_NO_CONTENT) async def stop_vmware_node(node: VMwareVM = Depends(dep_node)) -> Response: """ Stop a VMware node. """ await node.stop() return Response(status_code=status.HTTP_204_NO_CONTENT) @router.post("/{node_id}/suspend", status_code=status.HTTP_204_NO_CONTENT) async def suspend_vmware_node(node: VMwareVM = Depends(dep_node)) -> Response: """ Suspend a VMware node. """ await node.suspend() return Response(status_code=status.HTTP_204_NO_CONTENT) @router.post("/{node_id}/resume", status_code=status.HTTP_204_NO_CONTENT) async def resume_vmware_node(node: VMwareVM = Depends(dep_node)) -> Response: """ Resume a VMware node. """ await node.resume() return Response(status_code=status.HTTP_204_NO_CONTENT) @router.post("/{node_id}/reload", status_code=status.HTTP_204_NO_CONTENT) async def reload_vmware_node(node: VMwareVM = Depends(dep_node)) -> Response: """ Reload a VMware node. """ await node.reload() return Response(status_code=status.HTTP_204_NO_CONTENT) @router.post( "/{node_id}/adapters/{adapter_number}/ports/{port_number}/nio", status_code=status.HTTP_201_CREATED, response_model=schemas.UDPNIO, ) async def create_vmware_node_nio( *, adapter_number: int, port_number: int = Path(..., ge=0, le=0), nio_data: schemas.UDPNIO, node: VMwareVM = Depends(dep_node) ) -> schemas.UDPNIO: """ 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.asdict() @router.put( "/{node_id}/adapters/{adapter_number}/ports/{port_number}/nio", status_code=status.HTTP_201_CREATED, response_model=schemas.UDPNIO, ) async def update_vmware_node_nio( *, adapter_number: int, port_number: int = Path(..., ge=0, le=0), nio_data: schemas.UDPNIO, node: VMwareVM = Depends(dep_node) ) -> schemas.UDPNIO: """ 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.asdict() @router.delete("/{node_id}/adapters/{adapter_number}/ports/{port_number}/nio", status_code=status.HTTP_204_NO_CONTENT) async def delete_vmware_node_nio( adapter_number: int, port_number: int = Path(..., ge=0, le=0), node: VMwareVM = Depends(dep_node) ) -> Response: """ 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) return Response(status_code=status.HTTP_204_NO_CONTENT) @router.post("/{node_id}/adapters/{adapter_number}/ports/{port_number}/capture/start") async def start_vmware_node_capture( *, adapter_number: int, port_number: int = Path(..., ge=0, le=0), node_capture_data: schemas.NodeCapture, node: VMwareVM = Depends(dep_node) ) -> dict: """ 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 ) async def stop_vmware_node_capture( adapter_number: int, port_number: int = Path(..., ge=0, le=0), node: VMwareVM = Depends(dep_node) ) -> Response: """ Stop a packet capture on the node. The port number on the VMware node is always 0. """ await node.stop_capture(adapter_number) return Response(status_code=status.HTTP_204_NO_CONTENT) @router.get("/{node_id}/adapters/{adapter_number}/ports/{port_number}/capture/stream") async def stream_pcap_file( adapter_number: int, port_number: int = Path(..., ge=0, le=0), node: VMwareVM = Depends(dep_node) ) -> StreamingResponse: """ 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) 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)) -> None: """ Console WebSocket. """ await node.start_websocket_console(websocket) @router.post("/{node_id}/console/reset", status_code=status.HTTP_204_NO_CONTENT) async def reset_console(node: VMwareVM = Depends(dep_node)) -> Response: await node.reset_console() return Response(status_code=status.HTTP_204_NO_CONTENT)