gns3-server/gns3server/api/routes/compute/dynamips_nodes.py

292 lines
8.8 KiB
Python
Raw Normal View History

2020-10-02 06:37:50 +00:00
#
# 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 Dynamips nodes.
2020-10-02 06:37:50 +00:00
"""
import os
import sys
from fastapi import APIRouter, WebSocket, Depends, status
2020-10-02 06:37:50 +00:00
from fastapi.encoders import jsonable_encoder
from fastapi.responses import StreamingResponse
from typing import List
from uuid import UUID
from gns3server.compute.dynamips import Dynamips
from gns3server.compute.dynamips.nodes.router import Router
2020-10-02 06:37:50 +00:00
from gns3server.compute.dynamips.dynamips_error import DynamipsError
2020-10-31 05:32:21 +00:00
from gns3server import schemas
2020-10-02 06:37:50 +00:00
2021-04-13 09:16:50 +00:00
responses = {404: {"model": schemas.ErrorMessage, "description": "Could not find project or Dynamips node"}}
2021-04-13 06:49:56 +00:00
router = APIRouter(responses=responses)
2021-04-13 09:16:50 +00:00
DEFAULT_CHASSIS = {"c1700": "1720", "c2600": "2610", "c3600": "3640"}
2020-10-02 06:37:50 +00:00
def dep_node(project_id: UUID, node_id: UUID):
"""
Dependency to retrieve a node.
"""
dynamips_manager = Dynamips.instance()
node = dynamips_manager.get_node(str(node_id), project_id=str(project_id))
return node
2021-04-13 09:16:50 +00:00
@router.post(
"",
response_model=schemas.Dynamips,
status_code=status.HTTP_201_CREATED,
responses={409: {"model": schemas.ErrorMessage, "description": "Could not create Dynamips node"}},
)
2020-10-02 06:37:50 +00:00
async def create_router(project_id: UUID, node_data: schemas.DynamipsCreate):
"""
Create a new Dynamips router.
"""
dynamips_manager = Dynamips.instance()
platform = node_data.platform
chassis = None
if not node_data.chassis and platform in DEFAULT_CHASSIS:
chassis = DEFAULT_CHASSIS[platform]
node_data = jsonable_encoder(node_data, exclude_unset=True)
2021-04-13 09:16:50 +00:00
vm = await dynamips_manager.create_node(
node_data.pop("name"),
str(project_id),
node_data.get("node_id"),
dynamips_id=node_data.get("dynamips_id"),
platform=platform,
console=node_data.get("console"),
console_type=node_data.get("console_type", "telnet"),
aux=node_data.get("aux"),
aux_type=node_data.pop("aux_type", "none"),
chassis=chassis,
node_type="dynamips",
)
2020-10-02 06:37:50 +00:00
await dynamips_manager.update_vm_settings(vm, node_data)
2021-04-17 14:04:28 +00:00
return vm.asdict()
2020-10-02 06:37:50 +00:00
2021-04-13 09:16:50 +00:00
@router.get("/{node_id}", response_model=schemas.Dynamips)
def get_router(node: Router = Depends(dep_node)):
2020-10-02 06:37:50 +00:00
"""
Return Dynamips router.
"""
2021-04-17 14:04:28 +00:00
return node.asdict()
2020-10-02 06:37:50 +00:00
2021-04-13 09:16:50 +00:00
@router.put("/{node_id}", response_model=schemas.Dynamips)
async def update_router(node_data: schemas.DynamipsUpdate, node: Router = Depends(dep_node)):
2020-10-02 06:37:50 +00:00
"""
Update a Dynamips router.
"""
await Dynamips.instance().update_vm_settings(node, jsonable_encoder(node_data, exclude_unset=True))
node.updated()
2021-04-17 14:04:28 +00:00
return node.asdict()
2020-10-02 06:37:50 +00:00
2021-04-13 09:16:50 +00:00
@router.delete("/{node_id}", status_code=status.HTTP_204_NO_CONTENT)
async def delete_router(node: Router = Depends(dep_node)):
2020-10-02 06:37:50 +00:00
"""
Delete a Dynamips router.
"""
await Dynamips.instance().delete_node(node.id)
2020-10-02 06:37:50 +00:00
2021-04-13 09:16:50 +00:00
@router.post("/{node_id}/start", status_code=status.HTTP_204_NO_CONTENT)
async def start_router(node: Router = Depends(dep_node)):
2020-10-02 06:37:50 +00:00
"""
Start a Dynamips router.
"""
try:
await Dynamips.instance().ghost_ios_support(node)
2020-10-02 06:37:50 +00:00
except GeneratorExit:
pass
await node.start()
2020-10-02 06:37:50 +00:00
2021-04-13 09:16:50 +00:00
@router.post("/{node_id}/stop", status_code=status.HTTP_204_NO_CONTENT)
async def stop_router(node: Router = Depends(dep_node)):
2020-10-02 06:37:50 +00:00
"""
Stop a Dynamips router.
"""
await node.stop()
2020-10-02 06:37:50 +00:00
2021-04-13 09:16:50 +00:00
@router.post("/{node_id}/suspend", status_code=status.HTTP_204_NO_CONTENT)
async def suspend_router(node: Router = Depends(dep_node)):
2020-10-02 06:37:50 +00:00
await node.suspend()
2020-10-02 06:37:50 +00:00
2021-04-13 09:16:50 +00:00
@router.post("/{node_id}/resume", status_code=status.HTTP_204_NO_CONTENT)
async def resume_router(node: Router = Depends(dep_node)):
2020-10-02 06:37:50 +00:00
"""
Resume a suspended Dynamips router.
"""
await node.resume()
2020-10-02 06:37:50 +00:00
2021-04-13 09:16:50 +00:00
@router.post("/{node_id}/reload", status_code=status.HTTP_204_NO_CONTENT)
async def reload_router(node: Router = Depends(dep_node)):
2020-10-02 06:37:50 +00:00
"""
Reload a suspended Dynamips router.
"""
await node.reload()
2020-10-02 06:37:50 +00:00
2021-04-13 09:16:50 +00:00
@router.post(
"/{node_id}/adapters/{adapter_number}/ports/{port_number}/nio",
status_code=status.HTTP_201_CREATED,
response_model=schemas.UDPNIO,
)
async def create_nio(adapter_number: int, port_number: int, nio_data: schemas.UDPNIO, node: Router = Depends(dep_node)):
2020-10-02 06:37:50 +00:00
"""
Add a NIO (Network Input/Output) to the node.
"""
nio = await Dynamips.instance().create_nio(node, jsonable_encoder(nio_data, exclude_unset=True))
await node.slot_add_nio_binding(adapter_number, port_number, nio)
2021-04-17 14:04:28 +00:00
return nio.asdict()
2020-10-02 06:37:50 +00:00
2021-04-13 09:16:50 +00:00
@router.put(
"/{node_id}/adapters/{adapter_number}/ports/{port_number}/nio",
status_code=status.HTTP_201_CREATED,
response_model=schemas.UDPNIO,
)
async def update_nio(adapter_number: int, port_number: int, nio_data: schemas.UDPNIO, node: Router = Depends(dep_node)):
2020-10-02 06:37:50 +00:00
"""
Update a NIO (Network Input/Output) on the node.
"""
nio = node.get_nio(adapter_number, port_number)
2020-10-02 06:37:50 +00:00
if nio_data.filters:
nio.filters = nio_data.filters
await node.slot_update_nio_binding(adapter_number, port_number, nio)
2021-04-17 14:04:28 +00:00
return nio.asdict()
2020-10-02 06:37:50 +00:00
2021-04-13 09:16:50 +00:00
@router.delete("/{node_id}/adapters/{adapter_number}/ports/{port_number}/nio", status_code=status.HTTP_204_NO_CONTENT)
async def delete_nio(adapter_number: int, port_number: int, node: Router = Depends(dep_node)):
2020-10-02 06:37:50 +00:00
"""
Delete a NIO (Network Input/Output) from the node.
"""
nio = await node.slot_remove_nio_binding(adapter_number, port_number)
2020-10-02 06:37:50 +00:00
await nio.delete()
2021-04-13 06:49:56 +00:00
@router.post("/{node_id}/adapters/{adapter_number}/ports/{port_number}/capture/start")
2021-04-13 09:16:50 +00:00
async def start_capture(
adapter_number: int, port_number: int, node_capture_data: schemas.NodeCapture, node: Router = Depends(dep_node)
):
2020-10-02 06:37:50 +00:00
"""
Start a packet capture on the node.
"""
pcap_file_path = os.path.join(node.project.capture_working_directory(), node_capture_data.capture_file_name)
2020-10-02 06:37:50 +00:00
2021-04-13 09:16:50 +00:00
if sys.platform.startswith("win"):
2020-10-02 06:37:50 +00:00
# FIXME: Dynamips (Cygwin actually) doesn't like non ascii paths on Windows
try:
2021-04-13 09:16:50 +00:00
pcap_file_path.encode("ascii")
2020-10-02 06:37:50 +00:00
except UnicodeEncodeError:
2021-04-13 09:16:50 +00:00
raise DynamipsError(
f"The capture file path '{pcap_file_path}' must only contain ASCII (English) characters"
)
2020-10-02 06:37:50 +00:00
await node.start_capture(adapter_number, port_number, pcap_file_path, node_capture_data.data_link_type)
2020-10-02 06:37:50 +00:00
return {"pcap_file_path": pcap_file_path}
2021-04-13 09:16:50 +00:00
@router.post(
"/{node_id}/adapters/{adapter_number}/ports/{port_number}/capture/stop", status_code=status.HTTP_204_NO_CONTENT
)
async def stop_capture(adapter_number: int, port_number: int, node: Router = Depends(dep_node)):
2020-10-02 06:37:50 +00:00
"""
Stop a packet capture on the node.
"""
await node.stop_capture(adapter_number, port_number)
2020-10-02 06:37:50 +00:00
2021-04-13 06:49:56 +00:00
@router.get("/{node_id}/adapters/{adapter_number}/ports/{port_number}/capture/stream")
async def stream_pcap_file(adapter_number: int, port_number: int, node: Router = Depends(dep_node)):
2020-10-02 06:37:50 +00:00
"""
Stream the pcap capture file.
"""
nio = node.get_nio(adapter_number, port_number)
stream = Dynamips.instance().stream_pcap_file(nio, node.project.id)
2020-10-02 06:37:50 +00:00
return StreamingResponse(stream, media_type="application/vnd.tcpdump.pcap")
2021-04-13 06:49:56 +00:00
@router.get("/{node_id}/idlepc_proposals")
async def get_idlepcs(node: Router = Depends(dep_node)) -> List[str]:
2020-10-02 06:37:50 +00:00
"""
Retrieve Dynamips idle-pc proposals
"""
await node.set_idlepc("0x0")
return await node.get_idle_pc_prop()
2020-10-02 06:37:50 +00:00
2021-04-13 06:49:56 +00:00
@router.get("/{node_id}/auto_idlepc")
async def get_auto_idlepc(node: Router = Depends(dep_node)) -> dict:
2020-10-02 06:37:50 +00:00
"""
Get an automatically guessed best idle-pc value.
"""
idlepc = await Dynamips.instance().auto_idlepc(node)
2020-10-02 06:37:50 +00:00
return {"idlepc": idlepc}
2021-04-13 09:16:50 +00:00
@router.post("/{node_id}/duplicate", status_code=status.HTTP_201_CREATED)
async def duplicate_router(destination_node_id: UUID, node: Router = Depends(dep_node)):
2020-10-02 06:37:50 +00:00
"""
Duplicate a router.
"""
new_node = await Dynamips.instance().duplicate_node(node.id, str(destination_node_id))
2021-04-17 14:04:28 +00:00
return new_node.asdict()
2020-10-02 06:37:50 +00:00
@router.websocket("/{node_id}/console/ws")
async def console_ws(websocket: WebSocket, node: Router = Depends(dep_node)):
"""
Console WebSocket.
"""
await node.start_websocket_console(websocket)
2020-10-02 06:37:50 +00:00
2021-04-13 09:16:50 +00:00
@router.post("/{node_id}/console/reset", status_code=status.HTTP_204_NO_CONTENT)
async def reset_console(node: Router = Depends(dep_node)):
2020-10-02 06:37:50 +00:00
await node.reset_console()