1
0
mirror of https://github.com/GNS3/gns3-server synced 2024-12-04 22:28:12 +00:00
gns3-server/gns3server/handlers/api/compute/dynamips_vm_handler.py

549 lines
20 KiB
Python
Raw Normal View History

2015-02-10 01:24:13 +00:00
# -*- coding: utf-8 -*-
#
# Copyright (C) 2015 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/>.
2015-02-13 22:41:56 +00:00
import os
import sys
import aiohttp
2015-02-10 01:24:13 +00:00
2016-05-14 00:00:07 +00:00
from gns3server.web.route import Route
from gns3server.schemas.nio import NIO_SCHEMA
from gns3server.compute.dynamips import Dynamips
from gns3server.compute.dynamips.dynamips_error import DynamipsError
from gns3server.compute.project_manager import ProjectManager
from gns3server.schemas.node import (
NODE_CAPTURE_SCHEMA,
NODE_LIST_IMAGES_SCHEMA,
)
from gns3server.schemas.dynamips_vm import (
VM_CREATE_SCHEMA,
VM_UPDATE_SCHEMA,
VM_OBJECT_SCHEMA
2016-05-14 00:00:07 +00:00
)
2015-02-10 01:24:13 +00:00
2015-03-24 03:13:22 +00:00
DEFAULT_CHASSIS = {
"c1700": "1720",
"c2600": "2610",
"c3600": "3640"
}
2015-02-23 16:21:39 +00:00
class DynamipsVMHandler:
2015-02-10 01:24:13 +00:00
"""
API entry points for Dynamips VMs.
2015-02-10 01:24:13 +00:00
"""
@Route.post(
r"/projects/{project_id}/dynamips/nodes",
2015-02-10 01:24:13 +00:00
parameters={
2016-05-14 00:00:07 +00:00
"project_id": "Project UUID"
2015-02-10 01:24:13 +00:00
},
status_codes={
201: "Instance created",
400: "Invalid request",
409: "Conflict"
},
2015-02-12 02:21:34 +00:00
description="Create a new Dynamips VM instance",
input=VM_CREATE_SCHEMA,
output=VM_OBJECT_SCHEMA)
async def create(request, response):
2015-02-10 01:24:13 +00:00
dynamips_manager = Dynamips.instance()
2015-03-24 03:13:22 +00:00
platform = request.json.pop("platform")
default_chassis = None
if platform in DEFAULT_CHASSIS:
default_chassis = DEFAULT_CHASSIS[platform]
vm = await dynamips_manager.create_node(request.json.pop("name"),
request.match_info["project_id"],
request.json.get("node_id"),
dynamips_id=request.json.get("dynamips_id"),
platform=platform,
console=request.json.get("console"),
console_type=request.json.get("console_type", "telnet"),
aux=request.json.get("aux"),
chassis=request.json.pop("chassis", default_chassis),
node_type="dynamips")
await dynamips_manager.update_vm_settings(vm, request.json)
2015-02-12 02:21:34 +00:00
response.set_status(201)
response.json(vm)
@Route.get(
r"/projects/{project_id}/dynamips/nodes/{node_id}",
2015-02-12 02:21:34 +00:00
parameters={
2016-05-14 00:00:07 +00:00
"project_id": "Project UUID",
"node_id": "Node UUID"
2015-02-12 02:21:34 +00:00
},
status_codes={
200: "Success",
400: "Invalid request",
404: "Instance doesn't exist"
},
description="Get a Dynamips VM instance",
output=VM_OBJECT_SCHEMA)
def show(request, response):
dynamips_manager = Dynamips.instance()
vm = dynamips_manager.get_node(request.match_info["node_id"], project_id=request.match_info["project_id"])
2015-02-12 02:21:34 +00:00
response.json(vm)
@Route.put(
r"/projects/{project_id}/dynamips/nodes/{node_id}",
2015-02-12 02:21:34 +00:00
parameters={
2016-05-14 00:00:07 +00:00
"project_id": "Project UUID",
"node_id": "Node UUID"
2015-02-12 02:21:34 +00:00
},
status_codes={
200: "Instance updated",
400: "Invalid request",
404: "Instance doesn't exist",
409: "Conflict"
},
description="Update a Dynamips VM instance",
input=VM_UPDATE_SCHEMA,
output=VM_OBJECT_SCHEMA)
async def update(request, response):
2015-02-12 02:21:34 +00:00
dynamips_manager = Dynamips.instance()
vm = dynamips_manager.get_node(request.match_info["node_id"], project_id=request.match_info["project_id"])
await dynamips_manager.update_vm_settings(vm, request.json)
vm.updated()
2015-02-10 01:24:13 +00:00
response.json(vm)
2015-02-12 02:21:34 +00:00
@Route.delete(
r"/projects/{project_id}/dynamips/nodes/{node_id}",
2015-02-12 02:21:34 +00:00
parameters={
2016-05-14 00:00:07 +00:00
"project_id": "Project UUID",
"node_id": "Node UUID"
2015-02-12 02:21:34 +00:00
},
status_codes={
204: "Instance deleted",
400: "Invalid request",
404: "Instance doesn't exist"
},
description="Delete a Dynamips VM instance")
async def delete(request, response):
2015-02-12 02:21:34 +00:00
# check the project_id exists
ProjectManager.instance().get_project(request.match_info["project_id"])
await Dynamips.instance().delete_node(request.match_info["node_id"])
2015-02-12 02:21:34 +00:00
response.set_status(204)
@Route.post(
r"/projects/{project_id}/dynamips/nodes/{node_id}/start",
2015-02-12 02:21:34 +00:00
parameters={
2016-05-14 00:00:07 +00:00
"project_id": "Project UUID",
"node_id": "Node UUID"
2015-02-12 02:21:34 +00:00
},
status_codes={
204: "Instance started",
400: "Invalid request",
404: "Instance doesn't exist"
},
description="Start a Dynamips VM instance")
async def start(request, response):
2015-02-12 02:21:34 +00:00
dynamips_manager = Dynamips.instance()
vm = dynamips_manager.get_node(request.match_info["node_id"], project_id=request.match_info["project_id"])
try:
await dynamips_manager.ghost_ios_support(vm)
except GeneratorExit:
pass
await vm.start()
2015-02-12 02:21:34 +00:00
response.set_status(204)
@Route.post(
r"/projects/{project_id}/dynamips/nodes/{node_id}/stop",
2015-02-12 02:21:34 +00:00
parameters={
2016-05-14 00:00:07 +00:00
"project_id": "Project UUID",
"node_id": "Node UUID"
2015-02-12 02:21:34 +00:00
},
status_codes={
204: "Instance stopped",
400: "Invalid request",
404: "Instance doesn't exist"
},
description="Stop a Dynamips VM instance")
async def stop(request, response):
2015-02-12 02:21:34 +00:00
dynamips_manager = Dynamips.instance()
vm = dynamips_manager.get_node(request.match_info["node_id"], project_id=request.match_info["project_id"])
await vm.stop()
2015-02-12 02:21:34 +00:00
response.set_status(204)
@Route.post(
r"/projects/{project_id}/dynamips/nodes/{node_id}/suspend",
2015-02-12 02:21:34 +00:00
parameters={
2016-05-14 00:00:07 +00:00
"project_id": "Project UUID",
"node_id": "Node UUID"
2015-02-12 02:21:34 +00:00
},
status_codes={
204: "Instance suspended",
400: "Invalid request",
404: "Instance doesn't exist"
},
description="Suspend a Dynamips VM instance")
async def suspend(request, response):
2015-02-12 02:21:34 +00:00
dynamips_manager = Dynamips.instance()
vm = dynamips_manager.get_node(request.match_info["node_id"], project_id=request.match_info["project_id"])
await vm.suspend()
2015-02-12 02:21:34 +00:00
response.set_status(204)
@Route.post(
r"/projects/{project_id}/dynamips/nodes/{node_id}/resume",
2015-02-12 02:21:34 +00:00
parameters={
2016-05-14 00:00:07 +00:00
"project_id": "Project UUID",
"node_id": "Node UUID"
2015-02-12 02:21:34 +00:00
},
status_codes={
204: "Instance resumed",
400: "Invalid request",
404: "Instance doesn't exist"
},
description="Resume a suspended Dynamips VM instance")
async def resume(request, response):
2015-02-12 02:21:34 +00:00
dynamips_manager = Dynamips.instance()
vm = dynamips_manager.get_node(request.match_info["node_id"], project_id=request.match_info["project_id"])
await vm.resume()
2015-02-12 02:21:34 +00:00
response.set_status(204)
@Route.post(
r"/projects/{project_id}/dynamips/nodes/{node_id}/reload",
2015-02-12 02:21:34 +00:00
parameters={
2016-05-14 00:00:07 +00:00
"project_id": "Project UUID",
"node_id": "Node UUID"
2015-02-12 02:21:34 +00:00
},
status_codes={
204: "Instance reloaded",
400: "Invalid request",
404: "Instance doesn't exist"
},
description="Reload a Dynamips VM instance")
async def reload(request, response):
2015-02-12 02:21:34 +00:00
dynamips_manager = Dynamips.instance()
vm = dynamips_manager.get_node(request.match_info["node_id"], project_id=request.match_info["project_id"])
await vm.reload()
2015-02-12 02:21:34 +00:00
response.set_status(204)
2015-02-13 22:11:14 +00:00
@Route.post(
r"/projects/{project_id}/dynamips/nodes/{node_id}/adapters/{adapter_number:\d+}/ports/{port_number:\d+}/nio",
2015-02-13 22:11:14 +00:00
parameters={
2016-05-14 00:00:07 +00:00
"project_id": "Project UUID",
"node_id": "Node UUID",
2015-02-13 22:11:14 +00:00
"adapter_number": "Adapter where the nio should be added",
"port_number": "Port on the adapter"
},
status_codes={
201: "NIO created",
400: "Invalid request",
404: "Instance doesn't exist"
},
description="Add a NIO to a Dynamips VM instance",
input=NIO_SCHEMA,
output=NIO_SCHEMA)
async def create_nio(request, response):
2015-02-13 22:11:14 +00:00
dynamips_manager = Dynamips.instance()
vm = dynamips_manager.get_node(request.match_info["node_id"], project_id=request.match_info["project_id"])
nio = await dynamips_manager.create_nio(vm, request.json)
2015-02-13 22:11:14 +00:00
slot_number = int(request.match_info["adapter_number"])
port_number = int(request.match_info["port_number"])
await vm.slot_add_nio_binding(slot_number, port_number, nio)
2015-02-13 22:11:14 +00:00
response.set_status(201)
response.json(nio)
@Route.put(
r"/projects/{project_id}/dynamips/nodes/{node_id}/adapters/{adapter_number:\d+}/ports/{port_number:\d+}/nio",
parameters={
"project_id": "Project UUID",
"node_id": "Node UUID",
"adapter_number": "Network adapter where the nio is located",
"port_number": "Port from where the nio should be updated"
},
status_codes={
201: "NIO updated",
400: "Invalid request",
404: "Instance doesn't exist"
},
input=NIO_SCHEMA,
output=NIO_SCHEMA,
description="Update a NIO on a Dynamips instance")
async def update_nio(request, response):
dynamips_manager = Dynamips.instance()
vm = dynamips_manager.get_node(request.match_info["node_id"], project_id=request.match_info["project_id"])
slot_number = int(request.match_info["adapter_number"])
port_number = int(request.match_info["port_number"])
nio = vm.get_nio(slot_number, port_number)
if "filters" in request.json:
nio.filters = request.json["filters"]
await vm.slot_update_nio_binding(slot_number, port_number, nio)
response.set_status(201)
response.json(request.json)
2015-02-13 22:11:14 +00:00
@Route.delete(
r"/projects/{project_id}/dynamips/nodes/{node_id}/adapters/{adapter_number:\d+}/ports/{port_number:\d+}/nio",
2015-02-13 22:11:14 +00:00
parameters={
2016-05-14 00:00:07 +00:00
"project_id": "Project UUID",
"node_id": "Node UUID",
2015-02-13 22:11:14 +00:00
"adapter_number": "Adapter from where the nio should be removed",
"port_number": "Port on the adapter"
},
status_codes={
204: "NIO deleted",
400: "Invalid request",
404: "Instance doesn't exist"
},
description="Remove a NIO from a Dynamips VM instance")
async def delete_nio(request, response):
2015-02-13 22:11:14 +00:00
dynamips_manager = Dynamips.instance()
vm = dynamips_manager.get_node(request.match_info["node_id"], project_id=request.match_info["project_id"])
2015-02-13 22:11:14 +00:00
slot_number = int(request.match_info["adapter_number"])
port_number = int(request.match_info["port_number"])
nio = await vm.slot_remove_nio_binding(slot_number, port_number)
await nio.delete()
2015-02-13 22:11:14 +00:00
response.set_status(204)
2015-02-13 22:41:56 +00:00
@Route.post(
r"/projects/{project_id}/dynamips/nodes/{node_id}/adapters/{adapter_number:\d+}/ports/{port_number:\d+}/start_capture",
2015-02-13 22:41:56 +00:00
parameters={
2016-05-14 00:00:07 +00:00
"project_id": "Project UUID",
"node_id": "Node UUID",
2015-02-13 22:41:56 +00:00
"adapter_number": "Adapter to start a packet capture",
"port_number": "Port on the adapter"
},
status_codes={
200: "Capture started",
400: "Invalid request",
404: "Instance doesn't exist"
},
description="Start a packet capture on a Dynamips VM instance",
input=NODE_CAPTURE_SCHEMA)
async def start_capture(request, response):
2015-02-13 22:41:56 +00:00
dynamips_manager = Dynamips.instance()
vm = dynamips_manager.get_node(request.match_info["node_id"], project_id=request.match_info["project_id"])
2015-02-13 22:41:56 +00:00
slot_number = int(request.match_info["adapter_number"])
port_number = int(request.match_info["port_number"])
pcap_file_path = os.path.join(vm.project.capture_working_directory(), request.json["capture_file_name"])
if sys.platform.startswith('win'):
2015-11-09 11:28:00 +00:00
# FIXME: Dynamips (Cygwin actually) doesn't like non ascii paths on Windows
try:
pcap_file_path.encode('ascii')
except UnicodeEncodeError:
raise DynamipsError('The capture file path "{}" must only contain ASCII (English) characters'.format(pcap_file_path))
await vm.start_capture(slot_number, port_number, pcap_file_path, request.json["data_link_type"])
2015-02-13 22:41:56 +00:00
response.json({"pcap_file_path": pcap_file_path})
@Route.post(
r"/projects/{project_id}/dynamips/nodes/{node_id}/adapters/{adapter_number:\d+}/ports/{port_number:\d+}/stop_capture",
2015-02-13 22:41:56 +00:00
parameters={
2016-05-14 00:00:07 +00:00
"project_id": "Project UUID",
"node_id": "Node UUID",
2015-02-13 22:41:56 +00:00
"adapter_number": "Adapter to stop a packet capture",
"port_number": "Port on the adapter (always 0)"
},
status_codes={
204: "Capture stopped",
400: "Invalid request",
404: "Instance doesn't exist"
},
description="Stop a packet capture on a Dynamips VM instance")
async def stop_capture(request, response):
2015-02-13 22:41:56 +00:00
dynamips_manager = Dynamips.instance()
vm = dynamips_manager.get_node(request.match_info["node_id"], project_id=request.match_info["project_id"])
2015-02-13 22:41:56 +00:00
slot_number = int(request.match_info["adapter_number"])
port_number = int(request.match_info["port_number"])
await vm.stop_capture(slot_number, port_number)
2015-02-13 22:41:56 +00:00
response.set_status(204)
@Route.get(
r"/projects/{project_id}/dynamips/nodes/{node_id}/adapters/{adapter_number:\d+}/ports/{port_number:\d+}/pcap",
description="Stream the pcap capture file",
parameters={
"project_id": "Project UUID",
"node_id": "Node UUID",
"adapter_number": "Adapter to steam a packet capture",
"port_number": "Port on the adapter (always 0)"
},
status_codes={
200: "File returned",
403: "Permission denied",
404: "The file doesn't exist"
})
async def stream_pcap_file(request, response):
dynamips_manager = Dynamips.instance()
vm = dynamips_manager.get_node(request.match_info["node_id"], project_id=request.match_info["project_id"])
slot_number = int(request.match_info["adapter_number"])
port_number = int(request.match_info["port_number"])
nio = vm.get_nio(slot_number, port_number)
await dynamips_manager.stream_pcap_file(nio, vm.project.id, request, response)
2015-02-20 02:14:30 +00:00
@Route.get(
r"/projects/{project_id}/dynamips/nodes/{node_id}/idlepc_proposals",
2016-05-14 00:00:07 +00:00
parameters={
"project_id": "Project UUID",
"node_id": "Node UUID",
},
2015-02-20 02:14:30 +00:00
status_codes={
200: "Idle-PCs retrieved",
400: "Invalid request",
404: "Instance doesn't exist"
},
description="Retrieve the idlepc proposals")
async def get_idlepcs(request, response):
2015-02-20 02:14:30 +00:00
dynamips_manager = Dynamips.instance()
vm = dynamips_manager.get_node(request.match_info["node_id"], project_id=request.match_info["project_id"])
await vm.set_idlepc("0x0")
idlepcs = await vm.get_idle_pc_prop()
2015-02-20 23:53:51 +00:00
response.set_status(200)
response.json(idlepcs)
@Route.get(
r"/projects/{project_id}/dynamips/nodes/{node_id}/auto_idlepc",
2016-05-14 00:00:07 +00:00
parameters={
"project_id": "Project UUID",
"node_id": "Node UUID",
},
2015-02-20 23:53:51 +00:00
status_codes={
200: "Best Idle-pc value found",
400: "Invalid request",
404: "Instance doesn't exist"
},
description="Retrieve the idlepc proposals")
async def get_auto_idlepc(request, response):
2015-02-20 02:14:30 +00:00
2015-02-20 23:53:51 +00:00
dynamips_manager = Dynamips.instance()
vm = dynamips_manager.get_node(request.match_info["node_id"], project_id=request.match_info["project_id"])
idlepc = await dynamips_manager.auto_idlepc(vm)
2015-02-20 02:14:30 +00:00
response.set_status(200)
2015-02-20 23:53:51 +00:00
response.json({"idlepc": idlepc})
@Route.get(
2016-05-14 00:00:07 +00:00
r"/dynamips/images",
status_codes={
2016-05-14 00:00:07 +00:00
200: "List of Dynamips IOS images",
},
2016-05-14 00:00:07 +00:00
description="Retrieve the list of Dynamips IOS images",
output=NODE_LIST_IMAGES_SCHEMA)
async def list_images(request, response):
dynamips_manager = Dynamips.instance()
images = await dynamips_manager.list_images()
response.set_status(200)
2016-05-14 00:00:07 +00:00
response.json(images)
@Route.post(
2016-05-14 00:00:07 +00:00
r"/dynamips/images/{filename:.+}",
parameters={
"filename": "Image filename"
},
status_codes={
2016-05-14 00:00:07 +00:00
204: "Upload a Dynamips IOS image",
},
raw=True,
2016-05-14 00:00:07 +00:00
description="Upload a Dynamips IOS image")
async def upload_image(request, response):
dynamips_manager = Dynamips.instance()
filename = os.path.normpath(request.match_info["filename"])
await dynamips_manager.write_image(filename, request.content)
response.set_status(204)
@Route.get(
r"/dynamips/images/{filename:.+}",
parameters={
"filename": "Image filename"
},
status_codes={
200: "Image returned",
},
raw=True,
description="Download a Dynamips IOS image")
async def download_image(request, response):
filename = os.path.normpath(request.match_info["filename"])
# Raise error if user try to escape
2021-05-15 08:05:32 +00:00
if filename[0] == "." or os.path.sep in filename:
raise aiohttp.web.HTTPForbidden()
2021-05-15 08:05:32 +00:00
dynamips_manager = Dynamips.instance()
image_path = dynamips_manager.get_abs_image_path(filename)
2019-03-06 16:00:01 +00:00
await response.stream_file(image_path)
@Route.post(
r"/projects/{project_id}/dynamips/nodes/{node_id}/duplicate",
parameters={
"project_id": "Project UUID",
"node_id": "Node UUID"
},
status_codes={
201: "Instance duplicated",
404: "Instance doesn't exist"
},
description="Duplicate a dynamips instance")
async def duplicate(request, response):
new_node = await Dynamips.instance().duplicate_node(request.match_info["node_id"],
request.json["destination_node_id"])
response.set_status(201)
response.json(new_node)
2020-01-31 09:31:27 +00:00
@Route.get(
r"/projects/{project_id}/dynamips/nodes/{node_id}/console/ws",
description="WebSocket for console",
parameters={
"project_id": "Project UUID",
"node_id": "Node UUID",
})
async def console_ws(request, response):
dynamips_manager = Dynamips.instance()
vm = dynamips_manager.get_node(request.match_info["node_id"], project_id=request.match_info["project_id"])
return await vm.start_websocket_console(request)
@Route.post(
r"/projects/{project_id}/dynamips/nodes/{node_id}/console/reset",
description="Reset console",
parameters={
"project_id": "Project UUID",
"node_id": "Node UUID",
},
status_codes={
204: "Console has been reset",
400: "Invalid request",
404: "Instance doesn't exist",
409: "Container not started"
})
async def reset_console(request, response):
dynamips_manager = Dynamips.instance()
vm = dynamips_manager.get_node(request.match_info["node_id"], project_id=request.match_info["project_id"])
await vm.reset_console()
response.set_status(204)